Skip to main content

ProductImage Object

Represents a product image.

type ProductImage {
id: ID!
alt: String
sortOrder: Int
url(size: Int, format: ThumbnailFormatEnum = ORIGINAL): String!
}

Fields

ProductImage.id ● ID! non-null scalar miscellaneous

The ID of the image.

ProductImage.alt ● String scalar miscellaneous

The alt text of the image.

ProductImage.sortOrder ● Int scalar miscellaneous

The new relative sorting position of the item (from -inf to +inf). 1 moves the item one position forward, -1 moves the item one position backward, 0 leaves the item unchanged.

ProductImage.url ● String! non-null scalar miscellaneous

The URL of the image.

ProductImage.url.size ● Int scalar miscellaneous

Desired longest side the image in pixels. Defaults to 4096. Images are never cropped. Pass 0 to retrieve the original size (not recommended).

ProductImage.url.format ● ThumbnailFormatEnum enum miscellaneous

The format of the image. When not provided, format of the original image will be used.

Member Of

Product object ● ProductVariant object