Lightspeed · JSON Structure

Restaurant K Series Ape Restricted Item Paginated Response Structure

apeRestrictedItemPaginatedResponse schema from Lightspeed Restaurant K Series API

Type: object Properties: 2
POSRetailRestaurantEcommerce

apeRestrictedItemPaginatedResponse is a JSON Structure definition published by Lightspeed, describing 2 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

data metadata

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/lightspeed-pos/refs/heads/main/json-structure/restaurant-k-series-ape-restricted-item-paginated-response-structure.json",
  "name": "apeRestrictedItemPaginatedResponse",
  "description": "apeRestrictedItemPaginatedResponse schema from Lightspeed Restaurant K Series API",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sku": {
            "type": "string",
            "description": "The SKU assigned to the item.",
            "example": "SKU1"
          },
          "count": {
            "type": "int64",
            "description": "The count of available items.",
            "example": 50
          },
          "updatedAt": {
            "type": "datetime",
            "description": "The last update of the item count.",
            "example": "2025-07-08T14:20:00Z"
          }
        }
      }
    },
    "metadata": {
      "type": "object",
      "properties": {
        "warnings": {
          "description": "A list of warnings that occurred during the request, but which did not prevent a successful response.  For instance, if the Business Location does not have the required POS app version to support item availability.",
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "information": {
                "type": "string"
              },
              "type": {
                "type": "string"
              }
            }
          }
        },
        "current": {
          "type": "object",
          "properties": {
            "page": {
              "type": "int32",
              "description": "Current page number.",
              "example": 0
            },
            "pageSize": {
              "type": "int32",
              "description": "Number of items per page.",
              "example": 50
            }
          }
        },
        "total": {
          "type": "int32",
          "example": 1,
          "description": "Total number of items requested."
        },
        "totalPages": {
          "type": "int32",
          "example": 10,
          "description": "Total number of pages of items."
        }
      }
    }
  }
}