WinShopAPI docs
ReferenceDocumentsExpeditionWrite offs

Check whether write-off items can be deleted

Advisory pre-flight for `DELETE {documentId}/items`. `blockingReasons` holds `ITEMS_BLOCKED` when at least one id in `itemIds` is still referenced elsewhere. At most 1000 ids per call. Requires `Permissions.WriteOffs.Delete`.

GET
/api/documents/expedition/write-offs/{documentId}/items/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

Query Parameters

itemIds?array<>

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/expedition/write-offs/0/items/check-delete' \  -H 'Authorization: Bearer <access-token>'
{  "blockingReasons": [    "string"  ],  "canBeDeleted": true}