Download OpenAPI specification:Download
Shipwell's LTL, VLTL and FTL rate-share API: request rates from every eligible carrier on an account, book the LTL or VLTL rate you choose (FTL rates are tendered in the Shipwell app), follow the freight the carrier is moving (by polling, or pushed to your own URL), and pull back the documents it produces along the way.
| Capability | Operation | What it does |
|---|---|---|
| Rating | POST /rating/jobs |
Request rates from every eligible carrier for a shipment. |
GET /rating/jobs/{id} |
Read a rating job, and the rates it collected once it's terminal. | |
GET /rating/jobs/{id}/rates/{rate_id} |
Read one rate on its own — the URL a rate's self_link points at. |
|
GET /rating/jobs/{id}/transit-times |
Read each carrier's transit days and estimated delivery date from a rating job. | |
| Dispatching | POST /dispatching/jobs |
Book freight with a carrier, from a rate or from a stated shipment. |
GET /dispatching/jobs/{id} |
Read a dispatch job and the carrier's answer. | |
POST /dispatching/jobs/{id}/cancel |
Cancel a booked dispatch. | |
| eBOL | POST /ebol/jobs |
Get a bill of lading and PRO number from the carrier for a booked dispatch. |
GET /ebol/jobs/{id} |
Read an eBOL job and the PRO number the carrier assigned. | |
| Tracking | GET /tracking/timelines/{resource_id} |
Read where a booked shipment has got to, and every movement its carrier reported. |
| Tracking webhooks | POST /tracking/webhooks |
Register a URL; tracking changes for your freight are POSTed to it, signed. |
POST /tracking/webhooks/{id}/test |
Send a signed test delivery and see what your endpoint answered. | |
| Documents webhooks | POST /tracking/webhooks |
Include documents.updated in event_names; document changes for your freight are POSTed to the same URL, signed. |
| Documents | GET /documents/{resource_id} |
Read every document a carrier has produced for a resource so far. |
GET /documents/{resource_id}/{document_type} |
The same collection, narrowed to one document type. |