Choose a version:

catalogUpdate

mutation

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

Updates an existing catalog's configuration. Catalogs control product publishing and pricing for specific contexts like markets or B2B company locations.

You can modify the catalog's title, status, and associated context. You can also update the PriceList that determines pricing adjustments or the Publication that controls which products customers see.

Anchor to Arguments

Arguments

Anchor to idid

•ID!

required

The ID of the catalog to update.

Anchor to inputinput

•CatalogUpdateInput!

required

The properties of the updated catalog.

Was this section helpful?

Anchor to CatalogUpdatePayload returnsCatalogUpdatePayload returns

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

Was this section helpful?

Examples

catalogUpdate reference

Mutation Reference

mutation catalogUpdate($id: ID!, $input: CatalogUpdateInput!) {

catalogUpdate(id: $id, input: $input) {

catalog {

# Catalog fields

}

userErrors {

field

message

}

Input

{

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

"input": {

"title": "<your-title>",

"status": "ACTIVE",

"context": {

"marketIds": [

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

"companyLocationIds": [

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

]

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

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

}

Variables

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

Schema

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

input CatalogContextInput {
  marketIds: [ID!]
  companyLocationIds: [ID!]
}