We're constantly trying to improve your support experience, and your feedback is extremely valuable to us.

Please take a moment to tell us about your experience today.
Sign up for future Help Center user research studies.

productCreate

Version 2019-04

Creates a product.

Required access

write_products access scope

Interactive Example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

input ( ProductInput! ) required

The properties of the new product.

Input Fields

bodyHtml (String)

A description of the product. Supports HTML formatting. This argument is deprecated: Use descriptionHtml instead.

collectionsToJoin ([ID!])

The IDs of the collections that this product will be added to.

collectionsToLeave ([ID!])

The IDs of collections that will no longer include the product.

descriptionHtml (String)

The description of the product, complete with HTML formatting.

giftCard (Boolean)

Whether the product is a gift card.

giftCardTemplateSuffix (String)

The theme template used when viewing the gift card in a store.

handle (String)

A unique human-friendly string for the product. Automatically generated from the product's title.

id (ID)

Specifies the product to update or create a new product if absent.

images ([ImageInput!])

The images to associate with the product.

metafields ([MetafieldInput!])

The metafields to associate with this product.

options ([String!])

List of custom product options (maximum of 3 per product).

productPublications ([ProductPublicationInput!])

A list of the channels where the product is published. This argument is deprecated: Use PublishablePublish instead.

productType (String)

The product type specified by the merchant.

publications ([ProductPublicationInput!])

A list of the channels where the product is published. This argument is deprecated: Use PublishablePublish instead.

publishDate (DateTime)

This argument is deprecated: Use PublishablePublish instead.

publishOn (DateTime)

This argument is deprecated: Use PublishablePublish instead.

published (Boolean)

This argument is deprecated: Use PublishablePublish instead.

publishedAt (DateTime)

This argument is deprecated: Use PublishablePublish instead.

redirectNewHandle (Boolean)

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.

seo (SEOInput)

The SEO information associated with the product.

tags ([String!])

A list of the tags that have been added to the product.

templateSuffix (String)

The theme template used when viewing the product in a store.

title (String)

The title of the product.

variants ([ProductVariantInput!])

A list of variants associated with the product.

vendor (String)

The name of the product's vendor.

Return Fields

product (Product)

The product object.

shop (Shop!)

The shop associated with the product.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-07 (Latest)

Creates a product.

Required access

write_products access scope

Interactive Example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

input ( ProductInput! ) required

The properties of the new product.

Input Fields

bodyHtml (String)

A description of the product. Supports HTML formatting. This argument is deprecated: Use descriptionHtml instead.

collectionsToJoin ([ID!])

The IDs of the collections that this product will be added to.

collectionsToLeave ([ID!])

The IDs of collections that will no longer include the product.

descriptionHtml (String)

The description of the product, complete with HTML formatting.

giftCard (Boolean)

Whether the product is a gift card.

giftCardTemplateSuffix (String)

The theme template used when viewing the gift card in a store.

handle (String)

A unique human-friendly string for the product. Automatically generated from the product's title.

id (ID)

Specifies the product to update or create a new product if absent.

images ([ImageInput!])

The images to associate with the product.

metafields ([MetafieldInput!])

The metafields to associate with this product.

options ([String!])

List of custom product options (maximum of 3 per product).

productPublications ([ProductPublicationInput!])

A list of the channels where the product is published. This argument is deprecated: Use PublishablePublish instead.

productType (String)

The product type specified by the merchant.

publications ([ProductPublicationInput!])

A list of the channels where the product is published. This argument is deprecated: Use PublishablePublish instead.

publishDate (DateTime)

This argument is deprecated: Use PublishablePublish instead.

publishOn (DateTime)

This argument is deprecated: Use PublishablePublish instead.

published (Boolean)

This argument is deprecated: Use PublishablePublish instead.

publishedAt (DateTime)

This argument is deprecated: Use PublishablePublish instead.

redirectNewHandle (Boolean)

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.

seo (SEOInput)

The SEO information associated with the product.

tags ([String!])

A list of the tags that have been added to the product.

templateSuffix (String)

The theme template used when viewing the product in a store.

title (String)

The title of the product.

variants ([ProductVariantInput!])

A list of variants associated with the product.

vendor (String)

The name of the product's vendor.

Return Fields

product (Product)

The product object.

shop (Shop!)

The shop associated with the product.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-10 (Release candidate)

Creates a product.

Required access

write_products access scope

Interactive Example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

input ( ProductInput! ) required

The properties of the new product.

Input Fields

bodyHtml (String)

A description of the product. Supports HTML formatting. This argument is deprecated: Use descriptionHtml instead.

collectionsToJoin ([ID!])

The IDs of the collections that this product will be added to.

collectionsToLeave ([ID!])

The IDs of collections that will no longer include the product.

descriptionHtml (String)

The description of the product, complete with HTML formatting.

giftCard (Boolean)

Whether the product is a gift card.

giftCardTemplateSuffix (String)

The theme template used when viewing the gift card in a store.

handle (String)

A unique human-friendly string for the product. Automatically generated from the product's title.

id (ID)

Specifies the product to update or create a new product if absent.

images ([ImageInput!])

The images to associate with the product.

metafields ([MetafieldInput!])

The metafields to associate with this product.

options ([String!])

List of custom product options (maximum of 3 per product).

productPublications ([ProductPublicationInput!])

A list of the channels where the product is published. This argument is deprecated: Use PublishablePublish instead.

productType (String)

The product type specified by the merchant.

publications ([ProductPublicationInput!])

A list of the channels where the product is published. This argument is deprecated: Use PublishablePublish instead.

publishDate (DateTime)

This argument is deprecated: Use PublishablePublish instead.

publishOn (DateTime)

This argument is deprecated: Use PublishablePublish instead.

published (Boolean)

This argument is deprecated: Use PublishablePublish instead.

publishedAt (DateTime)

This argument is deprecated: Use PublishablePublish instead.

redirectNewHandle (Boolean)

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.

seo (SEOInput)

The SEO information associated with the product.

tags ([String!])

A list of the tags that have been added to the product.

templateSuffix (String)

The theme template used when viewing the product in a store.

title (String)

The title of the product.

variants ([ProductVariantInput!])

A list of variants associated with the product.

vendor (String)

The name of the product's vendor.

Return Fields

product (Product)

The product object.

shop (Shop!)

The shop associated with the product.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Sign up for a Partner account to get started.

Sign up