--- title: "UpdateDispatchRequest" url: "https://stage-api-docs.centraldispatch.com/apis/stage-fulfillment-api-1-0-0/versions/8637c155-7ff6-49fa-ac0a-3b4df78c9665/schemas/UpdateDispatchRequest" --- > Full API specification: https://stage-api-docs.centraldispatch.com/apis/stage-fulfillment-api-1-0-0/versions/8637c155-7ff6-49fa-ac0a-3b4df78c9665.md # UpdateDispatchRequest Details of a dispatch. ## 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 components: schemas: PriceRequest: type: object properties: totalPrice: minimum: 0.01 type: number description: The total amount to be paid for completing the dispatch. format: double example: 500 priceUnits: type: string description: The currency of `totalPrice`. default: USD nullable: true example: USD description: Details of the dispatch price. StopRequest: type: object properties: stopNumber: 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 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. example: DEALER name: type: string description: The name of the stop. nullable: true example: ABC Cars lot address: $ref: "#/components/schemas/AddressRequest" contact: $ref: "#/components/schemas/ContactRequest" externalLocationId: type: string description: A location identifier managed by the user. nullable: true example: Loc123 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. default: false example: true siteId: type: string description: The ID of the site. nullable: true example: ABC latitude: type: string description: The latitude of the location. nullable: true example: "33.81228788622535" longitude: type: string description: The longitude of the location. nullable: true example: "-117.91836265987132" buyerNumber: type: string description: The buyer reference number. nullable: true example: "12345" description: Details of a stop. VehicleRequest: type: object properties: vehicleAttributes: type: array items: $ref: "#/components/schemas/VehicleAttributeRequest" description: A collection of vehicle attributes. nullable: true vehicleId: type: string description: The ID of the vehicle. A UUID will be assigned if not sent. format: uuid example: b331c130-e89b-12d3-a456-426614174000 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 vin: type: string description: The vehicle identification number (VIN). Required if `year`, `make`, `model` values are not supplied. nullable: true example: KL8CH6SA6NC001234 distance: type: number description: The total travel distance. format: double nullable: true example: 267 distanceUnits: type: string description: The units of `distance`. default: MILES nullable: true example: MILES pickUpLocationId: type: integer description: The stop number (the sequential number of the stop along the route) of the pick up location. format: int32 example: 1 dropOffLocationId: type: integer description: The stop number (the sequential number of the stop along the route) of the delivery location. format: int32 example: 2 carrierPrice: type: number description: The price to be paid to the carrier for completing the delivery of this vehicle (reference only). format: double example: 500 carrierPriceUnits: type: string description: The currency of `carrierPrice`. default: USD nullable: true example: USD type: enum: - ATV - BOAT - CAR - HEAVY_EQUIPMENT - LARGE_YACHT - MOTORCYCLE - PICKUP - RV - SUV - TRAVEL_TRAILER - VAN - OTHER type: string description: The type of vehicle e.g. CAR, PICKUP, SUV. This list is not exhaustive and additional values may be added at any time. example: CAR size: enum: - SMALL - MEDIUM - LARGE - XLARGE - WIDELOAD - OVERSIZE - OTHER type: string description: The size of the vehicle. This list is not exhaustive and additional values may be added at any time. nullable: true example: MEDIUM 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-07-15T00:00:00.000Z shipperRequestedDropOffDate: 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-08-15T00:00:00.000Z color: type: string description: The color of the vehicle. nullable: true example: Red isInOperable: type: boolean description: Indicates whether the vehicle is inoperable. example: false isEnclosed: type: boolean description: Indicates whether the transport is enclosed. default: false example: true year: type: integer description: The 4 digit year of the vehicle. Required if `vin` is not supplied. format: int32 nullable: true example: 2022 make: type: string description: The manufacturer's make of the vehicle. Required if `vin` is not supplied. nullable: true example: Chevrolet model: type: string description: The manufacturer's model of the vehicle. Required if `vin` is not supplied. nullable: true example: Spark subModel: type: string description: The manufacturer's sub-model of the vehicle. nullable: true example: ACTIV weight: type: integer description: The weight of the vehicle. format: int32 example: 2246 weightUnits: type: string description: The units of `weight`. default: LBS nullable: true example: lbs inspectionType: enum: - STANDARD - ART type: string description: The type of inspection the vehicle requires. This list is not exhaustive and additional values may be added at any time. nullable: true example: ART isDriveAway: type: boolean description: Indicates whether the vehicle is a drive-away. default: false example: true 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 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. pickUpDateType: enum: - ESTIMATED - EXACTLY - NO_EARLIER_THAN - NO_LATER_THAN type: string description: The type of pick up date. This list is not exhaustive and additional values may be added at any time. default: ESTIMATED nullable: true example: NO_EARLIER_THAN dropOffDateType: enum: - ESTIMATED - EXACTLY - NO_EARLIER_THAN - NO_LATER_THAN type: string description: The type of delivery date. This list is not exhaustive and additional values may be added at any time. default: ESTIMATED nullable: true example: ESTIMATED tariff: type: number description: The tariff on the vehicle. format: double nullable: true example: 1030.5 trim: type: string description: The manufacturer's trim of the vehicle. nullable: true example: LS fuelType: type: string description: The type of fuel. nullable: true example: Gas height: type: integer description: The height of the vehicle. format: int32 nullable: true example: 58 width: type: integer description: The width of the vehicle. format: int32 nullable: true example: 62 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 widthUnits: type: string description: The units of `width`. default: inches nullable: true example: "62" heightUnits: type: string description: The units of `height`. default: inches nullable: true example: inches 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 nullable: true example: true inspectionAcknowledged: type: boolean description: Indicates whether the require inspection requirement was acknoowledged. default: false nullable: true example: true description: Details of a vehicle. AdditionalInformationRequest: type: object properties: name: type: string description: The name of the additional information. example: contractedCarrier value: type: string description: The value of the additional information. example: "true" description: Details of additional information. AddressRequest: type: object properties: address1: type: string description: The street address. example: 345 W Elm St. address2: type: string description: Additional street address line. nullable: true example: 2nd Floor city: type: string description: The city. example: Anaheim state: type: string description: The state. example: CA zipCode: type: string description: The ZIP code. Must be a valid United States ZIP code or Canadian postal code. example: "92802" countryCode: type: string description: The country code. US or CA. default: US nullable: true example: US description: Details of an address. ContactRequest: type: object properties: name: type: string description: The name of the contact. nullable: true example: Mickey Smith phone: type: string description: The primary phone number of the contact. nullable: true example: 949-555-0101 phone1: type: string description: An additional phone number of the contact. nullable: true example: 949-555-1323 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 cellPhone: type: string description: The cell phone number of the contact. nullable: true example: 949-555-1212 email: type: string description: The email address of the contact. Must be a valid email address format. nullable: true example: mickey@snoogle.com description: Details of a contact. VehicleAttributeRequest: type: object properties: type: enum: - feature - damage type: string description: The type of the vehicle attribute. Casing must be as listed (lowercase). This list is not exhaustive and additional values may be added at any time. example: damage name: 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. Casing must be as listed (camelCase). This list is not exhaustive and additional values may be added at any time. example: hasKeys value: type: boolean description: The value of the vehicle attribute. True or false. description: Details of a vehicle attribute. UpdateDispatchRequest: type: object properties: dispatchId: type: string description: The ID of the dispatch. format: uuid example: d159acc0-e89b-12d3-a456-426614174000 externalOrderId: type: string description: The identifier of the order that created the dispatch in the shipper system managed by the user. This value is not visible on the Central Dispatch website. nullable: true example: ORD-2023-0001 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 price: $ref: "#/components/schemas/PriceRequest" stops: type: array items: $ref: "#/components/schemas/StopRequest" description: A collection of stops. vehicles: type: array items: $ref: "#/components/schemas/VehicleRequest" description: A collection of vehicles. additionalInformation: type: array items: $ref: "#/components/schemas/AdditionalInformationRequest" description: Additional information (name, value pairs). nullable: true balanceAmount: minimum: 0 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`. default: USD nullable: true example: USD balancePaymentMethod: enum: - CASH - CERTIFIED_FUNDS - COMPANY_CHECK - COMCHEK - TCH type: string description: The payment method with which the balance due payment will be paid. Required if `balanceAmount` is greater than 0. This list is not exhaustive and additional values may be added at any time. nullable: true example: CASH balancePaymentTermsBeginOn: enum: - PICKUP - DELIVERY - RECEIVING_SIGNED_BOL type: string description: The terms for beginning balance payment. Required if `balanceAmount` is greater than 0. This list is not exhaustive and additional values may be added at any time. nullable: true example: PICKUP 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. Required if `balanceAmount` is greater than 0. This list is not exhaustive and additional values may be added at any time. nullable: true example: IMMEDIATELY codAmount: minimum: 0 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`. default: USD nullable: true example: USD codPaymentLocation: enum: - PICKUP - DELIVERY type: string description: The location that COD/COP payment is due. Required if `codAmount` is greater than 0. This list is not exhaustive and additional values may be added at any time. nullable: true example: PICKUP codPaymentMethod: enum: - CHECK - CASH_CERTIFIED_FUNDS type: string description: The method for the COD/COP payment. Required if `codAmount` is greater than 0. This list is not exhaustive and additional values may be added at any time. nullable: true example: CASH_CERTIFIED_FUNDS 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. \r Note: The original `instructions` value must be sent in any update request. If a different value is provided, the update will be rejected with status code `422 Unprocessable Entity`." nullable: true example: Charging cables need to be picked up with vehicles and if left behind a $200 fee will be applied. preDispatchNotes: 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. \r Note: The original `preDispatchNotes` value must be sent in any update request. If a different value is provided, the update will be rejected with status code `422 Unprocessable Entity`." 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: 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. 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). default: false nullable: true example: true description: Details of a dispatch. nullable: true ```