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

collectionPublish mutation

Version unstable

Deprecation warning

Use publishablePublish instead

Publishes a collection to a channel.

Required access

write_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

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

Specify a collection to publish and the sales channels to publish it to.

CollectionPublishInput fields

  • collectionPublications ([CollectionPublicationInput!]!) Required

    The channels where the collection will be published.

  • id (ID!) Required

    The collection to create or update publications for.

Return fields

  • collection (Collection)

    The published collection.

  • collectionPublications ([CollectionPublication!])

    The channels where the collection has been published.

  • shop (Shop!)

    The shop associated with the collection.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2021-04 (Release candidate)

Deprecation warning

Use publishablePublish instead

Publishes a collection to a channel.

Required access

write_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

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

Specify a collection to publish and the sales channels to publish it to.

CollectionPublishInput fields

  • collectionPublications ([CollectionPublicationInput!]!) Required

    The channels where the collection will be published.

  • id (ID!) Required

    The collection to create or update publications for.

Return fields

  • collection (Collection)

    The published collection.

  • collectionPublications ([CollectionPublication!])

    The channels where the collection has been published.

  • shop (Shop!)

    The shop associated with the collection.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2021-01 (Latest)

Deprecation warning

Use publishablePublish instead

Publishes a collection to a channel.

Required access

write_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

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

Specify a collection to publish and the sales channels to publish it to.

CollectionPublishInput fields

  • collectionPublications ([CollectionPublicationInput!]!) Required

    The channels where the collection will be published.

  • id (ID!) Required

    The collection to create or update publications for.

Return fields

  • collection (Collection)

    The published collection.

  • collectionPublications ([CollectionPublication!])

    The channels where the collection has been published.

  • shop (Shop!)

    The shop associated with the collection.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-10

Deprecation warning

Use publishablePublish instead

Publishes a collection to a channel.

Required access

write_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

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

Specify a collection to publish and the sales channels to publish it to.

CollectionPublishInput fields

  • collectionPublications ([CollectionPublicationInput!]!) Required

    The channels where the collection will be published.

  • id (ID!) Required

    The collection to create or update publications for.

Return fields

  • collection (Collection)

    The published collection.

  • collectionPublications ([CollectionPublication!])

    The channels where the collection has been published.

  • shop (Shop!)

    The shop associated with the collection.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-07

Deprecation warning

Use publishablePublish instead

Publishes a collection to a channel.

Required access

write_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

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

Specify a collection to publish and the sales channels to publish it to.

CollectionPublishInput fields

  • collectionPublications ([CollectionPublicationInput!]!) Required

    The channels where the collection will be published.

  • id (ID!) Required

    The collection to create or update publications for.

Return fields

  • collection (Collection)

    The published collection.

  • collectionPublications ([CollectionPublication!])

    The channels where the collection has been published.

  • shop (Shop!)

    The shop associated with the collection.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-04

Deprecation warning

Use publishablePublish instead

Publishes a collection to a channel.

Required access

write_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

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

Specify a collection to publish and the sales channels to publish it to.

CollectionPublishInput fields

  • collectionPublications ([CollectionPublicationInput!]!) Required

    The channels where the collection will be published.

  • id (ID!) Required

    The collection to create or update publications for.

Return fields

  • collection (Collection)

    The published collection.

  • collectionPublications ([CollectionPublication!])

    The channels where the collection has been published.

  • shop (Shop!)

    The shop associated with the collection.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-01 (Unsupported)

Deprecation warning

Use publishablePublish instead

Publishes a collection to a channel.

Required access

write_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

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

Specify a collection to publish and the sales channels to publish it to.

CollectionPublishInput fields

  • collectionPublications ([CollectionPublicationInput!]!) Required

    The channels where the collection will be published.

  • id (ID!) Required

    The collection to create or update publications for.

Return fields

  • collection (Collection)

    The published collection.

  • collectionPublications ([CollectionPublication!])

    The channels where the collection has been published.

  • shop (Shop!)

    The shop associated with the collection.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2019-10 (Unsupported)

Deprecation warning

Use publishablePublish instead

Publishes a collection to a channel.

Required access

write_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

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

Specify a collection to publish and the sales channels to publish it to.

CollectionPublishInput fields

  • collectionPublications ([CollectionPublicationInput!]!) Required

    The channels where the collection will be published.

  • id (ID!) Required

    The collection to create or update publications for.

Return fields

  • collection (Collection)

    The published collection.

  • collectionPublications ([CollectionPublication!])

    The channels where the collection has been published.

  • shop (Shop!)

    The shop associated with the collection.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2019-07 (Unsupported)

Deprecation warning

Use publishablePublish instead

Publishes a collection to a channel.

Required access

write_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

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

Specify a collection to publish and the sales channels to publish it to.

CollectionPublishInput fields

  • collectionPublications ([CollectionPublicationInput!]!) Required

    The channels where the collection will be published.

  • id (ID!) Required

    The collection to create or update publications for.

Return fields

  • collection (Collection)

    The published collection.

  • collectionPublications ([CollectionPublication!])

    The channels where the collection has been published.

  • shop (Shop!)

    The shop associated with the collection.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2019-04 (Unsupported)

Deprecation warning

Use publishablePublish instead

Publishes a collection to a channel.

Required access

write_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

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

Specify a collection to publish and the sales channels to publish it to.

CollectionPublishInput fields

  • collectionPublications ([CollectionPublicationInput!]!) Required

    The channels where the collection will be published.

  • id (ID!) Required

    The collection to create or update publications for.

Return fields

  • collection (Collection)

    The published collection.

  • collectionPublications ([CollectionPublication!])

    The channels where the collection has been published.

  • shop (Shop!)

    The shop associated with the collection.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.