WinShopAPI docs
ReferenceDocumentsOrdersCustomers

Check whether a customer order can be deleted

Advisory pre-flight for `DELETE {documentId}`. `canBeDeleted` is false when `blockingReasons` holds `HEADER_BLOCKED` or `ITEMS_BLOCKED`. The delete re-checks inside its own transaction, so a positive answer here is an indication rather than a guarantee. Requires `Permissions.OrderCustomer.Delete`.

GET
/api/documents/orders/customer/{documentId}/check-delete

Authorization

Bearer
headerAuthorizationBearer <token>

OAuth 2.0 client credentials. Obtain a client id/secret from Winshop support ([email protected]), then POST to the token URL.

Path Parameters

documentId*integer
Formatint32

Response Body

application/json
  1. response
blockingReasons*array<string>

Stable reason codes, see DocumentDeleteBlockingReasons. Empty when the delete is allowed.

canBeDeleted*boolean

True when nothing currently blocks the delete. The delete re-checks in its own transaction, so this is an indication rather than a guarantee.

curl -X GET 'https://<your-instance>/api/documents/orders/customer/0/check-delete' \  -H 'Authorization: Bearer <access-token>'
{  "blockingReasons": [    "string"  ],  "canBeDeleted": true}