Отмена заявки

Метод отменяет подтвержденную заявку. Отменить заявку с использованием этого метода можно до передачи товара курьеру. Далее отмена заказа возможна только через службу поддержки.

Отмена заявки может быть платной и бесплатной. Бесплатная отмена доступна до прибытия курьера на точку отправления, платная отмена доступна до начала движения по получению груза курьером. Чтобы узнать тип отмены, используйте операцию получения информации по заявке 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: 32

Max length: 64

Headers

Name

Description

Accept-Language*

Type: string

Предпочитаемый язык ответа

Например:
ru — русский
en — английский

Example: ru

Body

application/json

{
    "version": 1,
    "cancel_state": "free"
}

Name

Description

cancel_state*

Type: CancelState

Статус отмены (платная или бесплатная)

Example: free

Enum: free, paid

version*

Type: integer<int64>

Версия отменяемой заявки (int64)

Example: 1

CancelState

Статус отмены (платная или бесплатная)

Type

Description

CancelState

Example: free

Enum: free, paid

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: `741cedf82cd464fa6fa16d87155c636` Min length: `32` Max length: `64`
skip_client_notify*	Type: boolean
status*	Type: ClaimStatus Статус заявки. Подробнее см. в разделе Статусная модель Example: `new` Enum: `new`, `estimating`, `estimating_failed`, `ready_for_approval`, `accepted`, `performer_lookup`, `performer_draft`, `performer_found`, `performer_not_found`, `pickup_arrived`, `ready_for_pickup_confirmation`, `pickuped`, `delivery_arrived`, `ready_for_delivery_confirmation`, `delivered`, `delivered_finish`, `returning`, `return_arrived`, `ready_for_return_confirmation`, `returned`, `returned_finish`, `failed`, `cancelled`, `cancelled_with_payment`, `cancelled_by_taxi`, `cancelled_with_items_on_hands`
user_request_revision*	Type: string Текущая версия изменений в заявке, переданная пользователем
version*	Type: integer<int64> Версия заявки из запроса (int64) Example: `1`

ClaimStatus

Статус заявки. Подробнее см. в разделе Статусная модель

Type

Description

ClaimStatus

Example: new

Enum: new, estimating, estimating_failed, ready_for_approval, accepted, performer_lookup, performer_draft, performer_found, performer_not_found, pickup_arrived, ready_for_pickup_confirmation, pickuped, delivery_arrived, ready_for_delivery_confirmation, delivered, delivered_finish, returning, return_arrived, ready_for_return_confirmation, returned, returned_finish, failed, cancelled, cancelled_with_payment, cancelled_by_taxi, cancelled_with_items_on_hands

400 Bad Request

Некорректный запрос

Body

application/json

{
    "code": "bad_request",
    "message": "Неправильное тело запроса"
}

Name

Description

code*

Type: string

Код ошибки

Example: bad_request

Enum: unknown_error, bad_request

message*

Type: string

Описание ошибки

Example: Неправильное тело запроса

404 Not Found

Заявка не найдена

Body

application/json

{
    "code": "not_found",
    "message": "Заявка не найдена"
}

Name

Description

code*

Type: string

Код ошибки

Example: not_found

Enum: unknown_error, not_found

message*

Type: string

Описание ошибки

Example: Заявка не найдена

409 Conflict

Попытка отменить неактуальную версию заявки

Body

application/json

{
    "code": "inappropriate_status",
    "message": "Недопустимое действие над заявкой"
}

Name

Description

code*

Type: string

Код ошибки

Example: inappropriate_status

Enum: unknown_error, inappropriate_status, free_cancel_is_unavailable, state_mismatch

message*

Type: string

Описание ошибки

Example: Недопустимое действие над заявкой

Была ли статья полезна?

5. Условия отмены

1.1 Доступные тарифы