Lightspeed Restaurant K Series API
1.0.0

Lightspeed Restaurant offers a REST API in order to communicate with the data in the system. These APIs are built using the RESTful standards and adhere to the basic verb interactions as defined by the REST standard.

These services are in continuous development and subject to change. Find our versioning policy here.

This is the documentation for version 1.0.0 of the API. Last update on May 1, 2024.

Base URL 
https://api.trial.lsk.lightspeed.app

Get Single Menu

GET /o/op/1/menu/load/{menuId}
OAuth2

Returns details of a particular menu based on its unique identifier and other query parameters.

Path parameters

  • menuId integer(int64) Required

    Unique identifier for the menu.

Query parameters

  • businessLocationId integer(int64) Required

    The unique identifier of the business location.

  • accountProfile string

    The account profile code. Item prices returned will be those associated with this account profile, when applicable. See Guide for more details.

    Default value is empty.

  • richContent boolean

    Query parameter to include rich content of menu items.

    Default value is false.

Responses

  • • 200 application/json

    Successful retrieval of menu details.

    Hide response attributes Show response attributes object
    • menuName string

      The name of the menu.

    • menuEntryGroups array[object]

      Menu groups of this menu. The top-level entry will always be of type "group", representing a menu screen. Beneath each menuEntryGroup will be a menuEntry array containing any combination of one or more menu entries:

      • A menuItemEntry represents an individual item.
      • A menuGroupEntry represents a menu sub-screen.
      • A menuDealEntry represents a combo.
      Hide menuEntryGroups attributes Show menuEntryGroups attributes object
      • @type string

        Indicates this is a menu group, which represents a menu screen in the POS.

        Value is group.

      • id string

        The menu group ID.

      • name string

        The menu group name.

      • color string

        The color of the button in the POS.

      • menuEntry array[object]

        Array of menu entry objects.

        One of:
        apeMenuItemEntry object apeMenuDealEntry object apeMenuGroupEntry object
    • richDataMissing boolean

      Indicates whether or not rich item data is missing, if requested.

    • ikentooMenuId integer(int64)

      The unique identifier for the menu.
  • • 503 */*

    Service Unavailable

    Hide response attributes Show response attributes object
GET /o/op/1/menu/load/{menuId} 
curl \
 -X GET https://api.trial.lsk.lightspeed.app/o/op/1/menu/load/141948669132851?businessLocationId=45454565682155 \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "menuName": "Main Menu",
  "menuEntryGroups": [
    {
      "@type": "group",
      "id": "141948669133028",
      "name": "Mains",
      "color": "blue",
      "menuEntry": [
        {
          "@type": "menuItem",
          "productName": "Burger",
          "productPrice": 10.0,
          "color": "blue",
          "sku": "25",
          "customItemNameEnabled": false,
          "pricingStrategy": "PRICE_CANNOT_BE_CUSTOMIZED",
          "itemRichData": {
            "squareImageUrl": "http://s3-eu-west-1.amazonaws.com/com.ikentoo.trial.rich-content-store/8262_2f6c1716-0f06-488c-afc2-d888666d94fb.image/png",
            "rawImageUrl": "http://s3-eu-west-1.amazonaws.com/com.ikentoo.trial.rich-content-store/8262_2f6c1716-0f06-488c-afc2-d888666d94fb_raw.image/png",
            "texts": [
              {
                "locale": "en",
                "friendlyDisplayName": "Burger - ENG",
                "description": "<p>Burger in english</p>"
              }
            ],
            "allergenCodes": [
              "mustard",
              "cereals"
            ]
          },
          "defaultTaxAmount": 1.5,
          "defaultTaxPercentage": 15.0,
          "taxIncludedInPrice": false,
          "asSubItem": true,
          "productionInstructionList": [
            {
              "multiSelectionPermitted": false,
              "productionInstructionGroupName": "Meat cooking",
              "productionIntructionGroupId": 236025632784487,
              "productionInstructionList": [
                {
                  "instruction": "Bleu",
                  "ikentooModifierId": 236025632784488
                },
                {
                  "instruction": "Rare",
                  "ikentooModifierId": 236025632784490
                },
                {
                  "instruction": "Medium Rare",
                  "ikentooModifierId": 236025632784492
                },
                {
                  "instruction": "Medium",
                  "ikentooModifierId": 236025632784494
                },
                {
                  "instruction": "Medium well",
                  "ikentooModifierId": 236025632784496
                },
                {
                  "instruction": "Well done",
                  "ikentooModifierId": 236025632784498
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "richDataMissing": false,
  "ikentooMenuId": 141948669132851
}
Response examples (503) 
{
  "status": "503",
  "timestamp": "2024-05-04T09:42:00+00:00",
  "message": "string",
  "apiSubExceptions": [
    {
      "field": "string",
      "rejectedValue": "string",
      "message": "string"
    }
  ]
}