BizKitHub
DocsAPI ReferenceWorkflow/bff/workflow/group-delete
postWorkflowAdmin BFF

/bff/workflow/group-delete

Permanently deletes an order group. Allowed only when the group is not the default group, has already been deactivated (group-set-active = false) and contains at most 20 orders that are all cancelled (storno), unpaid and without invoices, payments, bank transactions, credit, shipments, complaints, subscriptions, stock movements, vouchers, files or child orders. Those orders are deleted together with the group (items, logs, status history). Customer contacts and organisation-wide statuses are kept. Otherwise the request fails with a message naming the blocking orders; keep such a group deactivated.

WorkflowpostBffWorkflowGroup-delete

Parameters

JSON body

Request body

application/json
codestringRequired

Code of the group to delete.

Exampleeshop

Response schema

1 status code documented

200Success
successbooleanRequired
Default: true
deletedOrderCountnumberRequired

Number of cancelled test orders deleted with the group.

Response example

application/json
{
  "success": true,
  "deletedOrderCount": 0
}

Request example

POST /bff/workflow/group-delete

post
curl -X POST "https://api.bizkithub.com/bff/workflow/group-delete" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "code": "eshop"
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key