Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

boolean isDefault

Field

Type

Description

String type

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

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.

integer imageWidth

Width if this is an

thumbnails

CartItemMultimediaThumbnail[ ]

Thumbnails available for this image.

integer imageHeight

Height if this is an image.

String viewUrltype

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.

String description

Description

String code

Code

boolean excludeFromGallery

True if the file should be excluded from gallery displays

CartItemMultimediaThumbnail[] thumbnails

Thumbnails available for this image.