Creating new freight in Trans.eu Platform and sending it to carriers assigned using SmartMatch algorithm.

Url parameters and connection settings

  • URL: https://api.platform.trans.eu
  • Endpoint: /ext/freights-api/v1/freight-smartmatch
  • Method: POST

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.

Freight publication and content

For information about freight payload please refer to freight description and freight schema.

Publication using Smart Match algorithm does not require any additional fields or settings. Please remember to set publish parameter to true.

 

Json Example Type Is required Description
shipment_external_id 2020/ABC/1/1 String No External identification number
external_source 1_api String No Freight source identifier assigned to client_id provided by Trans.eu
capacity 12 Float Yes Total freight capacity in tonnes. This value is being validated in comparison to the sum of all loads weight.
Range: 0,001 – 100000
loading_meters 8 Float No Total freight loading meters
Range: 0,01 – 417
publish True Boolean Yes Determines if the freight is automatically published or only created
payment Object No Payment conditions for publication using groups or smart match
requirements Object Yes Main freight requirements, including truck body and size adr classes, ways of loading
loads Array Yes Collection of freights’ loads. It is possible to send empty array of loads, nevertheless an array has to be set
spots Object Yes Collection of freights’ spots – at least one loading and one unloading is required

Example

Sample Json for creating new freight using required data only

{
  "capacity": 12,
  "requirements": {
    "is_ftl": false,
    "required_truck_bodies": [
      "curtainsider"
    ],
    "loads": []
  },
  "spots": [
    {
      "spot_order": 1,
      "place": {
        "address": {
          "country": "PL",
          "postal_code": "12345",
          "locality": "Wroclaw"
        }
      },
      "operations": [
        {
          "timespans": {
            "begin": "2021-02-03T13:00:00+0100",
            "end": "2021-02-03T14:00:00+0100"
          },
          "type": "loading",
          "operation_order": 1,
          "loads": []
        }
      ]
    },
    {
      "spot_order": 2,
      "place": {
        "address": {
          "country": "DE",
          "postal_code": "09876",
          "locality": "Nürnberg"
        }
      },
      "operations": [
        {
          "timespans": {
            "begin": "2021-02-04T08:00:00+0100",
            "end": "2021-02-04T08:00:00+0100"
          },
          "type": "unloading",
          "operation_order": 1,
          "loads": []
        }
      ]
    }
  ],
  "publish": true
}

Response

{
    "accepted_price": null,
    "capacity": 12,
    "carrier": null,
    "id": 592018,
    "loading_meters": null,
    "loads": [],
    "publication_price": null,
    "reference_number": "FR/2021/02/03/X64K",
    "requirements": {
        "is_ftl": false,
        "other_requirements": [],
        "required_adr_classes": [],
        "required_truck_bodies": [
            "curtainsider"
        ],
        "required_ways_of_loading": [],
        "shipping_remarks": null,
        "temperature": {
            "max": null,
            "min": null
        },
        "vehicle_size": "any_size"
    },
    "shipment_external_id": null,
    "spots": [
        {
            "description": null,
            "name": null,
            "operations": [
                {
                    "loads": [],
                    "operation_order": 1,
                    "timespans": {
                        "begin": "2021-02-03T13:00:00+01:00",
                        "end": "2021-02-03T14:00:00+01:00"
                    },
                    "type": "loading"
                }
            ],
            "place": {
                "address": {
                    "country": "PL",
                    "description": null,
                    "locality": "Wroclaw",
                    "number": null,
                    "postal_code": "12345",
                    "street": null
                },
                "coordinates": {
                    "latitude": null,
                    "longitude": null
                }
            },
            "spot_order": 1
        },
        {
            "description": null,
            "name": null,
            "operations": [
                {
                    "loads": [],
                    "operation_order": 1,
                    "timespans": {
                        "begin": "2021-02-04T08:00:00+01:00",
                        "end": "2021-02-04T08:00:00+01:00"
                    },
                    "type": "unloading"
                }
            ],
            "place": {
                "address": {
                    "country": "DE",
                    "description": null,
                    "locality": "Nürnberg",
                    "number": null,
                    "postal_code": "09876",
                    "street": null
                },
                "coordinates": {
                    "latitude": null,
                    "longitude": null
                }
            },
            "spot_order": 2
        }
    ],
    "status": "new"
}