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/{order-id}
- 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
Full description of order details and parameters can be found here.
Json example:
Example of details of received oreder
{ "additional_terms": null, "archived_at": null, "attachments": [], "can_archive": false, "cancellation": null, "cooperation": { "status": "ACTIVE" }, "created_at": "2021-06-11T11:28:43.293Z", "driver": null, "freight": { "carrier": { "assignee": { "account_id": 749989, "email": "trans@trans.eu", "family_name": "Kowalski", "fax": null, "given_name": "Jan", "telephone": "0048 111111111", "trans_id": "1007374-1" }, "legal_name": "Firma Testowa Spedycja", "vat_id": "1111111111" }, "reference_number": "FR/2021/06/11/C10R", "requirements": { "is_ftl": false, "other_requirements": [], "required_adr_classes": [], "required_truck_bodies": [ "curtainsider" ], "required_ways_of_loading": [], "shipping_remarks": null, "temperature": null, "vehicle_size_id": "any-size" }, "shipper": { "assignee": { "account_id": 750005, "email": "test@trans.eu", "family_name": "Testowy", "fax": null, "given_name": "Jan", "telephone": "0048 2222222222", "trans_id": "1007386-1" }, "legal_name": "Firma Testowa Załadowca", "vat_id": "PL22222222222" }, "spots": [ { "description": null, "name": null, "operations": [ { "loads": [], "operation_order": 1, "time_window": null, "time_window_reason": "LACK_OF_WAREHOUSE", "timespans": { "begin": "2021-06-14T11:26:44.000Z", "end": "2021-06-14T13:26:44.000Z" }, "type": "loading" } ], "place": { "address": { "country": "pl", "description": null, "locality": "Wrocław", "number": null, "postal_code": "12345", "street": null }, "coordinates": null }, "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-17T11:26:44.000Z", "end": "2021-06-17T13:26:44.000Z" }, "type": "unloading" } ], "place": { "address": { "country": "de", "description": null, "locality": "Warszawa", "number": null, "postal_code": "09876", "street": null }, "coordinates": null }, "spot_order": 2 } ] }, "id": "c6d56fc0-bed5-4829-8dcb-204949629280", "invoice": null, "is_archived_permanently": false, "legacy_freight_id": 750571, "monitoring": { "providers": [], "required": false }, "number": "2021/06/11/2", "payment": { "days": 60, "period": "deferred", "price": { "currency": "eur", "type": "route", "value": 110 } }, "related": [], "source": null, "status": { "comment": null, "value": "waiting-for-vehicle-and-driver" }, "vehicle": null }