ProductInput

Anchor to categorycategory

•ID

The ID of the category that's associated with the product.

Anchor to claimOwnershipclaimOwnership

•ProductClaimOwnershipInput

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.

Show input fields

Anchor to collectionsToJoincollectionsToJoin

•[ID!]

A list of collection IDs to associate with the product.

Anchor to collectionsToLeavecollectionsToLeave

•[ID!]

The collection IDs to disassociate from the product.

Anchor to combinedListingRolecombinedListingRole

•CombinedListingsRole

The role of the product in a combined listing. You can specify this field only when you create a product.

Show enum values

Anchor to customProductTypecustomProductType

•String

The custom product type that merchants define.

Anchor to descriptionHtmldescriptionHtml

•String

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

Anchor to giftCardgiftCard

•Boolean

Whether the product is a gift card.

Anchor to giftCardTemplateSuffixgiftCardTemplateSuffix

•String

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

Anchor to handlehandle

•String

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.

Anchor to idid

•ID

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.

Anchor to metafieldsmetafields

•[MetafieldInput!]

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

Show input fields

Anchor to productOptionsproductOptions

•[OptionCreateInput!]

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.

Show input fields

Anchor to productTypeproductType

•String

The product type that merchants define.

Anchor to redirectNewHandleredirectNewHandle

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

Anchor to requiresSellingPlanrequiresSellingPlan

•Boolean

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 seoseo

•SEOInput

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

Show input fields

Anchor to statusstatus

•ProductStatus

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

Show enum values

Anchor to tagstags

•[String!]

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.

Anchor to templateSuffixtemplateSuffix

•String

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

Anchor to titletitle

•String

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.

Anchor to vendorvendor

•String

The name of the product's vendor.

Deprecated fields

Anchor to bodyHtmlbodyHtml

•StringDeprecated

Anchor to privateMetafieldsprivateMetafields

•[PrivateMetafieldInput!]Deprecated

Anchor to productCategoryproductCategory

•ProductCategoryInputDeprecated

Anchor to productPublicationsproductPublications

•[ProductPublicationInput!]Deprecated

Anchor to publicationspublications

•[ProductPublicationInput!]Deprecated

Anchor to publishDatepublishDate

•DateTimeDeprecated

Anchor to publishedpublished

•BooleanDeprecated

Anchor to publishedAtpublishedAt

•DateTimeDeprecated

Anchor to publishOnpublishOn

•DateTimeDeprecated

Anchor to standardizedProductTypestandardizedProductType

•StandardizedProductTypeInputDeprecated

Anchor to productCreate.inputproductCreate.input

•MUTATION

Anchor to productUpdate.inputproductUpdate.input

•MUTATION