🔒

Requires write_product access 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:

1. Upload new images for products to enhance their display and marketing.
2. 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.

Public Request Parameters

Public Response Parameters

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

Body Parameters

Response Explanation

Successful Response

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.

Request Examples

curl --request POST \
     --url https://{shopdomain}.myshoplaza.com/openapi/2022-01/products/{product_id}/images \
     --header 'accept: application/json' \
     --header 'access-token: {your-access-token}' \
     --header 'content-type: application/json' \
     --data '{
         "image": {
             "src": "http://cdn.shoplazza.com/1.jpg",
             "position": 1,
             "alt": "Product image alt text",
             "width": 300,
             "height": 300
         }
     }'

Success Response Example

{
  "image": {
    "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": [
    "Product not found"
  ]
}

{
  "error": "store is not active"
}

Error Details