Anchor to section titled 'undefined'

catalogCreate
mutation

Requires write_products access scope. Also: The user must have a permission to create a catalog.

Creates a new catalog.

Anchor to section titled 'Arguments'

Arguments

Anchor to input
input
CatalogCreateInput!
required

The properties of the new catalog.

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

CatalogCreatePayload returns

Anchor to CatalogCreatePayload.catalog
catalog
Catalog

The newly created catalog.

Anchor to CatalogCreatePayload.userErrors
userErrors
[CatalogUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?
Hide code
Mutation reference
Copy
mutation catalogCreate($input: CatalogCreateInput!) {
  catalogCreate(input: $input) {
    catalog {
      # Catalog fields
    }
    userErrors {
      field
      message
    }
  }
}
Hide code
Input
Copy
{
  "input": {
    "context": {
      "companyLocationIds": [
        "gid://shopify/<objectName>/10079785100"
      ]
    },
    "priceListId": "gid://shopify/<objectName>/10079785100",
    "publicationId": "gid://shopify/<objectName>/10079785100",
    "status": "ACTIVE",
    "title": "<your-title>"
  }
}
input CatalogCreateInput {
  context: CatalogContextInput!
  priceListId: ID
  publicationId: ID
  status: CatalogStatus!
  title: String!
}

input CatalogContextInput {
  companyLocationIds: [ID!]
}