Get rich item by sku

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

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

Path parameters

  • businessId integer(int64) Required

    The unique identifier for the business.

  • sku string Required

    The SKU of the item.

    Maximum length is 25.

Responses

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

    OK

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

      The unique identifier for the business.

    • sku string

      The SKU of the item.

      Maximum length is 25.

    • descriptions array[object]

      List of localized descriptions

      Hide descriptions attributes Show descriptions attributes object
      • localeCode string Required

        The language code (ISO 639) of the description.

        Minimum length is 2, maximum length is 7.

      • description string

        The item description in the language of the locale.

        Maximum length is 4000.

      • displayName string

        The display name of the item in the language of the locale.

    • allergenCodes array[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.

    • rawPictureUrl string

      The URL of the raw picture.

    • _links object

      Additional properties are allowed.

      Hide _links attributes Show _links attributes object
      • self object

        Additional properties are allowed.

        Hide self attribute Show self attribute object
        • href string

          The URL of the item.

      • items object

        Additional properties are allowed.

        Hide items attribute Show items attribute object
        • href string

          The URL for all items.
  • 404

    Not Found

GET /i/richItem/{businessId}/{sku} 
curl \
 -X GET https://api.trial.lsk.lightspeed.app/i/richItem/454335871/UGG-BB-PUR-06 \
 -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": [
    "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.trial.lsk.lightspeed.app/i/richItem/8262/UGG-BB-PUR-06"
    },
    "items": {
      "href": "https://api.trial.lsk.lightspeed.app/i/richItem/8262/"
    }
  }
}