Upload product variation image async

Upload a custom image for a specific product variation referring to its ID.

Upload a product variation image asynchronously from an external resource.

Access scopes

Requires the following access scope: create_catalog

Path params

ParamTypeDescription
storeIdnumberEcwid store ID.
productIdnumberProduct ID.
combinationIdnumberProduct variation ID.

Headers

The Authorization header with a secret access token is required.

HeaderFormatDescription
AuthorizationBearer secret_ab***cdAccess token of the application.

Request

Request body can have the following fields:

FieldTypeDescription
urlstringImage URL for upload. Required
widthstringWidth of the image. Required
heightstringHeight of the image. Required
externalIdstringImage ID for Lightspeed R-Series/X-Series image sync. Optional field.
altobject altInformation about image alt text.

alt

FieldTypeDescription
mainstringImage alt text in the main store language.
translatedmap translatedImage alt text translations.

translated

Object with text field translations in the "lang": "text" format, where the "lang" is an ISO 639-1 language code. Example:

{
    "en": "Sample text",
    "nl": "Voorbeeldtekst"
}

Translations for each available language. If no other translations are provided, the default language translations is returned. See available languages in store language settings.

Language
Click Try It! to start a request and see the response here!