Choose a version:

catalogCreate

mutation

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

Creates a new catalog.

Arguments

Anchor to inputinput •CatalogCreateInput!required: The properties of the new catalog.

Was this section helpful?

Anchor to CatalogCreatePayload returnsCatalogCreatePayload returns

Anchor to catalogcatalog •Catalog: The newly created catalog.
Anchor to userErrorsuserErrors •[CatalogUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Mutation Reference

mutation catalogCreate($input: CatalogCreateInput!) {

catalogCreate(input: $input) {

catalog {

# Catalog fields

}

userErrors {

field

message

}

Input

{

"input": {

"context": {

"companyLocationIds": [

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

]

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

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

"status": "",

"title": "<your-title>"

}

{
  "input": {
    "context": {
      "companyLocationIds": [
        "gid://shopify/<objectName>/10079785100"
      ]
    },
    "priceListId": "gid://shopify/<objectName>/10079785100",
    "publicationId": "gid://shopify/<objectName>/10079785100",
    "status": "",
    "title": "<your-title>"
  }
}

input CatalogCreateInput {
  context: CatalogContextInput!
  priceListId: ID
  publicationId: ID
  status: CatalogStatus!
  title: String!
}

input CatalogContextInput {
  companyLocationIds: [ID!]
}