Choose a version:

catalogContextUpdate

mutation

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

Modifies which contexts, like markets or B2B company locations, can access a Catalog. You can add or remove contexts to control where the catalog's products and prices are available.

Learn more about managing catalog contexts and managing B2B catalogs.

Anchor to Arguments

Arguments

Anchor to catalogIdcatalogId

•ID!

required

The ID of the catalog for which to update the context.

Anchor to contextsToAddcontextsToAdd

•CatalogContextInput

The contexts to add to the catalog.

Show input fields

Anchor to contextsToRemovecontextsToRemove

•CatalogContextInput

The contexts to remove from the catalog.

Show input fields

Was this section helpful?

Anchor to CatalogContextUpdatePayload returnsCatalogContextUpdatePayload returns

Anchor to catalogcatalog •Catalog: The updated catalog.

Show fields
Anchor to userErrorsuserErrors •[CatalogUserError!]! non-null: The list of errors that occurred from executing the mutation.

Show fields

Was this section helpful?

Examples

catalogContextUpdate reference

Mutation Reference

mutation catalogContextUpdate($catalogId: ID!, $contextsToAdd: CatalogContextInput, $contextsToRemove: CatalogContextInput) {

catalogContextUpdate(catalogId: $catalogId, contextsToAdd: $contextsToAdd, contextsToRemove: $contextsToRemove) {

catalog {

# Catalog fields

}

userErrors {

field

message

}

Input

{

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

"contextsToAdd": {

"companyLocationIds": [

"gid://shopify/CompanyLocation/10079785100"

"marketIds": [

"gid://shopify/Market/10079785100"

]

"contextsToRemove": {

"companyLocationIds": [

"gid://shopify/CompanyLocation/10079785100"

"marketIds": [

"gid://shopify/Market/10079785100"

]

}

Variables

{
  "catalogId": "gid://shopify/<objectName>/10079785100",
  "contextsToAdd": {
    "companyLocationIds": [
      "gid://shopify/CompanyLocation/10079785100"
    ],
    "marketIds": [
      "gid://shopify/Market/10079785100"
    ]
  },
  "contextsToRemove": {
    "companyLocationIds": [
      "gid://shopify/CompanyLocation/10079785100"
    ],
    "marketIds": [
      "gid://shopify/Market/10079785100"
    ]
  }
}

Schema

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