🔒
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.

Response Explanation

Public Response Parameters

📘
Public Response Parameters

Success Response

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.

Error Response

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

API Structure Overview

200OK