---
title: "Get Dispatch"
url: "https://stage-api-docs.centraldispatch.com/apis/stage-fulfillment-api-1-0-0/versions/8637c155-7ff6-49fa-ac0a-3b4df78c9665/operations/getDispatchById"
---
> Full API specification: https://stage-api-docs.centraldispatch.com/apis/stage-fulfillment-api-1-0-0/versions/8637c155-7ff6-49fa-ac0a-3b4df78c9665.md
# Get Dispatch
`GET` `/api/fulfillments/id/{dispatchId}`
Operation ID: `getDispatchById`
Get a dispatch by ID. #### 📝 Important Notes - The ID of the resource is returned in resource's create endpoint. The response will contain a `Location` header that contains the fully qualified URL of the newly created resource. The final segment of the URL will be the ID of the resource. - The response will include an `ETag` header, which should be used for the `If-Match` header in subsequent updates.
## Path parameters
- `dispatchId` (string, uuid, required) - The ID of the dispatch.
## Query parameters
- `includeChanges` (boolean, optional) - Indicates whether the response should include change records (dispatch status change and additional information records with the dispatch and dispatch vehicle status change and dispatch vehicle date change records with the dispatch vehicle).
- `includeNotes` (boolean, optional) - Indicates whether the response should include internal load notes for the dispatch. Notes are scoped to the caller's customer ID and profile type.
## Header parameters
- `Accept` (string, required) - 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`.
## Responses
- `200` - OK. Successful request.
- `401` - Unauthorized. Authentication failed or missing.
- `403` - Forbidden. The attempted action is not permitted.
- `404` - Not Found.
- `429` - Too Many Requests. Rate limit exceeded.
- `500` - Error.
- `503` - Service Unavailable. Temporary service interruption.
## OpenAPI definition
```yaml
openapi: 3.0.1
info:
title: Fulfillment API
version: 1.0.0
servers:
- url: https://fulfillment-api.centraldispatch.com
description: Production server
paths:
/api/fulfillments/id/{dispatchId}:
get:
tags:
- Dispatch
summary: Get Dispatch
description: >-
Get a dispatch by ID.
#### 📝 Important Notes
- The ID of the resource is returned in resource's create endpoint. The
response will contain a `Location` header that contains the fully
qualified URL of the newly created resource. The final segment of the
URL will be the ID of the resource.
- The response will include an `ETag` header, which should be used for
the `If-Match` header in subsequent updates.
operationId: getDispatchById
parameters:
- name: dispatchId
in: path
description: The ID of the dispatch.
required: true
schema:
type: string
format: uuid
example: d159acc0-e89b-12d3-a456-426614174000
- name: includeChanges
in: query
description: Indicates whether the response should include change records
(dispatch status change and additional information records with the
dispatch and dispatch vehicle status change and dispatch vehicle
date change records with the dispatch vehicle).
schema:
type: boolean
default: false
example: true
- name: includeNotes
in: query
description: Indicates whether the response should include internal load notes
for the dispatch. Notes are scoped to the caller's customer ID and
profile type.
schema:
type: boolean
default: false
example: false
- name: Accept
in: header
description: 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`.
required: true
schema:
type: string
example: application/vnd.coxauto.v1+json
responses:
"200":
description: OK. Successful request.
headers:
Etag:
description: Contains the current version of the resource and should be used for
the `If-Match` header on updates.
schema:
type: string
example: "8675300"
Last-Modified:
description: Last-Modified
schema:
type: string
example: 2024-10-15T00:00:00Z
X-CoxAuto-Media-Type:
description: Contains the major version and format information.
schema:
type: string
example: coxauto.v1; format=json
content:
application/json:
schema:
$ref: "#/components/schemas/DispatchResponse"
"401":
description: Unauthorized. Authentication failed or missing.
"403":
description: Forbidden. The attempted action is not permitted.
"404":
description: Not Found.
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorsAlt"
"429":
description: Too Many Requests. Rate limit exceeded.
"500":
description: Error.
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorsAlt"
"503":
description: Service Unavailable. Temporary service interruption.
security:
- Bearer: []
security:
- Bearer: []
components:
schemas:
DispatchResponse:
type: object
properties:
vehicles:
type: array
items:
$ref: "#/components/schemas/VehicleResponse"
description: A collection of vehicles.
stops:
type: array
items:
$ref: "#/components/schemas/StopResponse"
description: A collection of stops.
dispatchStatusChanges:
type: array
items:
$ref: "#/components/schemas/StatusChangeResponse"
description: A collection of dispatch status changes.
nullable: true
additionalInformation:
type: array
items:
$ref: "#/components/schemas/AdditionalInformationResponse"
description: Additional information (name, value pairs).
nullable: true
dispatchDrivers:
$ref: "#/components/schemas/DriversResponse"
createdDateUtc:
type: string
description: The date and time the dispatch was created, in UTC/ISO 8601 format.
format: date-time
example: 2024-08-01T00:00:00Z
lastUpdatedDateUtc:
type: string
description: The date and time the dispatch was last updated, in UTC/ISO 8601
format.
format: date-time
nullable: true
example: 2024-10-15T00:00:00Z
lastUpdatedBy:
type: string
description: The Central Dispatch user ID of the user who last updated the
dispatch.
format: uuid
nullable: true
example: d71b5750-e89b-12d3-a456-426614174000
dispatchId:
type: string
description: The ID of the dispatch.
format: uuid
example: d159acc0-e89b-12d3-a456-426614174000
priceTotal:
type: number
description: The total amount to be paid for completing the dispatch.
format: double
example: 500
priceTotalCurrency:
type: string
description: The currency of `priceTotal`.
example: USD
href:
type: string
description: The fully qualified URL of the dispatch.
example: https://fulfillment-api.centraldispatch.com/api/fulfillments/id/d159acc0-e89b-12d3-a456-426614174000
shipmentDescriptionId:
type: string
description: The ID of the shipment description.
format: uuid
example: 519e0000-e89b-12d3-a456-426614174000
recordVersion:
type: integer
description: The version of the record which should be used for the `If-Match`
header on updates.
format: int32
example: 1234567
externalId:
type: string
description: An identifier managed by the user. Shippers can use this field to
map a record (e.g. order, shipment, dispatch) in their local TMS to
a Central Dispatch record. This value is displayed as the load
number on the Central Dispatch website.
nullable: true
example: RND10 CHEV
externalCompanyId:
type: string
description: The ID of the Central Dispatch customer who is shipping the vehicle.
format: uuid
example: e8560000-e89b-12d3-a456-426614174000
carrierId:
type: string
description: The ID of the Central Dispatch customer chosen by the shipper to
move cars in the dispatch.
format: uuid
example: 0ca91a43-fbee-4c05-9a6c-aa5c63888f5c
listingId:
type: string
description: The ID of the listing from which the dispatch was created.
nullable: true
example: "42220470"
loadNumber:
type: integer
description: The load number.
format: int32
example: 987123
marketplaceId:
type: integer
description: "The ID of the Central Dispatch Marketplace. There are three types
of Marketplaces:\r
\r
- **Public**: The public Marketplace ID is `10000`.\r
- **Test**: Test Marketplace IDs will be provided to you by Central
Dispatch.\r
- **Private**: Private Marketplace IDs will be provided to you by
Central Dispatch, if necessary."
format: int32
example: 10000
shipperOrderId:
type: string
description: The ID of the shipper order.
nullable: true
example: 123-abc 900
instructions:
type: string
description: "Displayed in Central Dispatch website/app as \"Load-Specific
Terms\", these are provisions added to a contract that specify extra
obligations, rights, or conditions beyond the standard terms.\r
Real Life Example: Charging cables need to be picked up with
vehicles and if left behind a $200 fee will be applied.\r
Rules: This information will be visible only to the assigned
carrier after the load is dispatched, and it will no longer be
editable at that point."
nullable: true
example: Charging cables need to be picked up with vehicles and if left behind a
$200 fee will be applied.
codAmount:
type: number
description: The cash on delivery (COD) or cash on pick up (COP) amount due.
format: double
example: 200
codAmountCurrency:
type: string
description: The currency of `codAmount`.
example: USD
codPaymentMethod:
enum:
- CHECK
- CASH_CERTIFIED_FUNDS
type: string
description: The method for the COD/COP payment. This list is not exhaustive and
additional values may be added at any time.
nullable: true
example: CASH_CERTIFIED_FUNDS
codPaymentLocation:
enum:
- PICKUP
- DELIVERY
type: string
description: The location that COD/COP payment is due. This list is not
exhaustive and additional values may be added at any time.
nullable: true
example: PICKUP
balanceAmount:
type: number
description: The balance amount that will be due after the COD/COP payment is
applied.
format: double
example: 300
balanceAmountCurrency:
type: string
description: The currency of `balanceAmount`.
nullable: true
example: USD
balancePaymentTime:
enum:
- IMMEDIATELY
- TWO_BUSINESS_DAYS_QUICK_PAY
- FIVE_BUSINESS_DAYS
- TEN_BUSINESS_DAYS
- FIFTEEN_BUSINESS_DAYS
- THIRTY_BUSINESS_DAYS
type: string
description: The time frame when the balance payment is due. This list is not
exhaustive and additional values may be added at any time.
nullable: true
example: IMMEDIATELY
balancePaymentTermsBeginOn:
enum:
- PICKUP
- DELIVERY
- RECEIVING_SIGNED_BOL
type: string
description: The terms for beginning balance payment. This list is not
exhaustive and additional values may be added at any time.
nullable: true
example: PICKUP
balancePaymentMethod:
enum:
- CASH
- CERTIFIED_FUNDS
- COMPANY_CHECK
- COMCHEK
- TCH
type: string
description: The payment method with which the balance due payment will be paid.
This list is not exhaustive and additional values may be added at
any time.
nullable: true
example: CASH
status:
type: string
description: The status of the dispatch.
example: PENDING_PICKUP
createdBy:
type: string
description: The Central Dispatch user ID of the user who created the dispatch.
format: uuid
example: 157a16f0-503d-4256-ba60-a4876e8eb9bb
preDispatchNotes:
maxLength: 4000
type: string
description: "Provides general preparation instructions for shipments. This
should not contain sensitive data as it is made available prior to
acceptance of terms by a carrier.\r
Rules: This information will always be visible to carriers,
and it will no longer be editable once the load is dispatched."
nullable: true
example: In order to pick up the keys you will have to walk through a lot with a
big dog that protects it, he's chained but will bark at you.
transportationReleaseNotes:
maxLength: 4000
type: string
description: "Displayed in Central Dispatch website/app as \"Transport Special
Instructions\", these are specific guidelines or details for the
safe and efficient pick up, delivery, or transportation of a load.
This may contain sensitive data and is not available prior to
acceptance of terms by a carrier.\r
Rules: This information is visible only to the assigned
carrier after the load is dispatched and remains editable at any
time."
nullable: true
example: You will need special clearance to get in the lot. Call Jean at
303-999-1212.
dispatchSource:
type: string
description: "The source of the dispatch. Values: `API`, `Web`, `ListingWeb`."
nullable: true
example: API
contractTerms:
type: string
description: Terms of the legal contract between the shipper and the carrier.
nullable: true
example: Nulla poena sine lege.
isCanceledBeforeAccept:
type: boolean
description: Indicates that the dispatch was canceled before it was accepted.
example: true
requiresDriverVerificationAtPickup:
type: boolean
description: Indicates if the driver verification process is required. A driver
must be assigned to the load before delivery. Information will be
emailed to the contact physically present at the pickup location for
use in verifying the driver's identification. The Central Dispatch
Mobile App must be used to perform the pickup and delivery
inspection. (Only currently applicable to select private
Marketplaces).
example: true
paymentStatus:
type: string
description: "The status of the payment of the dispatch. Values: `UNPAID`,
`INVOICED`, `PARTIALLY_PAID`, `FULLY_PAID`."
nullable: true
example: PARTIALLY_PAID
notes:
type: array
items:
$ref: "#/components/schemas/NoteResponse"
description: A collection of internal load notes for the dispatch. Only included
when `includeNotes` is `true`.
nullable: true
description: Details of a dispatch.
ErrorsAlt:
type: object
properties:
errors:
type: array
items:
$ref: "#/components/schemas/ErrorAlt"
description: A collection of errors.
nullable: true
description: An error occurred, and the request could not be completed.
VehicleResponse:
type: object
properties:
vehicleDetails:
type: array
items:
$ref: "#/components/schemas/VehicleDetailResponse"
description: A collection of vehicle details.
nullable: true
dispatchVehicleDateChanges:
type: array
items:
$ref: "#/components/schemas/VehicleDateChangeResponse"
description: A collection of dispatch vehicle date changes.
nullable: true
dispatchVehicleStatusChanges:
type: array
items:
$ref: "#/components/schemas/VehicleStatusChangeResponse"
description: A collection of dispatch vehicle status changes.
nullable: true
shipmentDescriptionVehicleId:
type: string
description: The ID of the shipment description.
format: uuid
example: b331c130-e89b-12d3-a456-426614174000
pickupStopId:
type: string
description: The system assigned UUID of the stop.
format: uuid
example: 4e2efc84-6add-435c-9f12-8b19e3e5ba21
dropoffStopId:
type: string
description: The stop number (the sequential number of the stop along the route)
of the delivery location.
format: uuid
example: fa110000-e89b-12d3-a456-426614174000
isEnclosed:
type: boolean
description: Indicates whether the transport is enclosed.
example: true
createdDateUtc:
type: string
description: The date and time the dispatch was created, in UTC/ISO 8601 format.
format: date-time
nullable: true
example: 2024-10-31T00:00:00Z
lastUpdatedDateUtc:
type: string
description: The date and time the dispatch was last updated, in UTC/ISO 8601
format.
format: date-time
nullable: true
example: 2024-10-15T00:00:00Z
lastUpdatedBy:
type: string
description: The Central Dispatch user ID of the user who last updated the
dispatch.
format: uuid
nullable: true
example: d71b5750-e89b-12d3-a456-426614174000
dispatchVehicleId:
type: string
description: The ID of the vehicle.
format: uuid
example: b331c130-e89b-12d3-a456-426614174000
dispatchId:
type: string
description: The ID of the dispatch.
format: uuid
example: d159acc0-e89b-12d3-a456-426614174000
externalId:
type: string
description: An identifier managed by the user. Shippers can use this field to
map a record (e.g. order, shipment, dispatch) in their local TMS to
a Central Dispatch record. This value is displayed as the load
number on the Central Dispatch website.
nullable: true
example: RND10 CHEV
vehicleId:
type: string
description: The ID of the vehicle.
format: uuid
example: b331c130-e89b-12d3-a456-426614174000
vin:
type: string
description: The vehicle identification number (VIN).
nullable: true
example: KL8CH6SA6NC001234
estimatedPickupDate:
type: string
description: The estimated pick up date, in UTC/ISO 8601 format.
format: date-time
example: 2025-11-05T00:00:00.000Z
estimatedDropOffDate:
type: string
description: The estimated delivery date, in UTC/ISO 8601 format.
format: date-time
example: 2025-07-15T00:00:00.000Z
actualPickupDate:
type: string
description: The actual pick up date and time, in UTC/ISO 8601 format.
format: date-time
nullable: true
example: 2025-11-05T00:00:00.000Z
actualDropOffDate:
type: string
description: The actual delivery date and time, in UTC/ISO 8601 format.
format: date-time
nullable: true
example: 2025-08-15T00:00:00.000Z
carrierEstimatedPickupDate:
type: string
description: The date the carrier estimates the vehicle will be picked up, in
UTC/ISO 8601 format.
format: date-time
example: 2025-11-05T00:00:00.000Z
carrierEstimatedDropOffDate:
type: string
description: The date the carrier estimates the vehicle will be dropped off, in
UTC/ISO 8601 format.
format: date-time
example: 2025-07-15T00:00:00.000Z
shipperRequestedPickupDate:
type: string
description: The date the shipper would like the vehicle to be picked up, in
UTC/ISO 8601 format.
format: date-time
example: 2025-11-05T00:00:00.000Z
shipperRequestedDropOffDate:
type: string
description: The date the shipper would like the vehicle to be dropped off, in
UTC/ISO 8601 format.
format: date-time
example: 2025-07-15T00:00:00.000Z
status:
type: string
description: The status of the vehicle.
nullable: true
example: PENDING_PICKUP
carrierPrice:
type: number
description: The price to be paid to the carrier for completing the delivery of
this vehicle (reference only).
format: double
carrierPriceCurrency:
type: string
description: The currency of `carrierPrice`.
nullable: true
example: USD
distance:
type: number
description: The total travel distance.
format: double
nullable: true
example: 267
distanceUnits:
type: string
description: The units of `distance`.
nullable: true
example: MILES
externalVehicleId:
type: string
description: A vehicle identifier managed by the user. Shippers can use this
field to map a vehicle record in their local TMS to a Central
Dispatch record.
nullable: true
example: EXT123456
needAction:
type: boolean
description: Indicates whether action is needed.
default: false
example: false
inspectionType:
type: string
description: The type of inspection the vehicle requires.
nullable: true
example: ART
isDriveAway:
type: boolean
description: Indicates whether the vehicle is a drive-away.
default: false
example: true
isOversize:
type: boolean
description: Indicates whether the load is oversized.
default: false
example: false
isWideload:
type: boolean
description: Indicates whether the load is a wide load.
default: false
example: false
pickUpDateType:
type: string
description: The type of pick up date.
nullable: true
example: NO_EARLIER_THAN
dropOffDateType:
type: string
description: The type of delivery date.
nullable: true
example: ESTIMATED
requiresInspection:
type: boolean
description: Indicates the shipper requests for the carrier to use the Central
Dispatch Mobile App to perform vehicle inspection at pickup and
delivery. If true, the carrier will be asked to acknowledge the
request before accepting the load.
default: false
example: true
inspectionAcknowledged:
type: boolean
description: Indicates whether the require inspection requirement was
acknoowledged.
default: false
example: true
description: Dispatch vehicle details.
StopResponse:
type: object
properties:
shipmentDescriptionId:
type: string
description: The ID of the shipment description.
format: uuid
nullable: true
example: 519e0000-e89b-12d3-a456-426614174000
href:
type: string
description: The URL used to query the current collection of the resource.
nullable: true
example: https://fulfillment-api.centraldispatch.com/api/fulfillments/id/d159acc0-e89b-12d3-a456-426614174000
stopId:
type: string
description: The system assigned UUID of the stop.
format: uuid
example: 9b6e0fad-8722-4da1-907c-f9522c04ef12
sequenceId:
type: integer
description: The sequential number of the stop along the route e.g. 1 is the
pick up stop and 2 is the delivery stop.
format: int32
nullable: true
example: 1
stopType:
enum:
- OTHER
- AIRPORT_RENTAL_CENTER
- AUCTION
- AUCTION_SATELLITE_LOT
- COMMERCIAL_BUSINESS
- CORPORATE_OFFICE_PLANT
- CROSS_DOCK_OR_SATELLITE_STAGING_LOT
- DEALER
- IMPOUND
- MARSHALLING_YARD
- MILITARY_BASE
- MOBILE_AUCTION
- PORT
- RAIL_YARD
- RECON_FACILITY
- RENTAL_CAR_RETAIL_SITE
- REPO
- RESIDENCE
- SERVICE_CENTER
- TERMINAL
type: string
description: The facility type of the stop. This list is not exhaustive and
additional values may be added at any time.
nullable: true
example: DEALER
stopTypeDescription:
type: string
description: The name of the stop.
nullable: true
example: Dealership in the heart of the city.
locationName:
type: string
description: The name of the stop.
nullable: true
example: ABC Cars lot
externalLocationId:
type: string
description: A location identifier managed by the user.
nullable: true
example: Loc123
address:
type: string
description: The street address.
nullable: true
example: 345 W Elm St.
address2:
type: string
description: Additional street address line.
nullable: true
example: 2nd Floor
city:
type: string
description: The city.
nullable: true
example: Anaheim
state:
type: string
description: The state.
nullable: true
example: CA
zipCode:
type: string
description: The ZIP code. Must be a valid United States ZIP code or Canadian
postal code.
nullable: true
example: "92802"
country:
type: string
description: The country code. US or CA.
nullable: true
example: US
phone:
type: string
description: The primary phone number of the contact.
nullable: true
example: 949-555-0101
phone2:
type: string
description: An additional phone number of the contact.
nullable: true
example: 949-555-2434
phone3:
type: string
description: An additional phone number of the contact.
nullable: true
example: 949-555-3545
siteId:
type: string
description: The ID of the site.
nullable: true
example: ABC
contactName:
type: string
description: The name of the contact.
nullable: true
example: Mickey Smith
contactPhone:
type: string
description: The primary phone number of the contact.
nullable: true
example: 949-555-0101
contactCellPhone:
type: string
description: The cell phone number of the contact.
nullable: true
example: 949-555-1212
contactEmail:
type: string
description: The email address of the contact. Must be a valid email address
format.
nullable: true
example: mickey@snoogle.com
isTWIC:
type: boolean
description: Indicates whether the stop requires driver to have a Transportation
Worker Identification Credential (TWIC). A TWIC is a credential
required by the Maritime Transportation Security Act for carriers to
access some locations. If you are not sure if a TWIC is needed,
please contact the location.
example: true
latitude:
type: number
description: The latitude of the location.
format: double
nullable: true
example: 33.81228788622535
longitude:
type: number
description: The longitude of the location.
format: double
nullable: true
example: -117.91836265987132
buyerNumber:
type: string
description: The buyer reference number.
nullable: true
example: "12345"
description: Details of a stop.
StatusChangeResponse:
type: object
properties:
submittedByUserName:
type: string
description: The Central Dispatch username of the person who submitted the
status change.
nullable: true
example: d71b5750-e89b-12d3-a456-426614174000
dispatchStatusChangeId:
type: string
description: The ID of the dispatch status change.
format: uuid
example: 157a16f0-503d-4256-ba60-a4876e8eb9bb
dateUtc:
type: string
description: The date and time of the status change, in UTC/ISO 8601 format.
format: date-time
example: 2024-10-31T00:00:00Z
status:
type: string
description: The status of the dispatch.
nullable: true
example: PENDING_PICKUP
cancellationReasonId:
type: string
description: The ID of the cancellation reason.
nullable: true
example: cac10000-e89b-12d3-a456-426614174000
notes:
type: string
description: "Additional notes regarding the status change. **Deprecated**: Use
`estimatedDateChangeNotes` instead."
nullable: true
example: Weather delay.
estimatedDateChangeNotes:
type: string
description: Additional notes regarding the estimated date change.
nullable: true
example: Weather delay.
submittedParty:
type: string
description: The party that submitted the status change e.g. SHIPPER or CARRIER.
nullable: true
example: SHIPPER
submittedBy:
type: string
description: The Central Dispatch user ID of the user who submitted the status
change.
format: uuid
nullable: true
example: 3ca6e1c2-98fb-4b4e-bfd8-ffaec58fb347
description: Details of a status change.
AdditionalInformationResponse:
type: object
properties:
attributeName:
type: string
description: Additional information (name, value pairs).
nullable: true
example: contractedCarrier
value:
type: string
description: The name of the additional information.
nullable: true
example: "true"
description: Details of additional information.
DriversResponse:
type: object
properties:
users:
type: array
items:
type: string
format: uuid
description: A collection of user IDs representing the drivers.
nullable: true
example:
- ddd151ee-b1d3-4cec-8eb5-4a21bddd900b
- 157a16f0-503d-4256-ba60-a4876e8eb9bb
description: Details of the drivers.
nullable: true
NoteResponse:
type: object
properties:
noteId:
type: string
description: The ID of the note.
format: uuid
example: 3fde6068-5fa2-4ae4-af16-06d65fc87dc9
dispatchId:
type: string
description: The ID of the dispatch.
format: uuid
example: d159acc0-e89b-12d3-a456-426614174000
customerId:
type: string
description: The Central Dispatch customer ID of the customer.
format: uuid
example: d5c62b14-cbd1-11ee-9a0e-0242ac110002
profileType:
type: string
description: The profile type of the note author.
nullable: true
example: CARRIER
loadType:
type: string
description: The load type associated with the note.
nullable: true
example: STANDARD
displayName:
type: string
description: The display name of the note author.
nullable: true
example: Mickey Smith
message:
type: string
description: The content of the note.
example: Carrier called - pickup rescheduled for tomorrow.
createdDateUtc:
type: string
description: The creation date and time of the item, in UTC/ISO 8601 format.
format: date-time
example: 2024-10-31T00:00:00Z
createdBy:
type: string
description: The Central Dispatch user ID of the user who created the note.
Returns the user ID if the note was created by an authenticated end
user, or the client ID if created via a TMS or client-credentials
flow.
format: uuid
nullable: true
example: d71b5750-e89b-12d3-a456-426614174000
visibilityType:
type: string
description: "The visibility type of the note. Allowed values: `INTERNAL`.
Defaults to `INTERNAL` if not provided."
nullable: true
example: INTERNAL
noteSource:
type: string
description: The source of the note.
nullable: true
example: WEB
description: Details of an internal load note.
ErrorAlt:
type: object
properties:
errorID:
type: string
description: The ID of the error.
nullable: true
example: 157a16f0-503d-4256-ba60-a4876e8eb9bb
code:
type: string
description: The code used for the issue.
nullable: true
example: resource.issue_type
description:
type: string
description: A detailed message.
nullable: true
example: The issue happened because something is wrong.
properties:
type: array
items:
$ref: "#/components/schemas/ErrorAltProperty"
description: Properties related to the issue.
nullable: true
description: Details of an error or issue.
VehicleDetailResponse:
type: object
properties:
vehicleAttributes:
type: array
items:
$ref: "#/components/schemas/VehicleAttributeResponse"
description: A collection of vehicle attributes.
nullable: true
shipmentDescriptionVehicleId:
type: string
description: The ID of the shipment description.
format: uuid
nullable: true
example: 519e0000-e89b-12d3-a456-426614174000
shipmentDescriptionVehicleDetailsId:
type: string
description: The ID of the shipment description vehicle details.
format: uuid
nullable: true
example: 2539f4b4-d3d6-45db-8df3-7ba768caba9b
vin:
type: string
description: The vehicle identification number (VIN).
nullable: true
example: KL8CH6SA6NC001234
year:
type: integer
description: The 4 digit year of the vehicle.
format: int32
nullable: true
example: 2022
make:
type: string
description: The manufacturer's make of the vehicle.
nullable: true
example: Chevrolet
model:
type: string
description: The manufacturer's model of the vehicle.
nullable: true
example: Spark
subModel:
type: string
description: The manufacturer's sub-model of the vehicle.
nullable: true
example: ACTIV
trim:
type: string
description: The manufacturer's trim of the vehicle.
nullable: true
example: LS
vehicleType:
type: string
description: The type of vehicle e.g. CAR, PICKUP, SUV.
nullable: true
example: CAR
vehicleTypeDescription:
type: string
description: The description of the vehicle type.
nullable: true
example: CAR
color:
type: string
description: The color of the vehicle.
nullable: true
example: Red
weight:
type: integer
description: The weight of the vehicle.
format: int32
nullable: true
example: 2246
weightUnits:
type: string
description: The units of `weight` and `decodedWeight`.
nullable: true
example: lbs
decodedWeight:
type: integer
description: The decoded weight of the vehicle.
format: int32
nullable: true
example: 2246
size:
type: string
description: The size of the vehicle.
nullable: true
example: MEDIUM
length:
type: integer
description: The length of the vehicle.
format: int32
nullable: true
example: 143
lengthUnits:
type: string
description: The units of `length`.
default: inches
nullable: true
example: inches
decodedLength:
type: integer
description: The decoded length of the vehicle in inches.
format: int32
nullable: true
example: 143
width:
type: integer
description: The width of the vehicle.
format: int32
nullable: true
example: 62
widthUnits:
type: string
description: The units of `width`.
default: inches
nullable: true
example: "62"
decodedWidth:
type: integer
description: The decoded width of the vehicle in inches.
format: int32
nullable: true
example: 62
height:
type: integer
description: The height of the vehicle.
format: int32
nullable: true
example: 58
heightUnits:
type: string
description: The units of `height`.
default: inches
nullable: true
example: inches
decodedHeight:
type: integer
description: The decoded height of the vehicle in inches.
format: int32
nullable: true
example: 58
licensePlate:
type: string
description: The license plate of the vehicle.
nullable: true
example: B314PIE
licensePlateState:
type: string
description: The two-letter state abbreviation of the vehicle's license plate.
nullable: true
example: CA
tariff:
type: number
description: The tariff on the vehicle.
format: double
nullable: true
example: 1030.5
lotNumber:
type: string
description: The lot number of the vehicle.
nullable: true
example: LOT789
additionalInformation:
type: string
description: Additional information.
nullable: true
example: The vehicle is in the back of the lot behind the big tree.
isInOperable:
type: boolean
description: Indicates whether the vehicle is inoperable.
example: false
reportedBy:
type: string
description: The person who reported the vehicle details.
nullable: true
example: d71b5750-e89b-12d3-a456-426614174000
decodedVehicleType:
type: string
description: The decoded type of the vehicle.
nullable: true
example: CAR
fuelType:
type: string
description: The type of fuel.
nullable: true
example: Gas
description: Details of a vehicle.
VehicleDateChangeResponse:
type: object
properties:
dateType:
enum:
- ESTIMATED_PICKUP
- ACTUAL_PICKUP
- ESTIMATED_DROPOFF
- ACTUAL_DROPOFF
- SHIPPER_REQUESTED_PICKUP
- SHIPPER_REQUESTED_DROPOFF
- CARRIER_ESTIMATED_PICKUP
- CARRIER_ESTIMATED_DROPOFF
type: string
description: The type of date. This list is not exhaustive and additional values
may be added at any time.
nullable: true
example: ESTIMATED_PICKUP
priorDate:
type: string
description: The date before the change, in UTC/ISO 8601 format.
format: date-time
nullable: true
example: 2025-08-15T00:00:00.000Z
newDate:
type: string
description: The date after the change, in UTC/ISO 8601 format.
format: date-time
nullable: true
example: 2025-09-30T00:00:00.000Z
dateChangeReasonId:
type: string
description: The ID of the date change reason.
nullable: true
example: da1e0000-e89b-12d3-a456-426614174000
notes:
type: string
description: Additional notes regarding the date change.
nullable: true
example: Weather delay.
dateChangedUtc:
type: string
description: The date and time the change was made, in UTC/ISO 8601 format.
format: date-time
example: 2024-09-10T00:00:00Z
description: Details of a vehicle date change.
VehicleStatusChangeResponse:
type: object
properties:
dateUtc:
type: string
description: The date and time of the status change, in UTC/ISO 8601 format.
format: date-time
example: 2024-10-31T00:00:00Z
status:
type: string
description: The status of the vehicle.
nullable: true
example: PENDING_PICKUP
description: Details of a vehicle status change.
ErrorAltProperty:
type: object
properties:
property:
type: string
description: The name of the property.
nullable: true
example: person
value:
type: string
description: The value of the property.
nullable: true
example: J0hn D03
description: Details of an error's property.
VehicleAttributeResponse:
type: object
properties:
shipmentDescriptionVehicleAttributeId:
type: string
description: The ID of the shipment description vehicle attribute.
format: uuid
nullable: true
example: 157a16f0-503d-4256-ba60-a4876e8eb9bb
shipmentDescriptionVehicleDetailsId:
type: string
description: The ID of the shipment description vehicle details.
format: uuid
nullable: true
example: 2539f4b4-d3d6-45db-8df3-7ba768caba9b
vehicleAttributeType:
enum:
- feature
- damage
type: string
description: The type of the vehicle attribute. This list is not exhaustive and
additional values may be added at any time.
nullable: true
example: damage
attributeName:
enum:
- oversizedUnit
- convertible
- flatBed
- regularCab
- crewCab
- extendedCab
- toolBox
- ladderRack
- leftKit
- shortBed
- longBed
- is4x4
- is4x2
- singleRearWheel
- dualRearWheel
- raisedRoof
- extendedLength
- utilityBody
- cabAndChassis
- standardLength
- oversizeTires
- hasKeys
- noTires
- flatTire
- frameDamage
- doesNotRun
- doesNotSteer
- doesNotRoll
- otherInop
- otherInopNotes
- isTWIC
type: string
description: The name of the vehicle attribute. This list is not exhaustive and
additional values may be added at any time.
nullable: true
example: hasKeys
value:
type: string
description: The value of the vehicle attribute.
nullable: true
example: "true"
description: Details of a vehicle attribute.
securitySchemes:
Bearer:
type: http
scheme: Bearer
```