1. Trans.eu Api
  2. Object
  3. Object: requirements

Object: requirements

Main freight require­ments.

Object Fields
AttributeTypeExam­pleManda­to­ryDescrip­tion
exemption_from_adrBooleanFalseNoThe load can be trans­port­ed by car­ri­er with­out ADR autho­riza­tion. It occurs only for other_requirements = adr.
is_ftlBooleanTrueYesDeter­mines if freight is a full truck load (True) or less than truck­load (False). See also transport.type below.
mon­i­tor­ingStringwithout_monitoringNoMon­i­tor­ing require­ment. Accept­able val­ues: required, without_monitoring.
other_requirementsArray of StringNoAddi­tion­al require­ments (see dic­tio­nary)
required_adr_classesArray of StringNoADR freight class­es (see dic­tio­nary)
required_door_typesArray of StringNoTip­per door types.
Avail­able only for dump-truck, aluminum, steel truck body. Accept­able val­ues: tailgate, door.
required_tipper_trailer_
additional_equipment		Array of StringNoTip­per equip­ment.
Avail­able only for dump-truck, aluminum, steel truck body. Accept­able val­ues: single_grain_hatch, double_grain_hatch, dust_sock.
required_truck_bodiesArray of StringYesExpect­ed vehi­cle body types matched to select­ed vehicle_size (see dic­tio­nary). Array can con­tains max 5 val­ues.
required_ways_of_loadingArray of StringNoThe way of loading/unloading vehi­cle. Accept­able val­ues: back, side, top.
shipping_remarksStringdescrip­tionNoAddi­tion­al ship­ping remarks
tem­per­a­tureObject125NoRequired freight trans­port tem­per­a­ture. It can be added only for one of the fol­low­ing truck_bodies: cooler, isotherm, hook-truck.
temperature.minInt-20NoThe input is between ‘-999’ and ‘999’, inclu­sive­ly
temperature.maxInt-5NoThe input is between ‘-999’ and ‘999’, inclu­sive­ly
trans­portObjectYes / NoRequired for multi_ftl trans­port type or for ton set­tle­ment.
transport.countInt5YesNum­ber of trans­ports — only occurs for multi_ftl trans­port type
transport.per_order_minInt1YesMin. lim­it of cours­es vis­i­ble for the con­trac­tor (range: 1 — transport.count)
transport.per_order_maxInt3YesMax. lim­it of cours­es vis­i­ble for the con­trac­tor (range: transport.per_order_min — transport.count)
transport.proposed_countInt2NoPre­ferred num­ber of cours­es per con­trac­tor.
transport.remainingInt2only responseNum­ber of trans­ports remain­ing to be nego­ti­at­ed by car­ri­er.
transport.schedule_typeStringcar­ri­erYesEdi­tor of sched­ul­ing haulages. Accept­able val­ues: shipper, carrier, together
transport.settlementStringtonYesType of set­tle­ment.
Avail­able val­ues: route, ton. Default is route.
For ton set­ting avail­able val­ues of required truck bod­ies are: aluminum, silos, steel, walkingfloor.
transport.settlement_basisStringload­ingYesSet­tle­ment basis.
No val­ues for route. Accept­able val­ues for ton: loading, unloading
transport.total_weightFloat24YesTotal trans­ports weight — only occurs for multi_ftl trans­port type with ton set­tle­ment
transport.typeStringftlYesTrans­port type.
If occurs it over­writes is_ftl attribute. Accept­able val­ues: ftl, ltl, multi_ftl
vehicle_sizeStringany_sizeNoExpect­ed vehi­cle size (see dic­tio­nary). Default val­ue is any_size. If you select any_size all 4 basic types of vehi­cle size are auto­mat­i­cal­ly select­ed.
Example Object Body
"requirements": {
        "exemption_from_adr": false,
        "is_ftl": true,
        "monitoring": "without_monitoring",
        "other_requirements": [
            "load_securing_poles",
            "qualimat_certificate",
            "adr"
        ],
        "required_adr_classes": [
            "adr_1"
        ],
        "required_door_types": [
            "tailgate"
        ],
        "required_tipper_trailer_additional_equipment": [
            "single_grain_hatch"
        ],
        "required_truck_bodies": [
            "dump-truck"
        ],
        "required_ways_of_loading": [
            "side"
        ],
        "shipping_remarks": "remarks",
        "temperature": {
            "max": null,
            "min": null
        },
        "transport": {
            "count": null,
            "schedule_type": "shipper",
            "settlement": "ton",
            "settlement_basis": "unloading",
            "total_weight": null,
            "type": "ftl"
        },
        "vehicle_size": "lorry"
    },