All operations use POST /public-api/publicapi.v1.Inventory/ and require the
creator’s inventory access in addition to the exact scope listed on each method.
Transfer status is a stable lowercase string (in_transit or completed),
never an internal enum integer. Quantities and Unix-second timestamps are int64
values, encoded as JSON strings.
StartInventoryTransfer moves stock from a source location to a destination.
When inTransit is false, the destination is credited immediately; when
true, the transfer stays in transit and must be completed later, and
expectedArrivalAt must be a future time. This operation has no idempotency key
and is not retry-safe. Requires inventory:transfer.
Generated Reference
POST /public-api/publicapi.v1.Inventory/StartInventoryTransfer
Starts an inter-location transfer, decrementing source stock immediately. In-transit transfers require a future expected_arrival_at and are completed later; direct transfers credit the destination at once. Not idempotent.
Request StartInventoryTransferRequest
Response StartInventoryTransferResponse
StartInventoryTransferRequest
| Field | Type | Description |
source_location_id | string | Location to move stock out of. |
destination_location_id | string | Location to move stock into. |
lines | repeated TransferLineInput | Lines to transfer. |
reference | string | Human-readable reference for the transfer. |
notes | string | Free-form notes for the transfer. |
in_transit | bool | When true, the transfer stays in transit and must be completed later; when false, the destination is credited immediately. |
expected_arrival_at | int64 | Unix seconds the stock is expected to arrive; required in the future when in_transit is true. |
StartInventoryTransferResponse
| Field | Type | Description |
transfer | InventoryTransfer | The created transfer. |
ListInventoryTransfers returns one bounded, numbered page of transfers,
optionally filtered to in_transit or completed. page defaults to 1;
pageSize defaults to 25, maximum 100. Increment page while hasMore is true.
Read-only. Requires inventory:read.
Generated Reference
POST /public-api/publicapi.v1.Inventory/ListInventoryTransfers
Lists inter-location transfers, optionally filtered by status.
Request ListInventoryTransfersRequest
Response ListInventoryTransfersResponse
ListInventoryTransfersRequest
| Field | Type | Description |
status | string | Optional status filter: empty for all, or in_transit or completed. |
page | int32 | 1-based page number. Defaults to 1. |
page_size | int32 | Maximum transfers to return; defaults are applied when zero. |
ListInventoryTransfersResponse
| Field | Type | Description |
transfers | repeated InventoryTransfer | Transfers for the requested page. |
page | int32 | Echoed 1-based page number. |
page_size | int32 | Effective page size used to build this response. |
has_more | bool | True when more transfers exist beyond this page. |
CompleteInventoryTransfer credits an in-transit transfer’s lines to the
destination location. It is state-convergent: completing an already-completed
transfer returns its completed state. Requires inventory:transfer.
Generated Reference
POST /public-api/publicapi.v1.Inventory/CompleteInventoryTransfer
Completes an in-transit transfer, crediting the destination. State-convergent: completing an already-completed transfer returns its current state.
Request CompleteInventoryTransferRequest
Response CompleteInventoryTransferResponse
CompleteInventoryTransferRequest
| Field | Type | Description |
transfer_id | string | In-transit transfer to complete. |
CompleteInventoryTransferResponse
| Field | Type | Description |
transfer | InventoryTransfer | The transfer after completion. |