Alokai

Video

Video model.

interface Video {
	description: string;
	id: number;
	length: string;
	product_id: number;
	sort_order: number;
	title: string;
	type: VideoType;
	video_id: string;
}

Properties

NameRequiredTypeDescription
descriptionRequiredstringThe description for the video. If left blank, this will be filled in according to data on a host site.
idRequirednumberThe unique numeric ID of the product video; increments sequentially.
lengthRequiredstringLength of the video. This will be filled in according to data on a host site.
product_idRequirednumberThe unique numeric identifier for the product with which the image is associated.
sort_orderRequirednumberThe 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_orders reordered.
titleRequiredstringThe title for the video. If left blank, this will be filled in according to data on a host site.
typeRequiredVideoTypeThe video type (a short name of a host site).
video_idRequiredstringThe ID of the video on a host site.

Referenced Types

On this page