Передача кода проверки
Отправляет Маркету код подтверждения для его проверки.
Код подтверждает передачу заказа или невыкупа:
- курьеру — курьер должен назвать магазину код;
- магазину — магазин называет код курьеру.
Если магазин получает невыкупленный заказ, то ему нужно назвать курьеру код из кабинета или приложения.
Если у магазина настроена работа с кодами подтверждения, в запросах POST order/status, PUT campaigns/{campaignId}/orders/{orderId}/status, GET campaigns/{campaignId}/orders, GET campaigns/{campaignId}/orders/{orderId} в параметре delivery, вложенном в order будет возвращаться параметр eacType с типом Enum — тип кода подтверждения для передачи заказа.
Возможные значения: MERCHANT_TO_COURIER — магазин называет код курьеру, COURIER_TO_MERCHANT — курьер называет код магазину.
Параметр eacType возвращается при статусах заказа COURIER_FOUND, COURIER_ARRIVED_TO_SENDER и DELIVERY_SERVICE_UNDELIVERED. Если заказ в других статусах, параметр может отсутствовать.
| ⚙️ Лимит: 1 000 000 запросов в час |
|---|
Request
PUT
https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/verifyEac
Path parameters
|
Name |
Type |
Description |
|
campaignId* |
integer<int64> |
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns. |
|
orderId* |
integer<int64> |
Идентификатор заказа. |
Body
{
"code": "string"
}
|
Name |
Type |
Description |
|
code |
string |
Код для подтверждения ЭАПП. |
Responses
200 OK
Проверка кода выполнена успешно
Body
{
"status": "OK",
"result": {
"verificationResult": "ACCEPTED",
"attemptsLeft": 0
}
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
result |
Результат выполнения запроса. |
EacVerificationResultDTO
Результат выполнения запроса.
|
Name |
Type |
Description |
|
verificationResult |
Статус проверки кода подтверждения.
|
|
|
attemptsLeft |
integer<int32> |
Количество оставшихся попыток проверки кода. Возвращается, если магазин отправил некорректный код. Когда все попытки будут исчерпаны, код обновится. |
EacVerificationStatusType
Статус проверки кода подтверждения:
ACCEPTED— код верный;REJECTED— код неверный;NEED_UPDATE— Маркет отправит новый код. Значение возвращается, если превышено количество попыток отправки кода.
|
Type |
Description |
|
Enum: |
400 Bad Request
Запрос содержит неправильные данные.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
ApiErrorDTO
Общий формат ошибки.
|
Name |
Type |
Description |
|
code* |
string |
Код ошибки. |
|
message |
string |
Описание ошибки. |
401 Unauthorized
В запросе не указаны данные для авторизации.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
403 Forbidden
Данные для авторизации неверны или доступ к ресурсу запрещен.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
404 Not Found
Запрашиваемый ресурс не найден.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
420 Method Failure
Превышено ограничение на доступ к ресурсу.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
500 Internal Server Error
Внутренняя ошибка сервера.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |