Валидация кода курьера
Валидация кода для получения заказа курьером
Request
POST
/platform/orders/{orderId}/codes/validate
Path parameters
|
Name |
Description |
|
orderId |
Type: string Идентификатор заказа во внешней системе Example: `` |
Headers
|
Name |
Description |
|
Authorization |
Type: string Токен сформированный на стороне ЯЕды Example: `` |
|
Partner-Name |
Type: string Имя партнера Example: `` |
Body
application/json
{
"code": "example"
}
|
Name |
Description |
|
code |
Type: string Код, который необходимо провалидировать Example: |
Responses
200 OK
OK
Body
application/json
{
"is_valid": true,
"validation_attempts_left": 0
}
|
Name |
Description |
|
is_valid |
Type: boolean Результат валидации. |
|
validation_attempts_left |
Type: integer Количество оставшихся попыток для валидации. |
400 Bad Request
Ошибка запроса
Body
application/json
{
"message": "example",
"code": 0
}
|
Name |
Description |
|
code |
Type: integer Код ошибки |
|
message |
Type: string Сообщение об ошибке Example: |
403 Forbidden
Access denied
404 Not Found
Плейс не найден
Body
application/json
{
"message": "example",
"code": 0
}
|
Name |
Description |
|
code |
Type: integer Код ошибки |
|
message |
Type: string Сообщение об ошибке Example: |
409 Conflict
Conflict. Возможные причины:
- 1001: Использованы все попытки валидации кода.
Body
application/json
{
"message": "example",
"code": 0
}
|
Name |
Description |
|
code |
Type: integer Код ошибки |
|
message |
Type: string Сообщение об ошибке Example: |
500 Internal Server Error
Ошибка сервиса
Body
application/json
{
"message": "example",
"code": 0
}
|
Name |
Description |
|
code |
Type: integer Код ошибки |
|
message |
Type: string Сообщение об ошибке Example: |