catalogCreate
mutation

Choose a version:

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?

Code examples for MUTATION: catalogCreate

Query Reference for MUTATION: catalogCreate

"mutation catalogCreate($input: CatalogCreateInput!) {\n  catalogCreate(input: $input) {\n    catalog {\n      # Catalog fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: catalogCreate

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

Schema Reference for MUTATION: catalogCreate

"input CatalogCreateInput {\n  context: CatalogContextInput!\n  priceListId: ID\n  publicationId: ID\n  status: CatalogStatus!\n  title: String!\n}\n\ninput CatalogContextInput {\n  companyLocationIds: [ID!]\n}\n"

Display Examples for MUTATION: catalogCreate

[]

catalogCreatemutation

Arguments

CatalogCreatePayload returns

catalogCreate
mutation