Валидация кода курьера
Метод позволяет Партнёру отправлять Яндекс Еде запрос на валидацию кода, который был получен от курьера Яндекс Еды.
Request
POST
/platform/orders/{orderId}/codes/validate
Path parameters
|
Name |
Description |
|
orderId |
Type: string Идентификатор заказа в системе Партнёра. Example: `` |
Headers
|
Name |
Description |
|
Authorization |
Type: string Токен, сформированный на стороне Яндекс Еды. Example: `` |
Body
application/json
{
"code": "example"
}
|
Name |
Description |
|
code |
Type: string Код, который необходимо провалидировать Example: |
Responses
200 OK
Успешный ответ с результатом валидации.
Body
application/json
{
"is_valid": true
}
|
Name |
Description |
|
is_valid |
Type: boolean Результат валидации. |
400 Bad Request
Неверно сформированный запрос.
Body
application/json
{
"message": "example",
"code": 0,
"details": {}
}
|
Name |
Description |
|
code |
Type: integer Код ошибки. |
|
message |
Type: string Сообщение об ошибке. Example: |
|
details |
Type: objectExample |
403 Forbidden
Доступ запрещен.
Body
application/json
{
"message": "example",
"code": 0,
"details": {}
}
|
Name |
Description |
|
code |
Type: integer Код ошибки. |
|
message |
Type: string Сообщение об ошибке. Example: |
|
details |
Type: objectExample |
404 Not Found
Будет возвращено, если заказ не будет найден в нашей системе.
Body
application/json
{
"message": "example",
"code": 0,
"details": {}
}
|
Name |
Description |
|
code |
Type: integer Код ошибки. |
|
message |
Type: string Сообщение об ошибке. Example: |
|
details |
Type: objectExample |
500 Internal Server Error
Внутренняя ошибка сервиса.
Body
application/json
{
"message": "example",
"code": 0,
"details": {}
}
|
Name |
Description |
|
code |
Type: integer Код ошибки. |
|
message |
Type: string Сообщение об ошибке. Example: |
|
details |
Type: objectExample |
No longer supported, please use an alternative and newer version.