go back to CarrierDispatchService

POST /carrierDispatch/bookload/{movementId}

This method allows assignment of a carrier to a movement for freight matching.

Roles that can access this endpoint are Freight Matching.

Parameters

name description type default type
movementId (Required) ID of the movement to be updated path String
carrierId (Required if no vendor supplied mcNumber parameter) ID of the carrier to be assigned
There is no default value
query String
mcNumber (Required if no vendor supplied carrierId parameter) MC number of the carrier to be assigned
There is no default value
query String
carrierPhone (Optional) Carrier phone number
There is no default value
query String
driverName (Optional) Override driver name
There is no default value
query String
driverPhone (Optional) Override driver phone number
There is no default value
query String
driverEmail (Optional) Override driver email
There is no default value
query String
carrierTractor (Optional) Tractor number
There is no default value
query String
carrierTrailer (Optional) Trailer number
There is no default value
query String
rateConfirmationEmail (Optional) Email recipient of the rate confirmation
There is no default value
query String
rateAmount (Optional) Vendor pay rate guidance
There is no default value
query BigDecimal
dispatcherEmail (Optional) Dispatcher email address
There is no default value
query String
emptyTractorCity (Optional) Empty tractor city location
There is no default value
query String
emptyTractorState (Optional) Empty tractor state location
There is no default value
query String
emptyTractorZip (Optional) Empty tractor zip location
There is no default value
query String
emptyTractorDateTime (Optional) Empty tractor date/time
There is no default value
query Date

Result

Response of type: text/plain

A response containing the success or failure of the assignment request

Either a carrierId or a mcNumber parameter must be supplied. Both can be supplied but both cannot be omitted
Exactly one carrier record must exist in the PowerBroker system for the given carrierId and/or mcNumber parameters.
If multiple carrier records exist, based on the supplied carrierId and/or mcNumber parameters, a non 200 status code will be returned along with a response message stating that multiple carriers exists.
If pay rate guidance is invalid, a non 200 status code will be returned along with a response message.

Try It Out

Request

- Authentication Help
- String
- String
- String
- String
- String
- String
- String
- String
- String
- String
- BigDecimal
- String
- String
- String
- String
- Date