Choose a version:

productByHandle

query

Requires read_products access scope.

Deprecated. Use `productByIdentifier` instead.

Return a product by its handle.

Arguments

Anchor to handlehandle • String!required: A unique string that identifies the product. Handles are automatically generated based on the product's title, and are always lowercase. Whitespace and special characters are replaced with a hyphen: -. If there are multiple consecutive whitespace or special characters, then they're replaced with a single hyphen. Whitespace or special characters at the beginning are removed. If a duplicate product title is used, then the handle is auto-incremented by one. For example, if you had two products called Potion, then their handles would be potion and potion-1. After a product has been created, changing the product title doesn't update the handle.

Was this section helpful?

Anchor to Possible returnsPossible returns

Product

•

Product

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 Shopify's product model, including limitations and considerations.

availablePublicationsCount• Count: The number of publications that a resource is published to, without feedback errors.
bundleComponents • ProductBundleComponentConnection! non-null: A list of components that are associated with a product in a bundle.
category• TaxonomyCategory: The category of a product from Shopify's Standard Product Taxonomy.
collections • CollectionConnection! non-null: A list of collections that include the product.
combinedListing• CombinedListing: A special product type that combines separate products from a store into a single product listing. Combined listings are connected by a shared option, such as color, model, or dimension.
combinedListingRole• CombinedListingsRole: The role of the product in a combined listing.

If null, then the product isn't part of any combined listing.
compareAtPriceRange• ProductCompareAtPriceRange: The compare-at price range of the product in the shop's default currency.
contextualPricing• ProductContextualPricing! non-null: The pricing that applies to a customer in a specific context. For example, a price might vary depending on the customer's location. As of API version 2025-04, only active markets are considered in the price resolution.
createdAt• DateTime! non-null: The date and time when the product was created.
defaultCursor• String! non-null: A default cursor that returns the single next record, sorted ascending by ID.
description• String! non-null: A single-line description of the product, with HTML tags removed.
descriptionHtml• HTML! non-null: The description of the product, with HTML tags. For example, the description might include bold  and italic  text.
events • EventConnection! non-null: The paginated list of events associated with the host subject.
featuredMedia• Media: The featured media associated with the product.
feedback• ResourceFeedback: The information that lets merchants know what steps they need to take to make sure that the app is set up correctly.

For example, if a merchant hasn't set up a product correctly in the app, then the feedback might include a message that says "You need to add a price to this product".
giftCardTemplateSuffix• String: The theme template that's used when customers view the gift card in a store.
handle• 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.
hasOnlyDefaultVariant• Boolean! non-null: Whether the product has only a single variant with the default option and value.
hasOutOfStockVariants• Boolean! non-null: Whether the product has variants that are out of stock.
hasVariantsThatRequiresComponents• Boolean! non-null: Whether at least one of the product variants requires bundle components.

Learn more about store eligibility for bundles.
id• ID! non-null: A globally-unique ID.
inCollection• Boolean! non-null: Whether the product is in a specified collection.
isGiftCard• Boolean! non-null: Whether the product is a gift card.
legacyResourceId• UnsignedInt64! non-null: The ID of the corresponding resource in the REST Admin API.
media • MediaConnection! non-null: The media associated with the product. Valid media are images, 3D models, videos.
mediaCount• Count: The total count of media that's associated with a product.
metafield• 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.
metafields • MetafieldConnection! non-null: A list of custom fields that a merchant associates with a Shopify resource.
onlineStorePreviewUrl• URL: The preview URL for the online store.
onlineStoreUrl• URL: The product's URL on the online store. If null, then the product isn't published to the online store sales channel.
options• [ProductOption!]! non-null: A list of product options. The limit is defined by the shop's resource limits for product options (Shop.resourceLimits.maxProductOptions).
priceRangeV2• ProductPriceRangeV2! 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.
productType• String! non-null: The product type that merchants define.
publishedAt• DateTime: The date and time when the product was published to the online store.
publishedInContext• Boolean! non-null: Whether the product is published for a customer only in a specified context. For example, a product might be published for a customer only in a specific location.
publishedOnCurrentPublication• Boolean! non-null: Whether the resource is published to the app's publication. For example, the resource might be published to the app's online store channel.
publishedOnPublication• Boolean! non-null: Whether the resource is published to a specified publication.
requiresSellingPlan• Boolean! non-null: Whether the product can only be purchased with a selling plan. Products that are sold on subscription (requiresSellingPlan: true) can be updated only for online stores. If you update a product to be subscription-only (requiresSellingPlan:false), then the product is unpublished from all channels, except the online store.
resourcePublicationOnCurrentPublication• ResourcePublicationV2: The resource that's either published or staged to be published to the publication.
resourcePublications • ResourcePublicationConnection! non-null: The list of resources that are published to a publication.
resourcePublicationsCount• Count: The number of publications that a resource is published to, without feedback errors.
resourcePublicationsV2 • ResourcePublicationV2Connection! non-null: The list of resources that are either published or staged to be published to a publication.
restrictedForResource• RestrictedForResource: Whether the merchant can make changes to the product when they edit the order associated with the product. For example, a merchant might be restricted from changing product details when they edit an order.
sellingPlanGroups • SellingPlanGroupConnection! non-null: A list of all selling plan groups that are associated with the product either directly, or through the product's variants.
sellingPlanGroupsCount• Count: A count of selling plan groups that are associated with the product.
seo• SEO! non-null: The SEO title and description that are associated with a product.
status• ProductStatus! non-null: The product status, which controls visibility across all sales channels.
tags• [String!]! non-null: A comma-separated list of searchable keywords that are associated with the product. For example, a merchant might apply the sports and summer tags to products that are associated with sportwear for summer.

Updating tags overwrites any existing tags that were previously added to the product. To add new tags without overwriting existing tags, use the tagsAdd mutation.
templateSuffix• String: The theme template that's used when customers view the product in a store.
title• 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.
totalInventory• Int! non-null: The quantity of inventory that's in stock.
tracksInventory• Boolean! non-null: Whether inventory tracking has been enabled for the product.
translations• [Translation!]! non-null: The published translations associated with the resource.
unpublishedPublications • PublicationConnection! non-null: The list of publications that the resource isn't published to.
updatedAt• DateTime! non-null: 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 • ProductVariantConnection! non-null: A list of variants associated with the product. If querying a single product at the root, you can fetch up to 2000 variants.
variantsCount• Count: The number of variants that are associated with the product.
vendor• String! non-null: The name of the product's vendor.
bodyHtml• String: The description of the product, with HTML tags. For example, the description might include bold  and italic  text.
customProductType• String: The custom product type specified by the merchant.
descriptionPlainSummary• String! non-null: Stripped description of the product, single line with HTML tags removed. Truncated to 60 characters.
featuredImage• Image: The featured image for the product.
images • ImageConnection! non-null: The images associated with the product.
metafieldDefinitions • MetafieldDefinitionConnection! non-null: List of metafield definitions.
priceRange• ProductPriceRange! non-null: The price range of the product.
productCategory• ProductCategory: The product category specified by the merchant.
productPublications • ProductPublicationConnection! non-null: A list of the channels where the product is published.
publicationCount• Int! non-null: The number of publications that a resource is published to, without feedback errors.
publications • ProductPublicationConnection! non-null: A list of the channels where the product is published.
publishedOnChannel• Boolean! non-null: Whether the resource is published to a specific channel.
publishedOnCurrentChannel• Boolean! non-null: Whether the resource is published to a channel. For example, the resource might be published to the online store channel.
sellingPlanGroupCount• Int! non-null: A count of selling plan groups that are associated with the product.
standardizedProductType• StandardizedProductType: The standardized product type in the Shopify product taxonomy.
storefrontId• StorefrontID! non-null: The Storefront GraphQL API ID of the Product.

As of the 2022-04 version release, the Storefront GraphQL API will no longer return Base64 encoded IDs to match the behavior of the Admin GraphQL API. Therefore, you can safely use the id field's value instead.
totalVariants• Int! non-null: The number of variants that are associated with the product.
unpublishedChannels • ChannelConnection! non-null: The list of channels that the resource is not published to.

Was this section helpful?

Retrieve a product by a handle that doesn't exist
Retrieve product information using the product handle
Retrieve the ID of a product with a specified handle

Examples

Open in GraphiQL

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

query {

productByHandle(handle: "there is no product with a handle like this") {

title

productType

description

vendor

}

}`,

);

const data = await response.json();

query {
  productByHandle(handle: "there is no product with a handle like this") {
    id
    title
    productType
    description
    vendor
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { productByHandle(handle: \"there is no product with a handle like this\") { id title productType description vendor } }"
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  query {
    productByHandle(handle: "there is no product with a handle like this") {
      id
      title
      productType
      description
      vendor
    }
  }`,
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    productByHandle(handle: "there is no product with a handle like this") {
      id
      title
      productType
      description
      vendor
    }
  }`,
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query {
    productByHandle(handle: "there is no product with a handle like this") {
      id
      title
      productType
      description
      vendor
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

{

"productByHandle": null

}