docs
  1. Admin Api
  2. Resources
  3. Product Images
  4. Create A Product Image

Create a product image

Create a new product image

Rate Limit: 300 Max attempts within 1 minute.

Path Parameters

ParameterDetails
productIdentifier
  • required
string
Examples:
  • ^[1-9][0-9]*$
  • ^key%3D[a-zA-Z0-9-_%\+\. ]*$

Request body

required
ParameterDetails
id
  • readonly
integer
referenceKey
string
Example:
my_original_name.jpg
name
string
Example:
image.jpg
mimeType
  • readonly
string
position
integer
Example:
3
source
  • writeonly
  • MinProps: 1
  • MaxProps: 1
object
url
string
Format:
uri
Example:
https://example.com/image.png
attachment
string
Format:
byte
Example:
U3dhZ2dlciByb2Nrcw==
assetUrl
string
Example:
images/my_image.jpg
attributes
object
Example:
[
  {
    "name": "view",
    "type": "simple",
    "value": "front",
    "isLocked": true
  }
]
name
string
type
string
Enum:
simple
simpleList
localizedString
localizedStringList
advanced
advancedList
value
shopCountrySpecific
array

Responses

201
Product image was successfully created.
application/json
Success
id
integer
referenceKey
string
Example:
my_original_name.jpg
name
string
Example:
image.jpg
mimeType
string
position
integer
Example:
3
object
assetUrl
string
Example:
images/my_image.jpg
Array of object
400
Bad Request
application/json
Error
401
Unauthorized
application/json
Error
404
Not Found
application/json
Error
POST/products/{productIdentifier}/images

Request samples

Response samples

201
Image:
Content type: application/json
Provide Feedback