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

POST 
/v1/orders

Запрос на получение заказов для водителей за заданный период времени.

Request

application/json

Body

required

query objectrequired

booked_at objectrequired

from date-time

to date-time

driver_profile object

id string

идентификатор водителя для которого выбирать зааказы, driver_profile не обязательное свойство

Responses

200

Выполнено успешно

application/json

Schema

Schema

orders object[]
Список заказов
Array [
address stringrequired
Адрес заказа одной строкой
country stringrequired
Страна из блока адреса заказа
city stringrequired
Город из блока адреса заказа
street stringrequired
Улица из блока адреса заказа
building stringrequired
Номер дома заказа
entrance stringrequired
Номер подъезда заказа, для частного дома "0" строкой
apartment stringrequired
Номер квартиры заказа, для частного дома "0" строкой
tenantPhone stringrequired
Последние цифры в номере тел. клиента (мин. 5 цифр - XXXXX)
leaveatDoor booleanrequired
Оставить заказ у двери
lat numberrequired
Координаты адреса заказа (широта)
lon numberrequired
Координаты адреса заказа (долгота)
orderID stringrequired
Внешний идентификатор заказа в системе-отправителе
driverID stringrequired
Внешний идентификатор водителя в системе-отправителе, должен совпадать с данными из /drivers
]
signature string

Подпись HMACSHA256 в base64 по данным массива заказов и секретного ключа, определяемого на этапе интеграции

Example (from schema)

{
  "orders": [
    {
      "address": "Россия, Москва, улица Ленина, 7, подъезд 1, кв. 10",
      "country": "Россия",
      "city": "Москва",
      "street": "Ленина",
      "building": "7",
      "entrance": "1",
      "apartment": "10",
      "tenantPhone": "42040",
      "leaveatDoor": false,
      "lat": 55.7319,
      "lon": 37.4718,
      "orderID": "60be42bbc0c9ce85465b2416",
      "driverID": "60be42aac0c9ce85465b2416"
    }
  ],
  "signature": "NtztnYRRTOzk8ateuZb9VzVXmhLEZ1+hNxnkJSQ9YWY="
}

401

Ошибка авторизации. Значение кодов ошибок:

• unauthorized - запрос от сервера, который не был влючен в wightlist

application/json

Schema

Schema

code stringrequired

Possible values: [unauthorized]

Коды ошибок

message stringrequired

Читабельное сообщение об ошибке

Example (from schema)

{
  "code": "unauthorized",
  "message": "Не верный формат данных"
}

Loading...