Stage - Fulfillment API
Assign Driver
Assign a driver to a load or unassign a driver from the load.
👥 Customer Type
- Carrier
📝 Important Notes
- May only be used by the assigned carrier or a broker with the carrier profile that is assigned to.
patch
https://fulfillment-api.centraldispatch.com/api/fulfillments/id/{dispatchId}/drivers
Path Parameters
dispatchIdstring(uuid)required
The ID of the dispatch.
Example:d159acc0-e89b-12d3-a456-426614174000
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
Body
application/json
AssignDriverRequest collection
Details of driver patch operation.
opstring
The operation to be performed. Values: ADD, REMOVE.
Example:ADD
pathstring
The path to the property to be modified.
Example:/drivers/drivers/-
valuesarray[object]
Details of driver patch operation.
Show Child Parameters
Response
Response
No Content. Successful request.
patch/api/fulfillments/id/{dispatchId}/drivers
Authentication
Path Parameters
Headers
Body
[
{
"op": "ADD",
"path": "/drivers/drivers/-",
"values": [
{
"driverId": "3ca6e1c2-98fb-4b4e-bfd8-ffaec58fb347"
}
]
}
]
Cancel Dispatch
Cancel a dispatch that has not been delivered.
📝 Important Notes
- A dispatch with a status of
DELIVEREDcannot be canceled. - A dispatch with a status of
PENDING_DELIVERYcan be canceled if thepostPickupCancelOverridevalue 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
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
Response
No Content. Successful request.
post/api/fulfillments/cancel
Authentication
Headers
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_UPusing 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
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. This list is not exhaustive and additional values may be added at any time.
Allowed values:PICKED_UPIN_TRANSITDELIVERED
Example:IN_TRANSIT
lastVehicleLocationIdstring | null(uuid)
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
Authentication
Path Parameters
Headers
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_UPusing 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
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. This list is not exhaustive and additional values may be added at any time.
Allowed values:PICKED_UPIN_TRANSITDELIVERED
Example:IN_TRANSIT
lastVehicleLocationIdstring | null(uuid)
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
Authentication
Path Parameters
Headers
application/json
Update Dispatch Payment Status
Update the payment status of a dispatch.
📝 Important Notes
- The shipper and carrier each have their own separate payment status that is tracked independently.
- Payment status can only be updated for dispatches in
PENDING_DELIVERY,DELIVERED,CANCELED, orARCHIVEDstatus. - Requires
adminorownerrole permissions.
post
https://fulfillment-api.centraldispatch.com/api/fulfillments/id/{dispatchId}/update-payment-status
Path Parameters
dispatchIdstring(uuid)required
The ID of the dispatch.
Example:d159acc0-e89b-12d3-a456-426614174000
Headers
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
Body
application/json
UpdatePaymentStatusRequest
UpdatePaymentStatusRequest
Details of dispatch payment status.
paymentStatusstring
The status of the payment of the dispatch. Values: UNPAID, INVOICED, PARTIALLY_PAID, FULLY_PAID. Set to null to remove status.
Example:PARTIALLY_PAID
Response
Response
No Content. Successful request.
post/api/fulfillments/id/{dispatchId}/update-payment-status
Authentication
Path Parameters
Headers
Body
{
"paymentStatus": "PARTIALLY_PAID"
}