catalogDelete

mutation

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

Delete a catalog.

Arguments

Anchor to deleteDependentResourcesdeleteDependentResources • BooleanDefault:false: Whether to also delete the price list and the publication owned by the catalog.
Anchor to idid • ID!required: The ID of the catalog to delete.

Was this section helpful?

Anchor to CatalogDeletePayload returnsCatalogDeletePayload returns

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

Was this section helpful?

Mutation Reference

1mutation catalogDelete($deleteDependentResources: Boolean, $id: ID!) {
2  catalogDelete(deleteDependentResources: $deleteDependentResources, id: $id) {
3    deletedId
4    userErrors {
5      field
6      message
7    }
8  }
9}

Input

1{
2  "deleteDependentResources": true,
3  "id": "gid://shopify/<objectName>/10079785100"
4}

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