Read a dispatch job and the carrier's answer.

Poll this until is_terminal is true.

COMPLETED means the carrier confirmed, and the pickup and PRO numbers are in references. ERRORED means it refused, and said why in errors. EXPIRED means it never answered at all — the tender may still have reached it, so confirm before dispatching the same freight again.

SecurityAPIKeyHeader

Request

path Parameters

dispatch_job_id

required

string (Dispatch Job Id)

header Parameters

X-Shipwell-Version

string (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 (DispatchResult)

A dispatch job: whether the carrier has answered, and what it said.

Polling is the only completion signal, and it is bounded: a dispatch the carrier never confirms is expired by the stale-dispatch cron, so is_terminal arrives either way.

400

Validation Error

404

No such rate, or no such dispatch job for this tenant.

500

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

get/dispatching/jobs/{dispatch_job_id}

Request samples

curl
Node.js
JavaScript
Python
Java

Response samples

application/json

{"data": {"capacity_provider": {"account_id": "01KBZ91QKW3D9VDP5PVY4HWQ1G",
"account_name": "ABF - Main"
},
"carrier_name": "ABF Freight",
"created_at": "2026-08-19T15:30:32.591Z",
"errors": [ ],
"id": "01KBZC9J8Q0000000000000000",
"is_terminal": false,
"provider_code": "ABF",
"references": [{"qualifier": "BOL_NUMBER",
"value": "BOL-77120"
}
],
"resource_id": "9f2c1b84-6d3a-4c17-9b0e-2f5a7c48d31e",
"resource_type": "dispatch_job",
"self_link": "https://api.shipwell.com/dispatching/jobs/01KBZC9J8Q0000000000000000",
"status": "PROCESSING"
}
}