Carries an idempotency key. Retried on network failure, timeout,
429, and 409 idempotency.in_progress - never on a 5xx.
Example
Parameters
string
required
string
required
The vault to hold the item. It must be the brand’s default vault or another vault the brand allows.
string
required
The 32-byte nonce in the owner’s signed approval.
string
required
The owner’s signature over the approval.
Returns
201 - VaultRequest.
string
required
string
required
object
required
'pending' | 'submitted' | 'active' | 'unvault_waiting' | 'unvaulting' | 'unvaulted' | 'cancelled' | 'expired' | 'rejected' | 'failed'
required
string | null
required
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
string | null
required
object | null
required
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.