Lightspeed · Schema

id-cards-apiCreateIdCardsResponse

id-cards-apiCreateIdCardsResponse schema from Lightspeed Restaurant K Series API

POSRetailRestaurantEcommerce

Properties

Name Type Description
batchId integer The unique identifier for the batch the cards were added to.
cards array
View JSON Schema on GitHub

JSON Schema

restaurant-k-series-id-cards-api-create-id-cards-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "id-cards-apiCreateIdCardsResponse",
  "description": "id-cards-apiCreateIdCardsResponse schema from Lightspeed Restaurant K Series API",
  "$id": "https://raw.githubusercontent.com/api-evangelist/lightspeed-pos/refs/heads/main/json-schema/restaurant-k-series-id-cards-api-create-id-cards-response-schema.json",
  "type": "object",
  "properties": {
    "batchId": {
      "type": "integer",
      "format": "int64",
      "description": "The unique identifier for the batch the cards were added to.",
      "example": 12345
    },
    "cards": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int64",
            "description": "The unique identifier for the ID card.",
            "example": 98765
          },
          "consumerRecordId": {
            "type": "integer",
            "format": "int64",
            "description": "The unique identifier for the associated consumer record.",
            "example": 54321
          },
          "consumerId": {
            "type": "integer",
            "format": "int64",
            "description": "The unique identifier for the associated consumer.",
            "example": 13579
          },
          "url": {
            "type": "string",
            "description": "The URL for the QR code associated with the ID card.",
            "example": "https://example.com/id-cards/98765/qr-code"
          }
        }
      }
    }
  }
}