Skip to main content
object

Requires read_products 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 availablePublicationsCountavailablePublicationsCount
Count

The number of publications that a resource is published to, without feedback errors.

ProductBundleComponentConnection!non-null

A list of components that are associated with a product in a bundle.

TaxonomyCategory

The category of a product from Shopify's Standard Product Taxonomy.

CollectionConnection!non-null

A list of collections that include the product.

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.

CombinedListingsRole

The role of the product in a combined listing.

If null, then the product isn't part of any combined listing.

ProductCompareAtPriceRange

The compare-at price range of the product in the shop's default currency.

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.

DateTime!non-null

The date and time when the product was created.

String!non-null

A default cursor that returns the single next record, sorted ascending by ID.

String!non-null

A single-line description of the product, with HTML tags removed.

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.

EventConnection!non-null

The paginated list of events associated with the host subject.

Media

The featured media associated with the product.

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".

Anchor to giftCardTemplateSuffixgiftCardTemplateSuffix
String

The theme template that's used when customers view the gift card in a store.

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 hasOnlyDefaultVarianthasOnlyDefaultVariant
Boolean!non-null

Whether the product has only a single variant with the default option and value.

Anchor to hasOutOfStockVariantshasOutOfStockVariants
Boolean!non-null

Whether the product has variants that are out of stock.

Anchor to hasVariantsThatRequiresComponentshasVariantsThatRequiresComponents
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.

Boolean!non-null

Whether the product is in a specified collection.

Boolean!non-null

Whether the product is a gift card.

UnsignedInt64!non-null

The ID of the corresponding resource in the REST Admin API.

MediaConnection!non-null

The media associated with the product. Valid media are images, 3D models, videos.

Count

The total count of media that's associated with a product.

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.

MetafieldConnection!non-null

A list of custom fields that a merchant associates with a Shopify resource.

Anchor to onlineStorePreviewUrlonlineStorePreviewUrl
URL

The preview URL for the online store.

URL

The product's URL on the online store. If null, then the product isn't published to the online store sales channel.

[ProductOption!]!non-null

A list of product options. The limit is defined by the shop's resource limits for product options (Shop.resourceLimits.maxProductOptions).

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.

String!non-null

The product type that merchants define.

DateTime

The date and time when the product was published to the online store.

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.

Anchor to publishedOnCurrentPublicationpublishedOnCurrentPublication
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.

Anchor to publishedOnPublicationpublishedOnPublication
Boolean!non-null

Whether the resource is published to a specified publication.

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.

Anchor to resourcePublicationOnCurrentPublicationresourcePublicationOnCurrentPublication
ResourcePublicationV2

The resource that's either published or staged to be published to the publication.

Anchor to resourcePublicationsresourcePublications
ResourcePublicationConnection!non-null

The list of resources that are published to a publication.

Anchor to resourcePublicationsCountresourcePublicationsCount
Count

The number of publications that a resource is published to, without feedback errors.

Anchor to resourcePublicationsV2resourcePublicationsV2
ResourcePublicationV2Connection!non-null

The list of resources that are either published or staged to be published to a publication.

Anchor to restrictedForResourcerestrictedForResource
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.

SellingPlanGroupConnection!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 sellingPlanGroupsCountsellingPlanGroupsCount
Count

A count of selling plan groups that are associated with the product.

SEO!non-null

The SEO title and description that are associated with a product.

ProductStatus!non-null

The product status, which controls visibility across all sales channels.

[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.

String

The theme template that's used when customers view the product in a store.

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.

Int!non-null

The quantity of inventory that's in stock.

Boolean!non-null

Whether inventory tracking has been enabled for the product.

[Translation!]!non-null

The published translations associated with the resource.

Anchor to unpublishedPublicationsunpublishedPublications
PublicationConnection!non-null

The list of publications that the resource isn't published to.

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.

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.

Count

The number of variants that are associated with the product.

String!non-null

The name of the product's vendor.

Deprecated fields and connections

StringDeprecated
StringDeprecated
Anchor to descriptionPlainSummarydescriptionPlainSummary
String!non-nullDeprecated
ImageDeprecated
ImageConnection!non-nullDeprecated
Anchor to metafieldDefinitionsmetafieldDefinitions
MetafieldDefinitionConnection!non-nullDeprecated
ProductPriceRange!non-nullDeprecated
ProductCategoryDeprecated
ProductPublicationConnection!non-nullDeprecated
Int!non-nullDeprecated
Boolean!non-nullDeprecated
Anchor to publishedOnCurrentChannelpublishedOnCurrentChannel
Boolean!non-nullDeprecated
Anchor to sellingPlanGroupCountsellingPlanGroupCount
Int!non-nullDeprecated
StorefrontID!non-nullDeprecated
Int!non-nullDeprecated
ChannelConnection!non-nullDeprecated

Was this section helpful?

query

Returns a Product resource by ID.

query

Return a product by an identifier.

query

Returns a list of products.


Was this section helpful?

mutation

Add, remove and update CombinedListings of a given Product.

CombinedListings are comprised of multiple products to create a single listing. There are two kinds of products used in a CombinedListing:

  1. Parent products
  2. Child products

The parent product is created with a productCreate with a CombinedListingRole of PARENT. Once created, you can associate child products with the parent product using this mutation. Parent products represent the idea of a product (e.g. Shoe).

Child products represent a particular option value (or combination of option values) of a parent product. For instance, with your Shoe parent product, you may have several child products representing specific colors of the shoe (e.g. Shoe - Blue). You could also have child products representing more than a single option (e.g. Shoe - Blue/Canvas, Shoe - Blue/Leather, etc...).

The combined listing is the association of parent product to one or more child products.

Learn more about Combined Listings.

Arguments

[OptionAndValueInput!]

The ordered options and values to be used by the combined listing. Options and values will be reordered to match the order specified here.

ID!required

The ID of the parent product.

[ChildProductRelationInput!]

The child products to add and their assigned options and option values.

[ChildProductRelationInput!]

The child products to edit and their assigned options and option values.

[ID!]

The IDs of products to be removed from the combined listing.

String

The updated title for the combined listing.


Fields

Product

The parent product.

[CombinedListingUpdateUserError!]!non-null

The list of errors that occurred from executing the mutation.

mutation

Updates the fixed prices for all variants for a product on a price list. You can use the priceListFixedPricesByProductUpdate mutation to set or remove a fixed price for all variants of a product associated with the price list.

Arguments

ID!required

The price list to update the prices for.

[PriceListProductPriceInput!]

A list of PriceListProductPriceInput that identifies which products to update the fixed prices for.

Anchor to pricesToDeleteByProductIdspricesToDeleteByProductIds
[ID!]

A list of product IDs that identifies which products to remove the fixed prices for.


Fields

PriceList

The price list for which the fixed prices were modified.

[Product!]

The product for which the fixed prices were added.

Anchor to pricesToDeleteProductspricesToDeleteProducts
[Product!]

The product for which the fixed prices were deleted.

[PriceListFixedPricesByProductBulkUpdateUserError!]!non-null

The list of errors that occurred from executing the mutation.

mutation

Creates a product with attributes such as title, description, and vendor. You can use the productCreate mutation to define options and values for products with product variants, such as different sizes or colors.

To create multiple product variants for a single product and manage prices, use the productVariantsBulkCreate mutation.

To create or update a product in a single request, use the productSet mutation.

Learn more about the product model and adding product data.

Arguments

ProductInputDeprecated
[CreateMediaInput!]

The media to add to the product.

ProductCreateInput

The attributes of the new product.


Fields

Product

The product object.

Shop!non-null

The shop associated with the product.

[UserError!]!non-null

The list of errors that occurred from executing the mutation.

mutation

Duplicates a product.

If you need to duplicate a large product, such as one that has many variants that are active at several locations, you might encounter timeout errors.

To avoid these timeout errors, you can instead duplicate the product asynchronously.

In API version 2024-10 and higher, include synchronous: false argument in this mutation to perform the duplication asynchronously.

In API version 2024-07 and lower, use the asynchronous ProductDuplicateAsyncV2.

Metafield values are not duplicated if the unique values capability is enabled.

Arguments

BooleanDefault:false

Specifies whether or not to duplicate images.

BooleanDefault:false

Specifies whether or not to duplicate translations.

ProductStatus

The new status of the product. If no value is provided the status will be inherited from the original product.

String!required

The new title of the product.

ID!required

The ID of the product to be duplicated.

BooleanDefault:true

Specifies whether or not to run the mutation synchronously.


Fields

Job

The asynchronous job that duplicates the product images.

Product

The duplicated product.

Anchor to productDuplicateOperationproductDuplicateOperation
ProductDuplicateOperation

The product duplicate operation, returned when run in asynchronous mode.

Shop!non-null

The user's shop.

[UserError!]!non-null

The list of errors that occurred from executing the mutation.

mutation

Adds multiple selling plan groups to a product.

Arguments

ID!required

The ID of the product.

[ID!]!required

The IDs of the selling plan groups to add.


Fields

Product

The product object.

[SellingPlanGroupUserError!]!non-null

The list of errors that occurred from executing the mutation.

mutation

Removes multiple groups from a product.

Arguments

ID!required

The ID of the product.

[ID!]!required

The IDs of the selling plan groups to add.


Fields

Product

The product object.

[SellingPlanGroupUserError!]!non-null

The list of errors that occurred from executing the mutation.

mutation

Creates options on a product.

Arguments

[OptionCreateInput!]!required

Options to add to the product.

ID!required

The ID of the product to update.

ProductOptionCreateVariantStrategyDefault:LEAVE_AS_IS

The strategy defines which behavior the mutation should observe regarding variants. If not provided or set to null, the strategy LEAVE_AS_IS will be used.


Fields

Product

The updated product object.

[ProductOptionsCreateUserError!]!non-null

The list of errors that occurred from executing the mutation.

mutation

Deletes the specified options.

Arguments

[ID!]!required

IDs of the options to delete from the product.

ID!required

ID of the product from which to delete the options.

ProductOptionDeleteStrategyDefault:DEFAULT

The strategy defines which behavior the mutation should observe,such as how to handle a situation where deleting an option would result in duplicate variants.


Fields

[ID!]

IDs of the options deleted.

Product

The updated product object.

[ProductOptionsDeleteUserError!]!non-null

The list of errors that occurred from executing the mutation.

mutation

Reorders options and option values on a product, causing product variants to alter their position.

Options order take precedence over option values order. Depending on the existing product variants, some input orders might not be achieved.

Example: Existing product variants: ["Red / Small", "Green / Medium", "Blue / Small"].

New order: [ { name: "Size", values: [{ name: "Small" }, { name: "Medium" }], name: "Color", values: [{ name: "Green" }, { name: "Red" }, { name: "Blue" }] } ].

Description: Variants with "Green" value are expected to appear before variants with "Red" and "Blue" values. However, "Size" option appears before "Color".

Therefore, output will be: ["Small / "Red", "Small / Blue", "Medium / Green"].

Arguments

[OptionReorderInput!]!required

Options to reorder on the product.

ID!required

The ID of the product to update.


Fields

Product

The updated product object.

[ProductOptionsReorderUserError!]!non-null

The list of errors that occurred from executing the mutation.

mutation

Updates a product option.

Arguments

OptionUpdateInput!required

Option to update.

[OptionValueCreateInput!]

New option values to create.

Anchor to optionValuesToDeleteoptionValuesToDelete
[ID!]

IDs of the existing option values to delete.

Anchor to optionValuesToUpdateoptionValuesToUpdate
[OptionValueUpdateInput!]

Existing option values to update.

ID!required

The ID of the Product the Option belongs to.

ProductOptionUpdateVariantStrategy

The strategy defines which behavior the mutation should observe regarding variants, such as creating variants or deleting them in response to option values to add or to delete. If not provided or set to null, the strategy LEAVE_AS_IS will be used.


Fields

Product

The product with which the option being updated is associated.

[ProductOptionUpdateUserError!]!non-null

The list of errors that occurred from executing the mutation.

mutation

Creates or updates a product in a single request.

Use this mutation when syncing information from an external data source into Shopify.

When using this mutation to update a product, specify that product's id in the input.

Any list field (e.g. collections, metafields, variants) will be updated so that all included entries are either created or updated, and all existing entries not included will be deleted.

All other fields will be updated to the value passed. Omitted fields will not be updated.

When run in synchronous mode, you will get the product back in the response. For versions 2024-04 and earlier, the synchronous mode has an input limit of 100 variants. This limit has been removed for versions 2024-07 and later.

In asynchronous mode, you will instead get a ProductSetOperation object back. You can then use the productOperation query to retrieve the updated product data. This query uses the ProductSetOperation object to check the status of the operation and to retrieve the details of the updated product and its variants.

If you need to update a subset of variants, use one of the bulk variant mutations:

If you need to update options, use one of the product option mutations:

See our guide to sync product data from an external source for more.

Arguments

ProductSetIdentifiers

Specifies the identifier that will be used to lookup the resource.

ProductSetInput!required

The properties of the newly created or updated product.

BooleanDefault:true

Whether the mutation should be run synchronously or asynchronously.

If true, the mutation will return the updated product.

If false, the mutation will return a productSetOperation.

Defaults to true.

Setting synchronous: false may be desirable depending on the input complexity/size, and should be used if you are experiencing timeouts.

Note: When run in the context of a bulk operation, the mutation will always run synchronously and this argument will be ignored.


Fields

Product

The product object.

ProductSetOperation

The product set operation, returned when run in asynchronous mode.

[ProductSetUserError!]!non-null

The list of errors that occurred from executing the mutation.

mutation

Updates a product.

For versions 2024-01 and older: If you update a product and only include some variants in the update, then any variants not included will be deleted.

To safely manage variants without the risk of deleting excluded variants, use productVariantsBulkUpdate.

If you want to update a single variant, then use productVariantUpdate.

Arguments

ProductInputDeprecated
[CreateMediaInput!]

List of new media to be added to the product.

ProductUpdateInput

The updated properties for a product.


Fields

Product

The updated product object.

[UserError!]!non-null

The list of errors that occurred from executing the mutation.

mutation

Appends media from a product to variants of the product.

Arguments

ID!required

Specifies the product associated to the media.

[ProductVariantAppendMediaInput!]!required

A list of pairs of variants and media to be attached to the variants.


Fields

Product

The product associated with the variants and media.

[ProductVariant!]

The product variants that were updated.

[MediaUserError!]!non-null

The list of errors that occurred from executing the mutation.

mutation

Detaches media from product variants.

Arguments

ID!required

Specifies the product to which the variants and media are associated.

[ProductVariantDetachMediaInput!]!required

A list of pairs of variants and media to be deleted from the variants.


Fields

Product

The product associated with the variants and media.

[ProductVariant!]

The product variants that were updated.

[MediaUserError!]!non-null

The list of errors that occurred from executing the mutation.

mutation

Creates multiple variants in a single product. This mutation can be called directly or via the bulkOperation.

Arguments

[CreateMediaInput!]

List of new media to be added to the product.

ID!required

The ID of the product on which to create the variants.

ProductVariantsBulkCreateStrategyDefault:DEFAULT

The strategy defines which behavior the mutation should observe, such as whether to keep or delete the standalone variant (when product has only a single or default variant) when creating new variants in bulk.

[ProductVariantsBulkInput!]!required

An array of product variants to be created.


Fields

Product

The updated product object.

[ProductVariant!]

The newly created variants.

[ProductVariantsBulkCreateUserError!]!non-null

The list of errors that occurred from executing the mutation.

mutation

Deletes multiple variants in a single product. This mutation can be called directly or via the bulkOperation.

Arguments

ID!required

The ID of the product with the variants to update.

[ID!]!required

An array of product variants IDs to delete.


Fields

Product

The updated product object.

[ProductVariantsBulkDeleteUserError!]!non-null

The list of errors that occurred from executing the mutation.

mutation

Reorders multiple variants in a single product. This mutation can be called directly or via the bulkOperation.

Arguments

[ProductVariantPositionInput!]!required

An array of variant positions.

ID!required

The product ID of the variants to be reordered.


Fields

Product

The updated product.

[ProductVariantsBulkReorderUserError!]!non-null

The list of errors that occurred from executing the mutation.

mutation

Updates multiple variants in a single product. This mutation can be called directly or via the bulkOperation.

Arguments

BooleanDefault:false

When partial updates are allowed, valid variant changes may be persisted even if some of the variants updated have invalid data and cannot be persisted. When partial updates are not allowed, any error will prevent all variants from updating.

[CreateMediaInput!]

List of new media to be added to the product.

ID!required

The ID of the product associated with the variants to update.

[ProductVariantsBulkInput!]!required

An array of product variants to update.


Fields

Product

The updated product object.

[ProductVariant!]

The updated variants.

[ProductVariantsBulkUpdateUserError!]!non-null

The list of errors that occurred from executing the mutation.

Deprecated mutations


Was this section helpful?