dispatchIdstring(uuid)required
The ID of the dispatch.
Example:d159acc0-e89b-12d3-a456-426614174000
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
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, 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"
}
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
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
Authentication
Headers
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)
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
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
Authentication
Query Parameters
Headers
application/json
AdditionalInformationRequest
objectDetails of additional information.
namestring
The name of the additional information.
Example:contractedCarrier
valuestring
The value of the additional information.
Example:true
Example
AdditionalInformationResponse
objectDetails of additional information.
attributeNamestring
Additional information (name, value pairs).
Example:contractedCarrier
valuestring
The name of the additional information.
Example:true
Example