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

Метод инициирует возврат заказа курьером в исходную точку отправки. Операция может быть выполнена только в том случае, если курьер уже забрал заказ.


Если на маршруте несколько точек назначения, то указанная в запросе точка будет пропущена, и в конце маршрута курьер вернет товар обратно отправителю.

Request

POST

b2b.taxi.yandex.net/b2b/cargo/integration/v2/claims/return

Адрес сервиса

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
{
    "point_id": 372036854775807,
    "comment": "Клиент отказался от заказа",
    "need_return_items": false
}

Name

Description

comment*

Type: string

Причина, по которой точку необходимо пропустить

Example: Клиент отказался от заказа

point_id*

Type: integer<int64>

Целочисленный идентификатор точки (int64), генерируемый
на стороне Яндекс Доставки.
Содержится в поле route_points[].id. Применимо к точкам с типом
source, destination, return.

Example: 372036854775807

need_return_items

Type: boolean

Вернуть товар в исходную точку отправления

Responses

200 OK

Возврат инициирован

400 Bad Request

Некорректная точка

Body

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

Name

Description

code*

Type: string

Код ошибки

Example: state_mismatch

Enum: unknown_error, state_mismatch

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": "state_mismatch",
    "message": "Недопустимое действие над заявкой"
}

Name

Description

code*

Type: string

Код ошибки

Example: state_mismatch

Enum: unknown_error, not_allowed, state_transition_forbidden, state_mismatch

message*

Type: string

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

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

410 Gone

Заявка в неактивном статусе

Body

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

Name

Description

code*

Type: string

Код ошибки

Example: inappropriate_status

Enum: unknown_error, inappropriate_status

message*

Type: string

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

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

No longer supported, please use an alternative and newer version.