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 rich items

GET /i/richItem/{businessId}
OAuth2

Returns all of the rich item information for a specific business.

Path parameters

Query parameters

  • page integer

    Starting page of results, when paginating.

    Default value is 0.

  • size integer

    Number of results to return, when paginating.

    Default value is 1000.

  • sort array[string]

    Field used to determine order of results.

Responses

  • • 200 application/hal+json;charset=UTF-8

    OK

    Hide response attributes Show response attributes object
    • _embedded object
      Hide _embedded attribute Show _embedded attribute
      • richItemDtoList array[object]

        List of rich items

        Hide richItemDtoList attributes Show richItemDtoList attributes object
        • businessId integer(int64)

          The id of the business

        • sku string

          A stock-keeping unit

        • descriptions array[object]

          Stores a description with its locale code

          Hide descriptions attributes Show descriptions attributes object
          • localeCode string Required

            Language code (ISO 639) of the description

            Minimum length is 2, maximum length is 7.

          • description string

            Item description in the provided language

            Maximum length is 4000.

          • displayName string

            Display name (for the customer) in the provided language

        • allergenCodes array[string]

          List of allergen codes

        • creationDate string(date-time)

          Creation date of the richItem

        • lastUpdateDate string(date-time)

          Last update date of the richItem

        • pictureUrl string

          URL of the picture

        • rawPictureUrl string

          URL of the raw picture

        • _links object
          Hide _links attributes Show _links attributes
          • self object
            Hide self attribute Show self attribute
          • items object
            Hide items attribute Show items attribute
    • _links object
      Hide _links attribute Show _links attribute
      • self object
        Hide self attribute Show self attribute
GET /i/richItem/{businessId} 
curl \
 -X GET https://api.trial.lsk.lightspeed.app/i/richItem/454335871 \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "_embedded": {
    "richItemDtoList": [
      {
        "businessId": 454335871,
        "sku": "UGG-BB-PUR-06",
        "descriptions": [
          {
            "localeCode": "de",
            "description": "Das ist ein Test",
            "displayName": "Rich Item 1 DE"
          },
          {
            "localeCode": "en",
            "description": "This is a test for a rich item",
            "displayName": "Rich Item 1"
          }
        ],
        "allergenCodes": [
          "milk",
          "cereals"
        ],
        "creationDate": "2021-11-03T13:50:47Z",
        "lastUpdateDate": "2021-11-11T16:29:56Z",
        "pictureUrl": "http://s3-eu-west-1.amazonaws.com/com.ikentoo.trial.rich-content-store/25372_029b5ad1-08f7-4e1f-9087-3ca91ad818f7.png",
        "rawPictureUrl": "http://s3-eu-west-1.amazonaws.com/com.ikentoo.trial.rich-content-store/25372_029b5ad1-08f7-4e1f-9087-3ca91ad818f7_raw.png",
        "_links": {
          "self": {
            "href": "https://api.sbx.lsk.lightspeed.app/i/richItem/454335871/UGG-BB-PUR-06"
          },
          "items": {
            "href": "https://api.sbx.lsk.lightspeed.app/i/richItem/454335871/"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.sbx.lsk.lightspeed.app/i/richItem/454335871/UGG-BB-PUR-06"
    }
  }
}