collectionUnpublish
mutation
deprecated

Choose a version:

Requires write_publications access scope. Also: The user must have a permission to unpublish a collection.

Unpublishes a collection. Use publishableUnpublish instead.

Anchor to section titled 'Arguments'

Arguments

Anchor to input input CollectionUnpublishInput! required: Specify a collection to unpublish and the sales channels to remove it from.

Was this section helpful?

Anchor to section titled 'CollectionUnpublishPayload returns'

CollectionUnpublishPayload returns

Anchor to CollectionUnpublishPayload.collection collection Collection: The collection that has been unpublished.
Anchor to CollectionUnpublishPayload.shop shop Shop! non-null: The shop associated with the collection.
Anchor to CollectionUnpublishPayload.userErrors userErrors [UserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: collectionUnpublish

Query Reference for MUTATION: collectionUnpublish

"mutation collectionUnpublish($input: CollectionUnpublishInput!) {\n  collectionUnpublish(input: $input) {\n    collection {\n      # Collection fields\n    }\n    shop {\n      # Shop fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: collectionUnpublish

"{\n  \"input\": {\n    \"collectionPublications\": [\n      {\n        \"channelHandle\": \"<your-channelHandle>\",\n        \"channelId\": \"gid://shopify/<objectName>/10079785100\",\n        \"publicationId\": \"gid://shopify/<objectName>/10079785100\"\n      }\n    ],\n    \"id\": \"gid://shopify/<objectName>/10079785100\"\n  }\n}"

Schema Reference for MUTATION: collectionUnpublish

"input CollectionUnpublishInput {\n  collectionPublications: [CollectionPublicationInput!]!\n  id: ID!\n}\n\ninput CollectionPublicationInput {\n  channelHandle: String\n  channelId: ID\n  publicationId: ID\n}\n"

Display Examples for MUTATION: collectionUnpublish

[]

collectionUnpublishmutationdeprecated

Arguments

CollectionUnpublishPayload returns

collectionUnpublish
mutation
deprecated