Stage - Fulfillment API

Fulfillment API

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. 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
 
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, or ARCHIVED status.
  • Requires admin or owner role 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

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

No Content. Successful request.

post/api/fulfillments/id/{dispatchId}/update-payment-status

Body

{ "paymentStatus": "PARTIALLY_PAID" }
 

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

marketplaceIdinteger | null(int32)

The Central Dispatch marketplace ID.

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

Create Dispatch Note

Create an internal load note for the given dispatch.

post
https://fulfillment-api.centraldispatch.com/api/fulfillments/notes

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

CreateNoteRequest

CreateNoteRequest

Details of a note.

dispatchIdstring(uuid)

The ID of the dispatch.

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

messagestring

The content of the note.

Example:Carrier called - pickup rescheduled for tomorrow.

visibilityTypestring | null

The visibility type of the note. Allowed values: INTERNAL. Defaults to INTERNAL if not provided.

Example:INTERNAL

Response

Created. Successful request.

post/api/fulfillments/notes

Body

{ "dispatchId": "d159acc0-e89b-12d3-a456-426614174000", "message": "Carrier called - pickup rescheduled for tomorrow.", "visibilityType": "INTERNAL" }