catalogContextUpdate
mutation

Choose a version:

Requires write_products access scope. Also: The user must have a permission to update a catalog.

Updates the context of a catalog.

Anchor to section titled 'Arguments'

Arguments

Anchor to catalogId catalogId ID! required: The ID of the catalog for which to update the context.
Anchor to contextsToAdd contextsToAdd CatalogContextInput: The contexts to add to the catalog.
Anchor to contextsToRemove contextsToRemove CatalogContextInput: The contexts to remove from the catalog.

Was this section helpful?

Anchor to section titled 'CatalogContextUpdatePayload returns'

CatalogContextUpdatePayload returns

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

Was this section helpful?

Code examples for MUTATION: catalogContextUpdate

Query Reference for MUTATION: catalogContextUpdate

"mutation catalogContextUpdate($catalogId: ID!) {\n  catalogContextUpdate(catalogId: $catalogId) {\n    catalog {\n      # Catalog fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: catalogContextUpdate

"{\n  \"catalogId\": \"gid://shopify/<objectName>/10079785100\",\n  \"contextsToAdd\": {\n    \"companyLocationIds\": [\n      \"gid://shopify/<objectName>/10079785100\"\n    ]\n  },\n  \"contextsToRemove\": {\n    \"companyLocationIds\": [\n      \"gid://shopify/<objectName>/10079785100\"\n    ]\n  }\n}"

Schema Reference for MUTATION: catalogContextUpdate

"input CatalogContextInput {\n  companyLocationIds: [ID!]\n}\n"

Display Examples for MUTATION: catalogContextUpdate

[]

catalogContextUpdatemutation

Arguments

CatalogContextUpdatePayload returns

catalogContextUpdate
mutation