Product Image

object

Common ProductImage properties.

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.

1 validation
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.

2 validations
description
string

The description for the image.

image_url
string

Publically available URL. Use the image_url when creating a product.

1 validation