This method allows you to add time window.

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: POST

Headers

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

Json example

Sample Json for creating time slot using required data only

{
  "valid_from": "2021-06-16",
  "valid_to": "2021-06-16",
  "range_type": "CYCLE",
  "external_number": "123xyz",
  "carrier": {
    "id": 1013865
  },
  "route": {
    "spots": [
      {
        "order": 1,
        "warehouse_id": 29,
        "operations": [
          {
            "operation_type": "LOADING",
            "order": 1,
            "belongs_to_time_window": true
          }
        ]
      },
      {
        "order": 2,
        "address": {
       },
        "operations": [
          {
            "operation_type": "UNLOADING",
            "order": 1,
            "belongs_to_time_window": false
          }
        ]
      }
    ]
  }
}
 

 

Response

{
    "carrier": {
        "id": 1013865,
        "legal_name": "Firma Testowa"
    },
    "created_at": "2021-06-16T10:07:55.42358",
    "end_time": null,
    "external_number": "123xyz",
    "freight_order": null,
    "id": 8596,
    "operation_type": "LOADING",
    "ramps": [],
    "range_type": "CYCLE",
    "reference_number": "DS/144461A",
    "route": {
        "spots": [
            {
                "address": {
                    "coordinates": {
                        "latitude": 90,
                        "longitude": 999
                    },
                    "country": "pl",
                    "locality": "Warszawa",
                    "name": "Magazyn_jeden",
                    "number": "12",
                    "postal_code": "00-950",
                    "street": "Nowa"
                },
                "operations": [
                    {
                        "begin": null,
                        "end": null,
                        "operation_type": "LOADING",
                        "order": 1,
                        "time_window_id": 8596
                    }
                ],
                "order": 1
            },
            {
                "address": {
                    "coordinates": null,
                    "country": null,
                    "locality": null,
                    "name": null,
                    "number": null,
                    "postal_code": null,
                    "street": null
                },
                "operations": [
                    {
                        "begin": null,
                        "end": null,
                        "operation_type": "UNLOADING",
                        "order": 1,
                        "time_window_id": null
                    }
                ],
                "order": 2
            }
        ]
    },
    "start_time": null,
    "status": "AVAILABLE",
    "valid_from": "2021-06-16",
    "valid_to": "2021-06-16",
    "warehouse": {
        "id": 29,
        "name": "Magazyn_jeden",
        "time_zone": {
            "id": "Europe/Warsaw",
            "offset": "+02:00"
        }
    }
}