Get delivery options for a city
get_delivery_optionsDelivery to a city as the Trailhead Supply checkout offers it right now: the delivery zone the city belongs to (matched_city=false means the catch-all rate applies), each courier option with its fee in USD and delivery time, the order total above which delivery is free, and whether same-day delivery is available today, with the reason when it is not. With a product (and quantity) same-day can account for that product's stock; with a basket subtotal each fee is the one that basket would pay.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"city": "<city>"
},
"name": "get_delivery_options"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| qty | No | Quantity of the product (default 1). | |
| city | Yes | The delivery city as the shopper writes it. | |
| locale | No | Answer language: en (default en). Names, labels and URLs follow it. | |
| product | No | The product: its public_id from an earlier answer, its page URL or slug on the store's website, or the manufacturer model number. | |
| subtotal | No | Basket subtotal in USD: each fee is then what that basket pays. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | The store's delivery terms page. | |
| city | Yes | ||
| zone | Yes | ||
| options | Yes | ||
| same_day | Yes | ||
| truncated | No | Present and true only when the answer outgrew the size budget and its last list items were left out; ask narrower to see them. | |
| free_above | Yes | Order total in USD from which delivery is free; null when there is none. | |
| answer_type | No | What this answer is, for rendering. |