Structure "Freight"
This structure describes a freight offer.
Field description
Name | Description | Data type | Required |
---|---|---|---|
id |
Unique offer id. | Number | + |
dateCreate |
Date of creating the offer, ms. | Timestamp | + |
dateRepeat |
Date of the offer repeat, ms. | Timestamp | + |
dateFrom |
Loading date, ms. | Timestamp | + |
dateTo |
Unloading date, ms. | Timestamp | + |
distanceLine |
Delivery distance calculated by road maps, m. | Number | + |
distanceTime |
Approximate delivery time according to calculated distance, ms. | Number | + |
waypointListSource |
Collection locations. | Array of "Collection location" structures | + |
waypointListTarget |
Delivery locations. | Array of "Collection location" structures | + |
bodyType |
Truck type from the directory (deprecated). | Structure "Basic directory element" | + |
bodyGroup |
Group of truck types from the directory (deprecated). | Structure "Basic directory element" | + |
cargoBodyTypes |
List of truck types from the directory. | Array of "Basic directory element" structures | + |
loadTypes |
Types of loading from the directory. | Array of "Basic directory element" structures | + |
payment |
Various aspects of payment in the offer. | Structure "Payment" | + |
note |
Note. | String | + |
cmr |
CMR consignment note. | Logical | + |
cmrInsurance |
CMR insurance. | Logical | + |
groupage |
LTL shipment option. | Logical | |
repeat |
Data about the offer repeats. | Structure "Offer repeats" | + |
t1 |
T1 transit declaration. | Logical | + |
tir |
TIR Carnet. | Logical | + |
adr |
ADR class. | Number | |
lorryAmount |
Required number of vehicles. | Number | |
photos |
Photos associated with the offer. | URL array | |
cargoPackaging[].type |
Package type | Structure "Basic directory element" | |
cargoPackaging[].count |
Number of package. | Number | |
paymentForms[].type |
Payment type | Structure "Basic directory element" | |
paymentForms[].vat |
VAT, if any | Logical | |
refrigeratorRegime |
Refrigerator temperature range. | Structure "Refrigerator temperature range" | |
content |
Load name. | Structure "Basic directory element" | + |
content.name |
Localized name. Can be an arbitrary string if the load name is not selected from the directory. | String | |
size |
Freight dimensions. | Structure "Freight dimensions" | + |
medicalRecords |
Medical records. | Logical | + |
customsControl |
Whether the shipment is under customs control. | Logical | + |
loadingFrequency |
Loading frequency from the directory. | Structure "Basic directory element" | |
owner |
Offer owner. | Structure "Offer owner" | |
cargoBodyTypeProperties |
Body characteristics - Doubledeck, Jumbo, Mega. | Array of names |
Sample
JSON
{
"id": 350203537,
"dateCreate": 1583231716000,
"dateRepeat": 1583231716000,
"dateFrom": 1583193600000,
"dateTo": 1583193600000,
"distanceLine": 1007483.586,
"distanceTime": 46075299,
"waypointListSource": [
{
"town": {
"id": 69,
"name": "Харьков"
},
"area": {
"id": 34,
"name": "Харьковская обл."
},
"country": {
"sign": "UA",
"name": "Украина"
},
"postCode": "61",
"address": "Зенитная улица, Павловка",
"lat": 49.9935,
"lon": 36.230383
}
],
"waypointListTarget": [
{
"town": {
"id": 179,
"name": "Львов"
},
"area": {
"id": 27,
"name": "Львовская обл."
},
"country": {
"sign": "UA",
"name": "Украина"
},
"postCode": "",
"address": "Золотая улица, 17",
"lat": 49.839683,
"lon": 24.029717
}
],
"bodyType": {
"id": 36,
"name": "Цельномет"
},
"bodyGroup": {
"id": 1,
"name": "Крытая"
},
"loadTypes": [
{
"id": 25,
"name": "боковая"
},
{
"id": 24,
"name": "верхняя"
},
{
"id": 26,
"name": "задняя"
}
],
"payment": {
"price": "1000",
"currency": {
"id": 2,
"name": "грн."
},
"unit": {
"id": 2,
"name": "км"
},
"moment": {
"id": 4,
"name": "на выгрузке"
},
"type": {
"id": 4,
"name": "безнал."
},
"prepay": 10,
"delay": 0,
"vat": true
},
"owner": {
"refId": 10101583040,
"name": "Ларди-Tест Бренд",
"face": "Контактное лицо",
"contactId": 0,
"phones": [
{
"number": "+380(95)1234567",
"messengers": [
"WHATSAPP",
"TELEGRAM",
"VIBER"
]
},
{
"number": "+380(95)2345678",
"messengers": [
"TELEGRAM"
]
},
{
"number": "+380(95)3456789",
"messengers": []
},
{
"number": "+380(95)4567890",
"messengers": []
}
],
"address": {
"town": {
"id": 69,
"name": "Харьков"
},
"area": {
"id": 34,
"name": "Харьковская обл."
},
"country": {
"sign": "UA",
"name": "Украина"
}
},
"rating": {
"positiveCommentCount": 7,
"negativeCommentCount": 1
}
},
"note": "хрупкий хруз",
"cmr": true,
"cmrInsurance": false,
"groupage": true,
"t1": false,
"tir": false,
"adr": 1,
"lorryAmount": 2,
"photos": [
"http://medianew.lardi-trans.com/originImage/proposal/5e5e3297f96e155451771afb/logo.jpg"
],
"repeat": {
"auto": false,
"countToday": 0
},
"content": {
"id": 1403,
"name": "стекло в ящиках"
},
"size": {
"massFrom": 15,
"massTo": 20,
"volumeFrom": 80,
"volumeTo": 90,
"length": 0,
"width": 0,
"height": 0
},
"medicalRecords": true,
"customsControl": false,
"loadingFrequency": {
"id": 3,
"name": "в неделю"
},
"cargoBodyTypeProperties": [
"Mega",
"Jumbo"
],
}