List of received orders

Allows to access list of trans­port orders.

Url parameters and connection settings

  • URL: https://api.platform.trans.eu
  • End­point: /ex­t/orders-api/v1/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 avail­able fil­ters

  • sta­tus: ?filter={“status”:“proposal-rejected”}
  • has attach­ments: ?fil­ter={“has_attachments”: true}
  • has invoice: ?filter={“has_invoice”:true}
  • vat id: ?filter={“vat_id”:“1111111111”}
  • cre­at­ed at: ?filter={“created_at”:{“$gt”: “2023–09-04T13:24:00.000Z”, “$lt”: “2023–11-03T13:24:00.000Z”}}

Filter example

https://api.platform.trans.eu/ext/orders-api/v1/orders-received?filter={"created_at":{"$gt": "2023-09-04T13:24:00.000Z", "$lt": "2023-11-03T13:24:00.000Z"}}

Sort by

  • num­ber (?sortBy=number&order=asc)
  • load­ing date (?sortBy=freight.first_loading_place.date&order=desc)
  • unload­ing date (?sortBy=freight.last_unloading_place.date&order=asc)
  • cre­ation date (?sortBy=created_at&order=asc)
  • sta­tus (?sortBy=status.value&order=desc)

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/orders-created?page=4

Search

  • ship­ment exter­nal id (?search={“shipment_external_id”: “1/1/1235”})

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

[
  {
    "attachments": [],
    "created_at": "2021-06-09T13:52:29.552Z",
    "driver": null,
    "freight": {
      "carrier": {
        "assignee": null,
        "legal_name": "Firma Testowa",
        "vat_id": "111111111"
      },
      "reference_number": null,
      "shipper": {
        "assignee": {
          "account_id": 750005,
          "family_name": "Kowalski",
          "given_name": "Jan",
          "trans_id": "1007386-1"
        },
        "legal_name": "Firma Testowa Załadowca",
        "vat_id": "2222222222"
      },
      "spots": [
        {
          "description": "Example description",
          "name": "Magazine 1",
          "operations": [
            {
              "loads": [],
              "operation_order": 1,
              "time_window": null,
              "time_window_reason": "LACK_OF_WAREHOUSE",
              "timespans": {
                "begin": "2021-06-12T13:52:27.000Z",
                "end": "2021-06-12T15:52:27.000Z"
              },
              "type": "loading"
            }
          ],
          "place": {
            "address": {
              "country": "pl",
              "description": null,
              "locality": "Kraków",
              "number": "5",
              "postal_code": "31-001",
              "street": "Wawel"
            },
            "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": "LACK_OF_WAREHOUSE",
              "timespans": {
                "begin": "2021-06-15T13:52:27.000Z",
                "end": "2021-06-15T15:52:27.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": "efc4dea5-ddd2-44d7-834d-d53d433a4de8",
    "invoice": null,
    "legacy_freight_id": null,
    "monitoring": {
      "providers": [],
      "required": true
    },
    "number": "123xy4z",
    "payment": {
      "days": 365,
      "price": {
        "currency": "eur",
        "protected": false,
        "type": "km",
        "value": 100
      }
    },
    "source": null,
    "status": {
      "comment": null,
      "value": "proposal-waiting"
    },
    "vehicle": null
  },
  {
    "next_order": "next_order"
  }
]