An access token is required to call this API. Refer to Authorization for more information about how to obtain the token.
Arguments
handle ● String
The handle of the Product.
id ● ID
The ID of the Product.
Returns
availableForSale ● Boolean
Indicates whether at least one variant is available for sale
brand ● String
deprecated
The product’s vendor name.
collections ● CollectionConnection
List of collections a product belongs to.
compareAtPriceRange ● ProductPriceRange
The compare at price of the product across all variants.
createdAt ● Date
The date and time when the product was created.
descriptionHtml ● String
The description of the product, complete with HTML formatting.
featuredImage ● Image
The featured image for the product.
tip
This field is functionally equivalent to imagesV2(first: 1).
handle ● String!non-null
A human-friendly unique string for the Product automatically generated from its title.
id ● ID!non-null
A globally-unique ID.
images ● [Image]
deprecated
List of images associated with the product.
imagesV2 ● ImageConnection
List of images associated with the product.
isGiftCard ● Boolean
Whether the product is a gift card.
media ● MediaConnection
The media associated with the product.
metafield ● Metafield
Metafield associated with a product.
metafields ● [Metafield]
Metafields associated with a product.
onlineStoreUrl ● String
The URL used for viewing the resource on the shop's Online Store. Returns null if the resource is currently not published to the Online Store sales channel.
options ● [ProductOption]
List of product options.
priceRange ● ProductPriceRange
The price range.
productType ● String
A categorization that a product can be tagged with, commonly used for filtering and searching.
publishedAt ● Date
The date and time when the product was published to the channel.
status ● ProductStatus
deprecated
The product’s status.
tags ● StringConnection
Product tags.
templatePath ● String
The product is in the theme template path
title ● String!non-null
The product’s title.
totalInventory ● Int
The total quantity of inventory in stock for this Product.
totalVariants ● Int
The total number of product variants
updatedAt ● Date
The date and time when the product was last modified. A product's updatedAt value can change for different reasons. For example, if an order is placed for a product that has inventory tracking set up, then the inventory adjustment is counted as an update.
variants ● [ProductVariant]
deprecated
List of the product’s variants.
variantsV2 ● ProductVariantConnection
List of the product’s variants.
vendor ● String
The product’s vendor name.
Error Code
For more information about common error codes, refer to Status and error codes.
Was this article helpful to you?