Choose a version:

collectionPublish

mutation

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

Deprecated. Use publishablePublish instead.

Publishes a collection to a channel.

Arguments

Anchor to inputinput • CollectionPublishInput!required: Specify a collection to publish and the sales channels to publish it to.

Was this section helpful?

Anchor to CollectionPublishPayload returnsCollectionPublishPayload returns

Anchor to collectioncollection • Collection: The published collection.
Anchor to collectionPublicationscollectionPublications • [CollectionPublication!]: The channels where the collection has been published.
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 collectionPublish($input: CollectionPublishInput!) {

collectionPublish(input: $input) {

collection {

# Collection fields

}

collectionPublications {

# CollectionPublication fields

}

shop {

# Shop fields

}

userErrors {

field

message

}

Input

{

"input": {

"collectionPublications": [

{

"channelHandle": "<your-channelHandle>",

"channelId": "gid://shopify/<objectName>/10079785100",

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

}

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

}

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

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

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