Lightspeed Commerce

Lightspeed Commerce Rich Item API

The Rich Item API from Lightspeed Commerce — 6 operation(s) for rich item.

GitHub OpenAPI
Business capability
Product Content Authoring Management BC-2370.20

Operations 10

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /i/allergens List allergens available for rich items · Get allergens #
Ask an LLM
“Which allergens can I tag on a menu item?”
“Where do I get the list of allergen codes for rich items?”
Tell an agent
List every allergen I can add to a rich item.
Show the allergen codes supported for item descriptions.
GET /i/locales/{businessId} Get a business's item languages · Get locales #
Ask an LLM
“Which languages are my item descriptions set up in?”
“How do I check the locales configured for a business?”
Tell an agent
Get the item locales for business {businessId}.
Show which languages business {businessId} uses for items.
PUT /i/locales/{businessId} Set a business's item languages · Update locales #
Ask an LLM
“How do I add French as an item language for my business?”
“Can item languages use regional codes like en_US?”
Tell an agent
Update the item languages for business {businessId}.
Set the supported locales on business {businessId} to English and French.
GET /i/richItem/{businessId} List all rich items for a business · Get rich items #
Ask an LLM
“How do I get all rich item descriptions and allergens for my business?”
“Can I page and sort through the full rich item catalog?”
Tell an agent
List all rich items for business {businessId}.
Get rich items for business {businessId}, page {page}, sorted by {sort}.
GET /i/richItem/{businessId}/{sku} Get one rich item by SKU · Get rich item by sku #
Ask an LLM
“How do I fetch the rich content for a single SKU?”
“What allergens and descriptions are stored for one item?”
Tell an agent
Get the rich item for SKU {sku} in business {businessId}.
Show the description and allergens for item {sku} at business {businessId}.
PATCH /i/richItem/{businessId}/{sku} Set the picture on a rich item · Update picture #
Ask an LLM
“How do I upload a photo for a menu item?”
“Can I send a raw picture along with its file type?”
Tell an agent
Set the picture for rich item {sku} at business {businessId} to {picture}.
Upload raw picture {rawPicture} of type {fileType} to item {sku} in business {businessId}.
PUT /i/richItem/{businessId}/{sku} Create or update a rich item's details · Create or update rich item #
Ask an LLM
“How do I add allergens and descriptions to a menu item?”
“Can I change an item's SKU when updating its rich content?”
Tell an agent
Set allergens {allergenCodes} on rich item {sku} for business {businessId}.
Create or update the rich item descriptions {descriptions} for SKU {sku} at business {businessId}.
DELETE /i/richItem/{businessId}/{sku} Delete a rich item · Delete rich item #
Ask an LLM
“How do I remove the rich content for an item?”
“Can I delete a rich item by its SKU?”
Tell an agent destructive · confirm first
Delete the rich item {sku} from business {businessId}.
Remove rich content for SKU {sku} at business {businessId}.
POST /i/richItem/{businessId}/itemsBySkus Get rich items for a list of SKUs · Get rich items by SKUs #
Ask an LLM
“Can I fetch rich content for several specific SKUs at once?”
“How do I get rich items for just the SKUs on an order?”
Tell an agent
Get rich items for a list of SKUs in business {businessId}.
Look up rich content for these specific SKUs at business {businessId}.
GET /i/richItem/{businessId}/pictureSpec Get picture requirements for rich items · Get picture specifications #
Ask an LLM
“What size and format must a rich item picture be?”
“Which picture specifications apply before I upload an item photo?”
Tell an agent
Get the rich item picture specifications for business {businessId}.
Show the image requirements for item photos at business {businessId}.

Documentation

📖
Documentation
https://x-series-api.lightspeedhq.com/docs/introduction
📖
APIReference
https://x-series-api.lightspeedhq.com/reference
📖
GettingStarted
https://x-series-api.lightspeedhq.com/docs/quick_start
📖
Documentation
https://api-portal.lsk.lightspeed.app/
📖
APIReference
https://api-docs.lsk.lightspeed.app/
📖
GettingStarted
https://api-portal.lsk.lightspeed.app/quick-start/intro

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/lightspeed/refs/heads/main/openapi/lightspeed-rich-item-api-openapi.yml

Other Resources

🔗
ChangeLog
https://x-series-api.lightspeedhq.com/changelog
🔗
LLMsTxt
https://raw.githubusercontent.com/api-evangelist/lightspeed/refs/heads/main/llms/lightspeed-llms.txt
🔗
SignUp
https://developers.retail.lightspeed.app/register
🔗
ChangeLog
https://api-docs.lsk.lightspeed.app/changes

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/lightspeed:lightspeed-rich-item-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

lightspeed-rich-item-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 1.0.0
  title: Lightspeed Restaurant K Series Rich Item API
  description: '**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.

    Detailed developer guides can be found in the Lightspeed Restaurant API Portal.

    These services are in continuous development and subject to change. Please find our versioning policy here.'
  x-logo:
    altText: Lightspeed Commerce
    url: static/lightspeed@2x.png
servers:
- url: https://api.trial.lsk.lightspeed.app
  description: Demo URL
  x-bump-branch-name: demo
- url: https://api.lsk.lightspeed.app
  description: Production URL
  x-bump-branch-name: prod
tags:
- name: Rich Item
paths:
  /i/allergens:
    get:
      summary: Get allergens
      operationId: teckelGetAllergens
      description: Returns a list of all possible allergens that can be added to a rich item. See Allergens Table for more details.
      tags:
      - Rich Item
      responses:
        '200':
          description: Allergens
          content:
            application/json:
              schema:
                description: A list of allergens.
                items:
                  description: Allergen
                  properties:
                    code:
                      description: The allergen code.
                      example: fish
                      type: string
                    translations:
                      description: List of translations.
                      example:
                      - locale: en
                        text: Fish
                      - locale: fr
                        text: Poisson
                      items:
                        properties:
                          locale:
                            description: Language locale (eg. 'en' or 'en_US').
                            example: en
                            nullable: false
                            type: string
                          text:
                            description: Translation in the language of the locale.
                            type: string
                        type: object
                      uniqueItems: true
                      type: array
                  type: object
                type: array
      security:
      - OAuth2:
        - orders-api
  /i/locales/{businessId}:
    get:
      summary: Get locales
      operationId: teckelGetLocales
      description: Returns the locales of a business in ISO Code 2 or language_localization (eg. 'en' or 'en_US').
      tags:
      - Rich Item
      parameters:
      - $ref: '#/components/parameters/teckelPathBusinessId'
      responses:
        '200':
          description: Locales
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teckelLocalesDto'
      security:
      - OAuth2:
        - orders-api
    put:
      summary: Update locales
      operationId: teckelUpdateLocales
      description: Sets business item languages. Supports language ISO code 2 or language_localization (eg. 'en' or 'en_US').
      tags:
      - Rich Item
      parameters:
      - $ref: '#/components/parameters/teckelPathBusinessId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/teckelLocalesDto'
        required: true
      responses:
        '200':
          description: OK
      security:
      - OAuth2:
        - orders-api
  /i/richItem/{businessId}:
    get:
      summary: Get rich items
      operationId: teckelGetRichItems
      description: Returns all of the rich item information for a specific business.
      tags:
      - Rich Item
      parameters:
      - $ref: '#/components/parameters/teckelPathBusinessId'
      - $ref: '#/components/parameters/teckelPage'
      - $ref: '#/components/parameters/teckelSize'
      - $ref: '#/components/parameters/teckelSort'
      responses:
        '200':
          description: Rich Items
          content:
            application/hal+json;charset=UTF-8:
              schema:
                properties:
                  _embedded:
                    properties:
                      richItemDtoList:
                        description: List of rich items
                        items:
                          allOf:
                          - $ref: '#/components/schemas/teckelRichItemDto'
                          - $ref: '#/components/schemas/teckelRichItemDtoDates'
                          - $ref: '#/components/schemas/teckelRichItemDtoPictures'
                          - $ref: '#/components/schemas/teckelRichItemDtoLinks'
                          type: object
                        type: array
                    type: object
                  _links:
                    $ref: '#/components/schemas/teckelLinkSelfPage'
      security:
      - OAuth2:
        - orders-api
  /i/richItem/{businessId}/{sku}:
    get:
      summary: Get rich item by sku
      operationId: teckelGetRichItem
      description: Get a rich item from its sku and the business id.
      tags:
      - Rich Item
      parameters:
      - $ref: '#/components/parameters/teckelPathBusinessId'
      - $ref: '#/components/parameters/teckelPathSKU'
      responses:
        '200':
          description: OK
          content:
            application/hal+json;charset=UTF-8:
              schema:
                allOf:
                - $ref: '#/components/schemas/teckelRichItemDto'
                - $ref: '#/components/schemas/teckelRichItemDtoDates'
                - $ref: '#/components/schemas/teckelRichItemDtoPictures'
                - $ref: '#/components/schemas/teckelRichItemDtoLinks'
                type: object
        '404':
          description: Not Found
      security:
      - OAuth2:
        - orders-api
    patch:
      summary: Update picture
      operationId: teckelUpdateRichItemPicture
      description: Partially updates the rich item to set the picture or rawPicture.
      tags:
      - Rich Item
      parameters:
      - $ref: '#/components/parameters/teckelPathBusinessId'
      - $ref: '#/components/parameters/teckelPathSKU'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                businessId:
                  description: The id of the business
                  type: integer
                  format: int64
                  examples:
                  - 454335871
                sku:
                  maxLength: 25
                  description: A stock-keeping unit
                  type: string
                  examples:
                  - UGG-BB-PUR-06
                fileType:
                  description: Image format (eg. 'jpeg' or 'png').
                  type: string
                  examples:
                  - png
                picture:
                  description: 'The cropped picture: use this field only to update picture (PATCH method). When updating picture, this field is required.'
                  type: string
                  format: byte
                  examples:
                  - iVBORw0KGgoAAAANSUhEUgAAAIwAAACMAQMAAACUDtN9AAAAAXNSR0IB2cksfwAAAAlwSFlzAAAAJwAAACcBKgmRTwAAAANQTFRFAAAAp3o92gAAABlJREFUeJztwTEBAAAAwqD1T20JT6AAAOBrCmQAASsQRDsAAAAASUVORK5CYII=
                rawPicture:
                  description: 'The raw picture (before cropping): use this field only to update picture (PATCH method). When updating picture, this field is optional.'
                  type: string
                  format: byte
                  examples:
                  - iVBORw0KGgoAAAANSUhEUgAAAIwAAACMAQMAAACUDtN9AAAAAXNSR0IB2cksfwAAAAlwSFlzAAAAJwAAACcBKgmRTwAAAANQTFRFAAAAp3o92gAAABlJREFUeJztwTEBAAAAwqD1T20JT6AAAOBrCmQAASsQRDsAAAAASUVORK5CYII=
              type: object
              required:
              - businessId
              - sku
        required: true
      responses:
        '200':
          description: Patched
          content:
            application/hal+json;charset=UTF-8:
              schema:
                allOf:
                - $ref: '#/components/schemas/teckelRichItemDto'
                - $ref: '#/components/schemas/teckelRichItemDtoDates'
                - $ref: '#/components/schemas/teckelRichItemDtoPictures'
                type: object
      security:
      - OAuth2:
        - orders-api
    put:
      summary: Create or update rich item
      operationId: teckelCreateOrUpdateRichItem
      description: Creates a new rich item or updates an existing rich item. To update the sku, set the new sku in the request body. The picture cannot be set using this method (use PATCH method).
      tags:
      - Rich Item
      parameters:
      - $ref: '#/components/parameters/teckelPathBusinessId'
      - $ref: '#/components/parameters/teckelPathSKU'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                businessId:
                  description: The id of the business
                  type: integer
                  format: int64
                  examples:
                  - 454335871
                sku:
                  maxLength: 25
                  description: A stock-keeping unit
                  type: string
                  examples:
                  - UGG-BB-PUR-06
                allergenCodes:
                  description: List of allergen codes
                  items:
                    type: string
                  uniqueItems: true
                  type: array
                  examples:
                  - - milk
                    - cereals
                descriptions:
                  description: List of localized descriptions
                  items:
                    $ref: '#/components/schemas/teckelRichItemDescriptionDto'
                  uniqueItems: true
                  type: array
                  examples:
                  - - localeCode: en
                      description: This is a test for a rich item
                      displayName: Rich Item 1
                    - localeCode: de
                      description: Das ist ein Test
                      displayName: Rich Item 1 DE
              type: object
              required:
              - businessId
              - sku
        required: true
      responses:
        '200':
          description: Updated
          content:
            application/hal+json;charset=UTF-8:
              schema:
                allOf:
                - $ref: '#/components/schemas/teckelRichItemDto'
                - $ref: '#/components/schemas/teckelRichItemDtoDates'
                - $ref: '#/components/schemas/teckelRichItemDtoPictures'
                type: object
      security:
      - OAuth2:
        - orders-api
    delete:
      summary: Delete rich item
      operationId: teckelDeleteRichItem
      tags:
      - Rich Item
      parameters:
      - $ref: '#/components/parameters/teckelPathBusinessId'
      - $ref: '#/components/parameters/teckelPathSKU'
      responses:
        '204':
          description: Item deleted
      security:
      - OAuth2:
        - orders-api
  /i/richItem/{businessId}/itemsBySkus:
    post:
      summary: Get rich items by SKUs
      operationId: teckelGetRichItemBySKUs
      description: Returns a list of rich items matching the SKUs provided in the request.
      tags:
      - Rich Item
      parameters:
      - $ref: '#/components/parameters/teckelPathBusinessId'
      requestBody:
        content:
          application/json:
            schema:
              items:
                example: UGG-BB-PUR-06
                maxLength: 25
                description: A stock-keeping unit
                type: string
              type: array
        required: true
      responses:
        '200':
          description: OK
          content:
            application/hal+json;charset=UTF-8:
              schema:
                properties:
                  _embedded:
                    properties:
                      richItemDtoList:
                        description: List of rich items
                        items:
                          allOf:
                          - $ref: '#/components/schemas/teckelRichItemDto'
                          - $ref: '#/components/schemas/teckelRichItemDtoDates'
                          - $ref: '#/components/schemas/teckelRichItemDtoPictures'
                          - $ref: '#/components/schemas/teckelRichItemDtoLinks'
                          type: object
                        type: array
                    type: object
                  _links:
                    allOf:
                    - $ref: '#/components/schemas/teckelLinkSelf'
                    type: object
      security:
      - OAuth2:
        - orders-api
  /i/richItem/{businessId}/pictureSpec:
    get:
      summary: Get picture specifications
      operationId: teckelGetRichItemPictureSpec
      description: Get rich item picture specifications.
      tags:
      - Rich Item
      parameters:
      - $ref: '#/components/parameters/teckelPathBusinessId'
      responses:
        '200':
          content:
            application/hal+json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/teckelPictureSpecDto'
          description: OK
      security:
      - OAuth2:
        - orders-api
components:
  parameters:
    teckelSort:
      in: query
      name: sort
      required: false
      schema:
        type: array
        items:
          type: string
          example: sku
          description: Field used to determine order of results.
    teckelSize:
      in: query
      name: size
      required: false
      schema:
        type: integer
        example: 100
        description: Number of results to return, when paginating.
        default: 1000
    teckelPage:
      in: query
      name: page
      required: false
      schema:
        type: integer
        example: 10
        description: Starting page of results, when paginating.
        default: 0
    teckelPathBusinessId:
      in: path
      name: businessId
      required: true
      schema:
        $ref: '#/components/schemas/teckelBusinessId'
    teckelPathSKU:
      in: path
      name: sku
      required: true
      schema:
        $ref: '#/components/schemas/teckelSKU'
  schemas:
    teckelRichItemDescriptionDto:
      description: Stores an item description with its locale code.
      example:
        localeCode: fr
        description: Ceci est un café. L'apostrophe.
        displayName: Super expresso
      properties:
        localeCode:
          description: The language code (ISO 639) of the description.
          minLength: 2
          maxLength: 7
          nullable: false
          type: string
        description:
          description: The item description in the language of the locale.
          maxLength: 4000
          type: string
        displayName:
          description: The display name of the item in the language of the locale.
          type: string
      required:
      - localeCode
      type: object
    teckelLinkItems:
      type: object
      properties:
        items:
          properties:
            href:
              example: https://api.trial.lsk.lightspeed.app/i/richItem/8262/
              type: string
              description: The URL for all items.
          type: object
    teckelBusinessId:
      example: 454335871
      description: The unique identifier for the business.
      type: integer
      format: int64
    teckelLinkSelfPage:
      type: object
      properties:
        self:
          properties:
            href:
              example: https://api.trial.lsk.lightspeed.app/i/i/richItem/8262?page=0&size=100&sort=
              type: string
              description: The URL of the page of results.
          type: object
    teckelLocalesDto:
      description: A list of locales.
      example:
      - en
      - es
      - de
      - fr
      items:
        type: string
      type: array
    teckelRichItemDto:
      properties:
        businessId:
          $ref: '#/components/schemas/teckelBusinessId'
        sku:
          $ref: '#/components/schemas/teckelSKU'
        descriptions:
          description: List of localized descriptions
          example:
          - 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
          items:
            $ref: '#/components/schemas/teckelRichItemDescriptionDto'
          uniqueItems: true
          type: array
        allergenCodes:
          description: List of allergen codes.
          example:
          - milk
          - cereals
          items:
            type: string
          uniqueItems: true
          type: array
      type: object
    teckelLinkSelf:
      type: object
      properties:
        self:
          properties:
            href:
              example: https://api.trial.lsk.lightspeed.app/i/richItem/8262/UGG-BB-PUR-06
              type: string
              description: The URL of the item.
          type: object
    teckelPictureSpecDto:
      description: Contains picture requirements.
      properties:
        _links:
          $ref: '#/components/schemas/teckelLinks'
        minHeight:
          description: The minimum image height.
          format: int32
          type: integer
        minWidth:
          description: The minimum image width.
          format: int32
          type: integer
        requiredAspectRatio:
          description: The image aspect ratio (width divided by length). If not set, there is no aspect ratio check.
          format: float
          type: number
      type: object
    teckelLinks:
      additionalProperties:
        $ref: '#/components/schemas/teckelLink'
      type: object
    teckelRichItemDtoLinks:
      properties:
        _links:
          allOf:
          - $ref: '#/components/schemas/teckelLinkSelf'
          - $ref: '#/components/schemas/teckelLinkItems'
      type: object
    teckelRichItemDtoPictures:
      properties:
        pictureUrl:
          example: http://s3-eu-west-1.amazonaws.com/com.ikentoo.trial.rich-content-store/25372_029b5ad1-08f7-4e1f-9087-3ca91ad818f7.png
          description: The URL of the picture.
          type: string
        previewPictureUrl:
          example: http://s3-eu-west-1.amazonaws.com/com.ikentoo.trial.rich-content-store/25372_029b5ad1-08f7-4e1f-9087-3ca91ad818f7.png
          description: The URL of the preview picture.
          type: string
        rawPictureUrl:
          example: http://s3-eu-west-1.amazonaws.com/com.ikentoo.trial.rich-content-store/25372_029b5ad1-08f7-4e1f-9087-3ca91ad818f7_raw.png
          description: The URL of the raw picture.
          type: string
      type: object
    teckelRichItemDtoDates:
      properties:
        creationDate:
          description: The creation date of the item.
          example: '2021-11-03T13:50:47Z'
          type: string
          format: date-time
        lastUpdateDate:
          description: The last update date of the item.
          example: '2021-11-11T16:29:56Z'
          type: string
          format: date-time
      type: object
    teckelLink:
      properties:
        deprecation:
          type: string
        href:
          type: string
        hreflang:
          type: string
        name:
          type: string
        profile:
          type: string
        templated:
          type: boolean
        title:
          type: string
        type:
          type: string
      type: object
    teckelSKU:
      example: UGG-BB-PUR-06
      maxLength: 25
      description: The SKU of the item.
      type: string
  securitySchemes:
    OAuth2:
      description: 'The Lightspeed Restaurant K-Series APIs support OAuth2 authentication using the [authorization code grant flow](https://www.oauth.com/oauth2-servers/server-side-apps/authorization-code/).

        See our [Authorization Quick Start Guide](https://api-portal.lsk.lightspeed.app/quick-start/authentication/authorization-overview) for more details on how to authenticate.

        '
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: /oauth/authorize
          tokenUrl: /oauth/token
          scopes:
            orders-api: 'Read business information, floors, menus, discounts, and production instructions.

              Read and write orders and payments. Read [Rich Item](https://api-docs.lsk.lightspeed.app/prod/group/endpoint-rich-item) data.'
            financial-api: Read financial data
            reservation-***: Platform reservations scope. The `***` will be replaced by the [platform-code](https://api-docs.lsk.lightspeed.app/operation/operation-reservation-servicesetbyplatformcode#operation-reservation-servicesetbyplatformcode-platform-code) of the reservation platform.
            items: Read and write items
            propertymanagement: Read and write Property Management System configurations.
            id-cards: Create and manage ID card batches and cards.
            staff-api: Read shift information, read and write user information.
            reservations-api: 'Configure *legacy* reservation integrations.

              **Note:** This API will eventually be deprecated in favour of the new [Reservations for Platforms](https://api-docs.lsk.lightspeed.app/group/endpoint-reservations-for-platforms) API.

              More information on the new reservations workflows can be found in the [Integration Guide](https://api-portal.lsk.lightspeed.app/category/reservations).'
x-tagGroups:
- name: Rich Item API
  tags:
  - Rich Item
  - Migration
- name: Tax Preview API
  tags:
  - Tax Breakdown
- name: Staff Api
  tags:
  - Staff
  - Internal Staff
- name: Reservation API
  tags:
  - Reservations for Platforms
- name: PMS API
  tags:
  - PMS
- name: Items API
  tags:
  - Items
  - ItemsV2
  - Menus
  - Buttons
  - Production Instructions
  - Inventory
  - Combos
  - Groups
  - MenusV2
  - Accounting Group
  - IntegrationMenu
  - Price Lists
  - Products
  - ItemAppearance
  - Modifiers
  - ModifierGroups
  - Allergens
  - Locales
  - RichItem
- name: id-cards-api API
  tags:
  - ID Cards
- name: Financial API
  tags:
  - Financial
  - FinancialV2
- name: Online Ordering API
  tags:
  - Order and Pay
  - 'Order and Pay: Webhook'