Skip to main content
The Dyspach API does two things:
  • Quote — send an origin, destination and items, and get back priced carrier services to allocate against.
  • Push shipments — send the shipments you have booked into your Dyspach shipment ledger, as a JSON batch or as a file, so reconciliation and invoicing run on complete, current data without anyone uploading a spreadsheet by hand.

Quickstart

Make your first quote request in a few minutes.

Authentication

Create and use an organisation API key.

Shipment structure

The one structure every shipment push uses.

Import shipments

Push a batch of shipments and track the import.

​
Base URL

All endpoints live under /v1/org.

​
Core concepts

You authenticate as your organisation (the tenant). A customer is one of your shippers. You reference a customer by its business internal id (e.g. ACME) — never a database UUID.
general.customerIds is a list. The response returns one entry under results per customer, with shared origin / destination / goods at the top level.
An optional filters block narrows which of a customer’s services and rate cards are priced — by carrier, service, service type/class, or rate card. See Filters.
Every response includes a quoteId per customer. Pass it to Fetch a quote to retrieve it later.
Shipments are never written inside your request. Every push — JSON or file — creates an import, returns its id, and is processed on a queue; you poll the import for the outcome and read back any rows it rejected. Shipments are identified by your shipmentId, so re-sending one updates it rather than duplicating it.
The API is server-to-server. Keep your API key secret and never expose it in a browser or mobile client.