Object: spots

Col­lec­tion of freight spots – at least one load­ing and one unload­ing is required.

Object Fields
AttributeTypeExam­pleManda­to­ryDescrip­tion
descrip­tionStringdescrip­tionNoDescrip­tion of the load­ing or unload­ing place
nameStringware­house 1NoName of spot
oper­a­tionsArray of ObjectsYesOper­a­tions to be com­plet­ed in giv­en spot
operations.operation_orderInt1YesOrder­ing of load­ing and unload­ing oper­a­tions at a giv­en spot — first oper­a­tion always is 1
operations.loadsObjectNoArray of loads to be loaded or unloaded dur­ing oper­a­tion
operations.loads.load_idString5ff7201734799NoRef­er­ence to a pre­vi­ous­ly defined load (see Object loads)
operations.loads.weightInt7NoWeight of load to be loaded or unloaded in oper­a­tion
operations.operation_timeInt60NoTime, in min­utes, to per­form the oper­a­tion at the point. This option is only avail­able for the Dock Sched­uler and ware­house spots.
operations.timespansObjectYesTimes­pan for select­ed oper­a­tions
operations.timespans.beginTime­stamp“2026–02–16T14:00:00+01:00”YesBegin­ning of time slot for load­ing or unload­ing oper­a­tion giv­en in publisher’s time zone — must be greater or equal today
operations.timespans.begin_localTime­stamp“2026–02–16T13:00:00+00:00”only responseBegin­ning of time slot for load­ing or unload­ing oper­a­tion giv­en in the local time zone of the spot
operations.timespans.endTime­stamp“2026–02–16T14:00:00+01:00”YesEnd of time slot for load­ing or unload­ing oper­a­tion giv­en in publisher’s time zone — must be greater than timespans.begin
operations.timespans.end_localTime­stamp“2026–02–16T13:00:00+00:00”only responseEnd of time slot for load­ing or unload­ing oper­a­tion giv­en in the local time zone of the spot
operations.timespans.timezoneString“Europe/London”only responseLocal time­zone of the spot
operations.typeString“load­ing”YesAccept­able val­ues: loading, unloading, customs_clearance.
The first place on the route required loading oper­a­tion, the last place required unloading oper­a­tion.
placeObjectYesInfor­ma­tion relat­ed to sin­gle place on freight’s route
place.addressObjectYesAddress of the select­ed point
place.address.countryStringPLYesCoun­try using ISO val­ues (see dic­tio­nary)
place.address.descriptionStringhead officeNoAddress descrip­tion
place.address.localityStringWrocławYesCity name
place.address.numberString12NoProp­er­ty num­ber
place.address.postal_codeString50–900YesPostal code
place.address.streetStringTrans­portowaNoStreet name
place.coordinatesObjectNoLon­gi­tude and lat­i­tude for select­ed point
place.coordinates.latitudeFloat53.35801NoLat­i­tude of the point along the freight route
place.coordinates.longitudeFloat-2.16539NoLon­gi­tude of the point along the freight route
spot_orderInt1YesOrder­ing of spot places — first spot always is 1
Example Object Body
"spots": [
        {
            "description": null,
            "name": null,
            "operations": [
                {
                    "loads": [],
                    "operation_order": 1,
                    "operation_time": null,
                    "timespans": {
                        "begin": "2026-01-02T13:04:18+01:00",
                        "begin_local": "2026-01-02T13:04:18+01:00",
                        "end": "2026-01-02T15:04:18+01:00",
                        "end_local": "2026-01-02T15:04:18+01:00",
                        "timezone": "Europe/Warsaw"
                    },
                    "type": "loading"
                }
            ],
            "place": {
                "address": {
                    "country": "pl",
                    "description": null,
                    "locality": "Wrocław",
                    "number": "2-4",
                    "postal_code": "53-146",
                    "street": "Racławicka"
                },
                "coordinates": {
                    "latitude": 51.0825872,
                    "longitude": 17.0038841
                }
            },
            "spot_order": 1
        },
        {
            "description": null,
            "name": null,
            "operations": [
                {
                    "loads": [],
                    "operation_order": 1,
                    "operation_time": null,
                    "timespans": {
                        "begin": "2026-01-03T13:04:18+01:00",
                        "begin_local": "2026-01-03T13:04:18+01:00",
                        "end": "2026-01-03T15:04:18+01:00",
                        "end_local": "2026-01-03T15:04:18+01:00",
                        "timezone": "Europe/Berlin"
                    },
                    "type": "customs_clearance"
                }
            ],
            "place": {
                "address": {
                    "country": "de",
                    "description": null,
                    "locality": "Munich",
                    "number": null,
                    "postal_code": "80331",
                    "street": null
                },
                "coordinates": {
                    "latitude": 48.135612857,
                    "longitude": 11.573308153
                }
            },
            "spot_order": 2
        },
        {
            "description": null,
            "name": null,
            "operations": [
                {
                    "loads": [],
                    "operation_order": 1,
                    "operation_time": null,
                    "timespans": {
                        "begin": "2026-01-05T13:04:18+01:00",
                        "begin_local": "2026-01-05T13:04:18+01:00",
                        "end": "2026-01-05T15:04:18+01:00",
                        "end_local": "2026-01-05T15:04:18+01:00",
                        "timezone": "Europe/San_Marino"
                    },
                    "type": "unloading"
                }
            ],
           "place": {
                "address": {
                    "country": "it",
                    "description": null,
                    "locality": "Milan",
                    "number": null,
                    "postal_code": "20097",
                    "street": null
                },
                "coordinates": {
                    "latitude": 45.397205283,
                    "longitude": 9.21659417
                }
            },
            "spot_order": 3
        }
    ],