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

Валидация кода для получения заказа курьером

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: example

Responses

200 OK

OK

Body

application/json
{
  "is_valid": true
}

Name

Description

is_valid

Type: boolean

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

400 Bad Request

Ошибка запроса

Body

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

Name

Description

code

Type: integer

Код ошибки

message

Type: string

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

Example: example

403 Forbidden

Access denied

404 Not Found

Плейс не найден

Body

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

Name

Description

code

Type: integer

Код ошибки

message

Type: string

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

Example: example

500 Internal Server Error

Ошибка сервиса

Body

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

Name

Description

code

Type: integer

Код ошибки

message

Type: string

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

Example: example

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