Requires
read_productaccess 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).
Note: The operation is scoped to a specific shop, identified by its unique domain prefix (shopdomain), ensuring all updates are applied to the correct store.
Public Request Parameters
| Parameter Name | Type | Required | Parameter Location | Parameter Value | Description |
|---|---|---|---|---|---|
| Access-Token | String | Yes | Header | Bx-_5aV eXNwl-4AB98s5xLV yg0fNzGf MuTpqtlBA | Used to authenticate API requests. Obtain an access token from the Access Token Guide. Pass it in the Authorization header for every request. |
| Content-Type | String | Yes | Header | application/json | Indicates the media type of the request body. It tells the server how to parse the request and the client how to interpret the response. For more details, visit Content-Type. |
Public Response Parameters
| Parameter Name | Type | Mandatory | Parameter Location | Example Value | Description |
|---|---|---|---|---|---|
| error | String | No | Response Body | { "error": "store is not active" } | Indicates an error encountered during the process. This field typically appears when the Access Token is missing or invalid. Example: { "error": "store is not active" }. |
| errors | Array | No | Response Body | { "errors"["No Context"] } | A list of errors that occurred during the request processing. Example: { "errors": [ "No Context" ] }. |
| Request-Id | String | Yes | Header | Bx-_5aV eXNwl-4AB98s5xLV yg0fNzGf MuTpqtlBA | A unique identifier for each request. It helps in identifying and debugging specific requests. |
Error and Errors Clarification:
Added explanation that the error and errors fields are currently dependent on the API implementation, with plans for future unification.
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
Successful Response
| Field | Type | Example | Description |
|---|---|---|---|
images | array | Array of image object. | |
images[].id | string | 91d032e7-bbc8-47e4-8668-9ba6fe714de6 | The unique identifier for the image. |
images[].product_id | string | 636a07da-39eb-4829-bde9-b65fae1c28b0 | The unique identifier for the product associated with the image. |
images[].position | integer | 1 | The position of the image relative to other images in the product gallery. |
images[].src | string | //cdn.shoplazza.com/efd33b921cacd5311a32dd03a9bc8740.png | The URL of the image. |
images[].width | integer | 1588 | The width of the image in pixels. |
images[].height | integer | 2246 | The height of the image in pixels. |
images[].alt | string | "" | 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. |
Request Examples
curl --request GET \
--url https://{shopdomain}.myshoplaza.com/openapi/2022-01/products/a1a88be0-a1d4-47e4-a2f2-ba6e131cf447/images \
--header 'accept: application/json' \
--header 'access-token: {token}'
Success Response Example
{
"images": [
{
"id": "91d032e7-bbc8-47e4-8668-9ba6fe714de6",
"product_id": "636a07da-39eb-4829-bde9-b65fae1c28b0",
"position": 1,
"src": "//cdn.shoplazza.com/efd33b921cacd5311a32dd03a9bc8740.png",
"width": 1588,
"height": 2246,
"alt": "",
"created_at": "2024-04-08T07:13:28Z",
"updated_at": "2024-04-08T07:13:28Z"
}
]
}
Error Response Example
{
"errors": [
"ProductId must be a valid UUID"
]
}
{
"error": "store is not active"
}
Product Response Fields
| 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"]} |