Image_2
Product image model.
interface Image {
date_modified: string;
description: string;
id: number;
image_file: string;
image_url?: string;
is_thumbnail: boolean;
product_id: number;
sort_order: number;
url_standard: string;
url_thumbnail: string;
url_tiny: string;
url_zoom: string;
}Properties
| Name | Required | Type | Description |
|---|---|---|---|
date_modified | Required | string | The date on which the product image was modified. |
description | Required | string | The description for the image. |
id | Required | number | The unique numeric ID of the image; increments sequentially. |
image_file | Required | string | The local path to the original image file uploaded to BigCommerce. Limit of 1MB per file. |
image_url | Optional | string | Must be a fully qualified URL path, including protocol. Limit of 8MB per file. |
is_thumbnail | Required | boolean | Flag for identifying whether the image is used as the product's thumbnail. |
product_id | Required | number | The unique numeric identifier for the product with which the image is associated. |
sort_order | Required | number | 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. |
url_standard | Required | string | The standard URL for this image. By default, this is used for product-page images. |
url_thumbnail | Required | 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 | Required | 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. |
url_zoom | Required | string | The zoom URL for this image. By default, this is used as the zoom image on product pages when zoom images are enabled. |