catalogUpdate
mutation

Choose a version:

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

Updates an existing catalog.

Anchor to section titled 'Arguments'

Arguments

Anchor to id id ID! required: The ID of the catalog to update.
Anchor to input input CatalogUpdateInput! required: The properties of the updated catalog.

Was this section helpful?

Anchor to section titled 'CatalogUpdatePayload returns'

CatalogUpdatePayload returns

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

Was this section helpful?

Code examples for MUTATION: catalogUpdate

Query Reference for MUTATION: catalogUpdate

"mutation catalogUpdate($id: ID!, $input: CatalogUpdateInput!) {\n  catalogUpdate(id: $id, input: $input) {\n    catalog {\n      # Catalog fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: catalogUpdate

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

Schema Reference for MUTATION: catalogUpdate

"input CatalogUpdateInput {\n  context: CatalogContextInput\n  priceListId: ID\n  publicationId: ID\n  status: CatalogStatus\n  title: String\n}\n\ninput CatalogContextInput {\n  companyLocationIds: [ID!]\n}\n"

Display Examples for MUTATION: catalogUpdate

[]

catalogUpdatemutation

Arguments

CatalogUpdatePayload returns

catalogUpdate
mutation