Create images in bulk
POST/v2/media/images/bulk
Create images in bulk
Request
Header Parameters
- application/json
Body
array
required
A list of create media image inputs
Array [
Array [
]
Array [
]
Array [
]
Array [
]
]
Unique product identifier that image relates to
External system from which image is being imported
External identifier of the image
alt
object[]
required
Image alt description that briefly explains the contents of the image.
Language to perform search for [min/max: 2]
Value of localized string
description
object[]
required
Image short description.
Language to perform search for [min/max: 2]
Value of localized string
tags
object[]
required
Image tags.
Language to perform search for [min/max: 2]
Value of localized string
Default value: 1000
Image display priority [Lower value has higher priority] - default: 1000
uploadImages
object[]
required
Upload File input reference.
Default value: en
Language specific image [Default value 'en']
Default value: URL
Upload type. Only URL is supported for bulk import.
urlFile
object
required
The public url to the file.
Name to use for storing the file
Responses
- 201
- 400
- 403
- 500
Bulk images successfully created
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Array [
]
Array [
]
Array [
]
Unique product identifier that image relates to
External system from which image is being imported
External identifier of the image
alt
object[]
required
Image alt description that briefly explains the contents of the image.
Language to perform search for [min/max: 2]
Value of localized string
description
object[]
required
Image short description.
Language to perform search for [min/max: 2]
Value of localized string
tags
object[]
required
Image tags.
Language to perform search for [min/max: 2]
Value of localized string
Default value: 1000
Image display priority [Lower value has higher priority] - default: 1000
uploadImages
object[]
required
Upload File input reference.
Default value: en
Language specific image [Default value 'en']
Default value: URL
Upload type. Only URL is supported for bulk import.
urlFile
object
required
The public url to the file.
Name to use for storing the file
{
"productId": 0,
"source": "string",
"sourceId": "string",
"alt": [
{
"language": "string",
"value": "string"
}
],
"description": [
{
"language": "string",
"value": "string"
}
],
"tags": [
{
"language": "string",
"values": [
"string"
]
}
],
"priority": 1000,
"uploadImages": [
{
"language": "en",
"uploadType": "URL",
"urlFile": {
"url": "string",
"fileName": "string"
}
}
]
}
Bad Request
Forbidden.
Unknown bulk images error