Create Product Image

POST 
/openapi/2022-01/products/:product_id/images

Create a new product image with the provided details.

Request

Path Parameters

product_id stringrequired

Product's ID

application/json

Body

Body

image object

positionint32

The position of the image. Must be greater than 0 if provided.

srcstringrequired

The relative URL of the image.

altstring

The alt text of the image.

widthint32

The width of the image in pixels. Must be greater than 0 if provided.

heightint32

The height of the image in pixels. Must be greater than 0 if provided.

Example

{
  "image": {
    "position": 0,
    "src": "string",
    "alt": "string",
    "width": 0,
    "height": 0
  }
}

Responses

200

200

application/json

Schema

Schema

image object
idstring
Example: 91d032e7-bbc8-47e4-8668-9ba6fe714de6
product_idstring
Example: 636a07da-39eb-4829-bde9-b65fae1c28b0
positioninteger
Default value: 0
Example: 1
srcstring
Example: //cdn.shoplazza.com/efd33b921cacd5311a32dd03a9bc8740.png
widthinteger
Default value: 0
Example: 1588
heightinteger
Default value: 0
Example: 2246
altstring
Example:
created_atstring
Example: 2024-04-08T07:13:28Z
updated_atstring
Example: 2024-04-08T07:13:28Z

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"
  }
}

Result

{
    "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"
    }
}

404

404

application/json

Schema

Schema

errorsstring[]

Example

{
  "errors": [
    "Product not found"
  ]
}

Result

{
  "errors": [
    "Product not found"
  ]
}

422

422

application/json

Schema

Schema

errorsstring[]

Example

{
  "errors": [
    "ProductId must be a valid UUID"
  ]
}

Result

{
  "errors": [
    "ProductId must be a valid UUID"
  ]
}