This method allows you to download a list of time windows.

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/warehouse/timeWindow
  • Http Method: GET

Headers

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

Available filters

List of available filters:

  • search – example for order number – (?filter={“search”:”2021/12/22/1”})
  • date_from (?filter={“date_from”:” “2021-11-23”})
  • date_to (?filter={“date_to”:” “2021-11-29”})
  • start_time (?filter={“start_time”:”15:59”})
  • end_time (?filter={“end_time”:”19:00”})
  • warehouse_ids (?filter={“warehouse_ids”:[11,22]})
  • shipper_ids (?filter={“shipper_ids”:[111111,222222]})
  • carrier_ids (?filter={“carrier_ids”:[1111111,222222]})
  • status (?filter={“status”:[“AVAILABLE”,”USED”]})
  • is_warehouse_locked (?filter={“is_warehouse_locked”: false})
  • is_warehouse_active (?filter={“is_warehouse_active”: true})
  • operation_type (?filter={“operation_type”: ”LOADING”})
  • creation_date_from (?filter={“creation_date_from”: ”2021-11-01T12:00:00”})
  • creation_date_to (?filter={“creation_date_to”: ”2021-12-01T12:00:00”})

Example of use: https://api.platform.trans.eu/dock-scheduler-api/v1/warehouse?filter={“search”:”Wro”}

Paging

When calling GET method, page should be added as parameter in the URL, for example: https://api.platform.trans.eu/dock-scheduler-api/v1/warehouse?page=2

 

Response example:

{
    "content": [
        {
            "carrier": {
                "id": 1013865,
                "legal_name": "Firma Testowa"
            },
            "end_time": "16:00:00",
            "external_number": null,
            "freight_order": null,
            "id": 3853,
            "operation_type": "LOADING",
            "range_type": "CYCLE",
            "reference_number": "DS/13752DF",
            "route": {
                "loading_place": null,
                "unloading_place": null
            },
            "start_time": "08:00:00",
            "status": "USED",
            "valid_from": "2020-09-30",
            "valid_to": "2020-09-30",
            "warehouse": {
                "id": 44,
                "name": "Magazyn Test",
                "time_zone": {
                    "id": "Europe/Warsaw",
                    "offset": "+02:00"
                }
            }
        },
        {/next time window}
    ],
    "page": 1,
    "page_count": 5,
    "page_size": 10,
    "total_items": 45
}