WinShopAPI docs
ReferenceDocumentsIntakes

Delete a intake

Deletes the intake 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.Intake.Delete`.

DELETE
/api/documents/intakes/{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/intakes/0' \  -H 'Authorization: Bearer <access-token>'
null

Get a intake GET

Returns one intake by `documentId`, with its header, items and item variants. Requires `Permissions.Intake.View`.

Update a intake PUT

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