CollectionInput

Specifies the input fields required to create a collection.

Show definition

# Specifies the input fields required to create a collection.
input CollectionInput {
  # The description of the collection, in HTML format.
  descriptionHtml: String

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

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

# The image associated with the collection. image: ImageInput

# Initial list of collection products. Only valid with productCreate and without rules. products: [ID!]

# Initial list of collection publications. Only valid with productCreate. This # argument is deprecated: Use PublishablePublish instead. publications: [CollectionPublicationInput!]

# The rules used to assign products to the collection. ruleSet: CollectionRuleSetInput

# The order in which the collection's products are sorted. sortOrder: CollectionSortOrder

# Required for creating a new collection. title: String

# SEO information for the collection. seo: SEOInput

# Indicates 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 }

Input Fields

descriptionHtml   (String)

The description of the collection, in HTML format.

handle   (String)

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

id   (ID)

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

image   (ImageInput)

The image associated with the collection.

products   ([ID!])

Initial list of collection products. Only valid with productCreate and without rules.

publications   ([CollectionPublicationInput!])

Initial list of collection publications. Only valid with productCreate. This argument is deprecated: Use PublishablePublish instead.

redirectNewHandle   (Boolean)

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

ruleSet   (CollectionRuleSetInput)

The rules used to assign products to the collection.

seo   (SEOInput)

SEO information for the collection.

sortOrder   (CollectionSortOrder)

The order in which the collection's products are sorted.

title   (String)

Required for creating a new collection.

Sign up for a Partner account to get started.

Sign up