Anchor to section titled 'undefined'

collectionUnpublish
mutation
deprecated

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?
Hide code
Mutation reference
Copy
mutation collectionUnpublish($input: CollectionUnpublishInput!) {
  collectionUnpublish(input: $input) {
    collection {
      # Collection fields
    }
    shop {
      # Shop fields
    }
    userErrors {
      field
      message
    }
  }
}
Hide code
Input
Copy
{
  "input": {
    "collectionPublications": [
      {
        "channelHandle": "<your-channelHandle>",
        "channelId": "gid://shopify/<objectName>/10079785100",
        "publicationId": "gid://shopify/<objectName>/10079785100"
      }
    ],
    "id": "gid://shopify/<objectName>/10079785100"
  }
}
input CollectionUnpublishInput {
  collectionPublications: [CollectionPublicationInput!]!
  id: ID!
}

input CollectionPublicationInput {
  channelHandle: String
  channelId: ID
  publicationId: ID
}