Skip to main content
Log inSign up

Shopify uses cookies to provide necessary site functionality and improve your experience. By using our website, you agree to our privacy policy and our cookie policy.

input_object

The input fields for creating or updating a product.

•

The input field to enable an app to provide additional product features. For example, you can specify bundles: true in the claimOwnership field to let an app add a product configuration extension.

•

A list of collection IDs to associate with the product.

•

The collection IDs to disassociate from the product.

•

The custom product type that merchants define.

•

The description of the product, with HTML tags. For example, the description might include bold <strong></strong> and italic <i></i> text.

•

Whether the product is a gift card.

Anchor to giftCardTemplateSuffixgiftCardTemplateSuffix
•

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

•

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. For example, if a product is titled "Black Sunglasses", then the handle is black-sunglasses.

•

The product's ID.

If you're creating a product, then you don't need to pass the id as input to the productCreate mutation. If you're updating a product, then you do need to pass the id as input to the productUpdate mutation to identify which product you want to update.

•

The custom fields to associate with the product for the purposes of adding and storing additional information.

•

A list of product options and option values. Maximum product options: three. There's no limit on the number of option values. This input is supported only with the productCreate mutation.

•

The product type that merchants define.

•

Whether a redirect is required after a new handle has been provided. If true, then the old handle is redirected to the new one automatically.

•

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.

•

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

•

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

•

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.

•

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

•

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.

•

The name of the product's vendor.

Show
deprecated fields Deprecated
•
StringDeprecated

A description of the product. Supports HTML formatting. Use descriptionHtml instead.

•
[String!]Deprecated

List of custom product options (maximum of 3 per product). Deprecated as of 2024-04.

Use productOptions field instead.

•

The private metafields to associate with this product. Metafields created using a reserved namespace are private by default. See our guide for migrating private metafields.

•

The product category in the Shopify product taxonomy. Deprecated in API version 2024-07. Use category instead.

•

A list of the channels where the product is published. Use PublishablePublish instead.

•

A list of the channels where the product is published. Use PublishablePublish instead.

•
DateTimeDeprecated

Only products with an active status can be published. Use PublishablePublish instead.

•
BooleanDeprecated

Only products with an active status can be published. Use PublishablePublish instead.

•
DateTimeDeprecated

Only products with an active status can be published. Use PublishablePublish instead.

•
DateTimeDeprecated

Only products with an active status can be published. Use PublishablePublish instead.

Anchor to standardizedProductTypestandardizedProductType
•

The standardized product type in the Shopify product taxonomy. Deprecated in API version 2024-07. Use category instead.

•

A list of variants associated with the product. Deprecated as of 2024-04.

Use one of the product option mutations instead:

See our guide to the new product model for more.


Was this section helpful?