Requires read_product access scope. More access scope
The Get Product Image Details API retrieves detailed information about a specific product image. By providing both the product_id and image_id, users can fetch attributes of a specific image, such as its dimensions, position, and alternate text. This API is particularly useful for managing product images or troubleshooting image-related issues.This API is especially useful for:
Retrieve detailed metadata for a specific product image to support catalog management.
Identify and update specific product images based on their attributes.
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
["Context"]
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
Product or Image Not Found
The product or image ID provided in the request does not exist.
{ "errors": ["Record not found"] }
Invalid or empty product_idorimage_id
Missing required product_id, image_id, or incorrect UUID types.
{ "errors": [ "ProductId must be a valid UUID", "ImageId must be a valid UUID"]}
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!
