POST /catalog/products/{product_id}/images
Creates a Product Image.
Required Fields
image_file, orimage_url
Usage Notes
image_url-255character limitContent-Type- Forimage_file, use themultipart/form-datamedia type. Forimage_url, use theapplication/jsontype. See Adding product images for more information.- You can create only one image at a time. A product can have up to 1000 images.
- Supported image file types are BMP, GIF, JPEG, PNG, WBMP, XBM, and WEBP.
- Each image file or image uploaded by URL can be up to 8 MB.
Servers
- https://api.bigcommerce.com/stores/{store_hash}/v3
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
product_id |
Integer | Yes |
The ID of the |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Accept |
String | Yes |
The MIME type of the response body. Default value: "application/json" |
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
date_modified |
String | No |
The date on which the product image was modified. |
sort_order |
Integer | No |
The order in which the image will be displayed on the product page. Higher integers give the image a lower priority. When updating, if the image is given a lower priority, all images with a |
is_thumbnail |
Boolean | No |
Flag for identifying whether the image is used as the productʼs thumbnail. |
description |
String | No |
The description for the image. |
product_id |
Integer | No |
The unique numeric identifier for the product with which the image is associated. |
image_url |
String | No |
The URL for an image displayed on the storefront when the conditions are applied. Limit of 8MB per file. Cannot be used with |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.