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

collectionUnpublish mutation

Version unstable

Deprecation warning

Use publishableUnpublish instead

Unpublishes a collection.

Required access

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

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

CollectionUnpublishInput fields

collectionPublications ([CollectionPublicationInput!]!) Required

The channels where the collection is published.

id (ID!) Required

The collection to create or update publications for.

Return fields

collection (Collection)

The collection that has been unpublished.

shop (Shop!)

The shop associated with the collection.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2021-01 (Release candidate)

Deprecation warning

Use publishableUnpublish instead

Unpublishes a collection.

Required access

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

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

CollectionUnpublishInput fields

collectionPublications ([CollectionPublicationInput!]!) Required

The channels where the collection is published.

id (ID!) Required

The collection to create or update publications for.

Return fields

collection (Collection)

The collection that has been unpublished.

shop (Shop!)

The shop associated with the collection.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2020-10 (Latest)

Deprecation warning

Use publishableUnpublish instead

Unpublishes a collection.

Required access

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

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

CollectionUnpublishInput fields

collectionPublications ([CollectionPublicationInput!]!) Required

The channels where the collection is published.

id (ID!) Required

The collection to create or update publications for.

Return fields

collection (Collection)

The collection that has been unpublished.

shop (Shop!)

The shop associated with the collection.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2020-07

Deprecation warning

Use publishableUnpublish instead

Unpublishes a collection.

Required access

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

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

CollectionUnpublishInput fields

collectionPublications ([CollectionPublicationInput!]!) Required

The channels where the collection is published.

id (ID!) Required

The collection to create or update publications for.

Return fields

collection (Collection)

The collection that has been unpublished.

shop (Shop!)

The shop associated with the collection.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2020-04

Deprecation warning

Use publishableUnpublish instead

Unpublishes a collection.

Required access

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

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

CollectionUnpublishInput fields

collectionPublications ([CollectionPublicationInput!]!) Required

The channels where the collection is published.

id (ID!) Required

The collection to create or update publications for.

Return fields

collection (Collection)

The collection that has been unpublished.

shop (Shop!)

The shop associated with the collection.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2020-01

Deprecation warning

Use publishableUnpublish instead

Unpublishes a collection.

Required access

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

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

CollectionUnpublishInput fields

collectionPublications ([CollectionPublicationInput!]!) Required

The channels where the collection is published.

id (ID!) Required

The collection to create or update publications for.

Return fields

collection (Collection)

The collection that has been unpublished.

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 publishableUnpublish instead

Unpublishes a collection.

Required access

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

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

CollectionUnpublishInput fields

collectionPublications ([CollectionPublicationInput!]!) Required

The channels where the collection is published.

id (ID!) Required

The collection to create or update publications for.

Return fields

collection (Collection)

The collection that has been unpublished.

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 publishableUnpublish instead

Unpublishes a collection.

Required access

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

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

CollectionUnpublishInput fields

collectionPublications ([CollectionPublicationInput!]!) Required

The channels where the collection is published.

id (ID!) Required

The collection to create or update publications for.

Return fields

collection (Collection)

The collection that has been unpublished.

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 publishableUnpublish instead

Unpublishes a collection.

Required access

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

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

CollectionUnpublishInput fields

collectionPublications ([CollectionPublicationInput!]!) Required

The channels where the collection is published.

id (ID!) Required

The collection to create or update publications for.

Return fields

collection (Collection)

The collection that has been unpublished.

shop (Shop!)

The shop associated with the collection.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.