1. Trans.eu Api
  2. Orders
  3. Transport order description

Transport order description

Descrip­tion of trans­port orders ele­ments with the usage and con­di­tions.

Trans­port orders allow to send coop­er­a­tion details to pre­vi­ous­ly select­ed car­ri­er, which is spec­i­fied with Tran­sId.

Creating new order

With the use of Trans.eu API it is pos­si­ble to cre­ate new own trans­port order, dis­played in Trans.eu Plat­form in Orders Sent mod­ule. After the order is cre­at­ed, it is also pos­si­ble to update it’s con­tent if it was not yet sent to car­ri­er for accep­tance.

Components of a single transport order

Each order con­sists of:

  • valid car­ri­er id
  • sum­ma­ry and require­ments
  • list of loads
  • spots, which are divid­ed into:
    • address­es
    • oper­a­tions

Validation rules

Most impor­tant val­i­da­tion rules con­sid­er­ing cre­at­ing new trans­port order:

  • all dates must be greater or equal today
  • first oper­a­tion date has to be low­er than last oper­a­tion date
  • first oper­a­tion always has to be load­ing
  • last oper­a­tion always has to be unload­ing
  • each spot has own sequence of oper­a­tions per­formed, there­fore in each spot first oper­a­tion always has operation_order set to 1
  • address must con­sists coun­try, postal code and local­i­ty
  • pay­ment val­ue must be greater than 0
  • for list of required fields please refer to the sum­ma­ry table below

Order statuses

  • in-prepa­ra­tion,
  • pro­pos­al-wait­ing,
  • wait­ing-for-vehi­cle-and-dri­ver,
  • ready,
  • in-progress,
  • pro­pos­al-reject­ed,
  • wait­ing-for-arrival-con­fir­ma­tion,
  • wait­ing-for-unload­ing-con­fir­ma­tion,
  • wait­ing-for-proof-of-deliv­ery,
  • wait­ing-for-con­fir­ma­tion,
  • deliv­ery-con­firmed,
  • com­plet­ed,
  • archived,
  • can­celled.

Diagram

Visu­al­iza­tion of trans­port order man­age­ment process

Description and example values

Structure of posting new order

JsonIs requiredTypeExam­pleDescrip­tion
external_sourceNoString3_apiOrder source iden­ti­fi­er assigned to client_id pro­vid­ed by Trans.eu
freightYesObjectDescrip­tion of freight on which cre­at­ed order bases
freight.shipment_external_idNoString123xyzExter­nal iden­ti­fi­ca­tion num­ber
freight.requirementsYesObjectMain freight require­ments, includ­ing truck body and size, adr class­es, ways of load­ing, etc
freight.requirements.is_ftlYesBooleanTrueDeter­mines if freight is a full truck load or less than truck­load
freight.requirements.required_truck_bodiesYesArrayCur­tain­sid­er, BoxAllowed vehi­cle types
freight.requirements.required_ways_of_loadingNoArrayTopAllowed ways of load­ing
freight.requirements.required_adr_classesNoArrayAdr_1Allowed ADR class­es
freight.requirements.other_requirementsNoArrayLift, HdsArray of addi­tion­al freight require­ments
freight.requirements.shipping_remarksNoStringShip­ping remarksAddi­tion­al ship­ping remarks
freight.requirements.vehicle_size_idNoStringBusAvail­able vehi­cle sizes
freight.requirements.temperatureNoObjectCan be added for one of fol­low­ing truck bod­ies: cool­er, isotherm, hook truck
freight.requirements.temperature.minNoInt10The input is between ‘-999′ and ‘999’, inclu­sive­ly”
freight.requirements.temperature.maxNoInt100The input is between ‘-999′ and ‘999’, inclu­sive­ly”
freight.carrierYesObjectCar­ri­er select­ed for cre­at­ed order
freight.carrier.company_idYesInt1111111Car­ri­er Office-Id
freight.capacityYesInt or float20Total freight capac­i­ty in tonnes. This val­ue is being val­i­dat­ed in com­par­i­son to the sum of all loads.
Range: 0,001 — 100000
freight.loading_metersNoInt or float10Total freight load­ing meters
Range: 0,01 — 417
freight.loadsYesArray of objectsArray of loads. At least an emp­ty array has to be sent.
freight.loads.load_idNoString11xxzzLoad id, which should help iden­ti­fy loads des­ig­nat­ed to freight. If freight.loads is not emp­ty, the field is required.
freight.loads.nameNoStringName1Name of a load. If freight.loads is not emp­ty, the field is required.
freight.loads.type_of_loadNoStringEuropaletteName of sup­port­ed type of load If freight.loads is not emp­ty, the field is required.
freight.loads.weightNoInt or float15Load weight
freight.loads.heightNoInt or float1Load height
freight.loads.widthNoInt or float2Load width
freight.loads.lengthNoInt or float3Load length
freight.loads.volumeNoInt or float4Load vol­ume
freight.loads.amountNoInt5Amount of load types with­in giv­en load
freight.loads.descriptionNoString Description1 Load descrip­tion
freight.loads.is_stackableNoBooleanTrueSpec­i­fies whether the type of load allows stack­ing
freight.loads.is_exchangableNoBooleanTrueDeter­mines if type of load is avail­able for exchange at unload­ing place
freight.spotsYesObjectSpots for des­ig­nat­ed route, at least one spot with operation_type load­ing and one with operation_type unload­ing are required.
freight.spots.nameNoStringMag­a­zine 1Name of the load­ing or unload­ing place
freight.spots.descriptionNoStringExam­ple descrip­tionDescrip­tion of the load­ing or unload­ing place
freight.spots.spot_orderYesInt1Infor­ma­tion about the order of spot places — first spot always has spot_order set to 1
freight.spots.placeYesObjectInfor­ma­tion relat­ed to sin­gle place on freight’s route
freight.spots.place.addressYesObjectAddress data
freight.spots.place.address.countryYesStringPLCoun­try ISO val­ue
freight.spots.place.address.postal_codeYesString31–001Postal code
freight.spots.place.address.localityYesStringKrakówCity name
freight.spots.place.address.streetNoStringWawelStreet name
freight.spots.place.address.numberNoString5Num­ber
freight.spots.place.address.descriptionNoStringExam­pledescrip­tionSpot address descrip­tion
freight.spots.place.address.coordinatesNoObjectLon­gi­tude and lat­i­tude for select­ed point
freight.spots.place.address.coordinates.latitudeNoFloat50.06143 Lat­i­tude of the point along the freight route
freight.spots.place.address.coordinates.longitudeNoFloat19.93658 Lon­gi­tude of the point along the freight route
freight.spots.operationsYesArray of objectsArray of oper­a­tions to be com­plet­ed in giv­en spot
freight.spots.operations.operation_orderYesInt1The order of load­ing and unload­ing oper­a­tions at a giv­en spot. First oper­a­tion always has operation_order set to 1
freight.spots.operations.loadsYesArray of objectsArray of loads to be loaded or unloaded dur­ing oper­a­tion
freight.spots.operations.typeYesStringLoad­ingCould be either load­ing or unload­ing, at least one of each is required. First oper­a­tion always has to be load­ig, last­op­er­a­tional­ways has to be unload­ing
freight.spots.operations.timespansYesObjectTimes­pan for select­ed oper­a­tion
freight.spots.operations.timespans.beginYesTime­stamp2021–06-22T11:00:00+0200 Begin­ning of load­ing or unload­ing oper­a­tion
freight.spots.operations.timespans.endYesTime­stamp2021–06-22T12:00:00+0200 End of load­ing or unload­ing oper­a­tion
additional_termsNoStringNullTrans­port order addi­tion­al terms
num­berNoString2021/06/22/2Trans­port order num­ber
pay­mentYesObjectInfor­ma­tion about pay­ment
payment.daysYesInt30Pay­ment due date in cal­len­dar days
payment.priceYesObjectPrice infor­ma­tion
payment.price.typeYesStringKmCan be either route or km
payment.price.valueYesInt or float1500Price val­ue
payment.price.currencyYesStringPlnPrice cur­ren­cy
mon­i­tor­ingYesObjectInfor­ma­tion about mon­i­tor­ing
monitoring.requiredYesBooleanTrueDefines if mon­i­tor­ing is demand­ed
insur­anceNoObjectInfor­ma­tion about insur­ance
insurance.loadNoObjectInfor­ma­tion about load insur­ance
insurance.load.valueNoInt1000Load val­ue
insurance.load.currencyNoStringPlnLoad val­ue cur­ren­cy
insurance.third_partyNoObjectRequired dri­ver’s lia­bil­i­ty insur­ance infor­ma­tion
insurance.third_party.valueNoInt100Required dri­ver’s lia­bil­i­ty insur­ance val­ue
insurance.third_party.currencyNostringPlnRequired dri­ver’s lia­bil­i­ty insur­ance cur­ren­cy

Posting new order — Json example

{
  "external_source": "3_api",
  "freight": {
    "shipment_external_id": "123xyz",
    "requirements": {
      "is_ftl": true,
      "required_truck_bodies": [
        "curtainsider",
        "box"
      ],
      "required_ways_of_loading": [
        "top"
      ],
      "required_adr_classes": [
        "adr_1"
      ],
      "other_requirements": [
        "lift",
        "hds"
      ],
      "shipping_remarks": "Shipping remarks",
      "vehicle_size_id": "bus",
      "temperature": {
        "min": 10,
        "max": 100
      }
    },
    "carrier": {
      "company_id": 1111111
    },
    "capacity": 20,
    "loading_meters": 10,
    "loads": [
      {
        "load_id": "11xxzz",
        "name": "name1",
        "type_of_load": "europalette",
        "weight": 15,
        "height": 1,
        "width": 2,
        "length": 3,
        "volume": 4,
        "amount": 5,
        "description": "Description1",
        "is_exchangeable": true,
        "is_stackable": true
      }
    ],
    "spots": [
      {
        "name": "Magazine 1",
        "description": "Example description",
        "spot_order": 1,
        "place": {
          "address": {
            "locality": "Kraków",
            "postal_code": "31-001",
            "country": "PL",
            "street": "Wawel",
            "number": "5"
          },
          "coordinates": {
            "latitude": 50.06143,
            "longitude": 19.93658
          }
        },
        "operations": [
          {
            "operation_order": 1,
            "loads": [],
            "type": "loading",
            "timespans": {
              "begin": "2021-06-22T11:00:00+0200",
              "end": "2021-06-22T12:00:00+0200"
            }
          }
        ]
      },
      {
        "name": null,
        "description": "Example description",
        "spot_order": 2,
        "place": {
          "address": {
            "locality": "Dąbrowa Środkowa",
            "postal_code": "59-330",
            "country": "PL",
            "street": "Średnia",
            "number": "34"
          },
          "coordinates": {
            "latitude": 51.41828,
            "longitude": 16.33485
          }
        },
        "operations": [
          {
            "type": "unloading",
            "operation_order": 1,
            "loads": [],
            "timespans": {
              "begin": "2021-06-23T11:00:00+0200",
              "end": "2021-06-23T11:00:00+0200"
            }
          }
        ]
      }
    ]
  },
  "additional_terms": null,
  "number": "2021/06/22/2",
  "payment": {
    "days": 30,
    "price": {
      "type": "km",
      "value": 1500,
      "currency": "pln"
    }
  },
  "monitoring": {
    "required": true
  },
  "insurance": {
    "load": {
      "value": 1000,
      "currency": "pln"
    },
    "third_party": {
      "value": 100,
      "currency": "pln"
    }
  }
}

Structure of getting orders list

JsonTypeExam­pleDescrip­tion
attach­mentsObjectInfor­ma­tion about attached doc­u­ments
attachments.descriptionStringExam­ple descrip­tionDoc­u­ment descrip­tion
attachments.media_idString73b95cd1-2dfd-40c4-9785–469fb097bf7bDoc­u­ment id
attachments.media_nameStringFile nameDoc­u­ment name
attachments.type_idStringWay­billDoc­u­ment type one of the fol­low­ing: way­bill, transport_order, cession_scan, cargo_photo, invoice_scan, cmr, oth­er
created_atTime­stamp2021–03-10T13:53:18.246ZOrder cre­ation date
dri­verObjectDri­ver infor­ma­tion
driver.account_idInt771476Dri­ver account id
driver.family_nameStringKowal­s­kiDri­ver last name
driver.full_nameStringJan Kowal­s­kiDri­ver full name
driver.given_nameStringJanDri­ver first name
driver.phoneInt111111111Dri­ver phone num­ber
freightObjectDescrip­tion of freight on which cre­at­ed order bases
freight.carrierObjectCar­ri­er select­ed for cre­at­ed order
freight.carrier.assigneeObjectFreight assignee on carrier’s side
freight.carrier.assignee.account_idInt749989Assignee account id
freight.carrier.assignee.family_nameStringKowal­s­kaAssignee last name
freight.carrier.assignee.given_nameStringAnnaAssignee first name
freight.carrier.assignee.trans_idString1013865–1Assignee Trans-Id
freight.carrier.legal_nameStringPrze­woźnik TestCom­pa­ny name
freight.carrier.vat_idStringPL111111111Com­pa­ny VAT num­ber
freight.reference_numberStringFR/2021/03/11/IETYFreight num­ber
freight.shipment_external_idString123xyzExter­nal iden­ti­fi­ca­tion num­ber
freight.shipperObjectShip­per infor­ma­tion
freight.shipper.assigneeObjectFreight assignee on shipper’s side
freight.shipper.assignee.account_idInt749989Assignee account id
freight.shipper.assignee.family_nameStringKowal­s­kiAssignee last name
freight.shipper.assignee.given_nameStringTomaszAssignee first name
freight.shipper.assignee.trans_idString1007374–1Assignee Trans-Id
freight.shipper.legal_nameStringFir­ma TestowaCom­pa­ny name
freight.shipper.vat_idStringPL2222222222Com­pa­ny VAT num­ber
freight.spotsObjectSpots for des­ig­nat­ed route, at least one spot with operation_type load­ing and one with operation_type unload­ing are required.
freight.spots.nameStringMag­a­zine 1Name of the load­ing or unload­ing place
freight.spots.descriptionStringExam­ple descrip­tionDescrip­tion of the load­ing or unload­ing place
freight.spots.operationsArray of objectsArray of oper­a­tions to be com­plet­ed in giv­en spot
freight.spots.operations.loadsArray of objectsArray of loads to be loaded or unloaded dur­ing oper­a­tion
freight.spots.operations.loads.loadArray of objectsArray of loads
freight.spots.operations.loads.load.load_idString11xxzzLoad id, which should help iden­ti­fy loads des­ig­nat­ed to freight
freight.spots.operations.loads.load.nameStringName1Name of a load
freight.spots.operations.loads.load.type_of_loadStringEuropaletteName of sup­port­ed type of load
freight.spots.operations.loads.load.weightInt or float15Load weight
freight.spots.operations.loads.load.heightInt or float1Load height
freight.spots.operations.loads.load.widthInt or float2Load width
freight.spots.operations.loads.load.lengthInt or float3Load length
freight.spots.operations.loads.load.volumeInt or float4Load vol­ume
freight.spots.operations.loads.load.amountInt5Amount of load types with­in giv­en load
freight.spots.operations.loads.load.descriptionStringDescription1Load descrip­tion
freight.spots.operations.loads.load.loads.is_stackableBooleantrueSpec­i­fies whether the type of load allows stack­ing
freight.spots.operations.loads.load.loads.is_exchangableBooleantrueDeter­mines if type of load is avail­able for exchange at unload­ing place
freight.spots.operations.operation_orderInt1The order of load­ing and unload­ing oper­a­tions at a giv­en spot.  First oper­a­tion always has operation_order set to 1
freight.spots.operations.time_windowObjectTime win­dow infor­ma­tion
freight.spots.operations.time_window.reference_numberStringDS/206D65Time slot ref­er­ence num­ber
freight.spots.operations.time_window_reasonStringNullIf time win­dow has been cre­at­ed rea­son will be null, if not rea­son may be: lack_of_slots, lack_of_warehouse, more_than_one_warehouse, date_scope_exceeded
freight.spots.operations.timespansObjectTimes­pan for select­ed oper­a­tion
freight.spots.operations.timespans.beginTime­stamp2021–06-22T11:00:00+0200Begin­ning of load­ing or unload­ing oper­a­tion
freight.spots.operations.timespans.endTime­stamp2021–06-22T12:00:00+0200End of load­ing or unload­ing oper­a­tion
freight.spots.operations.typeStringLoad­ingCould be either load­ing or unload­ing, at least one of each is required. First oper­a­tion always has to be load­ing, last oper­a­tion always has to be unload­ing
freight.spots.placeObjectInfor­ma­tion relat­ed to sin­gle place on freight’s route
freight.spots.place.addressObjectAddress data
freight.spots.place.address.countryStringPLCoun­try ISO val­ue
freight.spots.place.address.postal_codeString31–001Postal code
freight.spots.place.address.localityStringKrakówCity name
freight.spots.place.address.streetStringWawelStreet name
freight.spots.place.address.numberString5Num­ber
freight.spots.place.address.descriptionStringExam­ple descrip­tionSpot address descrip­tion
freight.spots.place.address.coordinatesObjectLon­gi­tude and lat­i­tude for select­ed point
freight.spots.place.address.coordinates.latitudeFloat50.06143Lat­i­tude of the point along the freight route
freight.spots.place.address.coordinates.longitudeFloat19.93658Lon­gi­tude of the point along the freight route
freight.spots.spot_orderInt1Infor­ma­tion about the order of spot places – first spot always has spot_order set to 1
idString7999470e-43eb-450b-bb83-9a9e07325c­c6Order id
invoiceStringNullInfor­ma­tion about invoice
legacy_freight_idInt708481Freight Id bas­ing on which order was cre­at­ed auto­mat­i­cal­ly
mon­i­tor­ingObjectInfor­ma­tion about mon­i­tor­ing
monitoring.providersStringTrans_taskMon­i­tor­ing provider infor­ma­tion
monitoring.requiredBooleanTrueDefines if  mon­i­tor­ing is demend­ed
num­berString2021/05/24/5Order num­ber
pay­mentObjectInfor­ma­tion about pay­ment
payment.daysInt30Pay­ment due date in cal­len­dar days
payment.priceObjectPrice infor­ma­tion
payment.price.typeStringKmCan be either route or km
payment.price.valueInt or float1500Price val­ue
payment.price.currencyStringPlnPrice cur­ren­cy
sta­tusObjectOrder sta­tus infor­ma­tion
status.commentStringAddi­tion­al com­mentAddi­tion­al com­ment for order in sta­tus can­celled or pro­pos­al reject­ed
status.valueStringReadyPos­si­ble sta­tus val­ues
vehi­cleObjectVehi­cle infor­ma­tion
vehicle.semi_trailerObjectSemi trail­er infor­ma­tion
vehicle.semi_trailer.dispatcher_idInt42026Dis­patch­er id
vehicle.semi_trailer.idInt236987Trail­er id
vehicle.semi_trailer.kindStringLor­rySemi trail­er kind
vehicle.semi_trailer.registration_plate_numberStringDWR9999999Semi trail­er reg­is­tra­tion plate num­ber
vehicle.semi_trailer.typeStringNullTrail­er type
vehicle.truckObjectTruck infor­ma­tion
vehicle.truck.dispatcher_idInt42026Dis­patch­er id
vehicle.truck.idInt236987Truck id
vehicle.truck.kindStringBus_vanTruck kind
vehicle.truck.registration_plate_numberStringDWR9999999Truck reg­is­tra­tion plate num­ber
vehicle.truck.typeStringCool­erTruck type

Structure of getting single order

JsonTypeExam­pleDescrip­tion
additional_termsStringOrder addi­tion­al termsAddi­tion­al arrange­ments
archived_atTime­stamp2021–06-29T10:31:23.398ZInfor­ma­tion about order archiviza­tion date
attach­mentsObjectInfor­ma­tion about attached doc­u­ments
attachments.descriptionStringExam­ple descrip­tionDoc­u­ment descrip­tion
attachments.media_idString73b95cd1-2dfd-40c4-9785–469fb097bf7bDoc­u­ment id
attachments.media_nameStringFile nameDoc­u­ment name
attachments.type_idStringWay­billDoc­u­ment type one of the fol­low­ing: way­bill, transport_order, cession_scan, cargo_photo, invoice_scan, cmr, oth­er
can­cel­la­tionObjectCan­cel­la­tion info­ma­tion for can­celled orders
cancellation.cancelled_atTime­stamp2021–06-29T10:31:23.398ZCan­cel­la­tion date
cancellation.cancelled_byObjectPer­son can­celling order infor­ma­tion
cancellation.cancelled_by.company_idInt1013865Com­pa­ny Id
cancellation.explanationStringOrder can­celled becauseAddi­tion­al expla­na­tion for can­cel­la­tion
cancellation.reasonsArrayPos­si­ble rea­sons on shipper’s side: contractor_did_not_obey_arrangements, oth­er, out_of_stock, otherwise_transported, contractor_tried_to_change_arrangement
Pos­si­ble rea­sons on carrier’s side: “no_driver”, “contractor_did_not_obey_arrangements”, “contractor_tried_to_change_arrangements”, “other”,“no_car”
cancellation.responseStringResponse to order can­cel­la­tionResponse to order can­cel­la­tion
coop­er­a­tionObjectInfor­ma­tion about coop­er­a­tion sta­tus between com­pa­nies
cooperation.statusStringACTIVECan be active or sus­pend­ed
created_atTime­stamp2021–06-24T08:31:46.425ZOrder cre­ation date
dri­verObjectDri­ver infor­ma­tion
driver.account_idInt771476Dri­ver account id
driver.emailStringtrans@trans.euDri­ver e‑mail address
driver.employee_idInt771477Employ­ee id
driver.family_nameStringKowal­s­kiDri­ver last name
driver.full_nameStringJan Kowal­s­kiDri­ver full name
driver.given_nameStringJanDri­ver first name
driver.identity_document_numberStringNullDri­ver doc­u­ment num­ber
freightObjectDescrip­tion of freight on which cre­at­ed order bases
freight.carrierObjectCar­ri­er select­ed for cre­at­ed order
freight.carrier.assigneeObjectFreight assignee on carrier’s side
freight.carrier.assignee.account_idInt749989Assignee id
freight.carrier.assignee.emailStringtest@trans.euAssignee email address
freight.carrier.assignee.family_nameStringKowal­s­kaAssignee last name
freight.carrier.assignee.faxString11222222222Assignee fax num­ber
freight.carrier.assignee.given_nameStringAnnaAssignee first name
freight.carrier.assignee.telephoneString11222222222Assignee tele­phone num­ber
freight.carrier.assignee.trans_idString1013865–1Assignee Trans-Id
freight.carrier.legal_nameStringPrze­woźnik TestCom­pa­ny name
freight.carrier.vat_idStringPL111111111Com­pa­ny VAT num­ber
freight.reference_numberStringFR/2021/03/11/IETYFreight num­ber
freight.shipment_external_idString123xyzExter­nal iden­ti­fi­ca­tion num­ber
freight.requirementsObjectMain freight require­ments, includ­ing truck body and size, adr class­es, ways of load­ing, etc.
freight.requirements.is_ftlBooleanTrueDeter­mines if freight is a full truck load or less than truck­load
freight.requirements.required_truck_bodiesArrayCur­tain­sid­er, BoxAllowed vehi­cle types
freight.requirements.required_ways_of_loadingArrayTopAllowed ways of load­ing
freight.requirements.required_adr_classesArrayAdr_1Allowed ADR class­es
freight.requirements.other_requirementsArrayLift, HdsArray of addi­tion­al freight require­ments
freight.requirements.shipping_remarksStringShip­ping remarksAddi­tion­al ship­ping remarks
freight.requirements.vehicle_size_idStringBusAvail­able vehi­cle sizes
freight.requirements.temperatureObjectCan be added for one of fol­low­ing truck bod­ies: cool­er, isotherm, hook truck
freight.requirements.temperature.minInt10The input is between ‘-999’ and ‘999’, inclu­sive­ly”
freight.requirements.temperature.maxInt100The input is between ‘-999’ and ‘999’, inclu­sive­ly”
freight.shipperObjectAssignee Trans-Id
freight.shipper.assigneeObjectFreight assignee on shipper’s side
freight.shipper.assignee.account_idInt749989Assignee account id
freight.shipper.assignee.emailStringtrans@trans.euAssignee email address
freight.shipper.assignee.family_nameStringKowal­s­kiAssignee last name
freight.shipper.assignee.faxString22111111111Assignee fax num­ber
freight.shipper.assignee.given_nameStringTomaszAssignee first name
freight.shipper.assignee.telephoneString22111111111Assignee tele­phone num­ber
freight.shipper.assignee.trans_idString1007374–1Assignee Trans-Id
freight.shipper.legal_nameStringFir­ma TestowaCom­pa­ny name
freight.shipper.vat_idStringPL2222222222Com­pa­ny VAT num­ber
freight.spotsObjectSpots for des­ig­nat­ed route, at least one spot with operation_type load­ing and one with operation_type unload­ing are required
freight.spots.nameStringMag­a­zine 1Name of the load­ing or unload­ing place
freight.spots.descriptionStringExam­ple descrip­tionDescrip­tion of the load­ing or unload­ing place
freight.spots.operationsArray of objectsArray of oper­a­tions to be com­plet­ed in giv­en spot
freight.spots.operations.loadsArray of objectsArray of loads to be loaded or unloaded dur­ing oper­a­tion
freight.spots.operations.loads.loadArray of objectsArray of loads
freight.spots.operations.loads.load.load_idString11xxzzLoad id, which should help iden­ti­fy loads des­ig­nat­ed to freight
freight.spots.operations.loads.load.nameStringName1Name of a load
freight.spots.operations.loads.load.type_of_loadStringEuropaletteName of sup­port­ed type of load
freight.spots.operations.loads.load.weightInt or float15Load weight
freight.spots.operations.loads.load.heightInt or float1Load height
freight.spots.operations.loads.load.widthInt or float2Load width
freight.spots.operations.loads.load.lengthInt or float3Load length
freight.spots.operations.loads.load.volumeInt or float4Load vol­ume
freight.spots.operations.loads.load.amountInt5Amount of load types with­in giv­en load
freight.spots.operations.loads.load.descriptionStringDescription1Load descrip­tion
freight.spots.operations.loads.load.loads.is_stackableBooleantrueSpec­i­fies whether the type of load allows stack­ing
freight.spots.operations.loads.load.loads.is_exchangableBooleantrueDeter­mines if type of load is avail­able for exchange at unload­ing place
freight.spots.operations.operation_orderInt1The order of load­ing and unload­ing oper­a­tions at a giv­en spot. First oper­a­tion always has operation_order set to 1
freight.spots.operations.time_windowObjectTime win­dow infor­ma­tion
freight.spots.operations.time_window.reference_numberStringDS/206D65Time slot ref­er­ence num­ber
freight.spots.operations.time_window_reasonStringNullIf time win­dow has been cre­at­ed rea­son will be null, if not rea­son may be: lack_of_slots, lack_of_warehouse, more_than_one_warehouse, date_scope_exceeded
freight.spots.operations.timespansObjectTimes­pan for select­ed oper­a­tion
freight.spots.operations.timespans.beginTime­stamp2021–06-22T11:00:00+0200Begin­ning load­ing or unload­ing oper­a­tion
freight.spots.operations.timespans.endTime­stamp2021–06-22T12:00:00+0200End load­ing or unload­ing oper­a­tion
freight.spots.operations.typeStringLoad­ingCould be either load­ing or unload­ing, at least one of each is required. First oper­a­tion always has to be load­ig, last oper­a­tion always has to be unload­ing
freight.spots.placeObjectInfor­ma­tion relat­ed to sin­gle place on freight’s route
freight.spots.place.addressObjectAddress data
freight.spots.place.address.countryStringPLCoun­try ISO val­ue
freight.spots.place.address.postal_codeString31–001Postal code
freight.spots.place.address.localityStringKrakówCity name
freight.spots.place.address.streetStringWawelStreet name
freight.spots.place.address.numberString5Num­ber
freight.spots.place.address.descriptionStringExam­ple descrip­tionSpot address descrip­tion
freight.spots.place.address.coordinatesObjectLon­gi­tude and lat­i­tude for select­ed point
freight.spots.place.address.coordinates.latitudeFloat50.06143Lat­i­tude of the point along the freight route
freight.spots.place.address.coordinates.longitudeFloat19.93658Lon­gi­tude of the point along the freight route
freight.spots.spot_orderInt1Infor­ma­tion about the order of spot places – first spot always has spot_order set to 1
idString7999470e-43eb-450b-bb83-9a9e07325c­c6Order Id
insur­anceObjectInfor­ma­tion about insur­ance
insurance.loadObjectInfor­ma­tion about load insur­ance
insurance.load.valueInt1000Load val­ue
insurance.load.currencyStringPlnLoad val­ue cur­ren­cy
insurance.third_partyObjectRequired driver’s lia­bil­i­ty insur­ance infor­ma­tion
insurance.third_party.valueInt100Required driver’s lia­bil­i­ty insur­ance val­ue
insurance.third_party.currencyStringPlnRequired driver’s lia­bil­i­ty insur­ance cur­ren­cy
invoiceStringNullInvoice infor­ma­tion
is_archived_permanentlyBooleanFlaseInfor­ma­tion about archiviza­tion
legacy_freight_idInt410610Freight Id bas­ing on which order was cre­at­ed auto­mat­i­cal­ly
mon­i­tor­ingObjectInfor­ma­tion about mon­i­tor­ing
monitoring.providersStringTrans_taskMon­i­tor­ing provider infor­ma­tion
monitoring.requiredBooleanTrueDefines if you demand mon­i­tor­ing from car­ri­er
num­berString2021/06/22/2Trans­port order num­ber
pay­mentObjectInfor­ma­tion about pay­ment
payment.daysInt30Pay­ment due date in cal­len­dar days
payment.priceObjectPrice infor­ma­tion
payment.price.typeStringKmCan be either per route or km
payment.price.valueInt or float1500Price val­ue
payment.price.currencyStringPlnPrice cur­ren­cy
relat­edObjectInfor­ma­tion about relat­ed orders
sourceStringApiCan be either offer or api
sta­tusObjectOrder sta­tus infor­ma­tion
status.commentStringAddi­tion­al com­mentAddi­tion­al com­ment for order in sta­tus can­celled or pro­pos­al reject­ed
status.valueStringReadyPos­si­ble sta­tus val­ues: in-prepa­ra­tion, pro­pos­al-wait­ing, wait­ing-for-vehi­cle-and-dri­ver, ready , can­celled, pro­pos­al-reject­ed, wait­ing-for-con­fir­ma­tion
vehi­cleObjectVehi­cle infor­ma­tion
vehicle.semi_trailerObjectSemi trail­er infor­ma­tion
vehicle.semi_trailer.dispatcher_idInt42026Dis­patch­er id
vehicle.semi_trailer.idInt236987Trail­er id
vehicle.semi_trailer.kindStringLor­rySemi trail­er kind
vehicle.semi_trailer.registration_plate_numberStringDWR9999999Semi trail­er reg­is­tra­tion plate num­ber
vehicle.semi_trailer.typeStringNullTrail­er type
vehicle.truckObjectTruck infor­ma­tion
vehicle.truck.dispatcher_idInt42026Dis­patch­er id
vehicle.truck.idInt236987Truck id
vehicle.truck.kindStringBus_vanTruck kind
vehicle.truck.registration_plate_numberStringDWR9999999Truck reg­is­tra­tion plate num­ber
vehicle.truck.typeStringCool­erTruck type

Impor­tant!
Weight is always rep­re­sent­ed in tonnes.
Height, length and width are always rep­re­sent­ed in meters.