Endpoint enables the carrier to respond to the shipper’s request to provide the required data to start the order execution.
Url parameters and connection settings
- URL: https://api.platform.trans.eu
- Endpoint: /ext/orders-api/v1/orders/{OrderID}/required-execution-data/provide
- Method: POST
The order ID is presented in the form of a Universally Unique Identifier (UUID) e.g. 93bc6a1a-8f1a-4f11-9c7e-14e16f826fd8
Headers:
- Content-type: application/json
- Accept: application/json
- Authorization: Bearer {access_token}
- Api-key: {unique_app_api-key}
Authorization
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.
Data that may be sent by the carrier:
- Name and surname of the driver (“driver.full_name”)
- Driver’s phone number (“driver.contact_phone”)
- Additional driver ID (“driver.identity_document_number”)
- Vehicle registration number (“vehicle.truck.registration_plate_number”)
- Vehicle emission class (“vehicle.truck.combustion_norm”,)
Json request example
{
"vehicle": {
"truck": {
"registration_plate_number": "DSW12345",
"combustion_norm": "EURO 6"
},
"driver": {
"full_name": "Jan Kowalski",
"identity_document_number": "56543456",
"contact_phone": {
"prefix": "48",
"number": "888123456"
}
}
}
}