Skip to main content

Permanently delete an attribute description from the system

DELETE 

/v2/attribute-descriptions/:lookupKey/:lookupValue

Remove an attribute description and all its configuration permanently from the system.

This operation will delete the attribute description schema including all metadata and configuration settings. This is a destructive operation that cannot be undone.

What happens depends on the class:

  • ORDER and ORDER_ITEM are refused with a 409 while anything still references them — an attribute value recorded on a processed order, or a live reference held by a cart or a tender. There is no override. Remove the references first, or archive the description rather than deleting it.
  • Every other class (PRODUCT, CATEGORY, CLUSTER, COMPANY, CONTACT, CUSTOMER) is deleted outright. No usage check runs at all, and cart and tender are never contacted, because neither can hold a reference to a non-order class.

Warning: for a non-order class this destroys every attribute built on the description, and the values those attributes hold, in the same transaction — however many there are and with no confirmation step. Check what depends on the description before calling this.

The deletion process:

  • Removes the attribute description record completely
  • Cascades to its attributes and sweeps the attribute values they leave orphaned
  • Cleans up associated metadata and configuration
  • Maintains system integrity and consistency
  • Cannot be reversed once completed

Request​

Responses​

Successfully deleted the attribute description