Allows to access list of transport orders.
Url parameters and connection settings
- URL: https://api.platform.trans.eu
- Endpoint: /ext/orders-api/v1/orders-received
- Method: GET
Headers:
- Content-type: application/json
- Accept: application/json
- Authorization: Bearer {access_token}
- Api-key: {unique_app_api-key}
Authorization and access
Authorization process is described here. Each API request must also consist of unique Api-key obtained during application registration together with client_id and client_secret.
Order
Details of order parameters, data range and description can be found here.
Available filters
List of available filters
- status (?filter={“status”:”proposal-rejected”})
- has_attachments (?filter={“has_attachments”: true})
- has_invoice (?filter={“has_invoice”:true})
- vat_id (?filter={“vat_id”:”1111111111″})
Sort by
- number (?sortBy=number&order=asc)
- loading date (?sortBy=freight.first_loading_place.date&order=desc)
- unloading date (?sortBy=freight.last_unloading_place.date&order=asc)
- creation date (?sortBy=created_at&order=asc)
- status (?sortBy=status.value&order=desc)
Paging
When calling GET method, page should be added as parameter in the URL, for example: https://api.platform.trans.eu/ext/orders-api/v1/orders-created?page=4
Search
- shipment external id (?search={“shipment_external_id”: “1/1/1235”})
Json example
List of orders containing one entity, each additional entity will repeat similar payload structure
[
{ "attachments": [], "created_at": "2021-06-09T13:52:29.552Z", "driver": null, "freight": { "carrier": { "assignee": null, "legal_name": "Firma Testowa", "vat_id": "111111111" }, "reference_number": null, "shipper": { "assignee": { "account_id": 750005, "family_name": "Kowalski", "given_name": "Jan", "trans_id": "1007386-1" }, "legal_name": "Firma Testowa Załadowca", "vat_id": "2222222222" }, "spots": [ { "description": "Example description", "name": "Magazine 1", "operations": [ { "loads": [], "operation_order": 1, "time_window": null, "time_window_reason": "LACK_OF_WAREHOUSE", "timespans": { "begin": "2021-06-12T13:52:27.000Z", "end": "2021-06-12T15:52:27.000Z" }, "type": "loading" } ], "place": { "address": { "country": "pl", "description": null, "locality": "Kraków", "number": "5", "postal_code": "31-001", "street": "Wawel" }, "coordinates": { "latitude": 50.06143, "longitude": 19.93658 } }, "spot_order": 1 }, { "description": null, "name": null, "operations": [ { "loads": [], "operation_order": 1, "time_window": null, "time_window_reason": "LACK_OF_WAREHOUSE", "timespans": { "begin": "2021-06-15T13:52:27.000Z", "end": "2021-06-15T15:52:27.000Z" }, "type": "unloading" } ], "place": { "address": { "country": "pl", "description": null, "locality": "Dąbrowa Środkowa", "number": "34", "postal_code": "59-330", "street": "Średnia" }, "coordinates": { "latitude": 51.41828, "longitude": 16.33485 } }, "spot_order": 2 } ] }, "id": "efc4dea5-ddd2-44d7-834d-d53d433a4de8", "invoice": null, "legacy_freight_id": null, "monitoring": { "providers": [], "required": true }, "number": "123xy4z", "payment": { "days": 365, "price": { "currency": "eur", "protected": false, "type": "km", "value": 100 } }, "source": null, "status": { "comment": null, "value": "proposal-waiting" }, "vehicle": null }
{next_order} ]