Anchor to section titled 'undefined'

publicationCreate
mutation

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

Creates a publication.

Anchor to section titled 'Arguments'

Arguments

Anchor to input
input
PublicationCreateInput!
required

The input fields to use when creating the publication.

Was this section helpful?
Anchor to section titled 'PublicationCreatePayload returns'

PublicationCreatePayload returns

Anchor to PublicationCreatePayload.publication
publication
Publication

The publication that's been created.

Anchor to PublicationCreatePayload.userErrors
userErrors
[PublicationUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?
Hide code
Mutation reference
Copy
mutation publicationCreate($input: PublicationCreateInput!) {
  publicationCreate(input: $input) {
    publication {
      # Publication fields
    }
    userErrors {
      field
      message
    }
  }
}
Hide code
Input
Copy
{
  "input": {
    "autoPublish": true,
    "catalogId": "gid://shopify/<objectName>/10079785100",
    "defaultState": "ALL_PRODUCTS"
  }
}
input PublicationCreateInput {
  autoPublish: Boolean
  catalogId: ID
  defaultState: PublicationCreateInputPublicationDefaultState
}