StopRequest
objectDetails of a stop.
The sequential number of the stop along the route e.g. 1 is the pick up stop and 2 is the delivery stop.
Example:1
The facility type of the stop. This list is not exhaustive and additional values may be added at any time.
Allowed values:OTHERAIRPORT_RENTAL_CENTERAUCTIONAUCTION_SATELLITE_LOTCOMMERCIAL_BUSINESSCORPORATE_OFFICE_PLANTCROSS_DOCK_OR_SATELLITE_STAGING_LOTDEALERIMPOUNDMARSHALLING_YARDMILITARY_BASEMOBILE_AUCTIONPORTRAIL_YARDRECON_FACILITYRENTAL_CAR_RETAIL_SITEREPORESIDENCESERVICE_CENTERTERMINAL
Example:DEALER
The name of the stop.
Example:ABC Cars lot
Details of an address.
Show Child Parameters
Details of a contact.
Show Child Parameters
A location identifier managed by the user.
Example:Loc123
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.
Default:false
Example:true
The ID of the site.
Example:ABC
The latitude of the location.
Example:33.81228788622535
The longitude of the location.
Example:-117.91836265987132
The buyer reference number.
Example:12345
StopResponse
objectDetails of a stop.
The ID of the shipment description.
Example:519e0000-e89b-12d3-a456-426614174000
The URL used to query the current collection of the resource.
Example:https://fulfillment-api.centraldispatch.com/api/fulfillments/id/d159acc0-e89b-12d3-a456-426614174000
The system assigned UUID of the stop.
Example:9b6e0fad-8722-4da1-907c-f9522c04ef12
The sequential number of the stop along the route e.g. 1 is the pick up stop and 2 is the delivery stop.
Example:1
The facility type of the stop. This list is not exhaustive and additional values may be added at any time.
Allowed values:OTHERAIRPORT_RENTAL_CENTERAUCTIONAUCTION_SATELLITE_LOTCOMMERCIAL_BUSINESSCORPORATE_OFFICE_PLANTCROSS_DOCK_OR_SATELLITE_STAGING_LOTDEALERIMPOUNDMARSHALLING_YARDMILITARY_BASEMOBILE_AUCTIONPORTRAIL_YARDRECON_FACILITYRENTAL_CAR_RETAIL_SITEREPORESIDENCESERVICE_CENTERTERMINAL
Example:DEALER
The name of the stop.
Example:Dealership in the heart of the city.
The name of the stop.
Example:ABC Cars lot
A location identifier managed by the user.
Example:Loc123
The street address.
Example:345 W Elm St.
Additional street address line.
Example:2nd Floor
The city.
Example:Anaheim
The state.
Example:CA
The ZIP code. Must be a valid United States ZIP code or Canadian postal code.
Example:92802
The country code. US or CA.
Example:US
The primary phone number of the contact.
Example:949-555-0101
An additional phone number of the contact.
Example:949-555-2434
An additional phone number of the contact.
Example:949-555-3545
The ID of the site.
Example:ABC
The name of the contact.
Example:Mickey Smith
The primary phone number of the contact.
Example:949-555-0101
The cell phone number of the contact.
Example:949-555-1212
The email address of the contact. Must be a valid email address format.
Example:mickey@snoogle.com
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
The latitude of the location.
Example:33.81228788622535
The longitude of the location.
Example:-117.91836265987132
The buyer reference number.
Example:12345
UpdateDispatchDatesRequest
objectDetails of dispatch vehicle date item.
The ID of the dispatch.
Example:d159acc0-e89b-12d3-a456-426614174000
Details of dispatch vehicle dates.
Show Child Parameters
UpdateDispatchDatesVehicleDateChangeRequest
objectDetails of vehicle dates.
The type of date. This list is not exhaustive and additional values may be added at any time.
Allowed values:ESTIMATED_PICKUPACTUAL_PICKUPESTIMATED_DROPOFFACTUAL_DROPOFFSHIPPER_REQUESTED_PICKUPSHIPPER_REQUESTED_DROPOFFCARRIER_ESTIMATED_PICKUPCARRIER_ESTIMATED_DROPOFF
Example:ESTIMATED_PICKUP
The date, in UTC/ISO 8601 format.
The ID of the date change reason. This value can be retrieved using the ‘Get Date Change Reasons’ endpoint. Required for carrier.
Additional information.
Example:Shipper needs more time to prepare the vehicle.
UpdateDispatchDatesVehiclesRequest
objectDetails of dispatch vehicle dates.
The ID of the vehicle.
Example:b331c130-e89b-12d3-a456-426614174000
Details of vehicle dates.