Skip to main content

Bulk images

POST 

/media/images/bulk

Fields

NameDescriptionTypeRequired
Array of mediaImage objectsarray[MediaImage]yes

MediaImage input

NameDescriptionTypeRequired
productIdId of the product resource the image should be linked tointegerno
sourceExternal system
Read more about lookup key source/sourceId
stringyes
sourceIdExternal system unique id
Read more about lookup key source/sourceId
stringyes
priorityImage display priority (lower value has higher priority)
Default is 1000
integerno
altImage alt description that briefly explains the contents of the imagearray[LocalizedString]yes
descriptionImage short descriptionarray[LocalizedString]yes
tagsFree format field to categorize image on type (e.g. logo, banner, icon, etc)array[LocalizedString]yes
uploadImagesarray[UploadImages]yes

UploadImages input

NameDescriptionTypeRequired
languageLanguage specific image
Default is en
stringno
uploadTypeDefault is URLstringno
urlFileUrlFile object

UrlFile input

NameDescriptionTypeRequired
urlPublic url to the imagestringyes
fileNameName to use for storing the filestringyes

Request

Responses

Bulk images - 200

Response Headers
    Alt-Svc
    Via
    alt-svc
    content-length
    date
    etag
    x-powered-by
    x-request-id