Anchor to catalogDeletecatalog
catalogDelete
mutation
Requires access scope. Also: The user must have permission to delete catalogs.
Delete a catalog.
Anchor to Arguments
Arguments
- Anchor to deleteDependentResourcesdelete•
Dependent Resources BooleanDefault:false Whether to also delete the price list and the publication owned by the catalog.
- •ID!required
The ID of the catalog to delete.
Was this section helpful?
Anchor to CatalogDeletePayload returnsCatalogDeletePayload returns
- Anchor to deletedIddeleted•
Id The ID of the deleted catalog.
- Anchor to userErrorsuser•
Errors [CatalogUser non-nullError!]! The list of errors that occurred from executing the mutation.
Was this section helpful?
Mutation Reference
mutation catalogDelete($deleteDependentResources: Boolean, $id: ID!) {
catalogDelete(deleteDependentResources: $deleteDependentResources, id: $id) {
deletedId
userErrors {
field
message
}
}
}
Input
{
"deleteDependentResources": true,
"id": "gid://shopify/<objectName>/10079785100"
}
{
"deleteDependentResources": true,
"id": "gid://shopify/<objectName>/10079785100"
}