collectionCreate

Version 2019-04

Creates a collection.

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 ( CollectionInput! ) required

The properties to use when creating the collection.

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.

templateSuffix (String)

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

title (String)

Required for creating a new collection.

Return Fields

collection (Collection)

The collection that has been created.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-07 (Latest)

Creates a collection.

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 ( CollectionInput! ) required

The properties to use when creating the collection.

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.

metafields ([MetafieldInput!])

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

templateSuffix (String)

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

title (String)

Required for creating a new collection.

Return Fields

collection (Collection)

The collection that has been created.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-10 (Release candidate)

Creates a collection.

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 ( CollectionInput! ) required

The properties to use when creating the collection.

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.

metafields ([MetafieldInput!])

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

templateSuffix (String)

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

title (String)

Required for creating a new collection.

Return Fields

collection (Collection)

The collection that has been created.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Sign up for a Partner account to get started.

Sign up