An access token is required to call this API. Refer to Authorization for more information about how to obtain the token.
Retrieve a Product using its handle.
Arguments
handle ● String!non-null
The unique string used to identify the product. The handle is generated based on the product title, converted to lowercase, and formatted to replace spaces and special characters with hyphens. If multiple products have the same title, the handle will automatically append a number to differentiate them. For example, if there are two products with the title "Clothing", their handles will be "clothing" and "clothing-1". Modifying the product title will not update the handle.
Return
collections ● CollectionConnection
List of collections the product belongs to.
More
compareAtPriceRange ● ProductCompareAtPriceRange
The original price range of the product based on the store's currency.
More
createdAt ● Date!non-null
The creation date and time of the product.
descriptionHtml ● String
The product's description, including HTML formatting.
featuredImage ● Image
The product's featured image.
More
featuredMedia ● Media
The product's featured media.
More
handle ● String!non-null
The product's handle.
hasOnlyDefaultVariant ● Boolean!non-null
If the value is true, it indicates that the product has only one variant with default options and values.
id ● ID!non-null
A universally unique identifier.
images ● ImageConnection
The images linked to the product.
More
inCollection ● Boolean
Determining if the product is part of a specified collection.
isGiftCard ● Boolean!non-null
Indicates if the product is a gift card.
media ● MediaConnection
The media linked to the product, including images and videos.
More
mediaCount ● Int!non-null
Total number of media associated with a product.
onlineStorePreviewUrl ● URL
The URL for previewing the online store.
onlineStoreUrl ● URL
The URL of the product in the online store. If not published to the online store, the value is null.
options ● [ProductOption]
The list of options for the product.
More
priceRange ● ProductPriceRange
The product’s price range, formatted as decimal prices.
More
productCategory ● ProductCategory
The standard product type defined by the merchant.
More
productType ● String
A product type customized by the merchant.
publishedAt ● Date
The date and time (in ISO 8601 format) at which the product was made available in the Online Store.
publishedInContext ● Boolean!non-null
Determining if the product is published for a customer in the given context
resourcePublicationsV2 ● ResourcePublicationV2Connection
A list of resources that are either already published or scheduled to be published to a publication.
More
spu ● String
The product's SPU code.
status ● ProductStatus!non-null
The product's status.
More
subtitle ● String
The product's summary.
tags ● [String]
The tags associated with the product.
title ● String!non-null
The product's title.
totalInventory ● Int!non-null
The amount of inventory available.
totalVariants ● Int!non-null
The product's number of variants
tracksInventory ● Boolean!non-null
Whether the product has inventory tracking enabled.
updatedAt ● Date
The last modified date and time of the product.
The list of product variants.
More
vendor ● String
The vendor name of the product.
Status and error codes
For detailed information about common codes, see Status and error codes.
Was this article helpful to you?