get
https://{subdomain}.myshoplaza.com/openapi/2025-06/products//images/
Retrieve details of a specific product image using its unique identifier.
Requiresread_productaccess 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.
Request Parameters
Public Request Parameters
Path Parameters
| Field | Type | Required | Example | Description |
|---|---|---|---|---|
product_id | string | Yes | 636a07da-39eb-4829-bde9-b65fae1c28b0 | The unique identifier of the product. |
image_id | string | Yes | 91d032e7-bbc8-47e4-8668-9ba6fe714de6 | The unique identifier of the image. |
Response Explanation
Public Response Parameters
Success Response
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
code |
string |
Yes | 'Success' | Response status |
data |
string |
Yes | Data Object | |
data.image |
object |
Yes | Image Object | |
data.image.src |
string |
Yes | "http://cdn.shoplazza.com/1.jpg" |
The URL of the image. Must be a valid URL. |
data.image.position |
string |
No | "1" |
The position of the image relative to other images. Must be greater than 0. |
data.image.alt |
string |
No | "Product front view" |
Alternative text for the image (used for accessibility or descriptions). |
data.mage.width |
int |
No | 300 |
The width of the image in pixels. Must be greater than 0. |
data.image.height |
int |
No | 300 |
The height of the image in pixels. Must be greater than 0. |
Error Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | InvalidParameter | Error http message |
message | string | `` | Error message |