🔒
Requires write_product access scope. More access scope

The Update Product Image API allows users to update the attributes of a specific product image, such as its source URL or position. By providing the product_id and image_id, users can precisely identify and modify the image's details. This API is useful for maintaining an up-to-date and accurate product catalog.This API is especially useful for:

Modify the source or position of a specific product image to ensure accurate representation in the catalog.
Optimize the order of images for better visual presentation.

Request Parameters

Public Request Parameters

📘
Public Request Parameters

Path Parameters

Field	Type	Required	Example	Description
`product_id`	string	Yes	`636a07da-39eb-4829-bde9-b65fae1c28b0`	The unique identifier of the product.
`image_id`	string	Yes	`91d032e7-bbc8-47e4-8668-9ba6fe714de6`	The unique identifier of the image.

Body Parameters

Field	Type	Required	Example	Description
`image.src`	string	No	`http://cdn.shoplazza.com/1.jpg`	The new source URL of the image.
`image.position`	int32	No	`2`	The new position of the image in the list. 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