ProductInput

Specifies the input fields required to create a product.

Show definition

# Specifies the input fields required to create a product.
input ProductInput {
  # A description of the product. Supports HTML formatting. This argument is deprecated: Use descriptionHtml instead.
  bodyHtml: String

# The IDs of the collections that this product will be added to. collectionsToJoin: [ID!]

# The IDs of collections that will no longer include the product. collectionsToLeave: [ID!]

# The description of the product, complete with HTML formatting. descriptionHtml: String

# Whether the product is a gift card. giftCard: Boolean

# The theme template used when viewing the gift card in a store. giftCardTemplateSuffix: String

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

# Specifies the product to update or create a new product if absent. id: ID

# The images to associate with the product. images: [ImageInput!]

# The metafields to associate with this product. metafields: [MetafieldInput!]

# List of custom product options (maximum of 3 per product). options: [String!]

# A list of the channels where the product is published. This argument is deprecated: Use PublishablePublish instead. productPublications: [ProductPublicationInput!]

# The product type specified by the merchant. productType: String

# A list of the channels where the product is published. This argument is deprecated: Use PublishablePublish instead. publications: [ProductPublicationInput!]

# 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

# 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. redirectNewHandle: Boolean = false

# The SEO information associated with the product. seo: SEOInput

# A list of the tags that have been added to the product. tags: [String!]

# The theme template used when viewing the product in a store. templateSuffix: String

# The title of the product. title: String

# A list of variants associated with the product. variants: [ProductVariantInput!]

# The name of the product's vendor. vendor: String }

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