🔒
Requires write_product access scope. More access scope

The Create Product Image APIallows users to upload and associate a new image with a specific product by providing the product's ID and image details. This API ensures efficient management of product images, enabling users to specify image attributes like dimensions, position, and alternative text.This API is especially useful for:

Upload new images for products to enhance their display and marketing.
Specify image attributes such as width, height, position, and alternative text for better presentation.

Note: The operation is scoped to a specific shop, identified by its unique domain prefix (shopdomain), ensuring all updates are applied to the correct store.

Request Parameters

Public Request Parameters

📘
Public Request Parameters

Path Parameters

Parameter	Type	Required	Example	Description
`product_id`	`string`	Yes	`9fb9f3c6-2300-42c1-8593-d9008d7cfc09`	The unique identifier for the product.

Body Parameters

Parameter	Type	Required	Example	Description
`code`	`string`	Yes	'Success'	Response status
`data`	`string`	Yes		Data Object
`data.image`	`object`	Yes		Image Object
`data.image.src`	`string`	Yes	`"http://cdn.shoplazza.com/1.jpg"`	The URL of the image. Must be a valid URL.
`data.image.position`	`string`	No	`"1"`	The position of the image relative to other images. Must be greater than 0.
`data.image.alt`	`string`	No	`"Product front view"`	Alternative text for the image (used for accessibility or descriptions).
`data.mage.width`	`int`	No	`300`	The width of the image in pixels. Must be greater than 0.
`data.image.height`	`int`	No	`300`	The height of the image in pixels. Must be greater than 0.

Response Explanation

Public Response Parameters

📘
Public Response Parameters

Success Response

Field	Type	Example	Description
`image.id`	`string`	`91d032e7-bbc8-47e4-8668-9ba6fe714de6`	The unique identifier for the image.
`image.product_id`	`string`	`636a07da-39eb-4829-bde9-b65fae1c28b0`	The unique identifier for the product associated with the image.
`image.position`	`integer`	`1`	The position of the image relative to other images in the product gallery.
`image.src`	`string`	//cdn.shoplazza.com/efd33b921cacd5311a32dd03a9bc8740.png	The URL of the image.
`image.width`	`integer`	`1588`	The width of the image in pixels.
`image.height`	`integer`	`2246`	The height of the image in pixels.
`image.alt`	`string`	`""`	Alternative text for the image (used for accessibility or descriptions).
`image.created_at`	`string`	`2024-04-08T07:13:28Z`	The timestamp indicating when the image was created.
`image.updated_at`	`string`	`2024-04-08T07:13:28Z`	The timestamp indicating when the image was last updated.

Error Response

Field	Type	Example	Description
`code`	string	`InvalidParameter`	Error http message
`message`	string	``	Error message

API Structure Overview

200OK