Get rich item by sku

GET /i/richItem/{businessId}/{sku}

Get a rich item from its sku and the business id.

Path parameters

  • businessId integer(int64) Required

    The id of the business

  • sku string Required

    A stock-keeping unit

    Maximum length is 25.


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


    Hide response attributes Show response 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.

      • Item description in the provided language

        Maximum length is 4000.

      • 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

    • URL of the picture

    • URL of the raw picture

  • Not Found

GET /i/richItem/{businessId}/{sku}
curl \
 -X GET \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
  "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": [
  "creationDate": "2021-11-03T13:50:47Z",
  "lastUpdateDate": "2021-11-11T16:29:56Z",
  "pictureUrl": "",
  "rawPictureUrl": "",
  "_links": {
    "self": {
      "href": ""
    "items": {
      "href": ""