Read an eBOL job and the PRO number the carrier assigned.

Poll this until is_terminal is true.

COMPLETED means the carrier accepted the bill of lading; the PRO number is in bol.referenceNumbers.pro. ERRORED means it refused, and errors says why in the carrier's words.

SecurityAPIKeyHeader
Request
path Parameters
ebol_job_id
required
string (Ebol Job Id)
header Parameters
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.

Responses
200

Successful Response

Response Schema: application/json
required
object (EbolJob)

An eBOL job: whether the carrier has answered, and the PRO number it assigned.

Poll until is_terminal is true. Shipwell does not retry a failed eBOL on its own; if status is ERRORED you may send POST /ebol/jobs again for the same dispatch.

400

Validation Error

404

No such dispatch job or eBOL job for your company.

500

An unknown internal server issue occured while processing a request. A report is created and logged.

get/ebol/jobs/{ebol_job_id}
Request samples
Response samples
application/json
{
  • "data": {
    }
}
Copyright © Shipwell 2025. All right reserved.