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

1mutation catalogCreate($input: CatalogCreateInput!) {
2  catalogCreate(input: $input) {
3    catalog {
4      # Catalog fields
5    }
6    userErrors {
7      field
8      message
9    }
10  }
11}

Input

1{
2  "input": {
3    "context": {
4      "companyLocationIds": [
5        "gid://shopify/<objectName>/10079785100"
6      ]
7    },
8    "priceListId": "gid://shopify/<objectName>/10079785100",
9    "publicationId": "gid://shopify/<objectName>/10079785100",
10    "status": "",
11    "title": "<your-title>"
12  }
13}

{
  "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!]
}