Home > @vsf-enterprise/bigcommerce-api > Video
# Video interface
Video model.
Signature:
export interface Video
# Properties
Property | Type | Description |
---|---|---|
description | string | The description for the video. If left blank, this will be filled in according to data on a host site. |
id | number | The unique numeric ID of the product video; increments sequentially. |
length | string | Length of the video. This will be filled in according to data on a host site. |
product_id | number | The unique numeric identifier for the product with which the image is associated. |
sort_order | number | The order in which the video will be displayed on the product page. Higher integers give the video a lower priority. When updating, if the video is given a lower priority, all videos with a sort_order the same as or greater than the video's new sort_order value will have their sort_order s reordered. |
title | string | The title for the video. If left blank, this will be filled in according to data on a host site. |
type | VideoType | The video type (a short name of a host site). |
video_id | string | The ID of the video on a host site. |