AdditionalInformationResponse
objectDetails of additional information.
Additional information (name, value pairs).
Example:contractedCarrier
The name of the additional information.
Example:true
AddressRequest
objectDetails of an address.
The street address.
Example:345 W Elm St.
Additional street address line.
Example:2nd Floor
The city.
Example:Anaheim
The state.
Example:CA
The ZIP code. Must be a valid United States ZIP code or Canadian postal code.
Example:92802
The country code. US or CA.
Default:US
Example:US
AssignDriverRequest
objectDetails of driver patch operation.
The operation to be performed. Values: ADD, REMOVE.
Example:ADD
The path to the property to be modified.
Example:/drivers/drivers/-
Details of driver patch operation.
Show Child Parameters
BalanceRequest
objectDetails of a dispatch balance.
The balance amount that will be due after the COD/COP payment is applied.
>= 0.01
Example:300
The time frame when the balance payment is due. Required if amount is greater than 0.
Allowed values:IMMEDIATELYTWO_BUSINESS_DAYS_QUICK_PAYFIVE_BUSINESS_DAYSTEN_BUSINESS_DAYSFIFTEEN_BUSINESS_DAYSTHIRTY_BUSINESS_DAYS
The terms for beginning balance payment. Required if amount is greater than 0.
Allowed values:PICKUPDELIVERYRECEIVING_SIGNED_BOL
Example:PICKUP
The payment method with which the balance due payment will be paid. Required if amount is greater than 0.
Allowed values:CASHCERTIFIED_FUNDSCOMPANY_CHECKCOMCHEKTCH
Example:CASH
CancelDispatchRequest
objectDetails of a dispatch cancellation.
The ID of the dispatch.
Example:d159acc0-e89b-12d3-a456-426614174000
The ID of the cancellation reason. This value can be retrieved using the ‘Get Cancellation Reasons’ endpoint. Required if caller is a carrier.
Example:cac10000-e89b-12d3-a456-426614174000
Additional notes regarding the cancellation.
Example:Weather delay.
Indicates if a cancellation override after vehicle pick up is allowed.
Default:false
Example:true