catalogContextUpdate

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.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the catalogContextUpdate action (under Catalog).
Fill in the fields below, then reference the result from later steps as {{catalogcontextupdate.response.data}}.

Query

This is the mutation the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

mutation CatalogContextUpdate($catalogId: ID!, $contextsToAdd: CatalogContextInput, $contextsToRemove: CatalogContextInput) {
  catalogContextUpdate(
    catalogId: $catalogId
    contextsToAdd: $contextsToAdd
    contextsToRemove: $contextsToRemove
  ) {
    catalog {
      id
      operations {
        id
        processedRowCount
        rowCount
        status
      }
      priceList {
        catalog
        currency
        fixedPricesCount
        id
        name
        parent
      }
      publication {
        app
        autoPublish
        catalog
        id
        name
        operation
        supportsFuturePublishing
      }
      status
      title
    }
    userErrors {
      code
      field
      message
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

catalogIdstringrequired

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

contextsToAddobject

The contexts to add to the catalog.

marketIdsarray<string>

companyLocationIdsarray<string>

contextsToRemoveobject

The contexts to remove from the catalog.

marketIdsarray<string>

companyLocationIdsarray<string>

json

{
  "catalogId": "string",
  "contextsToAdd": {
    "marketIds": [
      "string"
    ],
    "companyLocationIds": [
      "string"
    ]
  },
  "contextsToRemove": {
    "marketIds": [
      "string"
    ],
    "companyLocationIds": [
      "string"
    ]
  }
}

Response

Read the result with {{catalogcontextupdate.response.data.data.catalogContextUpdate}}. If the API returns errors, the step fails and they are at {{catalogcontextupdate.response.data.errors}}.

catalogobject

idstring

operationsarray<object>

priceListobject6 fields

publicationobject7 fields

statusstring

One ofACTIVEARCHIVEDDRAFT

titlestring

userErrorsarray<object>

codeobject

fieldobject

messageobject

Need more? See the Shopify guide for connection setup and behaviour shared by every action.

Was this page helpful?