Structure "Cargo Filter"
This structure describes the parameters of the cargo filter.
Field descriptions
Name | Description | Data type | Required |
---|---|---|---|
id | Current page. | String | |
name | Number of pages. | String | |
companyRefId | Company identifier. | Number | |
directionFrom | Loading point. Structure "Directions" | ProposalDirection | + |
directionTo | Unloading point. Structure "Directions" | ProposalDirection | |
distanceKmFrom | Distance from loading point. | Number | |
distanceKmTo | Distance from unloading point. | Number | |
dateFromISO | Start date of loading in ISO format. | String | |
dateToISO | End date of loading in ISO format. | String | |
dateCreate | Creation date. | String | |
dateUpdate | Update date | String | |
bodyTypeIds | Cargo type | Array of numbers | |
loadTypes | Body type | Array of strings | |
mass1 | Lower limit of cargo mass, tons. | Number | |
mass2 | Upper limit of cargo mass, tons. | Array of strings | |
volume1 | Lower limit of cargo volume, m3. | Number | |
volume2 | Upper limit of cargo volume, m3. | Number | |
length | Cargo length, m. | Array of strings | |
width | Cargo width, m. | Number | |
height | Cargo height, m. | Number | |
cmr | Presence of CMR waybill. | Boolean | |
groupage | Ability for groupage. | Boolean | |
photos | Presence of photos. | Boolean | |
t1 | Presence of T1 transit document. | Boolean | |
tir | Presence of TIR transit document. | Boolean | |
adr | ADR class. | String | |
paymentFormIds | Array of payment method identifiers. | Array of numbers | |
onlyNew | Only new offers. | Boolean | |
onlyActual | Only current offers. | Boolean | |
onlyApproved | Only approved offers. | Boolean | |
onlyShippers | Only shippers. | Boolean | |
onlyWithStavka | Only with rate. | Boolean | |
onlyPartners | Only partners. | Boolean | |
partnerGroups | Partner group. | Array of numbers | |
excludeIgnores | Excluded. | Boolean | |
onlyCarrier | Only carrier. | Boolean | |
onlyCarrierGps | Only carrier GPS. | Boolean | |
ekmt | EKMT certificate. | Boolean | |
frc | FRC certificate. | Boolean | |
medBook | Presence of medical certificate. | Boolean | |
customControl | Customer control. | Boolean | |
cargoId | Cargo identifier. | Number | |
cargoName | Cargo name. | String | |
priceRequest | Price request. | Boolean | |
cargoPackagingIds | Array of packaging type identifiers from the Reference book. | Array of numbers | |
cargo | Array of cargo type identifiers from the Reference Book | Array |
Example
JSON
{
"id": "",
"name": "тип груза",
"companyRefId": null,
"directionFrom": {
...
},
"directionTo": {
...
},
"dateFromISO": null,
"dateToISO": null,
"dateCreate": "2020-07-21T11:23:22.057+0000",
"dateUpdate": "2025-07-22T07:58:43.503+0000",
"bodyTypeIds": [],
"bodyTypeGroupIds": [],
"loadTypes": ["tent_off"],
"loadTypesStrict": false,
"mass1": 0,
"mass2": 0,
"volume1": 0,
"volume2": 0,
"length": null,
"width": null,
"height": null,
"cmr": null,
"groupage": false,
"photos": null,
"t1": null,
"tir": null,
"adr": null,
"paymentFormIds": [],
"onlyNew": false,
"onlyActual": false,
"onlyApproved": false,
"onlyShippers": false,
"onlyWithStavka": false,
"onlyPartners": null,
"excludeIgnores": false,
"onlyCarrier": false,
"onlyCarrierGps": null,
"onlyTopBrand": false,
"medBook": null,
"customControl": null,
"bodyTypeStrict": false,
"cargoId": 8,
"cargoName": null,
"cargo": []
}