New freight to private exchange

Creating new freight and sending it to Private exchange. To check private exchange id use that method first.

Url parameters and connection settings

URL: https://api.platform.trans.eu
Endpoint: /ext/freights-api/v1/private-exchange
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.

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
publish	True	Boolean	Yes	Determines if the freight is automatically published or only created
contact_employees	[“12345–1”, “12345–2”]	Array	No	The default contact person is always the publisher. If the field is sent, the contact persons will be only the ID’s sent in it
payment	Object		No	You can specify the value of the payment, the currency of the payment and the method of payment
requirements	Object		Yes	Main freight requirements, including truck body and size adr classes, ways of loading
exchanges	Object		Yes	Contains private exchange id
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

{
  "publish": true,
  "exchanges": [
    {
      "exchange_id": "051d6148-903a-4735-bc57-feebfdd8c900"
    }
  ],
  "capacity": 29,
  "requirements": {
    "is_ftl": true,
    "required_truck_bodies": [
      "curtainsider"
    ]
  },
  "spots": [
    {
      "spot_order": 1,
      "place": {
        "address": {
          "country": "GB",
          "postal_code": "SK7 1",
          "locality": "London"
        }
      },
      "operations": [
        {
          "operation_order": 1,
          "timespans": {
            "begin": "2022-04-30T13:40:00+0000",
            "end": "2022-04-30T15:10:00+0000"
          },
          "type": "loading"
        }
      ]
    },
    {
      "spot_order": 2,
      "place": {
        "address": {
          "country": "PL",
          "postal_code": "61-625",
          "locality": "Poznań"
        }
      },
      "operations": [
        {
          "operation_order": 1,
          "type": "unloading",
          "timespans": {
            "begin": "2022-05-01T13:00:00+0000",
            "end": "2022-05-01T14:00:00+0000"
          }
        }
      ]
    }
  ]
}

Example Response

{
  "accepted_price": null,
  "capacity": 29,
  "carrier": null,
  "contact_employees": [
    {
      "last_name": "Testowy",
      "name": "User",
      "trans_id": "100111-1"
    }
  ],
  "end_reason": null,
  "height": null,
  "id": 1240244,
  "length": null,
  "loading_meters": null,
  "loads": [],
  "publication_price": {
    "currency": "eur",
    "value": null
  },
  "publication_status": null,
  "reference_number": "FR/2022/04/11/ZLQO",
  "requirements": {
    "is_ftl": true,
    "monitoring": "without_monitoring",
    "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": "2022-04-30T15:40:00+02:00",
            "end": "2022-04-30T17:10:00+02:00"
          },
          "type": "loading"
        }
      ],
      "place": {
        "address": {
          "country": "gb",
          "description": null,
          "locality": "London",
          "number": null,
          "postal_code": "SK7 1",
          "street": null
        },
        "coordinates": {
          "latitude": null,
          "longitude": null
        }
      },
      "spot_order": 1
    },
    {
      "description": null,
      "name": null,
      "operations": [
        {
          "loads": [],
          "operation_order": 1,
          "timespans": {
            "begin": "2022-05-01T15:00:00+02:00",
            "end": "2022-05-01T16:00:00+02:00"
          },
          "type": "unloading"
        }
      ],
      "place": {
        "address": {
          "country": "pl",
          "description": null,
          "locality": "Poznań",
          "number": null,
          "postal_code": "61-625",
          "street": null
        },
        "coordinates": {
          "latitude": 52.436170987,
          "longitude": 16.951637018
        }
      },
      "spot_order": 2
    }
  ],
  "status": "new",
  "volume": null,
  "width": null
}