Anchor to section titled 'undefined'

catalogDelete
mutation

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

Delete a catalog.

Anchor to section titled 'Arguments'

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 section titled 'CatalogDeletePayload returns'

CatalogDeletePayload returns

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?
Hide code
Mutation reference
Copy
mutation catalogDelete($id: ID!) {
  catalogDelete(id: $id) {
    deletedId
    userErrors {
      field
      message
    }
  }
}
Hide code
Input
Copy
{
  "deleteDependentResources": true,
  "id": "gid://shopify/<objectName>/10079785100"
}