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
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
{
"2023-07-12": [
{
"fields_changes": {
"status": {
"after": "CONFIRMED",
"before": null
}
},
"modification_date_time": "2023-07-12T11:01:01",
"modified_by": {
"family_name": "Wankiewicz",
"given_name": "Paweł",
"trans_id": "1007386-1"
},
"properties_changed": [
"status"
]
},
{
"fields_changes": {
"arrival_delay": {
"after": 0,
"before": null
},
"custom_status_order": {
"after": 30,
"before": null
},
"modified_at": {
"after": "2023-07-12T11:01:27",
"before": null
},
"stage": {
"after": "VEHICLE_ARRIVED",
"before": null
},
"status": {
"after": "IN_PROGRESS",
"before": "CONFIRMED"
}
},
"modification_date_time": "2023-07-12T11:01:27",
"modified_by": {
"family_name": "Wankiewicz",
"given_name": "Paweł",
"trans_id": "1007386-1"
},
"properties_changed": [
"stage",
"modified_at",
"arrival_delay",
"custom_status_order",
"status"
]
},
{
"fields_changes": {
"custom_status_order": {
"after": 40,
"before": null
},
"modified_at": {
"after": "2023-07-12T11:01:30",
"before": null
},
"stage": {
"after": "STARTED",
"before": "VEHICLE_ARRIVED"
}
},
"modification_date_time": "2023-07-12T11:01:30",
"modified_by": {
"family_name": "Wankiewicz",
"given_name": "Paweł",
"trans_id": "1007386-1"
},
"properties_changed": [
"stage",
"modified_at",
"custom_status_order"
]
}
]
}