Ask the carrier for an electronic bill of lading for a dispatch booked through
POST /dispatching/jobs, and get back the PRO number it assigns.
Book first: the dispatch job must be COMPLETED. The bill of lading is built from that
dispatch (stops, contacts, freight, references, notes), so it always matches the pickup the
carrier was tendered. Works for every carrier with an eBOL integration, whether or not your
account issues one automatically at dispatch. A carrier that cannot issue one through Shipwell
answers 400 with the code ebol_not_supported: ABF (its PRO number is already in the
dispatch job's references), XPO (its eBOL would book a second pickup), and carriers with no
eBOL integration.
The carrier is called asynchronously: the response is the job in PROCESSING. Poll
GET /ebol/jobs/{id} until is_terminal is true; the PRO number is then in
bol.referenceNumbers.pro and in the dispatch job's references. A job still PROCESSING
after 15 minutes is not going to finish on its own, and calling again does not resend it:
contact Shipwell support with the eBOL job id.
One eBOL per dispatch. Calling again while it is in progress, or after it completed, returns
the same job with 200 and sends nothing. Only an ERRORED job is sent again, as the same
job, with 201. Shipwell does not retry a failed eBOL. When the job is ERRORED and the
error looks temporary (a timeout, the carrier unavailable), you may
call again; we suggest at most two more attempts, about ten seconds apart. An error about the
shipment itself (an address, a contact, the freight) will fail the same way every time.
X-Shipwell-Version (string) or X-Shipwell-Version (null) (X-Shipwell-Version) Pins this request to the API as it behaved on the given ISO date, e.g. 2026-08-25. Omitted or unparseable means the oldest behaviour, so a client that never sends it keeps the behaviour it was written against. |
The dispatch already has an eBOL job that is in progress or done; it is returned and nothing is sent to the carrier.
required | object (EbolJob) An eBOL job: whether the carrier has answered, and the PRO number it assigned. Poll until |
Successful Response
required | object (EbolJob) An eBOL job: whether the carrier has answered, and the PRO number it assigned. Poll until |
Validation Error
No such dispatch job or eBOL job for your company.
The dispatch job is not COMPLETED.
An unknown internal server issue occured while processing a request. A report is created and logged.
{- "dispatch_job_id": "01KBZC9J8Q0000000000000000"
}{- "data": {
- "bol": {
- "images": { },
- "referenceNumbers": {
- "pro": "987654321",
- "shipmentConfirmationNumber": "PU44812"
}, - "transactionDate": "2026-10-28T15:31:05.112Z",
- "version": "2.1.0"
}, - "created_at": "2026-10-28T15:30:32.591Z",
- "dispatch_job_id": "01KBZC9J8Q0000000000000000",
- "errors": [ ],
- "id": "01KC0EB0L00000000000000000",
- "is_terminal": true,
- "provider_code": "ESTES",
- "resource_id": "9f2c1b84-6d3a-4c17-9b0e-2f5a7c48d31e",
- "resource_type": "ebol_job",
- "status": "COMPLETED"
}
}