Retried on network failure, timeout,
429, and 5xx.
Example
Parameters
string
required
Unit id.
string
required
Vault request id.
Returns
200 - VaultRequest.
string
required
Vault request id.
string
required
The unit the request is for.
object
required
The vault the request names.
'pending' | 'submitted' | 'active' | 'unvault_waiting' | 'unvaulting' | 'unvaulted' | 'cancelled' | 'expired' | 'rejected' | 'failed'
required
Where the request is now.
pending: the owner approved and the vault has not decided. submitted: the vault confirmed it has the item and Endstate is recording it. active: the item is vaulted. unvault_waiting: the owner asked for the item back and the waiting period runs, or the item is ready to ship. unvaulting: the vault dispatched the item and Endstate is completing the unvault. unvaulted: the unvault is complete. cancelled, expired and rejected end a request that never vaulted the item, and never change again. failed: the item was not recorded as vaulted; the request becomes active if the item is later recorded as vaulted after all. A status can move back. A cancel of the unvault, once recorded, returns unvault_waiting to active, and unvaulting too in the rare case one is recorded after the dispatch. Rarely, the network revises its latest records, which can return unvaulted to unvaulting or active, unvault_waiting or unvaulting to active, and active to failed. Read the status as the request’s current state, not as a one-way log.string | null
required
Free text the vault’s staff left when they confirmed or rejected the request. Null when they left none.
string | null
required
Why the request was rejected: the vault’s reason, or
owner_changed when the unit changed hands after its owner approved.string | null
required
When the vault confirmed or rejected the request, or Endstate rejected it; null until then.
string | null
required
When the unvault’s waiting period ends. Null until the owner’s request to unvault is recorded, and again if the owner cancels it. A hold stops the clock, and lifting it moves this later by the time the hold lasted.
object | null
required
The hold on a waiting unvault, or null.
by says who placed it, the vault or the brand, and reason is their text. While it stands the item is not ready to ship.boolean
required
Whether the item is ready to ship: its waiting period has ended and nothing holds it. The vault records dispatch with a tap of the item from then on.
string | null
required
When the vault’s tap recorded the item’s dispatch. Endstate then completes the unvault; the vault hands the item over once the request reads
unvaulted.string | null
required
When a pending request expires; null once it has moved on.
Errors
Branch onerror.code, never on the HTTP status - several codes share one.
See Errors and retries for the error types and how to narrow them.