collectionUnpublish mutation

Deprecation warning

Use publishableUnpublish instead

Unpublishes a collection.

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 collectionUnpublish($input: CollectionUnpublishInput!) { collectionUnpublish(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;">shop</font> <font style="color:#555555;">{</font>
  9.   <font style="color:#1F61A0;">id</font>
  11. <font style="color:#555555;">}</font>
  13. <font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  15.   <font style="color:#1F61A0;">field</font>
  17.   <font style="color:#1F61A0;">message</font>
  19. <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
(
[CollectionUnpublishInput!](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/collectionunpublishinput)

) REQUIRED		 Specify a collection to unpublish and the sales channels to remove it from.

CollectionUnpublishInput fields

  • collectionPublications ([[CollectionPublicationInput!]!](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/collectionpublicationinput)) REQUIRED
    The channels where the collection is 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 collection that has been unpublished.
  • 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.