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. This list is not exhaustive and additional values may be added at any time.
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. This list is not exhaustive and additional values may be added at any time.
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. This list is not exhaustive and additional values may be added at any time.
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
CancelReasonCollection
objectDetails of dispatch cancel reasons.
Details of cancel reasons.
Show Child Parameters
CancelReasonResponse
objectDetails of cancel reasons.
The party responsible for the cancellation. This list is not exhaustive and additional values may be added at any time.
Allowed values:CARRIERSHIPPERALL
Example:SHIPPER
The ID of the cancellation reason.
Example:cac10000-e89b-12d3-a456-426614174000
The name of the cancellation reason.
Example:Carrier Unresponsive/Late
CarrierRequest
objectDetails of a carrier.
The ID of the Central Dispatch customer chosen by the shipper to move cars in the dispatch. The carrier must belong to the Marketplace identified by the marketplaceId and have a tier group of BROKER or CARRIER.
Example:0ca91a43-fbee-4c05-9a6c-aa5c63888f5c