Dispatch Job (Save)
The Dispatch Job API CreateDispatch supports the creation of new dispatch jobs and updates existing ones.
Request Example
https://api.cietrade.net/CreateDispatch?UserID=Example@email.com&UserPwd=abc123 &Account=CRATE AND BARREL &Location=KING OF PRUSSIA &TypeOfService=SWAP &Equipment=1.5 YARD BIN &DispatchDate=10/15/2024 &DispatchTime=09:00 &ScheduleDate=10/16/2024 &ScheduleTime=17:00 &User=UserName &ReqBy=Boss &Dept=01 &Status=OPEN &Material=waste &Carrier=Black Trucks &RcvAccount=Warehouse &RcvLocation=arlington &Priority=low &CompletedDate=10/22/2024 &CompletedTime=10:30 &ReturnNum=999 &OutNum=111 &DispatchRef=REF#0012345 ref&Weight=952 &WeightUOM=LBS &DispatchNotes=check at main gate &Questions=Who to receive &TruckNo=188 &Driver=Andrew &EmailNotification=bobr@blacktruckwaste.com &cieTradeNotes=one time request
Parameters
| UserID | cieTrade.net User Name. | Required | |
| UserPwd | cieTrade.net User Password. | Required | |
| Account | Service Account Associated With the dispatch Job. Accepts either Counterparty/Account Name, or the internal counterparty-id in cieTrade. Does not include Suppliers unless “Include both Suppliers and Customers on Dispatch Job Account list” is enabled in your cieTrade Settings. | Required | |
| Location | The Account Location associated with the Dispatch Job (where service is performed) | Required | |
| TypeOfService | Job type on dispatch job will be validated against job types defined in cieTrade |
Required | |
| DispatchDate | Record date of the job. | Required | |
| DispatchTime | Time job was created. Defaults to 9am if left blank. Use 24hr notation, for 5pm use “17:00” For 9am use “09:00” | Optional | |
| ScheduleDate | Schedule Date of the Service Request. | Required | |
| ScheduleTime | Schedule Time of the Service Request | Optional | |
| User | Name of user who created the dispatch job. Accepts either cieTrade UserName or UserID as it is stored in cietrade. | Required | |
| ReqBy | Freeform text field to record who requested the service, no internal validation on this field. | Optional | |
| Equipment | Equipment used for the dispatch job, will be validation against equipment types stored in cieTrade if provided. | Optional | |
| ServiceRecordNo | (Should be left blank ma be used at a later time.) | ||
| Dept | Department that th dispatch job will be assigned to. If field is left blank job will be automatically associated with your companies primary department. Accepts Department Shortname or internal department id within cieTrade. | Optional | |
| Status | Sets the status of the dispatch job, if left blank will be defaulted to “OPEN”. Accepts values: 'OPEN','DISPATCHED','SERVICED','COMPLETED','CANCELLED','FAILED' | Required | |
| Material | ): Accepts Grade Name, or GradeID as stored in cieTrade | Optional | |
| Carrier | Accepts either account name, or account "id" as it is stored in cieTrade | Optional | |
| RcvAccount | Required if RcvAccount is provided. Accepts Location Name for the associated receiving account. Will be verified against locations associated with the provided receiving accounto * If RcvAccount = “Warehouse”, then a valid warehouse name will be required. |
Depends | |
| Priority | Accepted values (“”, Low, Medium, High) | Optional | |
| CompletedDate | Date that the dispatch job was marked completed. format: mm/dd/yyyy | Optional | |
| CompletedTime | Time that the dispatch job was marked completed, 24hr notation (17:30 = 5:30pm). If left blank will default to 9am or 09:00. | Optional | |
| ReturnNum | "returning" Equipment number. | Optional | |
| OutNum | "set-out" Equipment number | Optional | |
| DispatchRef | Dispatch Job Notes field. | Optional | |
| Questions | Questions to ask in the field regarding this job. | Optional | |
| TruckNo | Truck equipment number | Optional | |
| Driver | Driver name of equipment or truck. | Optional | |
| EmailNotification | Email address of Hauler or Service Provider for where to send service notifications or requests to providers/haulers. | Optional | |
| cieTradeNotes | Internal cieTrade note about this dispatch job. | Optional | |
Response Examples
Upon successful dispatch creation, the ID of the newly create dispatch job will be returned such as : “372820”
Required field errors or validation errors: If any of the required fields are not provided, you will receive a response outlining the missing required fields.
Validation failure: If the values provided for the dispatch job do not match values that exist within cieTrade you will receive a string outlining the fields that do not have valid values.