Choose a version:

collectionUnpublish

mutation

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

Deprecated. Use publishableUnpublish instead.

Unpublishes a collection.

Arguments

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

Was this section helpful?

Anchor to CollectionUnpublishPayload returnsCollectionUnpublishPayload returns

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

Was this section helpful?

Mutation Reference

mutation collectionUnpublish($input: CollectionUnpublishInput!) {

collectionUnpublish(input: $input) {

collection {

# Collection fields

}

shop {

# Shop fields

}

userErrors {

field

message

}

Input

{

"input": {

"collectionPublications": [

{

"publicationId": "gid://shopify/<objectName>/10079785100"

}

"id": "gid://shopify/<objectName>/10079785100"

}

{
  "input": {
    "collectionPublications": [
      {
        "publicationId": "gid://shopify/<objectName>/10079785100"
      }
    ],
    "id": "gid://shopify/<objectName>/10079785100"
  }
}

input CollectionUnpublishInput {
  collectionPublications: [CollectionPublicationInput!]!
  id: ID!
}

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