...
,"crew_average_rating": 4.99
,"rating":4
,"rating_comment":"Ok"
,"route_address_from":{
...
Запрос на скрытие заказа (удалить поездку):
http://<ipaddress>:<port>/api/weborders/hide/44ebd09e5f224651bf3c8e2dd12ed890
Основные параметры Http-запроса:
Http-метод | PUT |
Url | /api/weborders/hide/<uid> |
Headers | Accept: application/json Authorization:Basic YWNod...YQ== Authorization: Bearer {JWT} |
Request (запрос):
Параметры запроса | Обязательный параметр | Описание |
<uid> | Да | UID заказа в БД ТН (полученный в ответе на запрос создания заказа). |
Response (ответ):
Статус ответа | Описание |
| 200 (OK) | Заказ успешно скрыт. |
| 404 (Not Found) | Заказ не найден. |
| 403 (Forbidden) | Действие запрещено, клиент не соответствует заказу. |
| 400 (Bad Request) | Статус заказа не соответсвует статусу "Выполнен"/"Перекинут на сервер(выполнен)" |
| 400 (Bad Request) | Не удалось скрыть заказ. |
| 500 (Internal Server Error) | Ошибка сервера. |
Клиенты
Запрос отчета по заказам клиентом (Запрос типа GET):
...
Описание полей ответа см. в Получение транзакции оплаты
Получение избранных адресов
http://<ipaddress>:<port>/api/client/addresses
Основные параметры Http-запроса:
Http-метод | GET |
Url | /api/client/addresses |
Headers | Content-Type: application/json Authorization: Basic YWNod...YQ |
Response (ответ):
Параметры ответа | Тип данных | Возможные значения | Описание |
favorite_address_uid | String | da2ed520-488e-4824-b4bc-13bfb2b566e9 | Идентификатор избранного адреса. |
alias | String | Мой дом | Название. Максимальный размер 100. |
| comment | String | Домофон не работает. | Комментарий для создания заказа. Максимальный размер 1024. |
| type | enum | 3 | Тип адреса: 1 - home, 2 - job, 3 - other. |
| entrance | Int32 | 1 | Подъезд |
| name | String | КРЕЩАТИК УЛ. | Улица или Объект. Если number пустое, то name это Объект, иначе Улица. Максимальный размер 200. |
| number | String | 7a | Номер дома. Максимальный размер 10. |
| lat | Decimal | 50.451063 | Широта |
| lng | Decimal | 50.451063 | Долгота |
[
{
"favorite_address_uid":"da2ed520-488e-4824-b4bc-13bfb2b566e9",
"alias":"Мой дом",
"comment":"Домофон не работает",
"type":1,
"address":{
"name":"КРЕЩАТИК УЛ.",
"number":"7a",
"lat":50.451063,
"lng":50.451063
},
"entrance":1
},
{
"favorite_address_uid":"7c0cae96-4510-41e6-997b-d564f62ba81f",
"alias":"alias1",
"comment":"Домофон не работает",
"type":2,
"address":{
"name":"КРЕЩАТИК УЛ.",
"number":"7a",
"lat":50.451063,
"lng":50.451063
},
"entrance":1
}
]
Сохранение избранного адреса
http://<ipaddress>:<port>/api/client/addresses
Основные параметры Http-запроса:
Http-метод | POST |
Url | /api/client/addresses |
Headers | Content-Type: application/json Authorization: Basic YWNod...YQ |
Request (запрос):
Параметры ответа | Тип данных | Обязательный параметр | Возможные значения | Описание |
alias | String | Нет | Мой дом | Название. Максимальный размер 100. |
| comment | String | Нет | Домофон не работает. | Комментарий для создания заказа. Максимальный размер 1024. |
| type | enum | Да | 3 | Тип адреса: 1 - home, 2 - job, 3 - other. |
| entrance | Int32 | Нет | 1 | Подъезд |
| name | String | Да | КРЕЩАТИК УЛ. | Улица или Объект. Если number пустое, то name это Объект, иначе Улица. Максимальный размер 200. |
| number | String | Нет | 7a | Номер дома. Максимальный размер 10. |
| lat | Decimal(9,6) | Да | 50.451063 | Широта |
| lng | Decimal(9,6) | Да | 150.451063 | Долгота |
{
"alias":"Мой дом",
"comment":"Домофон не работает",
"type":1,
"address":{
"name":"КРЕЩАТИК УЛ.",
"number":"7a",
"lat":50.451063,
"lng":150.451063
},
"entrance":1
}
Response (ответ):
Идентификатор избранного адреса : "7c0cae96-4510-41e6-997b-d564f62ba81f"
Статус ответа | Id ошибки | Описание |
400 (BadRequest) | -84 | Превышено максимальное количество избранных адресов клиента. Доступно не более 30. |
Изменение избранного адреса
http://<ipaddress>:<port>/api/client/addresses
Основные параметры Http-запроса:
Http-метод | PUT |
Url | /api/client/addresses |
Headers | Content-Type: application/json Authorization: Basic YWNod...YQ |
Request (запрос):
Параметры ответа | Тип данных | Возможные значения | Описание |
favorite_address_uid | String | da2ed520-488e-4824-b4bc-13bfb2b566e9 | Идентификатор избранного адреса, который необходимо обновить. |
alias | String | Мой дом | Название. Максимальный размер 100. |
| comment | String | Домофон не работает. | Комментарий для создания заказа. Максимальный размер 1024. |
| type | enum | 3 | Тип адреса: 1 - home, 2 - job, 3 - other. |
| entrance | Int32 | 1 | Подъезд |
| name | String | КРЕЩАТИК УЛ. | Улица или Объект. Если number пустое, то name это Объект, иначе Улица. Максимальный размер 200. |
| number | String | 7a | Номер дома. Максимальный размер 10. |
| lat | Decimal(9,6) | 50.451063 | Широта |
| lng | Decimal(9,6) | 50.451063 | Долгота |
{
"favorite_address_uid":"7c0cae96-4510-41e6-997b-d564f62ba81f",
"alias":"дом",
"comment":"Домофон не работает",
"type":2,
"address":{
"name":"КРЕЩАТИК УЛ.",
"number":"7a",
"lat":50.451063,
"lng":50.451063
},
"entrance":1
}
Удаление избранного адреса
http://<ipaddress>:<port>/api/client/addresses/<favoriteAddressGuid>
Основные параметры Http-запроса:
Http-метод | DELETE |
Url | /api/client/addresses/<favoriteAddressGuid> |
Headers | Content-Type: application/json Authorization: Basic YWNod...YQ |
Response (ответ):
Параметры ответа | Тип данных | Возможные значения | Описание |
favoriteAddressGuid | String | da2ed520-488e-4824-b4bc-13bfb2b566e9 | Идентификатор избранного адреса. |
Гео данные
Запрос гео-данных (всех объектов):
...
"payment_system_permitted": 0,
"add_cost_increment_value": 1
...
Установка версии API.
Header X-API-VERSION необходимо указывать для использования различных версий API, особенности в описании полей. Используемую версию WebOrders WebAPI можно запросить.
Если указывать версию в X-API-VERSION больше чем используемая версия бекенда, то будут задействованы контракты запроса/ответа используемой версии бекенда.
Если не указывать версию X-API-VERSION, то будет использованы контракты запроса/ответа которые были до введения заголовка версионности.
Response (ответ):
Параметры ответа | Тип данных | Описание |
repayment_status | Enum | Статус оплаты погашения долга. Возможные значения статуса оплаты долга: Created = 1, Success = 2, Failed = 3. |
| Блок кода | ||||
|---|---|---|---|---|
| ||||
{
"repayment_status":2
} |
...