Providing required execution data

End­point enables the car­ri­er to respond to the ship­per’s request to pro­vide the required data to start the order exe­cu­tion.

Url parameters and connection settings

  • URL: https://api.platform.trans.eu
  • End­point: /ext/orders-api/v1/orders/{OrderID}/required-execution-data/provide
  • Method: POST

The order ID is pre­sent­ed in the form of a Uni­ver­sal­ly Unique Iden­ti­fi­er (UUID) e.g. 93bc6a1a-8f1a-4f11-9c7e-14e16f826fd8

Headers:

  • Con­tent-type: application/json
  • Accept: application/json
  • Autho­riza­tion: Bear­er {access_token}
  • Api-key: {unique_ap­p_api-key}

Authorization

Autho­riza­tion process is described here. Each API request must also con­sist of unique Api-key obtained dur­ing appli­ca­tion reg­is­tra­tion togeth­er with client_id and client_secret.

Data that may be sent by the carrier:

  • Name and sur­name of the dri­ver (“driver.full_name”)
  • Dri­ver’s phone num­ber (“driver.contact_phone”)
  • Addi­tion­al dri­ver ID (“driver.identity_document_number”)
  • Vehi­cle reg­is­tra­tion num­ber (“vehicle.truck.registration_plate_number”)
  • Vehi­cle emis­sion 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"
            }
        }
    }
}