Requires read_product access scope. More access scope
The Get Product Image List API retrieves a list of images associated with a specific product. By providing the product’s unique identifier (product_id), users can fetch all images linked to a product, including details like their position, dimensions, and alternative text. This API is useful for displaying product images or managing image data within a product catalog.This API is especially useful for:
Retrieve all images associated with a specific product for display or editing purposes.
Support image management workflows by fetching relevant image details (e.g., dimensions, position, alternative text).
Alternative text for the image (used for accessibility or descriptions).
images[].created_at
string
2024-04-08T07:13:28Z
The timestamp indicating when the image was created.
images[].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
[ "ProductId must be a valid UUID"]
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 Not Found
The product ID provided in the request does not exist.
{ "errors": ["Record not found"] }
Invalid or empty product_id
missing required product_id or product_id with incorrect UUID types
{ "errors": [ "product_id has an invalid UUID"]}
429
StatusTooManyRequests
Exceed the rate of requests.
{ "errors": [ "Too Many Requests"]}
API Structure Overview
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!
