Docs
Catalog API
Products
Images

Images

Get All Product Images

GET /catalog/products/{product_id}/images

Request

Returns a list of Product Images. Optional parameters can be passed in.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string

example

Response

Body

object | application/json

Response payload for the BigCommerce API.

  • data    array[]

  • meta    object

    Data about the response, including pagination and collection totals.

example

Create a Product Image

POST /catalog/products/{product_id}/images

Request

Creates a Product Image.

Required Fields

  • image_file, or
  • image_url

Usage Notes

  • image_url - 255 character limit
  • For file uploads, use the multipart/form-data media type.
  • 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.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string

Body

application/json

The model for a POST to create an image on a product.

Body

multipart/form-data

The model for a POST to create an image on a product.

example

Response

Success

Body

object | application/json

Response payload for the BigCommerce API.

  • data

  • meta    object

    Response metadata.

example

Get a Product Image

GET /catalog/products/{product_id}/images/{image_id}

Request

Returns a single Product Image. Optional parameters can be passed in.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string

example

Response

Body

object | application/json

Response payload for the BigCommerce API.

  • data

    Common ProductImage properties.

  • meta    object

    Response metadata.

example

Update a Product Image

PUT /catalog/products/{product_id}/images/{image_id}

Request

Updates a Product Image.

Usage Notes

  • image_url - 255 character limit
  • Each image file or image uploaded by URL can be up to 8 MB.
  • For file uploads, send a POST request using the multipart/form-data media type

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string

Body

application/json

The model for a PUT to update applicable Product Image fields.

example

Response

Body

object | application/json

Response payload for the BigCommerce API.

  • data

  • meta    object

    Response metadata.

example

Delete a Product Image

DELETE /catalog/products/{product_id}/images/{image_id}

Request

Deletes a Product Image.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string

example

Response

Did you find what you were looking for?
Delete a Product Custom FieldGet All Product Images