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

1mutation catalogUpdate($id: ID!, $input: CatalogUpdateInput!) {
2  catalogUpdate(id: $id, input: $input) {
3    catalog {
4      # Catalog fields
5    }
6    userErrors {
7      field
8      message
9    }
10  }
11}

Input

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

{
  "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": "",
    "title": "<your-title>"
  }
}

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

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