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 Shopify's product model, including limitations and considerations.
Anchor to Fields and connectionsFields and connections
- Anchor to availablePublicationsCountavailable•
Publications Count The number of publications that a resource is published to, without feedback errors.
- Anchor to bundleComponentsbundle•
Components A list of components that are associated with a product in a bundle.
- Anchor to categorycategory•
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 combinedListingcombined•
Listing 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.
- Anchor to combinedListingRolecombined•
Listing Role The role of the product in a combined listing.
If
null
, then the product isn't part of any combined listing.- Anchor to compareAtPriceRangecompare•
At Price Range The compare-at price range of the product in the shop's default currency.
- Anchor to contextualPricingcontextual•
Pricing ProductContextual Pricing!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.
- Anchor to createdAtcreated•
At DateTime!non-null The date and time when the product was created.
- Anchor to defaultCursordefault•
Cursor String!non-null A default cursor that returns the single next record, sorted ascending by ID.
- Anchor to descriptiondescription•String!non-null
A single-line description of the product, with HTML tags removed.
- 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 eventsevents•Event
Connection!non-null The paginated list of events associated with the host subject.
- Anchor to featuredMediafeatured•
Media The featured media associated with the product.
- Anchor to feedbackfeedback•
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".
- Anchor to giftCardTemplateSuffixgift•
Card Template Suffix The theme template that's used when customers view the gift card in a store.
- 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.- Anchor to hasOnlyDefaultVarianthas•
Only Default Variant Boolean!non-null Whether the product has only a single variant with the default option and value.
- Anchor to hasOutOfStockVariantshas•
Out Of Stock Variants Boolean!non-null Whether the product has variants that are out of stock.
- Anchor to hasVariantsThatRequiresComponentshas•
Variants That Requires Components Boolean!non-null Whether at least one of the product variants requires bundle components.
Learn more about store eligibility for bundles.
- •ID!non-null
A globally-unique ID.
- Anchor to inCollectionin•
Collection Boolean!non-null Whether the product is in a specified collection.
- Anchor to isGiftCardis•
Gift Card Boolean!non-null Whether the product is a gift card.
- Anchor to legacyResourceIdlegacy•
Resource Id UnsignedInt64!non-null The ID of the corresponding resource in the REST Admin API.
- Anchor to mediamedia•Media
Connection!non-null The media associated with the product. Valid media are images, 3D models, videos.
- Anchor to mediaCountmedia•
Count The total count of media that's associated with a product.
- Anchor to metafieldmetafield•
A custom field, including its
namespace
andkey
, that's associated with a Shopify resource for the purposes of adding and storing additional information.- Anchor to metafieldsmetafields•Metafield
Connection!non-null A list of custom fields that a merchant associates with a Shopify resource.
- Anchor to onlineStorePreviewUrlonline•
Store Preview Url The preview URL for the online store.
- Anchor to onlineStoreUrlonline•
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