WinShopAPI docs
ReferenceDocumentsClaimsInternal

Delete a internal claim

Deletes the internal claim together with its items and item variants. Cannot be undone. Call `GET {documentId}/check-delete` first to find out whether the delete is allowed. Requires `Permissions.ClaimInternal.Delete`.

DELETE
/api/documents/claims/internal/{documentId}

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

response?unknownapplication/octet-stream
curl -X DELETE 'https://<your-instance>/api/documents/claims/internal/0' \  -H 'Authorization: Bearer <access-token>'
null

Get a internal claim GET

Returns one internal claim by `documentId`, with its header, items and item variants. Requires `Permissions.ClaimInternal.View`.

Update a internal claim PUT

Updates the internal claim header and the items sent in the body. Pass `removeItemsNotInRequest=true` to also delete the items the body leaves out. Requires `Permissions.ClaimInternal.Update`.