1. Trans.eu Api
  2. Orders
  3. Getting lists
  4. List of archived orders received

List of archived orders received

Allows to access list of received trans­port orders which have been already archived.

Url parameters and connection settings

  • URL: https://api.platform.trans.eu
  • End­point: /ex­t/orders-api/v1/archive-orders-received
  • Method: GET

Headers:

  • Con­tent-type: application/json
  • Accept: application/json
  • Autho­riza­tion: Bear­er {access_token}
  • Api-key: {unique_ap­p_api-key}

Authorization and access

Autho­riza­tion process is described here. Each API request must also con­sist of unique Api-key obtained dur­ing appli­ca­tion reg­is­tra­tion togeth­er with client_id and client_secret.

Order

Details of order para­me­ters, data range and descrip­tion can be found here.

Available filters

List of available filters

  • has attach­ments (?fil­ter={“has_attachments”: true})
  • load­ing place postal code (?filter={“loading_place.postal_code”: {“$regex”: “5.*”}})
  • load­ing place city (?fil­ter={“loading_place.locality”: “Wro­claw”})
  • load­ing place coun­try (?filter={“loading_place.country”: {“$eq”: “PL”}})
  • load­ing place date (?fil­ter={“loading_place.date”:{“$gte”: “2020–09-16T15:00:00.000Z”, “$lte”: “2020–12-31T15:00:00.000Z”}})
  • unload­ing place postal code (?filter={“unloading_place.postal_code”: {“$regex”: “53.*”}})
  • unload­ing place city (?fil­ter={“unloading_place.locality”: {“$regex”: “Wro.*”}})
  • unload­ing place coun­try (?filter={“unloading_place.country”: {“$eq”: “PL”}})
  • unload­ing place date (?fil­ter={“unloading_place.date”:{“$gte”: “2020–09-16T15:00:00.000Z”}})

Sort by

  • num­ber (?sortBy=number&order=asc)
  • cre­ation date (?sortBy=created_at&order=asc)
  • archiv­ing date (?sortBy=archived_at&order=desc)

Search

  • freight ref­er­ence num­ber (?search={“reference_number”:“FR/2021/03/08/IZO8”})

Paging

When call­ing GET method, page should be added as para­me­ter in the URL, for exam­ple: 

https://api.platform.trans.eu/ext/orders-api/v1/archive-orders-created?page=4

Json example

List of orders con­tain­ing one enti­ty, each addi­tion­al enti­ty will repeat sim­i­lar pay­load struc­ture

{
  "orders-archive": [
    {
      "archived_at": "2021-07-13T00:00:32.327Z",
      "attachments": [],
      "created_at": "2021-03-15T11:35:09.575Z",
      "driver": null,
      "freight": {
        "carrier": {
          "assignee": null,
          "legal_name": "FirmaTestowa",
          "vat_id": "11111111111"
        },
        "id": null,
        "reference_number": null,
        "shipper": {
          "assignee": {
            "account_id": 749989,
            "family_name": "Kowalski",
            "given_name": "Jan",
            "trans_id": "1007374-1"
          },
          "legal_name": "Firma Testowa 2",
          "vat_id": "22222222222"
        },
        "spots": [
          {
            "description": null,
            "name": null,
            "operations": [
              {
                "loads": [],
                "operation_order": 1,
                "time_window": null,
                "time_window_reason": null,
                "timespans": {
                  "begin": "2021-03-18T11:35:07.000Z",
                  "end": "2021-03-18T13:35:07.000Z"
                },
                "type": "loading"
              }
            ],
            "place": {
              "address": {
                "country": "pl",
                "description": null,
                "locality": "Kraków",
                "number": "12",
                "postal_code": "31-008",
                "street": "Stara"
              },
              "coordinates": {
                "latitude": 50.06143,
                "longitude": 19.93658
              }
            },
            "spot_order": 1
          },
          {
            "description": null,
            "name": null,
            "operations": [
              {
                "loads": [],
                "operation_order": 1,
                "time_window": null,
                "time_window_reason": null,
                "timespans": {
                  "begin": "2021-03-21T11:35:07.000Z",
                  "end": "2021-03-21T13:35:07.000Z"
                },
                "type": "unloading"
              }
            ],
            "place": {
              "address": {
                "country": "pl",
                "description": null,
                "locality": "DąbrowaŚrodkowa",
                "number": "34",
                "postal_code": "59-330",
                "street": "Średnia"
              },
              "coordinates": {
                "latitude": 51.41828,
                "longitude": 16.33485
              }
            },
            "spot_order": 2
          }
        ]
      },
      "id": "5f569a07-19d7-4667-bed6-cefd4a3bb7a1",
      "invoice": null,
      "legacy_freight_id": null,
      "monitoring": {
        "providers": [],
        "required": true
      },
      "number": "2021/03/15/9",
      "payment": {
        "days": 365,
        "price": {
          "currency": "eur",
          "protected": false,
          "type": "km",
          "value": 100
        }
      },
      "source": null,
      "status": {
        "comment": null,
        "value": "archived"
      },
      "vehicle": null
    },
    {
      "next_order": "next_order"
    }
  ],
  "page": 3,
  "page_count": 3
}