CartItemMultimedia

This object represents a multimedia file that is configured on an item.

Field

Type

Description

code

string

Code

description

string

Description

excludeFromGallery

boolean

True if the file should be excluded from gallery displays

imageHeight

integer

Height if this is an image.

imageWidth

integer

Width if this is an image.

isDefault

boolean

True if this is the default multimedia object for it's type. Please note there can be a default image, default video, default PDF file, etc. all on the same item.

thumbnails

CartItemMultimediaThumbnail[ ]

Thumbnails available for this image.

type

string

Type of multimedia file. See the ITEM_MULTIMEDIA_TYPE_ constants in the checkoutapi.js file for a list of valid values.

viewUrl

string

URL to view the multimedia file.