Get announcement list - Trans.eu Api

This method allows you to download a list of announcements.

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/dock-scheduler-api/v1/announcement
Http Method: GET

Headers

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

Available filters

Important for shipper role! To get the announcement list, at least warehouse filter has to be used.

List of available filters

warehouse ids (?filter={“warehouse_ids”: [10]})
carrier ids (?filter={“carrier_ids”: [1234,1235]})
shipper ids ( ?filter={“shipper_ids”: [1234,1235]})
date from (?filter={“date_from”: “2022–03-01”})
date to (?filter={“date_to”: “2022–03-31”})
order reference number (?filter={“order”: {“reference_number”: “2022/01/25/9”}})
time window reference number (?filter={“time_window”: {“reference_number”:“DS/21A645”}})
freight reference number (?filter={“freight”: {“reference_number”: “FR/2022/09/28/L1D2”}})
time window external number (?filter={“time_window”: {“external_number”: “1a2b3c”}})
announcement reference number (?filter={“reference_number”: “DS/21A645/1”})
stages (?filter={“statuses”: [“LOADING_REFUSED”]}) all available stages can be found here
purchase_order (?filter={“purchase_order”: {“number”: “12DE45”}})

Example of combined filter: ?filter={“warehouse_ids”:[10],“carrier_ids”: [1234]}

Paging

When calling GET method, page should be added as parameter in the URL, for example:

Json response example

{
  "content": [
    {
      "arrival_delay": null,
      "cargo": null,
      "carrier": {
        "id": 1013865,
        "legal_name": "Firma Testowa Przewoźnik IIT 2",
        "subcontractor": null,
        "type": "REGISTERED"
      },
      "date_from": "2019-12-12T11:00:00",
      "date_to": "2019-12-12T11:45:00",
      "driver": {
        "contact_phone": null,
        "document": {
          "issuing_authority": null,
          "number": "QQQ123456",
          "type": "IDENTITY_CARD"
        },
        "full_name": "John TheDriver",
        "phone_number": "601983760"
      },
      "external_reference_number": null,
      "forward": null,
      "forward_permissions": {
        "allow": false,
        "disallow": {
          "limit": null,
          "reason": "FORBIDDEN"
        },
        "require_carrier_data": false
      },
      "id": 538,
      "operation_type": "loading",
      "order_reference_number": null,
      "ramp": {
        "id": 141,
        "is_active": true,
        "is_locked": false,
        "name": "Suwnica 1",
        "warehouse": {
          "address": {
            "id": 44,
            "locality": "Wrocław"
          },
          "id": 44,
          "is_active": true,
          "is_locked": false,
          "name": "Magazyn Test PRO",
          "time_zone": {
            "id": "Europe/Warsaw",
            "offset": "+02:00",
            "offset_minutes": 120
          }
        }
      },
      "reference_number": "DSX-B9E211A",
      "remarks": null,
      "route": {
        "loading_place": {
          "country": "pl",
          "locality": "Wrocław",
          "name": "Magazyn Test PRO",
          "number": "2-4",
          "postal_code": "53-146",
          "street": "Racławicka"
        },
        "unloading_place": null
      },
      "shipper": {
        "id": 1007386,
        "legal_name": "Firma Testowa Załadowca IIT"
      },
      "stage": "REFUSED",
      "status": "FINISHED",
      "template": {
        "id": 1
      },
      "time_window": null,
      "transport": null,
      "vehicle": {
        "combustion_norm": null,
        "trailer_plate_number": "BB123",
        "truck_plate_number": "AA123",
        "weight": null
      }
    }
  ]
}