Allows to access list of transport orders.

Url parameters and connection settings

  • URL: https://api.platform.trans.eu
  • Endpoint: /ext/orders-api/v1/orders-received/{order-id}
  • Method: GET

Headers:

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

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.

For accessing freights API no additional scopes are set, therefore the scope parameter can be left empty.

Order

Full description of order details and parameters can be found here.

Json example:

Example of details of received oreder

{
  "id": "f38c6dca-bd4a-4998-85e4-f8e6d1af13d4",
  "number": "2018/12/31/08",
  "created_at": "2018-12-31T10:52:12.209Z",
  "freight": {
    "id": 1234,
    "created": "2019-09-13T13:38:18+02:00",
    "ftl": true,
    "proposals": null,
    "publication": null,
    "status": "new",
    "truck_bodies": [
      "truck"
    ],
    "loading": {
      "place": {
        "country": "pl",
        "locality": "Kraków",
        "postal_code": "31-008"
      },
      "timespans": {
        "begin": "2019-11-15T10:00:00+01:00",
        "end": "2019-11-15T11:00:00+01:00"
      }
    },
    "unloading": {
      "place": {
        "country": "pl",
        "locality": "Kraków",
        "postal_code": "31-008"
      },
      "timespans": {
        "begin": "2019-11-15T10:00:00+01:00",
        "end": "2019-11-15T11:00:00+01:00"
      }
    }
  },
  "payment": {
    "days": 365,
    "price": {
      "type": "km",
      "value": 100,
      "currency": "1_eur"
    }
  },
  "invoice": {},
  "acceptance": {},
  "source": {},
  "archived_at": "2018-12-31T10:52:12.209Z"
}