Search
K
Fulfillment API

Cancel Dispatch

Cancel a dispatch that has not been delivered.

📝 Important Notes

  • A dispatch with a status of DELIVERED cannot be canceled.
  • A dispatch with a status of PENDING_DELIVERY can be canceled if the postPickupCancelOverride value is true.
post
https://fulfillment-api.centraldispatch.com/api/fulfillments/cancel

Headers

If-Matchintegerrequired

This is a required field to ensure the update is being completed on an item that has not changed since it was last read. The value of this field will be the value of the ETag header that was received on the preceding get call.

Example:8675309

Content-Typestringrequired

The major version of the API to make a request against. This is a custom MIME type that contains vnd.coxauto.v[#]+. For example, to request a resource from version 1.x.x of an API, the Content-Type header should be set to application/vnd.coxauto.v1+json.

Example:application/vnd.coxauto.v1+json

Body

application/json

CancelDispatchRequest

CancelDispatchRequest

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 | null

Additional notes regarding the cancellation.

Example:Weather delay.

postPickupCancelOverrideboolean

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

Default:false

Example:true

Response

No Content. Successful request.

post/api/fulfillments/cancel

Body

{ "dispatchId": "d159acc0-e89b-12d3-a456-426614174000", "notes": "Weather delay.", "postPickupCancelOverride": true }
 

Get Vehicle's Last Location by Vehicle ID

Get the latitude/longitude position of the latest vehicle location by vehicle ID.

📝 Important Notes

  • Tracking data is only available if the vehicle was inspected and marked PICKED_UP using the Central Dispatch mobile application.
  • Location tracking must be enabled on the device used to perform the pick up inspection.
  • This location may be slightly shifted to protect the privacy of the carrier.
get
https://fulfillment-api.centraldispatch.com/api/fulfillments/vehicle-locations/vehicleId/{vehicleId}/last-vehicle-location

Path Parameters

vehicleIdstring(uuid)required

The ID of the vehicle.

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

Headers

Acceptstringrequired

The major version of the API to make a request against. This is a custom MIME type that contains vnd.coxauto.v[#]+. For example, to request a resource from version 1.x.x of an API, the Accept header should be set to application/vnd.coxauto.v1+json.

Example:application/vnd.coxauto.v1+json

Response

application/json

OK. Successful request.

VehicleLocationResponse

Details of a vehicle’s location.

hrefstring | null

The fully qualified URL of the dispatch.

Example:https://fulfillment-api.centraldispatch.com/api/fulfillments/id/d159acc0-e89b-12d3-a456-426614174000

vehicleIdstring(uuid)

The ID of the vehicle.

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

dispatchIdstring(uuid)

The ID of the dispatch.

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

userIdstring(uuid)

The Central Dispatch user ID.

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

vehicleTrackingDeviceIdstring | null

The vehicle tracking device ID.

Example:2539f4b4-d3d6-45db-8df3-7ba768caba9b

eventType

The event type.

Allowed values:PICKED_UPIN_TRANSITDELIVERED

Example:IN_TRANSIT

lastVehicleLocationIdstring | null

The location ID of the vehicle’s last location.

Example:3fde6068-5fa2-4ae4-af16-06d65fc87dc9

latitudenumber(double)

The latitude of the location.

Example:33.81228788622535

longitudenumber(double)

The longitude of the location.

Example:-117.91836265987132

locationDateUtcstring(date-time)

The date and time of the vehicle’s last location, in UTC/ISO 8601 format.

Example:2024-10-15T00:00:00Z

get/api/fulfillments/vehicle-locations/vehicleId/{vehicleId}/last-vehicle-location
 
application/json

Get Vehicle's Last Location by Dispatch ID

Get the latitude/longitude position of the latest vehicle location by dispatch ID.

📝 Important Notes

  • Tracking data is only available if the vehicle was inspected and marked PICKED_UP using the Central Dispatch mobile application.
  • Location tracking must be enabled on the device used to perform the pick up inspection.
  • This location may be slightly shifted to protect the privacy of the carrier.
get
https://fulfillment-api.centraldispatch.com/api/fulfillments/vehicle-locations/dispatchId/{dispatchId}/last-vehicle-location

Path Parameters

dispatchIdstring(uuid)required

The ID of the dispatch.

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

Headers

Acceptstringrequired

The major version of the API to make a request against. This is a custom MIME type that contains vnd.coxauto.v[#]+. For example, to request a resource from version 1.x.x of an API, the Accept header should be set to application/vnd.coxauto.v1+json.

Example:application/vnd.coxauto.v1+json

Response

application/json

OK. Successful request.

VehicleLocationResponse

Details of a vehicle’s location.

hrefstring | null

The fully qualified URL of the dispatch.

Example:https://fulfillment-api.centraldispatch.com/api/fulfillments/id/d159acc0-e89b-12d3-a456-426614174000

vehicleIdstring(uuid)

The ID of the vehicle.

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

dispatchIdstring(uuid)

The ID of the dispatch.

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

userIdstring(uuid)

The Central Dispatch user ID.

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

vehicleTrackingDeviceIdstring | null

The vehicle tracking device ID.

Example:2539f4b4-d3d6-45db-8df3-7ba768caba9b

eventType

The event type.

Allowed values:PICKED_UPIN_TRANSITDELIVERED

Example:IN_TRANSIT

lastVehicleLocationIdstring | null

The location ID of the vehicle’s last location.

Example:3fde6068-5fa2-4ae4-af16-06d65fc87dc9

latitudenumber(double)

The latitude of the location.

Example:33.81228788622535

longitudenumber(double)

The longitude of the location.

Example:-117.91836265987132

locationDateUtcstring(date-time)

The date and time of the vehicle’s last location, in UTC/ISO 8601 format.

Example:2024-10-15T00:00:00Z

get/api/fulfillments/vehicle-locations/dispatchId/{dispatchId}/last-vehicle-location
 
application/json

Get Date Change Reasons

Get a reference list of supported date change reasons.

get
https://fulfillment-api.centraldispatch.com/api/fulfillments/datechangereasons

Headers

Acceptstringrequired

The major version of the API to make a request against. This is a custom MIME type that contains vnd.coxauto.v[#]+. For example, to request a resource from version 1.x.x of an API, the Accept header should be set to application/vnd.coxauto.v1+json.

Example:application/vnd.coxauto.v1+json

Response

application/json

OK. Successful request.

DateChangeReasonCollection

Details of a collection of items with ID and Name pairs.

itemsarray | null[object]

Details of the date change reason.

Show Child Parameters
get/api/fulfillments/datechangereasons
 
application/json

Get Cancellation Reasons

Get a reference list of supported load cancellation reasons.

get
https://fulfillment-api.centraldispatch.com/api/fulfillments/loadcancellationreasons

Query Parameters

marketplaceIdstring | null

The Central Dispatch marketplace ID.

Default:null

Example:10000

Headers

Acceptstringrequired

The major version of the API to make a request against. This is a custom MIME type that contains vnd.coxauto.v[#]+. For example, to request a resource from version 1.x.x of an API, the Accept header should be set to application/vnd.coxauto.v1+json.

Example:application/vnd.coxauto.v1+json

Response

application/json

OK. Successful request.

CancelReasonCollection

Details of dispatch cancel reasons.

itemsarray | null[object]

Details of cancel reasons.

Show Child Parameters
get/api/fulfillments/loadcancellationreasons
 
application/json