Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ProductImage

Hierarchy

  • ProductImage

Index

Properties

Optional ID

ID: undefined | string

The unique identifier for the image. Optional, if null then an ID is generated based on the hash of the ImageUrl

ImageData

ImageData: string

The raw image data. Only required if ImageUrl is left empty.

Optional ImageUrl

ImageUrl: undefined | string

Where can the image be downloaded? Required unless ImageData is provided.

Optional IsPrimaryImage

IsPrimaryImage: undefined | false | true

If an image is specified as IsPrimaryImage = true then it will be used as the primary image on the product. If there is for some reason multiple images for a product that have IsPrimaryImage set to true then the last image that have this set will become the actual primary image.

Optional LocationType

LocationType: undefined | string

How the image should be stored. Usually empty.

Optional MimeType

MimeType: undefined | string

The image mime type. Optional, if null then the mime type will be guessed by the ImageUrl

Optional Name

Name: undefined | string

The human readable name of the image. Optional, if null then the name will be the ID of the image.

Optional Sequence

Sequence: undefined | number

The sequence number of the image, can be used to determine the display order of images and will be used to determine the primary image of the product.

Smaller numbers mean a higher priority.

By default this will be null and the sequence of the images will be determined by their ordering in the Images array.

The number provided here does not necessarily translate to the actual sequence number stored in EVA, only the relative order will be used. Given the sequence 1, 2, 4, 7 the actual sequence stored in EVA will be 0, 1, 2, 3.