WinShopAPI docs
ReferenceDocumentsInternal transfer

Process a internal transfer (deprecated)

**Deprecated.** Use `POST {documentId}/process` instead — this alias behaves identically and will be removed. Requires `Permissions.InternalTransfer.Update`.

Deprecated

POST
/api/documents/internal-transfers/{documentId}/finish

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

userId?|
Formatint32

Response Body

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

Check whether a internal transfer can be deleted GET

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.InternalTransfer.Delete`.

Add items to a internal transfer POST

Appends the items in the body to an existing internal transfer and recalculates the document totals. Requires `Permissions.InternalTransfer.Create`.