Update picture

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

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

Path parameters

  • businessId integer(int64) Required

    The id of the business

  • sku string Required

    A stock-keeping unit

    Maximum length is 25.

application/json

Body Required

  • businessId integer(int64) Required

    The id of the business

  • sku string Required

    A stock-keeping unit

    Maximum length is 25.

  • fileType string

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

  • picture string(byte)

    The cropped picture: used this field only to update picture (PATCH method)

  • rawPicture string(byte)

    The raw picture (before cropping): use this field only to update picture (PATCH method)

Responses

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

    Patched

    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.

      • description string

        Item description in the provided language

        Maximum length is 4000.

      • displayName string

        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

    • pictureUrl string

      Url of the picture

    • rawPictureUrl string

      Url of the raw picture
PATCH /i/richItem/{businessId}/{sku} 
curl \
 -X PATCH https://api.trial.lsk.lightspeed.app/i/richItem/454335871/UGG-BB-PUR-06 \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"businessId":454335871,"sku":"UGG-BB-PUR-06","fileType":"png","picture":"iVBORw0KGgoAAAANSUhEUgAAAIwAAACMAQMAAACUDtN9AAAAAXNSR0IB2cksfwAAAAlwSFlzAAAAJwAAACcBKgmRTwAAAANQTFRFAAAAp3o92gAAABlJREFUeJztwTEBAAAAwqD1T20JT6AAAOBrCmQAASsQRDsAAAAASUVORK5CYII=","rawPicture":"iVBORw0KGgoAAAANSUhEUgAAAIwAAACMAQMAAACUDtN9AAAAAXNSR0IB2cksfwAAAAlwSFlzAAAAJwAAACcBKgmRTwAAAANQTFRFAAAAp3o92gAAABlJREFUeJztwTEBAAAAwqD1T20JT6AAAOBrCmQAASsQRDsAAAAASUVORK5CYII="}'
Request example 
{
  "businessId": 454335871,
  "sku": "UGG-BB-PUR-06",
  "fileType": "png",
  "picture": "iVBORw0KGgoAAAANSUhEUgAAAIwAAACMAQMAAACUDtN9AAAAAXNSR0IB2cksfwAAAAlwSFlzAAAAJwAAACcBKgmRTwAAAANQTFRFAAAAp3o92gAAABlJREFUeJztwTEBAAAAwqD1T20JT6AAAOBrCmQAASsQRDsAAAAASUVORK5CYII=",
  "rawPicture": "iVBORw0KGgoAAAANSUhEUgAAAIwAAACMAQMAAACUDtN9AAAAAXNSR0IB2cksfwAAAAlwSFlzAAAAJwAAACcBKgmRTwAAAANQTFRFAAAAp3o92gAAABlJREFUeJztwTEBAAAAwqD1T20JT6AAAOBrCmQAASsQRDsAAAAASUVORK5CYII="
}