Получение списка причин отмены заказа
Для вызова метода отмены заказа в случае, если причины отмены заказа включены, необходимо получить список возможных причин отмены заказа.
Пример запроса
GET https://delivery.ucs.ru/orders/api/v1/rejectionReasons
Пример ответа
{
"result": [
{
"id": "a762a6da-2379-4fa2-9a04-7f5ca82b39d4",
"reason": "Тестовый заказ",
"type": "simple",
"isPossibleDelete": true
},
{
"id": "4239979e-093c-43c0-8351-6918364c5c94",
"reason": "Дубль",
"type": "simple",
"isPossibleDelete": true
},
{
"id": "37631981-7d11-4e36-8465-dd1887d888cc",
"reason": "Гость отказался",
"type": "simple",
"isPossibleDelete": true
},
{
"id": "7c224784-7382-4a47-8e5a-849d8529a34a",
"reason": "Гость не доступен / не открыл дверь",
"type": "simple",
"isPossibleDelete": true
},
{
"id": "bb8502fa-dfcc-4196-a306-08ec526abc91",
"reason": "Блюда нет в наличии",
"type": "simple",
"isPossibleDelete": true
},
{
"id": "73f8e0eb-06d5-489f-8258-42a941bede14",
"reason": "Отменён рестораном",
"type": "simple",
"isPossibleDelete": false
},
{
"id": "5ff37e88-61ef-46ff-9f6c-4c9579e74210",
"reason": "Другое",
"type": "text"
"isPossibleDelete": true
}
]
}
JSON
Ответ при успешной отмене заказа: 200 OK.
Отмена заказа
Запрос
PUT https://delivery.ucs.ru/orders/api/v1/orders/{orderId}/reject
Content-Type: application/json
Пример запроса
{
"rejectionReasonId": "7ca12506-0c20-4417-88b2-2a5b0d237770",
"rejectionReasonText": "Гость отказался"
}
YML
Пример запроса (если причины отмены заказа выключены)
{
"rejectionReasonId": "",
"rejectionReasonText": ""
}
YML
Описание параметров
| Параметр |
| Описание |
|---|
| rejectionReasonId | string | id причины отмены заказа |
| rejectionReasonText | string | Текст причины отмены заказа |
В качестве идентификатора используется номер заказа - orderId.
В качестве сопутствующей информации запрос может содержать restaurantId (id заведения).
Описание ошибок приведено в отдельной статье.
