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

  • 404

    Not Found

GET /i/richItem/{businessId}/{sku}
curl \
 -X GET \
 -H "Authorization: Bearer $ACCESS_TOKEN"