> ## Documentation Index
> Fetch the complete documentation index at: https://apidocs.dyspach.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Generate quotes
> Price carrier services for one or more customers.
**`POST`** `/v1/org/quote/getQuote`
Send an origin, destination, items, and the customer(s) to quote for. The response
returns shared `origin` / `destination` / `goods`, plus one `results` entry per
customer with its priced `quotes`.
## Authorization
Your organisation API key (`dzk_live_…`). See [Authentication](/authentication).
## Body
Customer internal id(s) to quote for, e.g. `["ACME"]`. At least one, max 50.
Each must belong to your organisation.
Pickup location. Only `postalCode` is required; the rest is enriched server-side.
Origin postcode, e.g. `"2000"`.
ISO country code.
Pickup company name.
Suburb.
Address line 1.
Contact name.
Contact phone.
Contact email.
Delivery location. Same fields as `origin` (with `postalCode` required).
Goods to quote. At least one item.
Number of items.
Length (metres).
Width (metres).
Height (metres).
Weight per item (kg).
Item type, e.g. `"Carton/Box"`.
Declared value.
Optional. Narrow which services / rate cards are priced. Empty or omitted = no
restriction. See [Filters](/guides/filters).
Carrier aliases.
Service aliases (= `serviceId` in the response).
Rate-card aliases (= `rateCardId` in the response).
e.g. `DOMESTIC`, `INTERNATIONAL`.
e.g. `STANDARD`, `EXPRESS`.
## Response
Enriched pickup location echoed back.
Enriched delivery location echoed back.
The items, with computed `chargeableWeight`.
One entry per requested customer.
The customer this block is for.
Unique id — pass to [Fetch a quote](/api-reference/fetch-quote).
Set when nothing could be priced.
One entry per matched service.
Reference for this priced line.
Human service name.
Service alias (use in `filters.serviceIds`).
Human rate-card name.
Rate-card alias (use in `filters.rateCardIds`).
Freight amount (sell).
Total incl. surcharges + GST.
GST portion.
Whether this is a spot rate.
Human transit estimate.
Minimum transit.
Maximum transit.
Transit unit, e.g. `D` (days).
Applied surcharges.
Surcharge name.
Description.
Surcharge key.
Surcharge amount.
```bash cURL theme={null}
curl https://api.dyspach.com/v1/org/quote/getQuote \
-H "x-api-key: $DYSPACH_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"general": { "customerIds": ["ACME"] },
"origin": { "postalCode": "2000", "countryCode": "AU" },
"destination": { "postalCode": "3000", "countryCode": "AU" },
"items": [
{ "type": "Carton/Box", "quantity": 2, "length": 0.3, "width": 0.3, "height": 0.3, "weight": 10 }
],
"filters": { "serviceIds": ["ZEPHYR", "FALCON"] }
}'
```
```json Body theme={null}
{
"general": { "customerIds": ["ACME"] },
"origin": { "postalCode": "2000", "countryCode": "AU" },
"destination": { "postalCode": "3000", "countryCode": "AU" },
"items": [
{ "type": "Carton/Box", "quantity": 2, "length": 0.3, "width": 0.3, "height": 0.3, "weight": 10 }
],
"filters": { "serviceIds": ["ZEPHYR", "FALCON"] }
}
```
```json 200 theme={null}
{
"origin": { "postalCode": "2000", "suburb": "BARANGAROO", "city": "Sydney", "state": "NSW", "stateName": "New South Wales", "countryCode": "AU" },
"destination": { "postalCode": "3000", "suburb": "MELBOURNE", "city": "Melbourne", "state": "VIC", "stateName": "Victoria", "countryCode": "AU" },
"goods": [
{ "type": "Carton/Box", "quantity": 2, "length": 30, "width": 30, "height": 30, "weight": 10, "chargeableWeight": 20 }
],
"results": [
{
"customerId": "ACME",
"quoteId": "K541037RNBUQ",
"noQuoteMessage": "",
"quotes": [
{
"rateId": "7cd6c7cf-84af-419d-b34d-6d270cc809ee",
"serviceName": "Falcon Freight",
"serviceId": "FALCON",
"rateCardName": "Falcon Standard",
"rateCardId": "FALCON_STD",
"isSpotRate": false,
"spotRateMessage": "",
"amount": 10,
"totalAmount": 19.8,
"gstAmount": 1.8,
"deliveryTime": "1 - 5 business day(s)",
"minTransitTime": 1,
"maxTransitTime": 5,
"transitTimeUnit": "D",
"surcharges": [
{ "name": "Remote Location", "description": "Remote Location", "key": "Remote Location", "amount": 8 }
]
},
{
"rateId": "ba9bc08c-0238-4c88-aff5-b4f26aaab790",
"serviceName": "Zephyr Couriers",
"serviceId": "ZEPHYR",
"rateCardName": "Zephyr Express",
"rateCardId": "ZEPHYR_EXP",
"isSpotRate": false,
"spotRateMessage": "",
"amount": 9,
"totalAmount": 11.09,
"gstAmount": 1.01,
"deliveryTime": "0 - 0 business day(s)",
"minTransitTime": 0,
"maxTransitTime": 0,
"transitTimeUnit": "D",
"surcharges": [
{ "name": "Fuel Surcharge", "description": "Fuel Surcharge", "key": "FUEL", "amount": 1.08 }
]
}
]
}
]
}
```