Metaimage Object
This object represents an image with additional metadata
Fields
#
available
A boolean value that represents if the image was accessible last time it was checked.
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
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.
Usages
#
References
#
- Field featuredImage from ProductGroup
- Field metaimages from ProductVariant
MetadataKeyStatusPayload
MetaimageInput