Image

object

Represents an image resource.

Anchor to Fields and connectionsFields and connections

Anchor to altTextaltText • String: A word or phrase to share the nature or contents of an image.
Anchor to heightheight • Int: The original height of the image in pixels. Returns null if the image isn't hosted by Shopify.
Anchor to idid • ID: A unique ID for the image.
Anchor to metafieldmetafield • Metafield: A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.
Anchor to metafieldsmetafields • MetafieldConnection!non-null: A list of custom fields that a merchant associates with a Shopify resource.
Anchor to urlurl • URL!non-null: The location of the image as a URL.

If no transform options are specified, then the original image will be preserved including any pre-applied transforms.

All transformation options are considered "best-effort". Any transformation that the original image type doesn't support will be ignored.

If you need multiple variations of the same image, then you can use GraphQL aliases.
Anchor to widthwidth • Int: The original width of the image in pixels. Returns null if the image isn't hosted by Shopify.

Show

deprecated fields and connections Deprecated

Anchor to originalSrcoriginalSrc • URL!non-nullDeprecated: The location of the original image as a URL.

If there are any existing transformations in the original source URL, they will remain and not be stripped. Use url instead.
Anchor to srcsrc • URL!non-nullDeprecated: The location of the image as a URL. Use url instead.
Anchor to transformedSrctransformedSrc • URL!non-nullDeprecated: The location of the transformed image as a URL.

All transformation arguments are considered "best-effort". If they can be applied to an image, they will be. Otherwise any transformations which an image type doesn't support will be ignored. Use url(transform:) instead

Was this section helpful?

Was this section helpful?