Requires
write_productaccess scope. More access scope
The Create Product Image APIallows users to upload and associate a new image with a specific product by providing the product's ID and image details. This API ensures efficient management of product images, enabling users to specify image attributes like dimensions, position, and alternative text.This API is especially useful for:
- Upload new images for products to enhance their display and marketing.
- Specify image attributes such as width, height, position, and alternative text for better presentation.
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.
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. |
Body Parameters
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
image |
object |
Yes | Image Object | |
image.src |
string |
Yes | "http://cdn.shoplazza.com/1.jpg" |
The URL of the image. Must be a valid URL. |
image.position |
string |
No | "1" |
The position of the image relative to other images. Must be greater than 0. |
image.alt |
string |
No | "Product front view" |
Alternative text for the image (used for accessibility or descriptions). |
image.width |
int |
No | 300 |
The width of the image in pixels. Must be greater than 0. |
image.height |
int |
No | 300 |
The height of the image in pixels. Must be greater than 0. |
Response Explanation
Public Response Parameters
Success Response
| Field | Type | Example | Description |
|---|---|---|---|
image.id |
string |
91d032e7-bbc8-47e4-8668-9ba6fe714de6 |
The unique identifier for the image. |
image.product_id |
string |
636a07da-39eb-4829-bde9-b65fae1c28b0 |
The unique identifier for the product associated with the image. |
image.position |
integer |
1 |
The position of the image relative to other images in the product gallery. |
image.src |
string |
//cdn.shoplazza.com/efd33b921cacd5311a32dd03a9bc8740.png | The URL of the image. |
image.width |
integer |
1588 |
The width of the image in pixels. |
image.height |
integer |
2246 |
The height of the image in pixels. |
image.alt |
string |
"" |
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). - Width, height or position values less than or equal to 0. | Bad Request |
| Unauthorized | The request is missing valid authentication credentials or the credentials provided are invalid. | Unauthorized | |
| 404 | Product not found | - The product ID provided in the request does not exist. - The requested resource (product) is not available. | { "errors": ["Product not found"] } |
| 422 | Invalid or empty product_id | missing required product_id or product_id with incorrect UUID types | { "errors": [ "ProductId must be a valid UUID"]} |