Choose a version:

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.

Anchor to originalSrcoriginalSrc •URL! non-nullDeprecated
Anchor to privateMetafieldprivateMetafield •PrivateMetafield Deprecated
Anchor to privateMetafieldsprivateMetafields •PrivateMetafieldConnection! non-nullDeprecated
Anchor to srcsrc •URL! non-nullDeprecated
Anchor to transformedSrctransformedSrc •URL! non-nullDeprecated

Was this section helpful?

•mutation

Deprecated

Anchor to inputinput •ProductAppendImagesInput! required: Specifies the new images and the product that they're being added to.

Anchor to newImagesnewImages •[Image!]: List of new images appended to the product.
Anchor to productproduct •Product: The product object.
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

•mutation

Deprecated

Anchor to imageimage •ImageInput! required: Image to be updated.
Anchor to productIdproductId •ID! required: The ID of the product on which to update the image.

Anchor to imageimage •Image: The image that has been updated.
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Was this section helpful?