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.

Refused while the description is still in use — by an attribute value, or by a cart or tender still holding a reference to it. There is no override: deleting it would destroy values on historical orders and leave open carts unable to check out. Remove what references it first.

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: The 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.
  • ATTRIBUTE_DESCRIPTION_USAGE_CHECK_FAILED: Usage could not be verified, so the delete was refused
  • 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.