marketplaceIdstring | null
The Central Dispatch marketplace ID.
Default:null
Example:10000
Get Cancellation Reasons
Get a reference list of supported load cancellation reasons.
get
https://fulfillment-api.centraldispatch.com/api/fulfillments/loadcancellationreasons
Query Parameters
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
AddressRequest
objectDetails of an address.
address1string
The street address.
Example:345 W Elm St.
address2string
Additional street address line.
Example:2nd Floor
citystring
The city.
Example:Anaheim
statestring
The state.
Example:CA
zipCodestring
The ZIP code. Must be a valid United States ZIP code or Canadian postal code.
Example:92802
countryCodestring
The country code. US or CA.
Default:US
Example:US
Example
AssignDriverRequest
objectDetails 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
Example