1. Trans.eu Api
  2. Dock Scheduler
  3. Time window
  4. Add time window

Add time window

This method allows you to add time win­dow.

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.

Url parameters and connection settings

  • URL: https://api.platform.trans.eu
  • End­point: /ex­t/­dock-sched­uler-api/v1/ware­house­/­timeWin­dow
  • Http Method: POST

Headers

  • Accept: application/json
  • Con­tent-type: application/json
  • Autho­riza­tion: Bear­er {access_token}
  • Api-key: {unique_ap­p_api-key}

Json example for carrier with trans id

Sam­ple Json for cre­at­ing time slot using required data only for car­ri­er with trans id. 

{
  "valid_from": "2021-06-16",
  "valid_to": "2021-06-16",
  "range_type": "CYCLE",
  "remarks": "Be Carefully",
  "external_number": "123xyz",
  "carrier": {
    "id": 1013865
  },
  "ramp_ids": [14532,14533],
  "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
          }
        ]
      }
    ]
  }
}

Json example for a carrier without trans id (not using the trans.eu platform)

Sam­ple Json for cre­at­ing time slot using required data only for car­ri­er with­out trans id (the car­ri­er does not use the trans.eu plat­form). 

{
  "valid_from": "2021-06-16",
  "valid_to": "2021-06-16",
  "range_type": "CYCLE",
  "remarks": "Be Carefully",
  "external_number": "123xyz",
  "carrier": {
    "email": "aa@bb.pl",
    "legal_name": "Name Surmane",
    "telephone": "38 73 592",
    "type": "EXTERNAL"
  },
  "ramp_ids": [14532,14533],
  "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 from the system (the request included TransID)

{
  "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": [
        {
            "id": 14532,
            "name": "Rampa1",
            "operation_type": "any",
            "ramp_type": "RAMP"
        },
        {
            "id": 14533,
            "name": "Rampa2",
            "operation_type": "any",
            "ramp_type": "RAMP"
        }
    ],
  "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"
    }
  }
}