Magidoc

Metaimage
Object

This object represents an image with additional metadata

Fields

#

available

Non-null

A boolean value that represents if the image was accessible last time it was checked.

createdAt

Non-null

The date and time this entity was created.

height

The height of the image in pixels.

id

Non-null

A unique internal GlobalId for this entity.

orientation

The orientation of the image

originalUrl

Non-null

The URL of the image

owningOrganisation

Non-null

The organisation which owns this entity.

position

The zero-based position of this image within the source array supplied at ingestion. The Cloudshelf Engine orders images by this value when every image on the parent entity has a non-null position; if any image on the parent has a null position, the engine falls back to legacy ordering (preferred image first).

preferredImage

Non-null

A boolean value that represents if the image is a preferred image for the entity it is linked too. The Cloudshelf Engine will always try to use a preferred image over a non-preferred image.

productGroup

productPreferredImage

Whether this image is explicitly preferred for the product as a whole. Null means the source connector did not distinguish product preference from the linked entity preference.

productVariant

The product variant which this metaimage is linked too.

quality

The quality of the image

updatedAt

Non-null

The date and time this entity was last updated.

url

Non-null

The URL of the image

width

The width of the image in pixels.

Usages

#

References

#