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

Метод возвращает информацию о возможности отмены.
Используйте этот метод для получения информации по заявке, созданной через claims/create.

Request

POST

b2b.taxi.yandex.net/b2b/cargo/integration/v2/claims/cancel-info

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

Query parameters

Name

Description

claim_id

Type: string

ID заявки, полученный на этапе создания заявки

Min length: 32

Max length: 64

Example: ``

Headers

Name

Description

Accept-Language

Type: string

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

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

Example: ru

Responses

200 OK

OK

Body

application/json
{
  "cancel_state": "free",
  "price": "12.50",
  "price_with_vat": null,
  "currency": "RUB"
}

Name

Description

cancel_state

Type: CancelInfoCancelState

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

Enum: free, paid, unavailable

currency

Type: string

Валюта, в которой ведется расчет

Example: RUB

price

Type: Money

Стоимость доставки в формате десятичной дроби Decimal(18, 4)

Pattern: ^-?[0-9]{1,14}(\.[0-9]{0,4})?$

Example: 12.50

price_with_vat

Type: Money

Стоимость доставки в формате десятичной дроби Decimal(18, 4)

Pattern: ^-?[0-9]{1,14}(\.[0-9]{0,4})?$

Example: 12.50

CancelInfoCancelState

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

Type: string

Enum: free, paid, unavailable

Money

Стоимость доставки в формате десятичной дроби Decimal(18, 4)

Type: string

Pattern: ^-?[0-9]{1,14}(\.[0-9]{0,4})?$

Example: 12.50

400 Bad Request

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

Body

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

Name

Description

code

Type: string

Код ошибки

Enum: unknown_error, bad_request

message

Type: string

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

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

404 Not Found

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

Body

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

Name

Description

code

Type: string

Код ошибки

Enum: unknown_error, not_found

message

Type: string

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

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

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