Dispatch Jobs

A Dispatch Job is an on-demand service request for a specified customer to be fulfilled by a specified vendor/hauler/service-provider on a scheduled date and time for a specific customer location and equipment type. The ListDispatchJobs API returns a list of Dispatch Jobs with associated Customer, Location, Service provider, schedule date and other details as a JSON data table. Each row in the return data set is an individual Dispatch Job request.

Request Example

https://api.cietrade.net/ListDispatchJobs?UserID=ExampleUser@gmail.com&UserPwd=123ABC&DateFrom=05/05/2024&DateTo=06/05/2024&Type=Schedule&AccountName=TargetAccount&Location=TargetLocation

Query Parameters (Filters)

UserID	cieTrade.net User Name.	Required
UserPwd	cieTrade.net User Password.	Required
Account	Target Account. Use exact company name as defined, the Account ID or blank value for all accounts.	Optional
Location	Target Dispatch Job Location or blank value for all locations of the specified Account parameter (above). Cannot have a value without an Account parameter.	Optional
DateFrom	Start of date range. Optional, if not provided, it will default to 30 days from today's date.	Optional
DateTo	End of date range. Optional, if not provided, it will default to Todays Date.	Optional
DateType	Inquiry date type either "Schedule" or "Dispatch". Sets whether the date filter is based off Scheduled Date or Dispatch Job create Date. if not provided, it will default to schedule Date	Optional
Dept	Department Filter Example: “00” as it is stored in cieTrade, or Department Short Name. This parameter is Optional, no default value if not provided.	Optional
Vendor	Hauler or vendor servicing account. Pass the exact company name as listed in cieTrade or the vendor’s account ID. Blank value defaults to all.	Optional

Response Example

{
        "job_id": 55304,
        "account_name": "3 R RECYCLING SOLUTION",
        "location_name": "Avon",
        "schedule_date": "2024-05-27",
        "schedule_time": "00:00:00",
        "equipment_type": "1100 litre Container",
        "job_type": "AD PICKUP",
        "vendor_name": "3P GLOBAL RESOURCES LLC",
        "status": "OPEN",
        "material": "",
        "completed_date": null,
        "completed_time": "00:00:00",
        "department": "ALLEGHENY",
        "dispatch_date": "2024-05-16",
        "dispatch_time": "00:00:00",
        "requested_by": "bob",
        "invoice_id": null,
        "username": "Kyle",
        "weight": "0",
        "weight_unit_of_measure": "",
        "service_address": "3 R RECYCLING SOLUTIONS 13 Robbie Rd  Avon MA 2322 USA",
        "notes": ""
    }