List of freight proposals

This method allows you to download a list of awaiting freight proposals created by freight forwarders and shippers on Trans.eu Patform.

Those freights origin from Freights received module.

Authorization and access

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.

Url parameters and connection settings

URL: https://api.platform.trans.eu
Endpoint: /ext/freights-api/v1/freight-proposals
Http Method: GET

Headers

Accept: application/json
Content-type: application/json
Authorization: Bearer {access_token}
Api-key: {unique_app_api-key}

Freight information available using a list

List of freights consists of limited information, to make freight management more data efficient.

id
creation date
publication information
freight status
external identification number
ftl/ltl information
array of allowed truck bodies
loading and unloading (first and last spot if freight consists of more than two spots)
- location
- operations

Available filters

List of available filters

proposal_request_status:
- published
- in_negotiation
- waiting_for_accept
- waiting_for_chain_accept
- accepted

and

is_archived:
- true
- false

Example of use:

?filter={"is_archived": false,"proposal_request_status":"published"}

Sort by

status (?sortBy=status&order=ASC/DESC)
loading date (?sortBy=loading_date&order=ASC/DESC)
unloading date (?sortBy=unloading_date&order=ASC/DESC)
status changed at (?sortBy=status_changed_at&order=ASC/DESC)

Json response example

[
  {
    "contact_employees": [
      {
        "account_id": 759284,
        "last_name": "Kowalski",
        "name": "Jan",
        "trans_id": "123456-1"
      }
    ],
    "created_at": "2021-03-08T10:58:59+01:00",
    "decision_date": "2021-03-11T10:58:55+01:00",
    "freight": {
      "capacity": {
        "unit_code": "t",
        "value": 12
      },
      "children": {
        "carrier": null,
        "id": null,
        "publication": null,
        "reference_number": null,
        "status": null,
        "version": null
      },
      "distance": 0,
      "id": 641839,
      "loading_meters": null,
      "publication": {
        "id": 549862,
        "is_quick_pay": false,
        "is_recommended": false,
        "period": {
          "days": 5,
          "payment": "1_deferred"
        },
        "price": {
          "currency": "eur",
          "value": 140
        },
        "price_type": "ROUTE",
        "publish_type": "companies",
        "total_price": {
          "currency": "eur",
          "value": 140
        }
      },
      "requirements": {
        "is_ftl": false,
        "other_requirements": [],
        "required_adr_classes": [],
        "required_truck_bodies": [
          "curtainsider"
        ],
        "required_ways_of_loading": [],
        "shipping_remarks": null,
        "vehicle_size_id": "any_size"
      },
      "shipment_request_name": null,
      "shipper": {
        "address": {
          "country": "pl",
          "description": null,
          "id": 324710,
          "locality": "Vhqwtwrqgi",
          "location_id": null,
          "postal_code": "74-507",
          "street": "Orfaliko 03"
        },
        "company_id": 1007386,
        "cooperation": {
          "is_suspended": false
        },
        "email": "info@trans.eu",
        "fax_number": "0048 1111111111",
        "id": 3981,
        "legal_name": "Firma Testowa Załadowca IIT",
        "source": "companies",
        "telephone": "0048 1111111",
        "vat_id": "PL811111111111"
      },
      "spots": [
        {
          "description": null,
          "id": 1413448,
          "name": null,
          "operations": [
            {
              "id": 1420054,
              "loads": [],
              "operation_order": 1,
              "timespans": {
                "begin": "2021-03-11T10:58:55+01:00",
                "end": "2021-03-11T12:58:55+01:00"
              },
              "type": "loading"
            }
          ],
          "place": {
            "address": {
              "country": "pl",
              "description": null,
              "detailed_location_id": null,
              "foreign_id": null,
              "id": 1328014,
              "locality": "Wroclaw",
              "location_id": null,
              "number": null,
              "postal_code": "12345",
              "radius": null,
              "street": null
            },
            "coordinates": {
              "latitude": null,
              "longitude": null
            },
            "range_distance": null
          },
          "spot_order": 1
        },
        {
          "description": null,
          "id": 1413449,
          "name": null,
          "operations": [
            {
              "id": 1420055,
              "loads": [],
              "operation_order": 1,
              "timespans": {
                "begin": "2021-03-14T10:58:55+01:00",
                "end": "2021-03-14T12:58:55+01:00"
              },
              "type": "unloading"
            }
          ],
          "place": {
            "address": {
              "country": "de",
              "description": null,
              "detailed_location_id": null,
              "foreign_id": null,
              "id": 1328015,
              "locality": "Nürnberg",
              "location_id": null,
              "number": null,
              "postal_code": "09876",
              "radius": null,
              "street": null
            },
            "coordinates": {
              "latitude": null,
              "longitude": null
            },
            "range_distance": null
          },
          "spot_order": 2
        }
      ]
    },
    "freight_publication_id": 549862,
    "id": "4a2dbtsd-bd6b-4c24-6t2c-256af1005591",
    "is_first_buy": false,
    "is_quick_pay": false,
    "new_status": "accepted",
    "price": {
      "currency": "eur",
      "value": 140
    },
    "price_type": "ROUTE",
    "publish_date": "2021-03-08T10:59:02+01:00",
    "stage": "active",
    "status": "accepted",
    "updated_at": "2021-03-08T11:29:24+01:00",
    "version": 6
  },
  {
    "next_freight": "next_freight"
  }
]