LIlightspeed
Rich Item

Get rich items

Changed on

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

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

Path parameters

businessIdinteger required

The unique identifier for the business.

Example:454335871

Query parameters

pageinteger

Starting page of results, when paginating.

Example:10
sizeinteger

Number of results to return, when paginating.

Example:100
sortstring[] 
[
  "sku"
]

Response

Rich Items

Example response

{
  "_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",
        "previewPictureUrl": "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/"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.trial.lsk.lightspeed.app/i/i/richItem/8262?page=0&size=100&sort="
    }
  }
}

Changes

  • 33472358c1edRevision changes
    • info

      added the optional property /////// to the response with the status

  • f0328406dcdbRevision changes
    • breaking

      for the query request parameter page, default value 0 was added

    • breaking

      for the query request parameter size, default value 1000 was added