Requests and filters

All requests to the Dashdoc API must be made over SSL (https, not http).

We recommend using JSON body format when performing API requests. In order to do a proper JSON-formatted request, make sure you provide Content-Type: application/json in HTTP request headers. XML data is also supported, see Sending XML data.

Our API uses the HTTP verbs for each action:\

MethodDescription

GET

Used for retrieving resources.

POST

Used for creating resources.

PUT

Used for replacing resources or collections.

PATCH

Used for partially updating resources or collections.

DELETE

Used for deleting resources.

URL Naming

Our API uses a straight-forward URL naming convention.

  • Each request must be made to the API endpoint https://www.dashdoc.com/api/v4/, followed by the type of object in a plural form, for example https://www.dashdoc.com/api/v4/transports/

  • When one item is being asked and such method exists, the UID of the item must be appended to the URL, for examplehttps://www.dashdoc.eu/api/v3/transports/51d1a23d-79de-4280-8e10-1a0309f3fc54/

  • The API token must be provided as part of the http header for all requests using the Authorization field:

Example of curl authenticated request
curl -X GET -H "Authorization: Token 5a4d02fad3975c169e9f538d8e733ead4069703x" "https://www.dashdoc.eu/api/v4/"

Filters

You can pass in filters to indicate which data you would like to fetch when asking for a collection/list of objects. When provided, you can add comparison filters that are separated from the field a double underscore:

FilterDescription

__gt

Greater than

__gte

Greater than or equal

__lt

Lower than

__lte

Lower than or equal

__in

Filter among multiple values, separated by commas

__exclude

Exclude multiple value, separated by commas

__not

Exclude single value

Most endpoints in our API support this.

For example, you may only want to fetch transports that were updated after a given date. We'll use the __gte to do that. This can be done using the following syntax:

Filtering transports on updated date

GET https://www.dashdoc.eu/api/v3/transports/?updated__gte=2018-12-31T00:00:00Z

Path Parameters

NameTypeDescription

updated__gte

string

Format for dates is yyyy-mm-ddThh:mm:ssZ

Headers

NameTypeDescription

Authentication

string

Send your token `Token YOUR_API_TOKEN`

{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "uid": "1cb778c11-1cf3-11ea-8c64-0242ac110007",
            "sequential_id": 481730,
            "created": "2019-12-12T15:21:47.275159Z",
            "updated": "2019-12-20T13:17:02.832990Z",
            "remote_id": "",
            "carrier_address": {
                "pk": 4846084,
                "name": "Transports Test",
                "address": "4 CHEMIN DU MOULIN",
                "city": "FRANCHEVILLE",
                "postcode": "28800",
                "country": "FR",
                "latitude": 48.192288,
                "longitude": 1.278002,
                "coords_validated": false,
                "is_demo": false,
                "is_carrier": true,
                "is_shipper": false,
                "is_origin": false,
                "is_destination": false,
                "created_by": 263923,
                "created": "2019-12-12T15:21:47.264481Z",
                "company": {
                    "pk": 263984,
                    "name": "FERRET CENTRE",
                    "phone_number": null,
                    "email": null,
                    "siren": "",
                    "trade_number": "44951345600037",
                    "vat_number": "FR449513456",
                    "settings": {
                        "cmr_only": false,
                        "print_mode": false,
                        "contract_html": "",
                        "signature_process": "skippable_electronic_signature",
                        "special_agreements": "",
                        "stamp": null,
                        "logo": null,
                        "tracking_page_logo": null
                    }
                },
                "original": 4573849
            },
            "created_by": {
                "pk": 263923,
                "name": "ENVIRONN'",
                "trade_number": "",
                "settings_contract_html": "",
                "settings_logo": null,
                "settings_stamp": null,
                "settings_tracking_page_logo": null,
                "settings_print_mode": false
            },
            "created_device": null,
            "creation_method": "web_app",
            "is_order": true,
            "archived_by": [],
            "invite_code": "RVQRWA",
            "deliveries": [
                {
                    "uid": "1ccd57zx-1cf3-11ea-8c64-0242ac110007",
                    "sequential_id": 532266,
                    "remote_id": "",
                    "tracking_id": "1CCD5A-101CF3",
                    "origin": {
                        "uid": "157616277856378hTf4fd",
                        "address": {
                            "pk": 4846087,
                            "name": "POMPSUD",
                            "address": "VALDESEINE",
                            "city": "DURANTON",
                            "postcode": "94460",
                            "country": "FR",
                            "latitude": 48.768732,
                            "longitude": 2.446657,
                            "coords_validated": false,
                            "is_demo": false,
                            "is_carrier": false,
                            "is_shipper": false,
                            "is_origin": true,
                            "is_destination": false,
                            "created_by": 263923,
                            "created": "2019-12-12T15:21:47.387207Z",
                            "company": {
                                "pk": 264008,
                                "name": "POMPSUD",
                                "trade_number": "",
                                "settings_contract_html": "",
                                "settings_logo": null,
                                "settings_stamp": null,
                                "settings_tracking_page_logo": null,
                                "settings_print_mode": false
                            },
                            "original": 4573902
                        },
                        "arrival_date": "2019-12-18",
                        "date_exact": true,
                        "arrival_time_min": "13:00",
                        "arrival_time_max": "15:00",
                        "signature_process": "skippable_electronic_signature",
                        "loading_instructions": "",
                        "unloading_instructions": "",
                        "reference": "",
                        "action": "",
                        "eta": null
                    },
                    "destination": {
                        "uid": "1576162778563763O5Eax",
                        "address": {
                            "pk": 4846088,
                            "name": "POITOU",
                            "address": "ENVIRONN'",
                            "city": "PALONNES",
                            "postcode": "86220",
                            "country": "FR",
                            "latitude": 46.8543067,
                            "longitude": 0.5903828,
                            "coords_validated": false,
                            "is_demo": false,
                            "is_carrier": false,
                            "is_shipper": false,
                            "is_origin": false,
                            "is_destination": true,
                            "created_by": 263923,
                            "created": "2019-12-12T15:21:47.395828Z",
                            "company": {
                                "pk": 263991,
                                "name": "POITOU",
                                "trade_number": "",
                                "settings_contract_html": "",
                                "settings_logo": null,
                                "settings_stamp": null,
                                "settings_tracking_page_logo": null,
                                "settings_print_mode": false
                            },
                            "original": 4573865
                        },
                        "arrival_date": "2019-12-19",
                        "date_exact": true,
                        "arrival_time_min": null,
                        "arrival_time_max": null,
                        "signature_process": "skippable_electronic_signature",
                        "loading_instructions": "",
                        "unloading_instructions": "",
                        "reference": "",
                        "action": "",
                        "eta": null
                    },
                    "shipper_address": {
                        "pk": 4846089,
                        "name": "ENVIRONN'",
                        "address": "21/23 Rue du petit Albi",
                        "city": "Cergy Saint-Christophe",
                        "postcode": "95800",
                        "country": "FR",
                        "latitude": 49.0536258,
                        "longitude": 2.0357387,
                        "coords_validated": false,
                        "is_demo": false,
                        "is_carrier": false,
                        "is_shipper": true,
                        "is_origin": false,
                        "is_destination": false,
                        "created_by": 263923,
                        "created": "2019-12-12T15:21:47.409875Z",
                        "company": {
                            "pk": 263923,
                            "name": "ENVIRONN'",
                            "trade_number": "",
                            "settings_contract_html": "",
                            "settings_logo": null,
                            "settings_stamp": null,
                            "settings_tracking_page_logo": null,
                            "settings_print_mode": false
                        },
                        "original": 4572517
                    },
                    "loads": [
                        {
                            "uid": "892331xa-1cf3-11ea-9c7d-0242ac110007",
                            "remote_id": "",
                            "description": "Boue d'épuration séchée thermiquement",
                            "weight": "28000",
                            "height": null,
                            "width": null,
                            "length": null,
                            "pallet_format": "",
                            "volume": "",
                            "volume_unit": "m3",
                            "linear_meters": "",
                            "quantity": null,
                            "category": "bulk",
                            "dangerous_goods_category": "4.2",
                            "complementary_information": "BS546",
                            "container_number": "",
                            "tare_weight": "",
                            "container_seal_number": "",
                            "refrigerated": false,
                            "temperature": "",
                            "steres": null
                        }
                    ],
                    "planned_loads": [
                        {
                            "uid": "892331xa-1cf3-11ea-9c7d-0242ac110007",
                            "remote_id": "",
                            "description": "Boue d'épuration séchée thermiquement",
                            "weight": "28000",
                            "height": null,
                            "width": null,
                            "length": null,
                            "pallet_format": "",
                            "volume": "",
                            "volume_unit": "m3",
                            "linear_meters": "",
                            "quantity": null,
                            "category": "bulk",
                            "dangerous_goods_category": "4.2",
                            "complementary_information": "BS546",
                            "container_number": "",
                            "tare_weight": "",
                            "container_seal_number": "",
                            "refrigerated": false,
                            "temperature": "",
                            "steres": null
                        }
                    ],
                    "origin_loads": null,
                    "destination_loads": null,
                    "tracking_contacts": [],
                    "shipper_reference": "",
                    "multiple_rounds": false,
                    "invoicing_address": null
                }
            ],
            "segments": [
                {
                    "uid": "1cc3dbpl-1cf3-11ea-8c64-0242ac110007",
                    "remote_id": "",
                    "trucker": null,
                    "origin": {
                        "uid": "157616277856378hTf4fd",
                        "address": {
                            "pk": 4846087,
                            "name": "POMPSUD",
                            "address": "VALDESEINE",
                            "city": "DURANTON",
                            "postcode": "94460",
                            "country": "FR",
                            "latitude": 48.768732,
                            "longitude": 2.446657,
                            "coords_validated": false,
                            "is_demo": false,
                            "is_carrier": false,
                            "is_shipper": false,
                            "is_origin": true,
                            "is_destination": false,
                            "created_by": 263923,
                            "created": "2019-12-12T15:21:47.387207Z",
                            "company": {
                                "pk": 264008,
                                "name": "POMPSUD",
                                "trade_number": "",
                                "settings_contract_html": "",
                                "settings_logo": null,
                                "settings_stamp": null,
                                "settings_tracking_page_logo": null,
                                "settings_print_mode": false
                            },
                            "original": 4573902
                        },
                        "arrival_date": "2019-12-18",
                        "date_exact": true,
                        "arrival_time_min": "13:00",
                        "arrival_time_max": "15:00",
                        "signature_process": "skippable_electronic_signature",
                        "loading_instructions": "",
                        "unloading_instructions": "",
                        "reference": "",
                        "action": "",
                        "eta": null
                    },
                    "destination": {
                        "uid": "1576162778563763O5Eax",
                        "address": {
                            "pk": 4846088,
                            "name": "POITOU",
                            "address": "ENVIRONN'",
                            "city": "PALONNES",
                            "postcode": "86220",
                            "country": "FR",
                            "latitude": 46.8543067,
                            "longitude": 0.5903828,
                            "coords_validated": false,
                            "is_demo": false,
                            "is_carrier": false,
                            "is_shipper": false,
                            "is_origin": false,
                            "is_destination": true,
                            "created_by": 263923,
                            "created": "2019-12-12T15:21:47.395828Z",
                            "company": {
                                "pk": 263991,
                                "name": "POITOU",
                                "trade_number": "",
                                "settings_contract_html": "",
                                "settings_logo": null,
                                "settings_stamp": null,
                                "settings_tracking_page_logo": null,
                                "settings_print_mode": false
                            },
                            "original": 4573865
                        },
                        "arrival_date": "2019-12-19",
                        "date_exact": true,
                        "arrival_time_min": null,
                        "arrival_time_max": null,
                        "signature_process": "skippable_electronic_signature",
                        "loading_instructions": "",
                        "unloading_instructions": "",
                        "reference": "",
                        "action": "",
                        "eta": null
                    },
                    "vehicle": null,
                    "trailers": [],
                    "sort_order": 0
                }
            ],
            "status": "done",
            "status_updates": [
                {
                    "uid": "1cb9c964-1cf3-11ea-8c64-0242ac110007",
                    "created": "2019-12-12T15:21:47.279317Z",
                    "created_device": null,
                    "creation_method": "auto",
                    "category": "created",
                    "author": {
                        "display_name": "Jean Lassalle",
                        "company": 263923,
                        "pk": 151478
                    },
                    "content": "",
                    "content_signatory": "",
                    "target": null,
                    "site": null,
                    "delivery": null,
                    "segment": null,
                    "transport": "1cb778c11-1cf3-11ea-8c64-0242ac110007",
                    "holder_exchanges": [],
                    "signature": null,
                    "latitude": null,
                    "longitude": null,
                    "update_details": null
                },
                {
                    "uid": "893aac52-1cf3-11ea-9c7d-0242ac110007",
                    "created": "2019-12-12T15:24:49.317958Z",
                    "created_device": null,
                    "creation_method": "auto",
                    "category": "updated",
                    "author": {
                        "display_name": "Jean Lassalle",
                        "company": 263923,
                        "pk": 151478
                    },
                    "content": "",
                    "content_signatory": "",
                    "target": null,
                    "site": null,
                    "delivery": "1ccd57zx-1cf3-11ea-8c64-0242ac110007",
                    "segment": null,
                    "transport": "1cb778c11-1cf3-11ea-8c64-0242ac110007",
                    "holder_exchanges": [],
                    "signature": null,
                    "latitude": null,
                    "longitude": null,
                    "update_details": {
                        "deliveries": [
                            {
                                "loads": [
                                    {
                                        "new": "Vrac, Boue d'épuration séchée thermiquement, 28000kg",
                                        "old": null
                                    }
                                ],
                                "planned_loads": [
                                    {
                                        "new": "Vrac, Boue d'épuration séchée thermiquement, 28000kg",
                                        "old": null
                                    }
                                ]
                            }
                        ]
                    }
                },
                {
                    "uid": "89eeeba4-1cf3-11ea-9c7d-0242ac110007",
                    "created": "2019-12-12T15:24:50.499380Z",
                    "created_device": null,
                    "creation_method": "auto",
                    "category": "updated",
                    "author": {
                        "display_name": "Jean Lassalle",
                        "company": 263923,
                        "pk": 151478
                    },
                    "content": "",
                    "content_signatory": "",
                    "target": null,
                    "site": null,
                    "delivery": null,
                    "segment": null,
                    "transport": "1cb778c11-1cf3-11ea-8c64-0242ac110007",
                    "holder_exchanges": [],
                    "signature": null,
                    "latitude": null,
                    "longitude": null,
                    "update_details": {}
                },
                {
                    "uid": "62a990e2-1d7c-11ea-87c3-0242ac110007",
                    "created": "2019-12-13T07:44:25.665515Z",
                    "created_device": null,
                    "creation_method": "manager",
                    "category": "confirmed",
                    "author": {
                        "display_name": "Bastien Becquerel",
                        "company": 263923,
                        "pk": 151512
                    },
                    "content": "",
                    "content_signatory": "",
                    "target": null,
                    "site": null,
                    "delivery": null,
                    "segment": null,
                    "transport": "1cb778c11-1cf3-11ea-8c64-0242ac110007",
                    "holder_exchanges": [],
                    "signature": null,
                    "latitude": null,
                    "longitude": null,
                    "update_details": null
                },
                {
                    "uid": "02e2866e-232b-11ea-939f-0242ac110007",
                    "created": "2019-12-20T13:17:02.781429Z",
                    "created_device": null,
                    "creation_method": "manager",
                    "category": "on_loading_site",
                    "author": {
                        "display_name": "Jean Lassalle",
                        "company": 263923,
                        "pk": 151478
                    },
                    "content": "",
                    "content_signatory": "",
                    "target": null,
                    "site": "157616277856378hTf4fd",
                    "delivery": null,
                    "segment": null,
                    "transport": "1cb778c11-1cf3-11ea-8c64-0242ac110007",
                    "holder_exchanges": [],
                    "signature": null,
                    "latitude": null,
                    "longitude": null,
                    "update_details": null
                },
                {
                    "uid": "02e40ec6-232b-11ea-939f-0242ac110007",
                    "created": "2019-12-20T13:17:02.781667Z",
                    "created_device": null,
                    "creation_method": "manager",
                    "category": "loading_complete",
                    "author": {
                        "display_name": "Jean Lassalle",
                        "company": 263923,
                        "pk": 151478
                    },
                    "content": "",
                    "content_signatory": "",
                    "target": null,
                    "site": "157616277856378hTf4fd",
                    "delivery": null,
                    "segment": null,
                    "transport": "1cb778c11-1cf3-11ea-8c64-0242ac110007",
                    "holder_exchanges": [],
                    "signature": null,
                    "latitude": null,
                    "longitude": null,
                    "update_details": null
                },
                {
                    "uid": "02e8675a-232b-11ea-939f-0242ac110007",
                    "created": "2019-12-20T13:17:02.790059Z",
                    "created_device": null,
                    "creation_method": "manager",
                    "category": "on_unloading_site",
                    "author": {
                        "display_name": "Jean Lassalle",
                        "company": 263923,
                        "pk": 151478
                    },
                    "content": "",
                    "content_signatory": "",
                    "target": null,
                    "site": "1576162778563763O5Eax",
                    "delivery": null,
                    "segment": null,
                    "transport": "1cb778c11-1cf3-11ea-8c64-0242ac110007",
                    "holder_exchanges": [],
                    "signature": null,
                    "latitude": null,
                    "longitude": null,
                    "update_details": null
                },
                {
                    "uid": "02ebf032-232b-11ea-939f-0242ac110007",
                    "created": "2019-12-20T13:17:02.790183Z",
                    "created_device": null,
                    "creation_method": "manager",
                    "category": "unloading_complete",
                    "author": {
                        "display_name": "Jean Lassalle",
                        "company": 263923,
                        "pk": 151478
                    },
                    "content": "",
                    "content_signatory": "",
                    "target": null,
                    "site": "1576162778563763O5Eax",
                    "delivery": null,
                    "segment": null,
                    "transport": "1cb778c11-1cf3-11ea-8c64-0242ac110007",
                    "holder_exchanges": [],
                    "signature": null,
                    "latitude": null,
                    "longitude": null,
                    "update_details": null
                },
                {
                    "uid": "02ef705e-232b-11ea-939f-0242ac110007",
                    "created": "2019-12-20T13:17:02.803931Z",
                    "created_device": null,
                    "creation_method": "manager",
                    "category": "done",
                    "author": {
                        "display_name": "Jean Lassalle",
                        "company": 263923,
                        "pk": 151478
                    },
                    "content": "",
                    "content_signatory": "",
                    "target": null,
                    "site": null,
                    "delivery": null,
                    "segment": null,
                    "transport": "1cb778c11-1cf3-11ea-8c64-0242ac110007",
                    "holder_exchanges": [],
                    "signature": null,
                    "latitude": null,
                    "longitude": null,
                    "update_details": null
                }
            ],
            "has_observations": false,
            "messages": [
                {
                    "uid": "50f58416-1cf3-11ea-9c7d-0242ac110007",
                    "created": "2019-12-12T15:23:14.912496Z",
                    "created_device": null,
                    "creation_method": "manager",
                    "author": {
                        "display_name": "Auguste Leroir",
                        "company": 263923,
                        "pk": 145248
                    },
                    "type": "document",
                    "document_title": "PS_C_FERRET_DURANTON_2019.pdf",
                    "document_type": "",
                    "document": "https://storage.googleapis.com/dashdoc-media/media/shipments/f39f1b1e-97e5-461a-b008-37d6cdd624b9.pdf",
                    "visibility_level": "everyone",
                    "is_attached_to_cmr": false,
                    "transport": "1cb778c11-1cf3-11ea-8c64-0242ac110007",
                    "message": null,
                    "delivery": "1ccd57zx-1cf3-11ea-8c64-0242ac110007",
                    "latitude": null,
                    "longitude": null
                },
                {
                    "uid": "9056614c-1cf4-11ea-a135-0242ac110007",
                    "created": "2019-12-12T15:32:10.740313Z",
                    "created_device": null,
                    "creation_method": "manager",
                    "author": {
                        "display_name": "Auguste Leroir",
                        "company": 263923,
                        "pk": 145248
                    },
                    "type": "document",
                    "document_title": "PS_D_FERRET_PALONNES_2018.pdf",
                    "document_type": "",
                    "document": "https://storage.googleapis.com/dashdoc-media/media/shipments/d9a70a7b-f2eb-4148-8c6f-189a151941d3.pdf",
                    "visibility_level": "everyone",
                    "is_attached_to_cmr": false,
                    "transport": "1cb778c11-1cf3-11ea-8c64-0242ac110007",
                    "message": null,
                    "delivery": "1ccd57zx-1cf3-11ea-8c64-0242ac110007",
                    "latitude": null,
                    "longitude": null
                }
            ],
            "requested_vehicle": "tractor_trailer",
            "documents": [
                {
                    "pk": 498848,
                    "file_updated_date": "2019-12-13T07:44:25.785620Z",
                    "delivery": null,
                    "category": "chc",
                    "name": "Charter confirmation",
                    "file": "https://test.dashdoc.eu/api/delivery-documents/62aeeb44-1d7c-11ea-87c3-0242ac110007"
                },
                {
                    "pk": 497112,
                    "file_updated_date": "2019-12-20T13:17:03.342620Z",
                    "delivery": "1ccd57zx-1cf3-11ea-8c64-0242ac110007",
                    "category": "ldv",
                    "name": "National bill of lading",
                    "file": "https://test.dashdoc.eu/api/delivery-documents/1cd1e6as-1cf3-11ea-8c64-0242ac110007"
                },
                {
                    "pk": 497111,
                    "file_updated_date": "2019-12-12T15:21:47.786533Z",
                    "delivery": null,
                    "category": "orc",
                    "name": "Order confirmation",
                    "file": "https://www.dashdoc.eu/api/delivery-documents/1cbeb833-1cf3-11ea-8c64-0242ac110007"
                }
            ],
            "carrier_reference": "",
            "price": 1088.0,
            "requires_washing": false,
            "business_privacy": false
        }
    ]
}

Last updated