Versions Compared

Key

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

...

Field

Description

String type

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

boolean isDefault

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 image.

integer imageHeight

Height if this is an image.

String viewUrl

URL to view the multimedia file.

String viewSsl

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

String description

Description

String code

Code

boolean excludeFromGallery

True if the file should be excluded from gallery displays

ItemMultimediaThumbnail[ ] thumbnails

Array of Thumbnails available for this image.