Валидация кода курьера

Метод валидации кода курьера

Request

POST

/platform/orders/{orderId}/codes/validate

Path parameters

Name

Description

orderId*

Type: string

Идентификатор заказа в системе Партнёра.

Headers

Name

Description

Authorization*

Type: string

Токен, сформированный на стороне Яндекс Еды.

Body

application/json
{
    "code": "string"
}

Name

Description

code*

Type: string

Код, который необходимо провалидировать

Responses

200 OK

Успешный ответ с результатом валидации.

Body

application/json
{
    "is_valid": false
}

Name

Description

is_valid*

Type: boolean

Результат валидации.

400 Bad Request

Неверно сформированный запрос.

Body

application/json
{
    "message": "string",
    "code": 0
}

Name

Description

code*

Type: integer

Код ошибки.

message*

Type: string

Сообщение об ошибке.

details

Type: Error

Error

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

Name

Description

code*

Type: integer

Код ошибки.

message*

Type: string

Сообщение об ошибке.

details

Type: Error

403 Forbidden

Доступ запрещен.

Body

application/json
{
    "message": "string",
    "code": 0
}

Name

Description

code*

Type: integer

Код ошибки.

message*

Type: string

Сообщение об ошибке.

details

Type: Error

404 Not Found

Будет возвращено, если заказ не будет найден в нашей системе.

Body

application/json
{
    "message": "string",
    "code": 0
}

Name

Description

code*

Type: integer

Код ошибки.

message*

Type: string

Сообщение об ошибке.

details

Type: Error

500 Internal Server Error

Внутренняя ошибка сервиса.

Body

application/json
{
    "message": "string",
    "code": 0
}

Name

Description

code*

Type: integer

Код ошибки.

message*

Type: string

Сообщение об ошибке.

details

Type: Error

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