ItemMultimedia

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

Field

Type

Description

code

code

The code is used mostly by the product categories. Images can be retrieved by code. For example, a line of t-shirts may have a "back side" image. Each item could have that image with the code "backside". The catalog page could then display the back side image in a smaller image next to the front of the image by simply requesting the image with the code 'backside' instead of having to know the name of the image or require a fixed image name.

description

description

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.

viewSslstring

URL to view the multimedia file using SSL. Note: This url will probably be prefixed with // instead of https:// so that it will use the same protocol of the page. So, it is actually appropriate to use for both secure and non-secure pages and still provide a fast browsing experience.

Note: Only available in Checkout REST Api

viewUrl

string

URL to view the multimedia file.

thumbnails

ItemMultimediaThumbnail [ ]

Array of 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.