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.
Backorder status is a stable lowercase string (open or received), never an
internal enum integer. A backorder tracks incoming stock as inbound; it does not
add available stock. Available stock is added only when the goods are received
through the receipt lifecycle. Quantities and Unix-second timestamps are int64
values, encoded as JSON strings.
CreateInventoryBackorder records expected inbound stock at a destination
location with a future expectedArrivalAt and expected lines. Requires
inventory_backorder:write. idempotencyKey makes retries safe; reusing it with
a different payload conflicts.
Generated Reference
POST /public-api/publicapi.v1.Inventory/CreateInventoryBackorder
Creates an inbound backorder tracking expected arrivals for a destination location. Idempotent by key.
Request CreateInventoryBackorderRequest
Response CreateInventoryBackorderResponse
CreateInventoryBackorderRequest
| Field | Type | Description |
destination_location_id | string | Location the inbound stock is expected at. |
lines | repeated BackorderLineInput | Lines expected on the backorder. |
expected_arrival_at | int64 | Unix seconds the stock is expected to arrive; must be in the future. |
reference | string | Human-readable reference for the backorder. |
notes | string | Free-form notes for the backorder. |
idempotency_key | string | Idempotency key; reusing it with a different payload conflicts. |
CreateInventoryBackorderResponse
| Field | Type | Description |
backorder | InventoryBackorder | The created backorder. |
ListInventoryBackorders returns one bounded, numbered page of backorders,
optionally filtered to open or received. 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/ListInventoryBackorders
Lists inbound backorders, optionally filtered by status.
Request ListInventoryBackordersRequest
Response ListInventoryBackordersResponse
ListInventoryBackordersRequest
| Field | Type | Description |
status | string | Optional status filter: empty for all, or open or received. |
page | int32 | 1-based page number. Defaults to 1. |
page_size | int32 | Maximum backorders to return; defaults are applied when zero. |
ListInventoryBackordersResponse
| Field | Type | Description |
backorders | repeated InventoryBackorder | Backorders 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 backorders exist beyond this page. |
UpdateInventoryBackorderEta reschedules an open backorder’s expected arrival to
a new future time. It does not receive the backorder or change its lines; a
received backorder cannot be rescheduled. Requires inventory_backorder:write.
Generated Reference
POST /public-api/publicapi.v1.Inventory/UpdateInventoryBackorderEta
Updates the expected arrival time of an open backorder. Only valid while the backorder is open.
Request UpdateInventoryBackorderEtaRequest
Response UpdateInventoryBackorderEtaResponse
UpdateInventoryBackorderEtaRequest
| Field | Type | Description |
backorder_id | string | Open backorder to update. |
expected_arrival_at | int64 | New expected arrival time in Unix seconds; must be in the future. |
UpdateInventoryBackorderEtaResponse
| Field | Type | Description |
backorder | InventoryBackorder | The backorder after the ETA update. |