Check whether a customer claim 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.ClaimCustomer.Delete`.
BearerAuthorizationBearer <token>OAuth 2.0 client credentials. Obtain a client id/secret from Winshop support ([email protected]), then POST to the token URL.
documentId*integerint32application/json- response
blockingReasons*array<string>Stable reason codes, see DocumentDeleteBlockingReasons. Empty when the delete is allowed.
canBeDeleted*booleanTrue 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/claims/customer/0/check-delete' \ -H 'Authorization: Bearer <access-token>'{ "blockingReasons": [ "string" ], "canBeDeleted": true}Update a customer claim PUT
Updates the customer claim header and the items sent in the body. Pass `removeItemsNotInRequest=true` to also delete the items the body leaves out. Requires `Permissions.ClaimCustomer.Update`.
Add items to a customer claim POST
Appends the items in the body to an existing customer claim and recalculates the document totals. Requires `Permissions.ClaimCustomer.Create`.