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.
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
Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.
Field
Type
Example
Description
errors
Array
[ "Position must be greater than 0"]
A list of errors encountered during the request processing.
Field
Type
Example
Description
error
Array
"store is not active"
Indicates an error encountered during the process.
Error Details
Status Code
Message
Possible Reason
Example Response
400
Bad Request
Invalid input format or request structure (e.g., missing required fields or incorrect data types).
Bad Request
Unauthorized
The request is missing valid authentication credentials or the credentials provided are invalid.
Unauthorized
422
position must be greater than 0
The position provided in the request is invalid.
{ "errors": ["Position must be greater than 0"] }
API Structure Overview
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!
