New freight to direct person

Creating new freight in Trans.eu Platform and sending it to direct person.

Url parameters and connection settings

URL: https://api.platform.trans.eu
Endpoint: /ext/freights-api/v1/freight-employees
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 of freight to selected person requires at least one Trans id to be given:

"employees" : ["1111111-1"]

Also, please remember to set publish parameter to true.

Json	Example	Type	Is required	Description
employees	1111111–1	String	Yes	contains the IDs of the employees to whom we want to send freight
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
publish	True	Boolean	Yes	Determines if the freight is automatically published or only created
payment	Boolean		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		No	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 request

Sample Json for creating new freight using required data only

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

Response


{
    "accepted_price": null,
    "capacity": 12,
    "carrier": null,
    "contact_employees": [
        {
            "last_name": "Testowy",
            "name": "Jan",
            "trans_id": "1000000-1"
        }
    ],
    "distance": null,
    "end_reason": null,
    "height": null,
    "id": 2185542,
    "length": null,
    "loading_meters": null,
    "loads": [],
    "publication_price": {
        "currency": "eur",
        "value": null
    },
    "publication_receivers": [
        "1111111-1"
    ],
    "publication_status": null,
    "reference_number": "FR/2023/10/02/25JXT",
    "requirements": {
        "is_ftl": false,
        "monitoring": "without_monitoring",
        "other_requirements": [],
        "required_adr_classes": [],
        "required_truck_bodies": [
            "curtainsider"
        ],
        "required_ways_of_loading": [],
        "shipping_remarks": null,
        "temperature": {
            "max": null,
            "min": null
        },
        "transport": {
            "count": null,
            "per_order_max": null,
            "per_order_min": null,
            "proposed_count": null,
            "schedule_type": null,
            "settlement": null,
            "settlement_basis": null,
            "total_weight": null,
            "type": "ltl",
            "units_per_transport": null
        },
        "vehicle_size": "any_size"
    },
    "shipment_external_id": null,
    "spots": [
        {
            "description": null,
            "name": null,
            "operations": [
                {
                    "loads": [],
                    "operation_order": 1,
                    "operation_time": null,
                    "timespans": {
                        "begin": "2023-10-03T14:00:00+02:00",
                        "end": "2023-10-03T15:00:00+02: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,
                    "operation_time": null,
                    "timespans": {
                        "begin": "2023-10-04T09:00:00+02:00",
                        "end": "2023-10-04T09:00:00+02: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",
    "transit_time": null,
    "volume": null,
    "width": null
}