Skip to main content

attributeDescriptionDelete

Permanently delete an attribute description from the system.

Removes the attribute description and all associated configuration. This action cannot be undone.

What happens next depends on the class.

ORDER and ORDER_ITEM descriptions are refused while still in use — by an attribute value recorded on a processed order, or by a cart or tender still holding a reference. There is no override: deleting one would destroy values on historical orders and leave open carts unable to check out. Remove what references it first. A description that should be retired but is still referenced by old orders needs archiving, not deletion.

Every other class (PRODUCT, CATEGORY, CLUSTER, COMPANY, CONTACT, CUSTOMER) is deleted outright, together with its attributes and the values they leave behind, in a single transaction and however many there are. Nothing outside this service can hold a reference to those, so there is nothing for a usage check to protect — and no usage check is performed.

Possible errors:

  • ATTRIBUTE_DESCRIPTION_NOT_FOUND: Attribute description with the specified ID does not exist
  • ATTRIBUTE_DESCRIPTION_DELETE: Failed to delete the attribute description
  • ATTRIBUTE_DESCRIPTION_IN_USE: An ORDER or ORDER_ITEM description is still referenced. Carries a per-source usage breakdown (usage.values, usage.carts, usage.tenders) so a client can show what is holding it. Never raised for any other class.
  • ATTRIBUTE_DESCRIPTION_USAGE_CHECK_FAILED: Usage of an ORDER or ORDER_ITEM description could not be verified, so the delete was refused. Never raised for any other class, which never contacts cart or tender.
  • FORBIDDEN: Insufficient permissions

AUTH: Role=[configuration.OWNER]

attributeDescriptionDelete(
  id: String!
): Boolean!

Arguments​

attributeDescriptionDelete.id ● String! non-null scalar​

Unique identifier of the attribute description to delete.

Must be a valid UUID format representing an existing attribute description in the system.

Type​

Boolean scalar​

The Boolean scalar type represents true or false.