catalogDelete
mutation

Choose a version:

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

Delete a catalog.

Arguments

Anchor to deleteDependentResources deleteDependentResources Boolean default:false: Whether to also delete the price list and the publication owned by the catalog.
Anchor to id id ID! required: The ID of the catalog to delete.

Was this section helpful?

Anchor to CatalogDeletePayload.deletedId deletedId ID: The ID of the deleted catalog.
Anchor to CatalogDeletePayload.userErrors userErrors [CatalogUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: catalogDelete

Query Reference for MUTATION: catalogDelete

"mutation catalogDelete($id: ID!) {\n  catalogDelete(id: $id) {\n    deletedId\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: catalogDelete

"{\n  \"deleteDependentResources\": true,\n  \"id\": \"gid://shopify/<objectName>/10079785100\"\n}"

Schema Reference for MUTATION: catalogDelete

""

Display Examples for MUTATION: catalogDelete

[]