1. Trans.eu Api
  2. Freights
  3. Creating multifreight

Creating multifreight

Mul­ti­freight allows pub­lish­ing a freight offer that includes mul­ti­ple trans­port oper­a­tions, with set­tle­ment per route or per ton of car­go.

Url parameters and connection settings

  • URL: https://api.platform.trans.eu

You can use any pub­lish­ing method:

  • End­point: /ext/freights-api/v1/freight-exchange
  • End­point: /ex­t/freights-api/v1/freight-employ­ees
  • End­point: /ex­t/freights-api/v2/freights
  • End­point: /ex­t/freights-api/v1/freight-com­pa­nies
  • End­point: /ex­t/freights-api/v1/freight-auto
  • End­point: /ex­t/freights-api/v1/pri­vate-exchange
  • End­point: /ex­t/freights-api/v1/freight-cor­po­rate
  • Method: POST

Headers:

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

Authorization

Autho­riza­tion process is described here.

Fields in requirements.transport

JsonTypeDescrip­tion
typestringAlways multi_ftl for mul­ti­freight.
set­tle­mentstringSet­tle­ment method: route (per course) or ton (per ton).
settlement_basisstringRequired when set­tle­ment = ton. Val­ues: load­ing, unload­ing.
schedule_typestringWho defines sched­ule: car­ri­er, ship­per, togeth­er.
countinte­gerTotal num­ber of cours­es.
total_weightinte­gerTotal weight in tons. Required when set­tle­ment = ton.
per_order_mininte­gerMin­i­mum num­ber of cours­es per car­ri­er.
per_order_maxinte­gerMax­i­mum num­ber of cours­es per car­ri­er.
proposed_countinte­gerPre­ferred num­ber of cours­es per car­ri­er.

Exam­ple request – Set­tle­ment per Route

{
  "publish": true,
  "capacity": 24,
  "requirements": {
    "transport": {
      "type": "multi_ftl",
      "settlement": "route",
      "schedule_type": "carrier",
      "per_order_min": 4,
      "per_order_max": 5,
      "proposed_count": 4,
      "count": 5
    },
    "required_truck_bodies": [
      "dump-truck"
    ]
  },
  "loads": [
    {
      "load_id": "some-id",
      "name": "Load name 1",
      "amount": 33,
      "type_of_load": "europalette"
    }
  ],
  "spots": [
    {
      "name": "Some place",
      "spot_order": 1,
      "place": {
        "address": {
          "country": "pl",
          "street": "Racławicka",
          "locality": "Wrocław",
          "postal_code": "53-146"
        },
        "coordinates": {
          "latitude": 51.085615,
          "longitude": 17.0105
        }
      },
      "operations": [
        {
          "type": "loading",
          "operation_order": 1,
          "operation_time": 15,
          "timespans": {
            "end": "2024-04-03T13:10:00+0000",
            "begin": "2024-04-03T13:10:00+0000"
          }
        }
      ]
    },
    {
      "name": "Other place",
      "spot_order": 2,
      "place": {
        "address": {
          "country": "de",
          "street": "Aktienstraße 177",
          "locality": "Essen",
          "postal_code": "45359"
        },
        "coordinates": {
          "latitude": 51.4518992,
          "longitude": 6.9190441
        }
      },
      "operations": [
        {
          "type": "unloading",
          "operation_order": 1,
          "operation_time": 15,
          "timespans": {
            "end": "2024-04-04T13:10:00+0000",
            "begin": "2024-04-04T13:10:00+0000"
          }
        }
      ]
    }
  ],
  "payment": {
    "price": {
      "value": 100,
      "currency": "eur"
    }
  }
}

Exam­ple Request – Set­tle­ment per Ton

{
    "publish": true,
    "capacity": 24,
    "requirements": {
        "transport": {
            "type": "multi_ftl",
            "settlement": "ton",
            "settlement_basis": "loading",
            "schedule_type": "carrier",
            "count": 5,
            "total_weight": 120,
            "per_order_min": 4,
            "per_order_max": 5,
            "proposed_count": 4
        },
        "required_truck_bodies": [
            "dump-truck"
        ]
    },
    "loads": [
        {
            "load_id": "some-id",
            "name": "Load name 1",
            "amount": 33,
            "type_of_load": "europalette"
        }
    ],
    "spots": [
        {
            "name": "Some place",
            "spot_order": 1,
            "place": {
                "address": {
                    "country": "pl",
                    "street": "Racławicka",
                    "locality": "Wrocław",
                    "postal_code": "53-146"
                },
                "coordinates": {
                    "latitude": 51.085615,
                    "longitude": 17.0105
                }
            },
            "operations": [
                {
                    "type": "loading",
                    "operation_order": 1,
                    "operation_time": 15,
                    "timespans": {
                        "end": "2024-04-03T13:10:00+0000",
                        "begin": "2024-04-03T13:10:00+0000"
                    }
                }
            ]
        },
        {
            "name": "Other place",
            "spot_order": 2,
            "place": {
                "address": {
                    "country": "de",
                    "street": "Aktienstraße 177",
                    "locality": "Essen",
                    "postal_code": "45359"
                },
                "coordinates": {
                    "latitude": 51.4518992,
                    "longitude": 6.9190441
                }
            },
            "operations": [
                {
                    "type": "unloading",
                    "operation_order": 1,
                    "operation_time": 15,
                    "timespans": {
                        "end": "2024-04-04T13:10:00+0000",
                        "begin": "2024-04-04T13:10:00+0000"
                    }
                }
            ]
        }
    ],
    "payment": {
        "price": {
            "value": 100,
            "currency": "eur"
        }
    }
}