Displays details of one, previously created freight, by the API, including freights created by users on the Trans.eu Platform.

Query

Request address and parameters.

  • HTTP Method: GET
  • URL: https://api.platform.trans.eu
  • Endpoint: /ext/freights-api/freights/{freightId}

Headers

  • Accept: application/json
  • Content-type: application/json
  • Authorization: Bearer {access_token}

Authorization

Authorization process is described here.

For accessing freights API no additional scopes are set, therefore the scope parameter can be left empty.

Response

Response to properly given freight id.

{
  "capacity": 20,
  "loading_meters": 2,
  "status" : "search_for_carriers",
  "price" : 123.22,
  "requirements": {
    "is_ftl": true,
    "required_truck_bodies": [
      "truck"
    ]
  },
  "carrier" : {
      "id" : "123",  
      "name" : "Example company name",
      "vat" : "PL123456789",
      "address" : {
          "country" : "pl",
          "locality" : "Sopot",
          "postal_code" : "12-345",
          "street" : "Example street",
          "number" : "13a"
      }
},
  "loads": [
      "id": 279606,
      "name": "Example load no 1",
      "type_of_load": "1_palette",
      "weight": 2,
      "height": 1,
      "width": 2,
      "length": 9,
      "volume": 20,
      "amount": 3,
      "description": null,
      "load_id": null,
      "is_stackable": false,
      "is_exchangeable": false
   }
],
  "spots": [
    {
      "name": "string",
      "description": "string",
      "spot_order": 0,
      "place": {
        "address": {
          "country": "pl",
          "street": "Racławicka",
          "number": "2-4",
          "locality": "Wrocław",
          "postal_code": "53-146",
          "description": "Trans.eu office"
        },
        "coordinates": {
          "latitude": 51.085615,
          "longitude": 17.0105
        }
      },
      "operations": {
        "operation_order": 0,
        "loads": [],
        "timespans": {
          "end": "2018-07-18T14:30:00+0200",
          "begin": "2018-07-20T14:30:00+0200"
        },
        "type": "loading"
      }
    },
    {
      "name": "Second spot name",
      "description": "Second spot description",
      "spot_order": 0,
      "place": {
        "address": {
          "country": "lt",
          "street": "Example street",
          "number": "5",
          "locality": "Riga",
          "postal_code": "1016",
          "description": "Trans.eu office"
        },
        "coordinates": {
          "latitude": 52.085615,
          "longitude": 19.0105
        }
      },
      "operations": {
        "operation_order": 0,
        "loads": [{
            "id" : 123456,
            "weight" : 12
        ],
        "timespans": {
          "end": "2018-07-18T14:30:00+0200",
          "begin": "2018-07-20T14:30:00+0200"
        },
        "type": "unloading"
      }
    },
  ]
}

Important! It is allowed to access freights created by employees of authorized user’s company account only.