ProductInput input object

Version 2020-01 (Release candidate)

Specifies the input fields required to create a 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).

privateMetafields ([PrivateMetafieldInput!])

The private metafields to associated with this 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.

Version 2019-10 (Latest)

Specifies the input fields required to create a 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).

privateMetafields ([PrivateMetafieldInput!])

The private metafields to associated with this 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.

Version 2019-07

Specifies the input fields required to create a 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.

Version 2019-04

Specifies the input fields required to create a 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.

Sign up for a Partner account to get started.

Sign up