post

/catalog/products/{product_id}/images

Creates a Product Image.

Required Fields

  • image_file, or
  • image_url

Usage Notes

  • image_url - 255 character limit
  • Only one image at a time can be created

Authorization

apiKey - X-Auth-Client
apiKey - X-Auth-Token

Request Parameters

1 Path Parameter
2 Headers

Request Body

2 Examples
Form data (multipart/form-data)
id
integer

The unique numeric ID of the image; increments sequentially.

product_id
integer

The unique numeric identifier for the product with which the image is associated.

image_file
string

The local path to the original image file uploaded to BigCommerce.

url_zoom
string

The zoom URL for this image. By default, this is used as the zoom image on product pages when zoom images are enabled.

url_standard
string

The standard URL for this image. By default, this is used for product-page images.

url_thumbnail
string

The thumbnail URL for this image. By default, this is the image size used on the category page and in side panels.

url_tiny
string

The tiny URL for this image. By default, this is the image size used for thumbnails beneath the product image on a product page.

date_modified
string

The date on which the product image was modified.

format: date-time
is_thumbnail
boolean

Flag for identifying whether the image is used as the product’s thumbnail.

sort_order
integer

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 sort_order the same as or greater than the image’s new sort_order value will have their sort_orders reordered.

minimum: -2147483648
maximum: 2147483647
description
string

The description for the image.

image_url
string

Must be a fully qualified URL path, including protocol. Limit of 8MB per file.

Responses

1 Example
Schema
object

Response payload for the BigCommerce API.

data
object

Common ProductImage properties.

meta
object

Empty meta object; may be used later.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
product_id
$$.env
2 variables not set
store_hash
X-Auth-Client
X-Auth-Token