---
title: "Get rich items"
method: GET
path: "/i/richItem/{businessId}"
tags: ["Rich Item"]
---

# Get rich items

`GET /i/richItem/{businessId}`

## Request

- Base URL: `https://api.trial.lsk.lightspeed.app`
- URL: `https://api.trial.lsk.lightspeed.app/i/richItem/{businessId}`
- Auth: OAuth 2
  - Authorization code: `https://auth.lsk-prod.app/realms/k-series/protocol/openid-connect/auth`
  - Token URL: `https://auth.lsk-prod.app/realms/k-series/protocol/openid-connect/token` scopes: `orders-api`

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

## Path parameters

- `businessId` integer, required: The unique identifier for the business.

## Query parameters

- `page` integer: Starting page of results, when paginating.
- `size` integer: Number of results to return, when paginating.
- `sort` string[]

## Response `200`

Rich Items

- object
  - `_embedded` object
    - `richItemDtoList` object[]: List of rich items
      - `businessId` integer: The unique identifier for the business.
      - `sku` string: The SKU of the item.
      - `descriptions` TeckelRichItemDescriptionDto[]: List of localized descriptions
        - `localeCode` string, required: The language code (ISO 639) of the description.
        - `description` string: The item description in the language of the locale.
        - `displayName` string: The display name of the item in the language of the locale.
      - `allergenCodes` string[]: List of allergen codes.
      - `creationDate` string, date-time: The creation date of the item.
      - `lastUpdateDate` string, date-time: The last update date of the item.
      - `pictureUrl` string: The URL of the picture.
      - `previewPictureUrl` string: The URL of the preview picture.
      - `rawPictureUrl` string: The URL of the raw picture.
      - `_links` object
        - `self` object
          - `href` string: The URL of the item.
        - `items` object
          - `href` string: The URL for all items.
  - `_links` TeckelLinkSelfPage
    - `self` object
      - `href` string: The URL of the page of results.

## Changes

> 31 revisions in range; 1 not diffed.

- **2026-02-12** `33472358c1ed`: 1 info
  - added the optional property `_embedded/richItemDtoList/items/allOf[#/components/schemas/teckelRichItemDtoPictures]/previewPictureUrl` to the response with the `200` status
- **2024-07-22** `f0328406dcdb`: 2 breaking
  - for the `query` request parameter `page`, default value `0` was added
  - for the `query` request parameter `size`, default value `1000` was added

[Operation history](https://skmtc.dev/lightspeed/apis/lightspeed-restaurant-k-series-api/changes/i/richItem/:businessId/get.md)

---

[API](https://skmtc.dev/lightspeed/apis/lightspeed-restaurant-k-series-api.md) - [All operations](https://skmtc.dev/lightspeed/apis/lightspeed-restaurant-k-series-api/llms.txt) - [OpenAPI document](https://skmtc.dev/lightspeed/apis/lightspeed-restaurant-k-series-api/revisions/af001485cf2b?raw)