Search
K
Fulfillment API

CancelDispatchRequest

object

Details of a dispatch cancellation.

dispatchIdstring(uuid)

The ID of the dispatch.

Example:d159acc0-e89b-12d3-a456-426614174000

cancellationReasonIdstring(uuid)

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

notesstring

Additional notes regarding the cancellation.

Example:Weather delay.

postPickupCancelOverrideboolean

Indicates if a cancellation override after vehicle pick up is allowed.

Default:false

Example:true

Example

CancelReasonCollection

object

Details of dispatch cancel reasons.

itemsarray[object]

Details of cancel reasons.

Show Child Parameters
Example

CancelReasonResponse

object

Details of cancel reasons.

responsiblePartystring

The party responsible for the cancellation.

Example:SHIPPER

idstring(uuid)

The ID of the cancellation reason.

Example:cac10000-e89b-12d3-a456-426614174000

namestring

The name of the cancellation reason.

Example:Carrier Unresponsive/Late

Example

CarrierRequest

object

Details of a carrier.

carrierIdstring(uuid)

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

Example

CodRequest

object

Details of cash of delivery or cash on payment (COD/COP).

amountnumber(double)

The cash on delivery (COD) or cash on pick up (COP) amount due.

>= 0

Example:200

paymentMethodstring

The method for the COD/COP payment. Required if amount is greater than 0.

Allowed values:CHECKCASH_CERTIFIED_FUNDS

Example:CASH_CERTIFIED_FUNDS

paymentLocationstring

The location that COD/COP payment is due. Required if amount is greater than 0.

Allowed values:PICKUPDELIVERY

Example:PICKUP

Example