collectionPublish
mutation
deprecated

Choose a version:

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

Publishes a collection to a channel. Use publishablePublish instead.

Anchor to section titled 'Arguments'

Arguments

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

Was this section helpful?

Anchor to section titled 'CollectionPublishPayload returns'

CollectionPublishPayload returns

Anchor to CollectionPublishPayload.collection collection Collection: The published collection.
Anchor to CollectionPublishPayload.collectionPublications collectionPublications [CollectionPublication!]: The channels where the collection has been published.
Anchor to CollectionPublishPayload.shop shop Shop! non-null: The shop associated with the collection.
Anchor to CollectionPublishPayload.userErrors userErrors [UserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: collectionPublish

Query Reference for MUTATION: collectionPublish

"mutation collectionPublish($input: CollectionPublishInput!) {\n  collectionPublish(input: $input) {\n    collection {\n      # Collection fields\n    }\n    collectionPublications {\n      # CollectionPublication fields\n    }\n    shop {\n      # Shop fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: collectionPublish

"{\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: collectionPublish

"input CollectionPublishInput {\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: collectionPublish

[]

collectionPublishmutationdeprecated

Arguments

CollectionPublishPayload returns

collectionPublish
mutation
deprecated