Choose a version:

publicationCreate

mutation

Requires write_publications access scope. Also: The user must have a permission to create and edit catalogs.

Creates a Publication that controls which Product and Collection customers can access through a Catalog.

You can create an empty publication and add products later, or prepopulate it with all existing products. The autoPublish field determines whether the publication automatically adds newly created products.

Anchor to Arguments

Arguments

Anchor to inputinput

•PublicationCreateInput!

required

The input fields to use when creating the publication.

Was this section helpful?

Anchor to PublicationCreatePayload returnsPublicationCreatePayload returns

Anchor to publicationpublication •Publication: The publication that's been created.
Anchor to userErrorsuserErrors •[PublicationUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

publicationCreate reference

Mutation Reference

mutation publicationCreate($input: PublicationCreateInput!) {

publicationCreate(input: $input) {

publication {

# Publication fields

}

userErrors {

field

message

}

Input

{

"input": {

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

"defaultState": "EMPTY",

"autoPublish": true

}

Variables

{
  "input": {
    "catalogId": "gid://shopify/<objectName>/10079785100",
    "defaultState": "EMPTY",
    "autoPublish": true
  }
}

Schema

input PublicationCreateInput {
  catalogId: ID
  defaultState: PublicationCreateInputPublicationDefaultState
  autoPublish: Boolean
}