Get freight by id

Dis­plays details of one, pre­vi­ous­ly cre­at­ed freight, by the API, includ­ing freights cre­at­ed by users on the Trans.eu Plat­form.

Url parameters and connection settings

  • HTTP Method: GET
  • URL: https://api.platform.trans.eu
  • End­point: /ext/freights-api/v1/freights/{freightId}

Headers

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

Authorization

{
  "accepted_price": null,
  "capacity": 20,
  "carrier": null,
  "contact_employees": [
    {
      "last_name": "Testowy",
      "name": "Jan",
      "trans_id": "111111-1"
    }
  ],
  "distance": 1344,
  "end_reason": "timeout",
  "height": null,
  "id": 1111111,
  "length": null,
  "loading_meters": 2,
  "loads": [],
  "publication_price": {
    "currency": "pln",
    "value": 69
  },
  "publication_status": "finished",
  "reference_number": "FR/2022/02/11/H7DG",
  "requirements": {
    "is_ftl": false,
    "other_requirements": [
      "gps",
      "hds",
      "lift",
      "adr"
    ],
    "required_adr_classes": [
      "adr_1_2",
      "adr_1",
      "adr_1_1",
      "adr_2"
    ],
    "required_truck_bodies": [
      "20-standard",
      "hook-truck"
    ],
    "required_ways_of_loading": [
      "top",
      "side",
      "back"
    ],
    "shipping_remarks": "Inne wymagania",
    "temperature": {
      "max": null,
      "min": null
    },
    "vehicle_size": "lorry"
  },
  "shipment_external_id": null,
  "spots": [
    {
      "description": null,
      "name": null,
      "operations": [
        {
          "loads": [],
          "operation_order": 1,
          "timespans": {
            "begin": "2021-12-14T15:08:35+01:00",
            "end": "2021-12-14T17:08:35+01:00"
          },
          "type": "loading"
        }
      ],
      "place": {
        "address": {
          "country": "nl",
          "description": null,
          "locality": "Amsterdam",
          "number": null,
          "postal_code": "1011",
          "street": null
        },
        "coordinates": {
          "latitude": null,
          "longitude": null
        }
      },
      "spot_order": 1
    },
    {
      "description": null,
      "name": null,
      "operations": [
        {
          "loads": [],
          "operation_order": 1,
          "timespans": {
            "begin": "2021-12-16T15:08:35+01:00",
            "end": "2021-12-16T17:08:35+01:00"
          },
          "type": "unloading"
        }
      ],
      "place": {
        "address": {
          "country": "pl",
          "description": null,
          "locality": "Kraków",
          "number": null,
          "postal_code": "11-111",
          "street": null
        },
        "coordinates": {
          "latitude": 11.11111,
          "longitude": 1.1111
        }
      },
      "spot_order": 2
    }
  ],
  "status": "unsuccessful_publication",
  "volume": null,
  "width": null
}

Autho­riza­tion process is described here.

Response to prop­er­ly giv­en freight id.

Impor­tant! It is allowed to access freights cre­at­ed by employ­ees of autho­rized user’s com­pa­ny account only.