Get the dispatch associated with a dispatch request by its ID.

Retrieve the list of rates associated with a specific rating request.

SecurityAPIKeyHeader
Request
path Parameters
dispatch_request_id
required
string (Dispatch Request Id)
Responses
200

Successful Response

Response Schema: application/json
Request Log Link (string) or Request Log Link (null) (Request Log Link)

Presigned url for carrier request

Response Log Link (string) or Response Log Link (null) (Response Log Link)

Presigned url for carrier response

Request Log Key (string) or Request Log Key (null) (Request Log Key)

Log location at object storage

Response Log Key (string) or Response Log Key (null) (Response Log Key)

Log location at object storage

Log Date (string) or Log Date (null) (Log Date)

timestamp of when the logs were created

dispatch_request_id
required
string (Dispatch Request Id)
account_id
required
string (Account Id)
Pickup Number (string) or Pickup Number (null) (Pickup Number)

The internal pickup request ID generated or existing in the carrier's system associated with this dispatch result.

Error Message (string) or Error Message (null) (Error Message)
id
required
string (Id)

Unique identifier for an individual dispatch.

400

Validation Error

404

The resource requested was not found either because you do not have permissions to access it or it does not exist.

500

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

get/dispatching/{dispatch_request_id}/dispatch
Request samples
Response samples
application/json
{
  • "request_log_link": "string",
  • "response_log_link": "string",
  • "request_log_key": "string",
  • "response_log_key": "string",
  • "log_date": "2019-08-24T14:15:22Z",
  • "dispatch_request_id": "string",
  • "account_id": "string",
  • "pickup_number": "string",
  • "error_message": "string",
  • "id": "string"
}
Copyright © Shipwell 2025. All right reserved.