Image


Describes an image.

ai_processed?

Whether the image has been processed by AI.

alt

The alt text for the image.

aspect_ratio

The aspect ratio of the image, e.g. 16:9.

attached_to_variant?

Whether the image is attached to a variant.

This only available when image is access through following methods:

  • product.images
  • product.featured_image or product.image
  • product.media
  • product.featured_media

description

The description of the image.

file_extension

The file extension of the image.

file_name

The file name of the image.

file_size

The size of the image.

height

The height of the image.

mime_type

The mime type of the image.

orientation

The orientation of the image, e.g. landscape.

sort_order

The sort order of the image.

tags

The tags of the image.

title

The title (alt) of the image.

type

The type of the media.

url

The URL of the image.

variants

The variants the image is attached to.

This only available when image is access through following methods:

  • product.images
  • product.featured_image or product.image
  • product.media
  • product.featured_media

width

The width of the image.