Lightspeed · JSON Structure

Restaurant K Series Ape Account Profiles Structure

apeAccountProfiles schema from Lightspeed Restaurant K Series API

Type: object Properties: 2
POSRetailRestaurantEcommerce

apeAccountProfiles 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

businessLocationId accountProfileList

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-account-profiles-structure.json",
  "name": "apeAccountProfiles",
  "description": "apeAccountProfiles schema from Lightspeed Restaurant K Series API",
  "type": "object",
  "properties": {
    "businessLocationId": {
      "description": "The unique identifier for the business location.",
      "type": "int64",
      "example": 45454565682155
    },
    "accountProfileList": {
      "items": {
        "properties": {
          "id": {
            "type": "int64",
            "description": "The unique identifier for the order profile.",
            "example": 12454575601144
          },
          "code": {
            "type": "string",
            "description": "A short code representing the order profile.",
            "example": "takeaway"
          },
          "name": {
            "type": "string",
            "example": "Takeaway",
            "description": "The system display name for the order profile."
          },
          "deliveryMode": {
            "enum": [
              "NONE",
              "TAKE_AWAY",
              "DELIVERY"
            ],
            "type": "string",
            "example": "TAKE_AWAY",
            "description": "Specifies the delivery mode for the order profile."
          }
        },
        "type": "object"
      },
      "type": "array"
    }
  }
}