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

Request Parameters

Public Request Parameters

📘
Public Request Parameters

Path Parameters

Parameter	Type	Required	Example	Description
`product_id`	`string`	Yes	`9fb9f3c6-2300-42c1-8593-d9008d7cfc09`	The unique identifier for the product.

Response Explanation

Public Response Parameters

📘
Public Response Parameters

Success Response

Field	Type	Example	Description
`code`	`string`	`"success"`	Status code of the response
`message`	`string`		Descriptive message of the response
`data.images`	array	Array of image objects	List of product images
`data.images[].id`	string	`91d032e7-bbc8- 47e4-8668-9ba6fe714de6`	The unique identifier for the image
`data.images[].product_id`	string	`636a07da-39eb-48 29-bde9-b65fae1c28b0`	The unique identifier for the product associated with the image
`data.images[].position`	integer	`1`	The position of the image relative to other images in the product gallery
`data.images[].src`	string	`//cdn.shoplazza.com/ efd33b921cacd5311a32dd 03a9bc8740.png`	The URL of the image
`data.images[].width`	integer	`1588`	The width of the image in pixels
`data.images[].height`	integer	`2246`	The height of the image in pixels
`data.images[].alt`	string	`""`	Alternative text for the image (used for accessibility or descriptions)
`data.images[].created_at`	string	`2024-04-08T07:13:28Z`	The timestamp indicating when the image was created
`data.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

200OK