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