Skip to main content

attributeDescriptionDeleteBulk

Bulk delete multiple attribute descriptions from the system in a single optimized operation.

Removes multiple attribute descriptions and all their associated configurations efficiently using a single database transaction. This is significantly more performant than calling attributeDescriptionDelete multiple times.

The response includes three fields:

  • deletedIds: IDs that were successfully deleted
  • failedIds: IDs that failed to delete (not found, still in use, or not verifiable)
  • failures: one entry per failed ID, in the same order, carrying the reason and — for an in-use description — the same usage breakdown the single delete returns with its 409

Performance: every ORDER or ORDER_ITEM description in the request is probed against cart and tender individually, and each probe scans that tenant's carts and tenders in full. Large batches of order-class descriptions can therefore be slow — split them across several requests if the call times out.

A description that is still in use, or whose usage could not be determined because cart or tender was unreachable, is reported in failedIds — the rest of the batch still succeeds. There is no override; an in-use description cannot be deleted through this API.

Read failures[].reason before offering a retry: ATTRIBUTE_DESCRIPTION_USAGE_CHECK_FAILED means nothing was touched and the request is worth repeating, while ATTRIBUTE_DESCRIPTION_IN_USE and ATTRIBUTE_DESCRIPTION_NOT_FOUND describe a state a repeat cannot change.

Possible errors:

  • FORBIDDEN: Insufficient permissions

AUTH: Role=[configuration.OWNER]

attributeDescriptionDeleteBulk(
ids: [String!]!
): AttributeDescriptionBulkDeleteResponse!

Arguments

attributeDescriptionDeleteBulk.ids ● [String!]! non-null scalar

Array of unique identifiers of attribute descriptions to delete.

Each must be a valid UUID format representing an existing attribute description in the system. Rejected with BAD_USER_INPUT otherwise, and for an empty list. Repeated IDs are collapsed, so an ID sent twice gets one verdict. Recommended maximum: 100 IDs per request for optimal performance — advisory, not enforced.

Type

AttributeDescriptionBulkDeleteResponse object