catalogUpdate

mutation

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

Updates an existing catalog.

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?

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": {

"context": {

"companyLocationIds": [

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

"marketIds": [

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

]

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

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

"status": "ACTIVE",

"title": "<your-title>"

}

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

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

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