Skip to content

Delete Catalog Rule

Deletes a catalog rule — the Delete row action on the admin Marketing → Promotions → Catalog Rules screen. Removing a rule recomputes affected product prices in the background.

TIP

New here? Read the Catalog Rules overview for what a catalog rule does and how its fields behave.

Operation

OperationTypePurpose
deleteAdminMarketingCatalogRuleMutationDelete a catalog rule

Details

  • Requires an admin Bearer token and the marketing.promotions.catalog_rules.delete permission.
  • Pass the rule's IRI as id. Use the list query to discover valid ids.

Returns the deleted rule + a message

The delete mutation returns a snapshot of the just-deleted rule — select id, _id, name, and the other scalar fields to confirm exactly what was removed. The message field carries the success confirmation ("Catalog rule deleted successfully."). A response with no errors[] means the delete succeeded. The channels / customerGroups connections come back empty on a delete result (the rule's rows are already gone) — read those from the detail query before deleting if you need them. The REST endpoint (DELETE /api/admin/marketing/catalog-rules/{id}) returns { "message": "Catalog rule deleted successfully." }.

Input fields

FieldTypeRequiredNotes
idIDYesThe rule's IRI

Released under the MIT License.