Commit Warehouse Transfer

POST /inventory/warehouse-transfers/{id}/commit

Group: Inventory › Warehouse Transfers · Operation ID: commitWarehouseTransfer

Commits a warehouse transfer, moving the stock and recording it in a journal entry.

Posts the transfer: the goods leave the source warehouse, arrive at the target, and a journal entry records the movement. The transfer becomes committed. Stock availability is checked here, and a transfer of stock that is not there fails with POSTING_REJECTED. This does not create the intercompany bill. On an intercompany transfer the invoice is a separate call, POST inventory/warehouse-transfers/:id/bill. journalEntryId is absent when the posting produced no entry: an intercompany return writes two and names neither, and a movement with no financial posting has none. The stock has moved either way.

Open in the interactive reference

Parameters

Name	In	Type	Required	Description
`Api-Version`	header	`"v1"`	yes	The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version `v1`.
`Idempotency-Key`	header	string	no	An opaque caller-chosen string (1-255 characters) that makes this request safe to retry. Repeating the same key with an identical request body replays the original response instead of re-executing - but only once that original request succeeded; a failed attempt re-executes on retry. Repeating the key with a different body is answered with 422. A key still in flight is answered with 409 - as is a key whose original request was interrupted before it finished, for a few minutes afterwards, until that attempt is presumed dead. A completed response stays replayable for 24 hours. The key is scoped to the caller, not to the action: reusing it for a different action is answered with 409 or 422 rather than treated independently. On read actions this header is ignored. On write actions that cannot offer the guarantee it is answered with `400 IDEMPOTENCY_NOT_SUPPORTED` rather than silently ignored.
`id`	path	string	yes	The unique identifier for the transfer to commit.

Response

200 Success

Under data (commitWarehouseTransferOutput):

Field	Type	Required	Description
`id`	string	yes	The unique identifier for the transfer.
`documentStatus`	string	yes	The status of the transfer, read back from the document. 'COMMITTED' on success.
`journalEntryId`	string	no	The journal entry the commit wrote. Absent when the posting produced none, as on an intercompany return that writes two entries and names neither, or a movement with no financial posting. See id on GET accounting/journal-entries/:id.
`warnings`	array of string	yes	Non-fatal advisories from the posting. An empty array on a clean run. The commit succeeded whatever it lists.

Response headers

Idempotency-Replayed — Present and true only when this response replays a previously stored one for the same Idempotency-Key, rather than reflecting a live execution. Absent on a live response - never sent as false.

Errors

Code	Status
`NOT_FOUND`	400
`WRONG_STATUS`	400
`POSTING_REJECTED`	400
`IDEMPOTENCY_KEY_CONFLICT`	409
`IDEMPOTENCY_PAYLOAD_MISMATCH`	422

Statuses

400 — Invalid request or business failure. Codes: NOT_FOUND, WRONG_STATUS, POSTING_REJECTED
401 — Missing or invalid access token
403 — Not authorized
404 — Not found
409 — The Idempotency-Key is still being processed by another request.
422 — The Idempotency-Key was already used with a different request payload.
429 — Too many requests
500 — Internal server error