Получение списка заказов

cursor

string

Курсор для получения следующий порции данных,
значение должно быть взято из ответа на предыдущий запрос

limit *

integer

Ограничение сверху на число заказов в ответе

Минимальное значение: 1.
Максимальное значение: 500.

query *

object

query.park *

object

query.park.car

object

query.park.car.id *

string

Идентификатор автомобиля

query.park.driver_profile

object

query.park.driver_profile.id *

string

Идентификатор водителя

query.park.id *

string

Идентификатор партнёра

query.park.order *

object

Обязательно наличие одного из booked_at или ended_at

query.park.order.booked_at

object

query.park.order.booked_at.from *

string

ISO 8601 с временной зоной

query.park.order.booked_at.to *

string

ISO 8601 с временной зоной

query.park.order.categories[]

array

Список категорий ТС. Допустимые значения:

• econom - эконом;
• comfort - комфорт;
• comfort_plus - комфорт+;
• business - бизнес;
• minivan - минивен;
• vip - VIP;
• wagon - универсальный;
• pool - pool;
• start - старт;
• standart - стандарт;
• ultimate - премьер;
• maybach - elite;
• promo - промо;
• premium_van - круиз;
• premium_suv - премиум внедорожник;
• suv - внедорожник;
• personal_driver - персональный водитель;
• express - доставка;
• cargo - грузовой.

query.park.order.ended_at

object

query.park.order.ended_at.from *

string

ISO 8601 с временной зоной

query.park.order.ended_at.to *

string

ISO 8601 с временной зоной

query.park.order.ids[]

array

query.park.order.payment_methods[]

array

query.park.order.price

object

query.park.order.price.from

string

Сумма с фиксированной точностью

query.park.order.price.to

string

Сумма с фиксированной точностью

query.park.order.providers[]

array

query.park.order.short_ids[]

array

query.park.order.statuses[]

array

query.park.order.type

object

query.park.order.type.ids[] *

array

cursor

string

Курсор для получения следующий порции данных

limit *

integer

Ограничение сверху на число заказов в ответе

Минимальное значение: 1.
Максимальное значение: 500.

orders[] *

array

orders[].address_from *

object

orders[].address_from.address *

string

Адрес заказа

orders[].address_from.lat *

number

Географическая широта

orders[].address_from.lon *

number

Географическая долгота

orders[].amenities[] *

array

Удобства в ТС. Допустимые значения:

• conditioner
• no_smoking
• child_chair
• animal_transport
• universal
• wifi
• check
• card
• yamoney
• newspaper
• coupon
• creditcard
• dont_call
• smoking
• delivery
• vip_event
• woman_driver
• post_terminal
• bicycle
• skiing
• passenger_plus
• cargo_clean
• door_to_door
• sticker
• lightbox

orders[].booked_at *

string

ISO 8601 с временной зоной

orders[].cancellation_description

string

orders[].car

object

orders[].car.brand_model

string

Марка и модель автомобиля

orders[].car.callsign

string

Позывной

orders[].car.id

string

Идентификатор автомобиля

orders[].car.license

object

orders[].car.license.number *

string

Регистрационный номер ТС

orders[].category

string

Категория ТС. Допустимые значения:

• econom - эконом;
• comfort - комфорт;
• comfort_plus - комфорт+;
• business - бизнес;
• minivan - минивен;
• vip - VIP;
• wagon - универсальный;
• pool - pool;
• start - старт;
• standart - стандарт;
• child_tariff - детский;
• ultimate - премьер;
• maybach - elite;
• promo - промо;
• premium_van - круиз;
• premium_suv - премиум внедорожник;
• suv - внедорожник;
• personal_driver - персональный водитель;
• express - доставка;
• cargo - грузовой.

1. econom
2. comfort
3. comfort_plus
4. business
5. minivan
6. vip
7. wagon
8. pool
9. start
10. standart
11. child_tariff
12. ultimate
13. maybach
14. promo
15. premium_van
16. premium_suv
17. suv
18. personal_driver
19. express
20. cargo

orders[].created_at *

string

ISO 8601 с временной зоной

orders[].driver_profile

object

orders[].driver_profile.id

string

Идентификатор водителя

orders[].driver_profile.name

string

ФИО водителя

orders[].driver_work_rule

object

Условие работы водителя

orders[].driver_work_rule.id

string

Идентификатор условия работы водителя

orders[].driver_work_rule.name

string

Название условия работы водителя

orders[].ended_at

string

ISO 8601 с временной зоной

orders[].events[] *

array

orders[].events[].event_at *

string

ISO 8601 с временной зоной

orders[].events[].order_status *

string

Статус заказа. Допустимые значения:

• none - без статуса;
• driving - в пути;
• waiting - ждёт клиента;
• transporting - везёт клиента;
• complete - выполнен;
• cancelled - отменён;
• calling - ошибка, технический статус;
• expired - ошибка, технический статус;
• failed - ошибка, технический статус.

1. none
2. driving
3. waiting
4. transporting
5. complete
6. cancelled
7. calling
8. expired
9. failed

orders[].id *

string

Идентификатор заказа

orders[].mileage

string

orders[].park_details

object

orders[].park_details.company

object

orders[].park_details.company.comment

string

orders[].park_details.company.id

string

orders[].park_details.company.name

string

orders[].park_details.company.slip

string

orders[].park_details.passenger

object

orders[].park_details.passenger.name

string

orders[].park_details.passenger.phones[]

array

orders[].park_details.tariff

object

Тарифы парка

orders[].park_details.tariff.id *

string

orders[].park_details.tariff.name *

string

orders[].payment_method

string

Способ оплаты. Допустимые значения:

• cash - наличные;
• cashless - безнал;
• card - карта;
• internal - внутренний;
• other - другое;
• corp - корп. счёт;
• prepaid - предоплата.

1. cash
2. cashless
3. card
4. internal
5. other
6. corp
7. prepaid

orders[].price

string

Сумма с фиксированной точностью

orders[].provider *

string

1. none
2. partner
3. platform

orders[].route_points[] *

array

orders[].route_points[].address *

string

Адрес заказа

orders[].route_points[].lat *

number

Географическая широта

orders[].route_points[].lon *

number

Географическая долгота

orders[].short_id *

integer

Порядковый номер заказ (с учётом несостоявшихся заказов)

Минимальное значение: 0.

orders[].status *

string

Статус заказа. Допустимые значения:

• none - без статуса;
• driving - в пути;
• waiting - ждёт клиента;
• transporting - везёт клиента;
• complete - выполнен;
• cancelled - отменён;
• calling - ошибка, технический статус;
• expired - ошибка, технический статус;
• failed - ошибка, технический статус.

1. none
2. driving
3. waiting
4. transporting
5. complete
6. cancelled
7. calling
8. expired
9. failed

orders[].type

object

orders[].type.id *

string

Идентификатор типа заказа

orders[].type.name *

string

Название типа заказа

code

string

Машиночитаемый код ошибки

message *

string

Человекочитаемое сообщение об ошибке

code

string

Машиночитаемый код ошибки

message *

string

Человекочитаемое сообщение об ошибке

code

string

Машиночитаемый код ошибки

message *

string

Человекочитаемое сообщение об ошибке

code

string

Машиночитаемый код ошибки

message *

string

Человекочитаемое сообщение об ошибке

code

string

Машиночитаемый код ошибки

message *

string

Человекочитаемое сообщение об ошибке