Preliminary evaluation without creating a claim

route_points

Type: RoutePointWithAddress[]

Route points. Sorted in order of visits A-B1....BN

Min items: 1

[
  {
    "id": 1,
    "coordinates": [
      0.1,
      0.1
    ],
    "fullname": "Saint Petersburg, Bol'shaya Monetnaya Street, 1f1A"
  }
]

items

Type: Item[]

Item parameters

Min items: 1

[
  {
    "size": {
      "length": 0.1,
      "width": 0.2,
      "height": 0.3
    },
    "weight": 2.105,
    "quantity": 1,
    "pickup_point": 1,
    "dropoff_point": 2
  }
]

requirements

Type: Requirements

Delivery requirements (vehicle class, options)

{
  "taxi_class": "cargo",
  "cargo_type": "lcv_m",
  "cargo_loaders": 1,
  "pro_courier": false,
  "cargo_options": [
    "thermobag"
  ],
  "same_day_data": {
    "delivery_interval": {
      "from": "2020-01-01T00:00:00+00:00",
      "to": "2020-01-02T00:00:00+00:00"
    }
  }
}

skip_door_to_door

Type: boolean

Disable door-to-door delivery (disable the "Door-to-door" option).
Possible values:

• true (the courier will deliver the order only at the entrance outside)
• false (the courier will deliver the order at the door) - default value.

Default: false

height

Type: number

Height in meters

length

Type: number

Length in meters

width

Type: number

Width in meters

quantity

Type: integer

Number of items

Min value: 1

dropoff_point

Type: integer

ID of the point (int64) to deliver the item to.
It can be any number. Must match the route_points[].id value of the destination point.
The parameter is mandatory if there are multiple delivery points in the order.

pickup_point

Type: integer

ID of the point (int64) to pick up the item from.
It can be any number. Must match the route_points[].id value of the dispatch point.
The parameter is mandatory if there are multiple delivery points in the order.

size

Type: CargoItemSizes

Unit dimensions in meters. The actual values should be added to the fields.
If the dimensions aren't added, the order is placed, taking into account the maximum dimensions allowed for the selected rate.
If the actual characteristics of the unit exceed the allowed dimensions, the courier has the right to refuse to fulfill the order on site.
In this case, the minimum fee will be withheld.
Courier: up to 0.80 m × 0.50 m × 0.50 м
Express: up to 1.00 m × 0.60 m × 0.50 m
Cargo:

• Small body: up to 1.70 m × 0.96 m × 0.90 m
• Medium body: up to 2.60 m × 1.30 m × 1.50 m
• Large body: up to 3.80 m × 1.80 m × 1.80 m

{
  "length": 0.1,
  "width": 0.2,
  "height": 0.3
}

weight

Type: number

Item weight in kilograms.
Example: 2.105

coordinates

Type: Point

Coordinates of points in the form of an array of two real numbers: longitude and latitude — exactly in that order.

Min items: 2

Max items: 2

[
  0.1,
  0.1
]

fullname

Type: AddressFullname

Full address with an indication of the city, street, and house number.
You don't need to specify the flat, the entrance number, or the floor.

Example: Saint Petersburg, Bol'shaya Monetnaya Street, 1f1A

id

Type: integer

Numeric point id (int64). The parameter is mandatory if there are multiple delivery points in the order

from

Type: string<date-time>

Interval start

Example: 2020-01-01T00:00:00+00:00

to

Type: string<date-time>

Interval end (date and time)

Example: 2020-01-02T00:00:00+00:00

cargo_loaders

Type: integer

Number of loaders for the cargo rate.
Possible values: 0, 1, 2.
For an exact list of possible values for a particular geo point, use the method for obtaining rates tariffs

cargo_options

Type: CargoOptions

List of additional rate options.

Possible separate options:

• auto_courier (a courier with a vehicle only)
• thermobag (a courier with a thermobag)

Example of a list of options: ["auto_courier"].

For an exact list of possible values for a particular geo point,
use the method for obtaining rates tariffs

[
  "thermobag"
]

cargo_type

Type: CargoType

Body type (size) for the cargo rate.\nPossible values:

• van ("Small body")
• lcv_m ("Medium body")
• lcv_l ("Large body")
• lcv_xl ("XL body")
  For an exact list of possible values for a particular geo point,\nuse the method for obtaining rates tariffs

Enum: van, lcv_m, lcv_l, lcv_xl

pro_courier

Type: boolean

Enable the "Pro" option for "Express" and "Courier" rates.
In this case, we will look only for experienced couriers.

same_day_data

{
  "from": "2020-01-01T00:00:00+00:00",
  "to": "2020-01-02T00:00:00+00:00"
}

"Same-day delivery" options

{
  "delivery_interval": {
    "from": "2020-01-01T00:00:00+00:00",
    "to": "2020-01-02T00:00:00+00:00"
  }
}

taxi_class

Type: string

Delivery vehicle class.
Possible values: courier, express, cargo.
For an exact list of possible values for a particular geo point, use the method for obtaining rates tariffs

Example: cargo