LIlightspeed
Rich Item

Update picture

Changed on

Partially updates the rich item to set the picture or rawPicture.

patch/i/richItem/{businessId}/{sku}

Request

  • Base URL
    https://api.trial.lsk.lightspeed.app
  • URL
    https://api.trial.lsk.lightspeed.app/i/richItem/{businessId}/{sku}
  • 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
skustring required

The SKU of the item.

Example:UGG-BB-PUR-06

Request body

businessIdinteger required

The id of the business

skustring required

A stock-keeping unit

fileTypestring

Image format (eg. 'jpeg' or 'png').

picturestring byte

The cropped picture: use this field only to update picture (PATCH method). When updating picture, this field is required.

rawPicturestring byte

The raw picture (before cropping): use this field only to update picture (PATCH method). When updating picture, this field is optional.

Example request

{
  "businessId": 454335871,
  "sku": "UGG-BB-PUR-06",
  "fileType": "png",
  "picture": "iVBORw0KGgoAAAANSUhEUgAAAIwAAACMAQMAAACUDtN9AAAAAXNSR0IB2cksfwAAAAlwSFlzAAAAJwAAACcBKgmRTwAAAANQTFRFAAAAp3o92gAAABlJREFUeJztwTEBAAAAwqD1T20JT6AAAOBrCmQAASsQRDsAAAAASUVORK5CYII=",
  "rawPicture": "iVBORw0KGgoAAAANSUhEUgAAAIwAAACMAQMAAACUDtN9AAAAAXNSR0IB2cksfwAAAAlwSFlzAAAAJwAAACcBKgmRTwAAAANQTFRFAAAAp3o92gAAABlJREFUeJztwTEBAAAAwqD1T20JT6AAAOBrCmQAASsQRDsAAAAASUVORK5CYII="
}

Response

Patched

businessIdinteger

The unique identifier for the business.

skustring

The SKU of the item.

allergenCodesstring[]

List of allergen codes.

creationDatestring date-time

The creation date of the item.

lastUpdateDatestring date-time

The last update date of the item.

pictureUrlstring

The URL of the picture.

previewPictureUrlstring

The URL of the preview picture.

rawPictureUrlstring

The URL of the raw picture.

Example response

{
  "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"
}

Changes

  • 33472358c1edRevision changes
    • info

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