Product
Requires access scope.
The Product object lets you manage products in a merchant’s store.
Products are the goods and services that merchants offer to customers. They can include various details such as title, description, price, images, and options such as size or color. You can use product variants to create or update different versions of the same product. You can also add or update product media. Products can be organized by grouping them into a collection.
Learn more about working with products and collections.
Anchor to FieldsFields
- Anchor to adjacentVariantsadjacent•[Product
Variants Variant!]! non-null A list of variants whose selected options differ with the provided selected options by one, ordered by variant id. If selected options are not provided, adjacent variants to the first available variant is returned.
Note that this field returns an array of variants. In most cases, the number of variants in this array will be low. However, with a low number of options and a high number of values per option, the number of variants returned here can be high. In such cases, it recommended to avoid using this field.
This list of variants can be used in combination with the
optionsfield to build a rich variant picker that includes variant availability or other variant information.- Anchor to selectedOptionsselected•[Selected
Options Option Input!] The input fields used for a selected option.
The input must not contain more than
250values.- Anchor to ignoreUnknownOptionsignore•Boolean
Unknown Options Default:true Whether to ignore product options that are not present on the requested product.
- Anchor to caseInsensitiveMatchcase•Boolean
Insensitive Match Default:false Whether to perform case insensitive match on option names and values.
Arguments
- Anchor to availableForSaleavailable•Boolean!
For Sale non-null Indicates if at least one product variant is available for sale.
- Anchor to categorycategory•Taxonomy
Category The category of a product from Shopify's Standard Product Taxonomy.
- Anchor to collectionscollections•Collection
Connection! non-null A list of collections that include the product.
- Anchor to firstfirst•Int
Returns up to the first
nelements from the list.- Anchor to afterafter•String
Returns the elements that come after the specified cursor.
- Anchor to lastlast•Int
Returns up to the last
nelements from the list.- Anchor to beforebefore•String
Returns the elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- Anchor to compareAtPriceRangecompare•Product
At Price Range Price Range! non-null The compare-at price range of the product in the shop's default currency.
- Anchor to createdAtcreated•Date
At Time! non-null The date and time when the product was created.
- Anchor to descriptiondescription•String!non-null
A single-line description of the product, with HTML tags removed.
- Anchor to truncateAttruncate•Int
At Truncates a string after the given length.
Arguments
- Anchor to descriptionHtmldescription•HTML!
Html non-null The description of the product, with HTML tags. For example, the description might include bold
<strong></strong>and italic<i></i>text.- Anchor to encodedVariantAvailabilityencoded•String
Variant Availability An encoded string containing all option value combinations with a corresponding variant that is currently available for sale.
Integers represent option and values: [0,1] represents option_value at array index 0 for the option at array index 0
:,,,and-are control characters.:indicates a new option. ex: 0:1 indicates value 0 for the option in position 1, value 1 for the option in position 2.,indicates the end of a repeated prefix, mulitple consecutive commas indicate the end of multiple repeated prefixes.indicates a gap in the sequence of option values. ex: 0 4 indicates option values in position 0 and 4 are present.-indicates a continuous range of option values. ex: 0 1-3 4Decoding process:
Example options: [Size, Color, Material] Example values: [[Small, Medium, Large], [Red, Blue], [Cotton, Wool]] Example encoded string: "0:0:0,1:0-1,,1:0:0-1,1:1,,2:0:1,1:0,,"
Step 1: Expand ranges into the numbers they represent: "0:0:0,1:0 1,,1:0:0 1,1:1,,2:0:1,1:0,," Step 2: Expand repeated prefixes: "0:0:0,0:1:0 1,1:0:0 1,1:1:1,2:0:1,2:1:0," Step 3: Expand shared prefixes so data is encoded as a string: "0:0:0,0:1:0,0:1:1,1:0:0,1:0:1,1:1:1,2:0:1,2:1:0," Step 4: Map to options + option values to determine existing variants:
[Small, Red, Cotton] (0:0:0), [Small, Blue, Cotton] (0:1:0), [Small, Blue, Wool] (0:1:1), [Medium, Red, Cotton] (1:0:0), [Medium, Red, Wool] (1:0:1), [Medium, Blue, Wool] (1:1:1), [Large, Red, Wool] (2:0:1), [Large, Blue, Cotton] (2:1:0).
- Anchor to encodedVariantExistenceencoded•String
Variant Existence An encoded string containing all option value combinations with a corresponding variant.
Integers represent option and values: [0,1] represents option_value at array index 0 for the option at array index 0
:,,,and-are control characters.:indicates a new option. ex: 0:1 indicates value 0 for the option in position 1, value 1 for the option in position 2.,indicates the end of a repeated prefix, mulitple consecutive commas indicate the end of multiple repeated prefixes.indicates a gap in the sequence of option values. ex: 0 4 indicates option values in position 0 and 4 are present.-indicates a continuous range of option values. ex: 0 1-3 4Decoding process:
Example options: [Size, Color, Material] Example values: [[Small, Medium, Large], [Red, Blue], [Cotton, Wool]] Example encoded string: "0:0:0,1:0-1,,1:0:0-1,1:1,,2:0:1,1:0,,"
Step 1: Expand ranges into the numbers they represent: "0:0:0,1:0 1,,1:0:0 1,1:1,,2:0:1,1:0,," Step 2: Expand repeated prefixes: "0:0:0,0:1:0 1,1:0:0 1,1:1:1,2:0:1,2:1:0," Step 3: Expand shared prefixes so data is encoded as a string: "0:0:0,0:1:0,0:1:1,1:0:0,1:0:1,1:1:1,2:0:1,2:1:0," Step 4: Map to options + option values to determine existing variants:
[Small, Red, Cotton] (0:0:0), [Small, Blue, Cotton] (0:1:0), [Small, Blue, Wool] (0:1:1), [Medium, Red, Cotton] (1:0:0), [Medium, Red, Wool] (1:0:1), [Medium, Blue, Wool] (1:1:1), [Large, Red, Wool] (2:0:1), [Large, Blue, Cotton] (2:1:0).
- Anchor to featuredImagefeatured•Image
Image The featured image for the product.
This field is functionally equivalent to
images(first: 1).- Anchor to handlehandle•String!non-null
A unique, human-readable string of the product's title. A handle can contain letters, hyphens (
-), and numbers, but no spaces. The handle is used in the online store URL for the product.- •ID!non-null
A globally-unique ID.
- Anchor to imagesimages•Image
Connection! non-null List of images associated with the product.
- Anchor to firstfirst•Int
Returns up to the first
nelements from the list.- Anchor to afterafter•String
Returns the elements that come after the specified cursor.
- Anchor to lastlast•Int
Returns up to the last
nelements from the list.- Anchor to beforebefore•String
Returns the elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•Product
Key Image Sort Keys Default:POSITION Sort the underlying list by the given key.
Arguments
- Anchor to isGiftCardis•Boolean!
Gift Card non-null Whether the product is a gift card.
- Anchor to mediamedia•Media
Connection! non-null The media that are associated with the product. Valid media are images, 3D models, videos.
- Anchor to firstfirst•Int
Returns up to the first
nelements from the list.- Anchor to afterafter•String
Returns the elements that come after the specified cursor.
- Anchor to lastlast•Int
Returns up to the last
nelements from the list.- Anchor to beforebefore•String
Returns the elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•Product
Key Media Sort Keys Default:POSITION Sort the underlying list by the given key.
Arguments
- Anchor to metafieldmetafield•MetafieldToken access required
A custom field, including its
namespaceandkey, that's associated with a Shopify resource for the purposes of adding and storing additional information.- Anchor to namespacenamespace•String
The container the metafield belongs to. If omitted, the app-reserved namespace will be used.
- •String!required
The identifier for the metafield.
Arguments
- Anchor to metafieldsmetafields•[Metafield]!non-null Token access required
A list of custom fields that a merchant associates with a Shopify resource.
- Anchor to identifiersidentifiers•[Has
Metafields Identifier!]! required The list of metafields to retrieve by namespace and key.
The input must not contain more than
250values.
Arguments
- Anchor to onlineStoreUrlonline•URL
Store Url The product's URL on the online store. If
null, then the product isn't published to the online store sales channel.- Anchor to optionsoptions•[Product
Option!]! non-null A list of product options. The limit is defined by the shop's resource limits for product options (
).- Anchor to firstfirst•Int
Truncate the array result to this size.
Arguments
- Anchor to priceRangeprice•Product
Range Price Range! non-null The minimum and maximum prices of a product, expressed in decimal numbers. For example, if the product is priced between $10.00 and $50.00, then the price range is $10.00 - $50.00.
- Anchor to productTypeproduct•String!
Type non-null The product type that merchants define.
- Anchor to publishedAtpublished•Date
At Time! non-null The date and time when the product was published to the channel.
- Anchor to requiresSellingPlanrequires•Boolean!
Selling Plan non-null Whether the product can only be purchased with a selling plan. Products that are sold on subscription (
) can be updated only for online stores. If you update a product to be subscription-only (), then the product is unpublished from all channels, except the online store.- Anchor to selectedOrFirstAvailableVariantselected•Product
Or First Available Variant Variant Find an active product variant based on selected options, availability or the first variant.
All arguments are optional. If no selected options are provided, the first available variant is returned. If no variants are available, the first variant is returned.
- Anchor to selectedOptionsselected•[Selected
Options Option Input!] The input fields used for a selected option.
The input must not contain more than
250values.- Anchor to ignoreUnknownOptionsignore•Boolean
Unknown Options Default:true Whether to ignore unknown product options.
- Anchor to caseInsensitiveMatchcase•Boolean
Insensitive Match Default:false Whether to perform case insensitive match on option names and values.
Arguments
- Anchor to sellingPlanGroupsselling•Selling
Plan Groups Plan Group Connection! non-null A list of all selling plan groups that are associated with the product either directly, or through the product's variants.
- Anchor to firstfirst•Int
Returns up to the first
nelements from the list.- Anchor to afterafter•String
Returns the elements that come after the specified cursor.
- Anchor to lastlast•Int
Returns up to the last
nelements from the list.- Anchor to beforebefore•String
Returns the elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- •SEO!non-null
The SEO title and description that are associated with a product.
- •[String!]!non-null
A comma-separated list of searchable keywords that are associated with the product. For example, a merchant might apply the
sportsandsummertags to products that are associated with sportwear for summer. Updatingtagsoverwrites any existing tags that were previously added to the product. To add new tags without overwriting existing tags, use the GraphQL Admin API'smutation.- Anchor to titletitle•String!non-null
The name for the product that displays to customers. The title is used to construct the product's handle. For example, if a product is titled "Black Sunglasses", then the handle is
black-sunglasses.- Anchor to totalInventorytotal•Int
Inventory Token access required The quantity of inventory that's in stock.
- Anchor to trackingParameterstracking•String
Parameters URL parameters to be added to a page URL to track the origin of on-site search traffic for analytics reporting. Returns a result when accessed through the search or predictiveSearch queries, otherwise returns null.
- Anchor to updatedAtupdated•Date
At Time! non-null The date and time when the product was last modified. A product's
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.- Anchor to variantBySelectedOptionsvariant•Product
By Selected Options Variant Find a product’s variant based on its selected options. This is useful for converting a user’s selection of product options into a single matching variant. If there is not a variant for the selected options,
nullwill be returned.- Anchor to selectedOptionsselected•[Selected
Options Option Input!]! required The input fields used for a selected option.
The input must not contain more than
250values.- Anchor to ignoreUnknownOptionsignore•Boolean
Unknown Options Default:false Whether to ignore unknown product options.
- Anchor to caseInsensitiveMatchcase•Boolean
Insensitive Match Default:false Whether to perform case insensitive match on option names and values.
Arguments
- Anchor to variantsvariants•Product
Variant Connection! non-null A list of variants that are associated with the product.
- Anchor to firstfirst•Int
Returns up to the first
nelements from the list.- Anchor to afterafter•String
Returns the elements that come after the specified cursor.
- Anchor to lastlast•Int
Returns up to the last
nelements from the list.- Anchor to beforebefore•String
Returns the elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•Product
Key Variant Sort Keys Default:POSITION Sort the underlying list by the given key.
Arguments
- Anchor to variantsCountvariants•Count
Count The number of variants that are associated with the product.
- Anchor to vendorvendor•String!non-null
The name of the product's vendor.
Anchor to QueriesQueries
- •query
Fetch a specific
Productby one of its unique attributes.- •ID
The ID of the
Product.- Anchor to handlehandle•String
The handle of the
Product.
Arguments
- •query
Find recommended products related to a given
. To learn more about how recommendations are generated, see Showing product recommendations on product pages.- Anchor to productIdproduct•ID
Id The id of the product.
- Anchor to productHandleproduct•String
Handle The handle of the product.
- Anchor to intentintent•Product
Recommendation Intent Default:RELATED The recommendation intent that is used to generate product recommendations. You can use intent to generate product recommendations on various pages across the channels, according to different strategies.
Arguments
- •query
Returns a list of the shop's products. For storefront search, use the
searchquery.- Anchor to firstfirst•Int
Returns up to the first
nelements from the list.- Anchor to afterafter•String
Returns the elements that come after the specified cursor.
- Anchor to lastlast•Int
Returns up to the last
nelements from the list.- Anchor to beforebefore•String
Returns the elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•Product
Key Sort Keys Default:ID Sort the underlying list by the given key.
- Anchor to queryquery•String
You can apply one or multiple filters to a query. Learn more about Shopify API search syntax.
- Anchor to available_for_sale•
Filter by products that have at least one product variant available for sale.
- Anchor to created_at•
Filter by the date and time when the product was created.
created_at:>'2020-10-21T23:39:20Z'created_at:<nowcreated_at:<=2024- Anchor to product_type•
Filter by a comma-separated list of product types.
product_type:snowboard- Anchor to tag_not•
Filter by products that don't have the specified product tags.
tag_not:my_tag- Anchor to updated_at•
Filter by the date and time when the product was last updated.
updated_at:>'2020-10-21T23:39:20Z'updated_at:<nowupdated_at:<=2024- Anchor to variants.price•
Filter by the price of the product's variants.
Example:
Example:
Example:
Example:
Arguments
- •queryDeprecated
- Anchor to handlehandle•String!required
A unique, human-readable string of the product's title. A handle can contain letters, hyphens (
-), and numbers, but no spaces. The handle is used in the online store URL for the product.
Arguments