Skip to main content

​
API Url

https://{company_name}.datatruck.io/api/v1/openapi/orders/
Here, please put your company name in the url. Ex: if it is CompanyX company, then url should be 
https://companyx.datatruck.io/api/v1/openapi/orders/

​
Sample request

curl --request GET \
--url https://{company_name}.datatruck.io/api/v1/openapi/orders/ \
--header "Authorization: Token cc92174571ac12f386e5657b187d39bb210f3270a837730125ed4029a44fsdfasd" \
--header "Content-Type: application/json"

​
Sample response

The Datatruck API returns JSON-encoded responses (It is list of loads): 
[
    {
        "id": 2489,
        "load_id": "T-111QT34XS",
        "shipment_id": "DT-002489",
        "status": "dispatched",
        "load_pay": 148.17,
        "total_miles": 574.31,
        "created_datetime": "2023-10-11T13:42:54.456045Z",
        "created_by__full_name": "Super Admin",
        "total_other_pay": 122.0,
        "total_pay": 270.17,
        "per_mile_revenue": 0.26,
        "tags": [
            {
                "name": "AUTOBOT"
            }
        ],
        "dispatcher__full_name": " ",
        "customer__company_name": "string",
        "mc_number__company_name": "Updated Test Mc Number",
        "office__office_name": null,
        "pickup_appointment_time": "2023-10-08T20:00:00Z",
        "delivery_appointment_time": "2023-10-11T23:14:00Z",
        "pickup_time": "2023-10-08T20:00:00Z",
        "delivery_time": "2023-10-11T23:14:00Z",
        "trip": {
            "id": 1913,
            "status": "assigned",
            "trip_id": "TR-002489-01",
            "mile": 574.31,
            "empty_mile": 0.0,
            "total_load_pay": 148.17,
            "carrier__name": null,
            "driver__full_name": "awefas fasdfads",
            "team_driver__full_name": " ",
            "truck__unit_number": "2105",
            "pickup": {
                "id": 1348,
                "company": "DWA9",
                "address1": "3711 142nd Ave E, Sumner, WA 98390, USA",
                "city": "Sumner",
                "state": "Washington",
                "zip_code": "98390"
            },
            "delivery": {
                "id": 1348,
                "company": "DWA9",
                "address1": "3711 142nd Ave E, Sumner, WA 98390, USA",
                "city": "Sumner",
                "state": "Washington",
                "zip_code": "98390"
            },
            "settlement": null
        },
        "batch_orders": null
    }
]

​
Filters

You can apply filters by giving filter=[] in query parameter. 
https://{company_name}.datatruck.io/api/v1/openapi/orders/?filter=[{"contains":"between","column":"delivery_time","value":"2024-06-26T00:00:00.000Z,2024-07-10T23:59:59.000Z"}]
Contains can be: “between”, “before” or “after”. When it is “between”, it returns loads in this datetime range. When it is “after”, it returns loads after this datetime. When it is “before”, it returns loads before this datetime. For “before” and “after” the query parameter should be as following: 
https://{company_name}.datatruck.io/api/v1/openapi/orders/?filter=[{"contains":"after","column":"delivery_time","value":"2024-06-26T00:00:00.000Z"}]