Get rich items by SKUs

POST /i/richItem/{businessId}/itemsBySkus

Returns a list of rich items matching the SKUs provided in the request.

Path parameters

application/json

Body Required

array[string] array[string]

A stock-keeping unit

Maximum length of each is 25.

Responses

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

    OK

    Hide response attributes Show response attributes object
    • Hide _embedded attribute Show _embedded attribute
      • richItemDtoList array[object]

        List of rich items

        Hide richItemDtoList attributes Show richItemDtoList 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

POST /i/richItem/{businessId}/itemsBySkus
curl \
 -X POST https://api.trial.lsk.lightspeed.app/i/richItem/454335871/itemsBySkus \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '["UGG-BB-PUR-06"]'
Request example
[
  "UGG-BB-PUR-06"
]
Response examples (200)
{
  "_embedded": {
    "richItemDtoList": [
      {
        "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.sbx.lsk.lightspeed.app/i/richItem/454335871/UGG-BB-PUR-06"
          },
          "items": {
            "href": "https://api.sbx.lsk.lightspeed.app/i/richItem/454335871/"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.sbx.lsk.lightspeed.app/i/richItem/454335871/UGG-BB-PUR-06"
    }
  }
}