Dispatch Job (Update)
The Dispatch Job API "UpdateDispatch" supports updating select fields on existing Dispatch Jobs.
If any of the optional fields are not provided, the values will be unchanged. Only the values that you provide in your PUT request will be updated on the target Dispatch Job.
Request Example
https://api.cietrade.net/UpdateDispatch?UserID=Example@cieTrade.net &DispatchID=382844 &Status=Dispatched &Weight=9445 &WeightUOM=LBS &Reference=Updated Ref &RequestedBy=Updated Reqested &TruckNo=Updated TruckNo &Driver=Updated Driver &OutNo=Updated OutNo &ReturnNo=Updated returnNo &ScheduleDate=3/1/2026 &CompletionDate=3/9/2026 &DispatchNotes=Updated Notes &Questions=Updated Questions &EmailNotification=Example@cieTrade.net
Parameters
| UserID | cieTrade.net User Name, failure to provide this will not allow you to access api.cietrade.net | Required | |
| DispatchID | The ticket # of the dispatch job. The # associated with the job shown in the inquiry page as well as the top left of the Dispatch page. Failure to provide this field will return a Text string prompting the error. "[DispatchID] is a required field"
|
Required | |
| Status | Sets the status of the dispatch job, Accepted Values:('OPEN','DISPATCHED','SERVICED','COMPLETED','CANCELLED','FAILED'). If invalid value provided, the Status field will remain unchanged
|
Optional | |
| Priority
|
Accepted values:( Low, Medium, High). If invalid value provided, the Priority field will remain unchanged
|
Optional | |
| Weight | Material Weight on Dispatch Job | Optional | |
| WeightUOM | UOM of Weight. Accepted Values:('LBS','KG','MT','ST','EA')
|
Optional | |
| Reference | Reference Field | Optional | |
| RequestedBy | Requested By Field | Optional | |
| TruckNo | Truck# Field | Optional | |
| Driver | Driver Field | Optional | |
| OutNo | Equipment Out # | Optional | |
| ReturnNo | Equipment Return # | Optional | |
| ScheduleDate | Schedule Date (MM/DD/YYYY). if invalid date is provided, the Schedule Date will remain unchanged | Optional | |
| CompletionDate | Completion Date (MM/DD/YYYY). if invalid date is provided, the Schedule Date will remain unchanged | Optional | |
| DispatchNotes | Dispatch Notes Field | Optional | |
| Questions | Questions To Ask Field | Optional | |
| EmailNotification | Email Notification Field. | Optional | |
Response Examples
Upon successful dispatch Update, the ID of the dispatch job will be returned such as : “372820”