API version: unstable
API version: 2021-04 Release candidate
API version: 2021-01 Latest
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

collectionUpdate mutation

Version unstable

Updates 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

Argument Description
input ( CollectionInput! ) required

The updated properties for the collection.

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

  • privateMetafields ([PrivateMetafieldInput!])

    The private metafields to associated with this product.

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

  • job (Job)

    The asynchronous job updating the products based on the new rule set.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2021-04 (Release candidate)

Updates 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

Argument Description
input ( CollectionInput! ) required

The updated properties for the collection.

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

  • privateMetafields ([PrivateMetafieldInput!])

    The private metafields to associated with this product.

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

  • job (Job)

    The asynchronous job updating the products based on the new rule set.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2021-01 (Latest)

Updates 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

Argument Description
input ( CollectionInput! ) required

The updated properties for the collection.

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

  • privateMetafields ([PrivateMetafieldInput!])

    The private metafields to associated with this product.

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

  • job (Job)

    The asynchronous job updating the products based on the new rule set.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-10

Updates 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

Argument Description
input ( CollectionInput! ) required

The updated properties for the collection.

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

  • privateMetafields ([PrivateMetafieldInput!])

    The private metafields to associated with this product.

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

  • job (Job)

    The asynchronous job updating the products based on the new rule set.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-07

Updates 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

Argument Description
input ( CollectionInput! ) required

The updated properties for the collection.

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

  • privateMetafields ([PrivateMetafieldInput!])

    The private metafields to associated with this product.

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

  • job (Job)

    The asynchronous job updating the products based on the new rule set.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-04

Updates 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

Argument Description
input ( CollectionInput! ) required

The updated properties for the collection.

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

  • privateMetafields ([PrivateMetafieldInput!])

    The private metafields to associated with this product.

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

  • job (Job)

    The asynchronous job updating the products based on the new rule set.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-01 (Unsupported)

Updates 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

Argument Description
input ( CollectionInput! ) required

The updated properties for the collection.

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

  • privateMetafields ([PrivateMetafieldInput!])

    The private metafields to associated with this product.

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

  • job (Job)

    The asynchronous job updating the products based on the new rule set.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2019-10 (Unsupported)

Updates 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

Argument Description
input ( CollectionInput! ) required

The updated properties for the collection.

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

  • privateMetafields ([PrivateMetafieldInput!])

    The private metafields to associated with this product.

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

  • job (Job)

    The asynchronous job updating the products based on the new rule set.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2019-07 (Unsupported)

Updates 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

Argument Description
input ( CollectionInput! ) required

The updated properties for the collection.

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

  • privateMetafields ([PrivateMetafieldInput!])

    The private metafields to associated with this product.

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

  • job (Job)

    The asynchronous job updating the products based on the new rule set.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2019-04 (Unsupported)

Updates 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

Argument Description
input ( CollectionInput! ) required

The updated properties for the collection.

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

  • privateMetafields ([PrivateMetafieldInput!])

    The private metafields to associated with this product.

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

  • job (Job)

    The asynchronous job updating the products based on the new rule set.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.