Отмена заявки
Метод отменяет подтвержденную заявку. Отменить заявку с использованием этого метода можно до передачи товара курьеру. Далее отмена заказа возможна только через службу поддержки.
Отмена заявки может быть платной и бесплатной. Бесплатная отмена доступна до прибытия курьера на точку отправления, платная отмена доступна до начала движения по получению груза курьером. Чтобы узнать тип отмены, используйте операцию получения информации по заявке claims/cancel-info (поле cancel_state).
В случае бесплатной отмены заявка перейдет в статус cancelled, в случае платной отмены - в статус cancelled_with_payment.
Request
POST
b2b.taxi.yandex.net/b2b/cargo/integration/v2/claims/cancel
Адрес сервиса
Query parameters
|
Name |
Description |
|
claim_id* |
Type: string Идентификатор (ID) заявки, полученный на этапе создания заявки Min length: Max length: |
Headers
|
Name |
Description |
|
Accept-Language* |
Type: string Предпочитаемый язык ответа. Примеры:«ru» - русский, «en» - английский |
Body
application/json
{
"version": 1,
"cancel_state": "free"
}
|
Name |
Description |
|
cancel_state* |
Type: CancelState Статус отмены (платная или бесплатная) Example: Enum: |
|
version* |
Type: integer<int64> Версия отменяемой заявки (int64) Example: |
CancelState
Статус отмены (платная или бесплатная)
|
Type |
Description |
|
Example: Enum: |
Responses
200 OK
Заявка отменена
Body
application/json
{
"id": "741cedf82cd464fa6fa16d87155c636",
"status": "new",
"version": 1,
"user_request_revision": "string",
"skip_client_notify": false
}
|
Name |
Description |
|
id* |
Type: string Идентификатор(ID) заявки, полученный на этапе создания заявки Example: Min length: Max length: |
|
skip_client_notify* |
Type: boolean |
|
status* |
Type: ClaimStatus Статус заявки. Подробнее см. в разделе Статусная модель Example: Enum: |
|
user_request_revision* |
Type: string Текущая версия изменений в заявке, переданная пользователем |
|
version* |
Type: integer<int64> Версия заявки из запроса (int64) Example: |
ClaimStatus
Статус заявки. Подробнее см. в разделе Статусная модель
|
Type |
Description |
|
Example: Enum: |
400 Bad Request
Некорректный запрос
Body
application/json
{
"code": "bad_request",
"message": "Неправильное тело запроса"
}
|
Name |
Description |
|
code* |
Type: string Код ошибки Example: Enum: |
|
message* |
Type: string Описание ошибки Example: |
404 Not Found
Заявка не найдена
Body
application/json
{
"code": "not_found",
"message": "Заявка не найдена"
}
|
Name |
Description |
|
code* |
Type: string Код ошибки Example: Enum: |
|
message* |
Type: string Описание ошибки Example: |
409 Conflict
Попытка отменить неактуальную версию заявки
Body
application/json
{
"code": "inappropriate_status",
"message": "Недопустимое действие над заявкой"
}
|
Name |
Description |
|
code* |
Type: string Код ошибки Example: Enum: |
|
message* |
Type: string Описание ошибки Example: |