Generate quotes

curl https://api.dyspach.com/v1/org/quote \
  -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,
        "customFieldValues": [{ "key": "ITEM_CATEGORY", "value": "FRAGILE" }]
      }
    ],
    "customFieldValues": [{ "key": "ACCOUNT_TYPE", "value": "PREMIUM" }],
    "filters": { "serviceIds": ["ZEPHYR", "FALCON"] }
  }'

{
  "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,
      "customFieldValues": [{ "key": "ITEM_CATEGORY", "value": "FRAGILE" }]
    }
  ],
  "customFieldValues": [{ "key": "ACCOUNT_TYPE", "value": "PREMIUM" }],
  "filters": { "serviceIds": ["ZEPHYR", "FALCON"] }
}

{
  "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, "palletSpaces": 0,
      "length": 30, "width": 30, "height": 30, "weight": 10, "chargeableWeight": 20,
      "customFieldValues": [{ "key": "ITEM_CATEGORY", "value": "FRAGILE" }]
    }
  ],
  "customFieldValues": [{ "key": "ACCOUNT_TYPE", "value": "PREMIUM" }],
  "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 }
          ]
        }
      ]
    }
  ]
}

POST /v1/org/quote

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

string

required

Your organisation API key (dzk_live_…). See Authentication.

Body

object

required

Hide general

string[]

required

Customer internal id(s) to quote for, e.g. ["ACME"]. At least one, max 50. Each must belong to your organisation.

object

required

Pickup location. Only postalCode is required; the rest is enriched server-side.

Show origin

string

required

Origin postcode, e.g. "2000".

string

default:"AU"

ISO country code.

string

Pickup company name.

string

Suburb.

string

Address line 1.

string

Contact name.

string

Contact phone.

string

Contact email.

object

required

Delivery location. Same fields as origin (with postalCode required).

object[]

required

Goods to quote. At least one item.

Show item

integer

required

Number of items.

integer

Number of pallet spaces occupied by this item. Defaults to 0.

number

required

Length (metres).

number

required

Width (metres).

number

required

Height (metres).

number

required

Weight per item (kg).

string

Item type, e.g. "Carton/Box".

number

Declared value.

object[]

Per-item custom field values. Keys must match the org’s SHIPMENT_LEDGER_GOODS custom field keys.

Show customFieldValue

string

required

Custom field key, e.g. "ITEM_CATEGORY".

string | string[]

required

Field value. Pass an array of strings for multi-select fields.

object[]

Optional shipment-level custom field values. Keys must match the org’s SHIPMENT_LEDGER custom field keys (e.g. "ACCOUNT_TYPE"). Echoed back unchanged at the response root.

Show customFieldValue

string

required

Custom field key, e.g. "ACCOUNT_TYPE".

string | string[]

required

Field value. Pass an array of strings for multi-select fields.

object

Optional. Narrow which services / rate cards are priced. Empty or omitted = no restriction. See Filters.

Show filters

string[]

Carrier aliases.

string[]

Service aliases (= serviceId in the response).

string[]

Rate-card aliases (= rateCardId in the response).

string[]

e.g. DOMESTIC, INTERNATIONAL.

string[]

e.g. STANDARD, EXPRESS.

Response

object

Enriched pickup location echoed back.

object

Enriched delivery location echoed back.

object[]

The items, with computed chargeableWeight. Each entry also echoes back any customFieldValues supplied for that item (empty array when none were sent).

object[]

Shipment-level custom field values echoed back from the request. Each entry is { key: string; value: string | string[] }. Empty array when none were sent.

object[]

One entry per requested customer.

Show result

string

The customer this block is for.

string

Unique id — pass to Fetch a quote.

string

Set when nothing could be priced.

object[]

One entry per matched service.

Show quote

string

Reference for this priced line.

string

Human service name.

string

Service alias (use in filters.serviceIds).

string

Human rate-card name.

string

Rate-card alias (use in filters.rateCardIds).

number

Freight amount (sell).

number

Total incl. surcharges + GST.

number

GST portion.

boolean

Whether this is a spot rate.

string

Human transit estimate.

integer

Minimum transit.

integer

Maximum transit.

string

Transit unit, e.g. D (days).

object[]

Applied surcharges.

Show surcharge

string

Surcharge name.

string

Description.

string

Surcharge key.

number

Surcharge amount.

curl https://api.dyspach.com/v1/org/quote \
  -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,
        "customFieldValues": [{ "key": "ITEM_CATEGORY", "value": "FRAGILE" }]
      }
    ],
    "customFieldValues": [{ "key": "ACCOUNT_TYPE", "value": "PREMIUM" }],
    "filters": { "serviceIds": ["ZEPHYR", "FALCON"] }
  }'

{
  "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,
      "customFieldValues": [{ "key": "ITEM_CATEGORY", "value": "FRAGILE" }]
    }
  ],
  "customFieldValues": [{ "key": "ACCOUNT_TYPE", "value": "PREMIUM" }],
  "filters": { "serviceIds": ["ZEPHYR", "FALCON"] }
}

{
  "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, "palletSpaces": 0,
      "length": 30, "width": 30, "height": 30, "weight": 10, "chargeableWeight": 20,
      "customFieldValues": [{ "key": "ITEM_CATEGORY", "value": "FRAGILE" }]
    }
  ],
  "customFieldValues": [{ "key": "ACCOUNT_TYPE", "value": "PREMIUM" }],
  "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 }
          ]
        }
      ]
    }
  ]
}

Getting Started

Guides

Quotes

Shipments

Authorization

Body

Response

​Authorization

​Body

​Response

Authorization

Body

Response