Get delivery estimate
supply_deliveryNon-committing checkout probe for shipping ETA/cost. Uses agent default_destination, else linked org default address, or country override. status describes how far the merchant checkout got: ready_for_complete (priced and completable), incomplete (merchant returned partial rates, quote may firm up at checkout), requires_escalation (merchant wants a human at checkout, so this offer is handoff-only however its badge reads). needs_interaction=true means the same. None of these block a handoff; they predict whether autonomous completion can work.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| region | No | Optional region/state override | |
| country | No | ISO country override, e.g. US (else agent/org destination) | |
| agent_id | No | Agent id — uses agent destination else org default when country omitted | |
| quantity | No | Units to price shipping for (default 1) | |
| supply_id | Yes | Offer supply id from supply_search / supply_details | |
| postal_code | No | Postal/ZIP override for the probe destination | |
| session_token | No | Session token from agent_authenticate — required whenever agent_id is passed |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| hint | No | ||
| next | No | ||
| note | No | ||
| error | No | ||
| detail | No | ||
| status | No | ||
| country | No | ||
| options | No | ||
| currency | No | ||
| eta_text | No | ||
| available | No | ||
| shippable | No | ||
| supply_id | No | ||
| postal_code | No | ||
| payment_rails | No | ||
| shipping_cost | No | ||
| needs_interaction | No |