collectionPublish mutation

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.

On this page

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.

mutation collectionPublish($input: CollectionPublishInput!) { collectionPublish(input: $input) { 
  1. <font style="color:#1F61A0;">collection</font> <font style="color:#555555;">{</font>
  3.   <font style="color:#1F61A0;">id</font>
  5. <font style="color:#555555;">}</font>
  7. <font style="color:#1F61A0;">collectionPublications</font> <font style="color:#555555;">{</font>
  9.   <font style="color:#1F61A0;">isPublished</font>
  11.   <font style="color:#1F61A0;">publishDate</font>
  13. <font style="color:#555555;">}</font>
  15. <font style="color:#1F61A0;">shop</font> <font style="color:#555555;">{</font>
  17.   <font style="color:#1F61A0;">id</font>
  19. <font style="color:#555555;">}</font>
  21. <font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  23.   <font style="color:#1F61A0;">field</font>
  25.   <font style="color:#1F61A0;">message</font>
  27. <font style="color:#555555;">}</font>
} } { “input”: { 
  1. <font style="color:#8B2BB9;">"id"</font><font style="color:#555555;">:</font> <font style="color:#D64292;">"Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="</font><font style="color:#555555;">,</font>
  3. <font style="color:#8B2BB9;">"collectionPublications"</font><font style="color:#555555;">:</font> <font style="color:#555555;">[</font>
  5.   <font style="color:#555555;">{}</font>
  7. <font style="color:#555555;">]</font>
} }

Arguments

Argument Description
input
(
[CollectionPublishInput!](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/collectionpublishinput)

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

CollectionPublishInput fields

  • collectionPublications ([[CollectionPublicationInput!]!](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/collectionpublicationinput)) REQUIRED
    The channels where the collection will be published.
  • id ([ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)) REQUIRED
    The collection to create or update publications for.

Return fields

  • collection ([Collection](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/collection))
    The published collection.
  • collectionPublications ([[CollectionPublication!]](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/collectionpublication))
    The channels where the collection has been published.
  • shop ([Shop!](https://shopify.dev/docs/admin-api/graphql/reference/store-properties/shop))
    The shop associated with the collection.
  • userErrors ([[UserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/usererror))
    List of errors that occurred executing the mutation.