Add time window with purchase order

This method allows adding an order object to a defined time win­dow, togeth­er with a com­plete set of data regard­ing deliv­ery, busi­ness part­ner, and car­go. As a result, the sys­tem can auto­mat­i­cal­ly link orders with the trans­port sched­ule and logis­tics process­es.

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}

Purchase order object

JsonDescrip­tionIs requiredType
purchase_order.numberPur­chase order num­ber (size must be between 0 and 50)YESstring
execution_constraints.delivery_dateDeliv­ery dateNOdate
execution_constraints.delivery_timeDeliv­ery timeNOtime
execution_constraints.delivery_conditionsDeliv­ery con­di­tionsNOstring
execution_constraints.payment_conditionsPay­ment con­di­tionsNOstring
document.created_dateCre­ation dateNOtime­stamp
document.author.created_byCre­at­ed byNOstring
document.author.phonePhone num­berNOstring
document.author.emailEmail addressNOstring
delivery_place.receiver_nameReceiv­er nameNOstring
delivery_place.countryCoun­tryNOstring
delivery_place.cityCityNOstring
delivery_place.postal_codePostal codeNOstring
delivery_place.streetStreetNOstring
business_partner.numberBusi­ness part­ner num­berNOstring
business_partner.nameBusi­ness part­ner nameNOstring
business_partner.tax_idTax iden­ti­fi­ca­tion num­berNOstring
business_partner.contact_personCon­tact per­sonNOstring
shipment_document.numberShip­ment doc­u­ment num­berNOstring
invoice.numberInvoice num­berNOstring
warehouse_issue.numberWare­house issue (WZ)NOstring
loads.nameCar­go nameNOstring
loads.typeCar­go typeNOstring
loads.quantityCar­go quan­ti­tyNOinte­ger
loads.weightTotal weightNOdec­i­mal
loads.reference_numberCar­go ref­er­ence num­berNOstring
loads.warehouse_unitWare­house unitNOstring
loads.categoryCar­go cat­e­go­ryNOstring
loads.business_partner_load_numberBusi­ness part­ner load num­berNOstring
loads.commercial_numberCom­mer­cial car­go num­berNOstring
loads.forwarding_numberFor­ward­ing num­berNOstring
loads.container_numberCon­tain­er num­berNOstring
loads.descriptionCar­go descrip­tionNOstring

Request exam­ple

{
    "valid_from": "2025-09-08",
    "valid_to": "2025-09-08",
    "start_time": "12:00:00",
    "end_time": "18:00:00",
    "remarks": "Test remark !@#$",
    "range_type": "CYCLE",
    "external_number": "1DX124DAW7871",
    "carrier": {
        "id": 956529
    },
    "purchase_order": {
        "number": "purchase_order_number_46be0354e8ef",
        "execution_constraints": {
            "delivery_date": "2025-04-22",
            "delivery_time": "14:50:19",
            "delivery_conditions": "delivery_conditions_13f786506c62",
            "payment_conditions": "payment_conditions_d3bc906c82b5"
        },
        "document": {
            "created_date": "2099-01-05",
            "author": {
                "created_by": "Lincoln",
                "phone": "0048 600600600",
                "email": "lincoln@ford.com"
            }
        },
        "delivery_place": {
            "receiver_name": "receiver_name_fdcb53f26f0a",
            "country": "country_48771b243932",
            "city": "city_3db029c3ec4e",
            "postal_code": "41a3e0797",
            "street": "street_46cd2d92845b"
        },
        "business_partner": {
            "number": "number_ca724db783c2",
            "name": "name_a95a422817f1",
            "tax_id": "tax_id_fae3d33b3bf7",
            "contact_person": "contact_person_d985cf6abd8f"
        },
        "shipment_document": {
            "number": "number_aa63e54e69ad"
        },
        "invoice": {
            "number": "number_2f9bf43ad4c5"
        },
        "warehouse_issue": {
            "number": "number_9db7225e175e"
        },
        "loads": [
            {
                "name": "name_ed0283531277",
                "type": "type_37c574fa8fbc",
                "quantity": "501",
                "weight": "11",
                "reference_number": "reference_number_0240404aedbf",
                "warehouse_unit": "warehouse_unit_5e1adda5f496",
                "category": "category_f660ad4f3d7c",
                "business_partner_load_number": "business_partner_load_number_a7bb99929090",
                "commercial_number": "commercial_number_e8fc8ee76056",
                "forwarding_number": "forwarding_number_84ee71ccbda3",
                "container_number": "container_number_ef12a0a869c8",
                "description": "description_e68ae86cdffa"
            },
            {
                "name": "name_ed0283531277_v2",
                "type": "type_37c574fa8fbc_v2",
                "quantity": "5012",
                "weight": "112",
                "reference_number": "reference_number_0240404aedbf_v2",
                "warehouse_unit": "warehouse_unit_5e1adda5f496_v2",
                "category": "category_f660ad4f3d7c_v2",
                "business_partner_load_number": "business_partner_load_number_a7bb99929090_v2",
                "commercial_number": "commercial_number_e8fc8ee76056_v2",
                "forwarding_number": "forwarding_number_84ee71ccbda3_v2",
                "container_number": "container_number_ef12a0a869c8_v2",
                "description": "description_e68ae86cdffa_v2"
            }
        ]
    },
    "route": {
        "spots": [
            {
                "warehouse_id": 6596,
                "order": 1,
                "address": {
                    "country": "af",
                    "locality": "Kabul",
                    "street": "Testing Street",
                    "number": "12T",
                    "name": "Cypresss",
                    "remarks": null,
                    "postal_code": "1002"
                },
                "operations": [
                    {
                        "operation_type": "loading",
                        "order": 1,
                        "belongs_to_time_window": true
                    }
                ]
            }
        ]
    }
}