Передача кода подтверждения

Info

Console

Метод доступен для модели Экспресс.

Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке

inventory-and-order-processing — Обработка заказов и учёт товаров
all-methods — Полное управление кабинетом

Отправляет Маркету код подтверждения для его проверки.

Если у магазина настроена работа с кодами подтверждения:

В параметре 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/v2/campaigns/{campaignId}/orders/{orderId}/verifyEac

Path parameters

Name

Description

campaignId

Type: integer

Идентификатор кампании (магазина) — технический идентификатор, который представляет ваш магазин в системе Яндекс Маркета при работе через API. Он однозначно связывается с вашим магазином, но предназначен только для автоматизированного взаимодействия.

Его можно узнать с помощью запроса GET v2/campaigns или найти в кабинете продавца на Маркете. Нажмите на иконку вашего аккаунта → Настройки и в меню слева выберите API и модули:

блок Идентификатор кампании;
вкладка Лог запросов → выпадающий список в блоке Показывать логи.

⚠️ Не путайте его с:

идентификатором магазина, который отображается в личном кабинете продавца;
рекламными кампаниями.

Min value: 1

orderId

Type: integer

Идентификатор заказа.

Body

application/json

{
  "code": "example"
}

Name

Description

code

Type: string

Код для подтверждения ЭАПП.

Example: example

Responses

200 OK

Проверка кода выполнена успешно.

Body

application/json

{
  "status": "OK",
  "result": {
    "verificationResult": "ACCEPTED",
    "attemptsLeft": 0
  }
}

Type: object

All of 2 types

Type: ApiResponse

Стандартная обертка для ответов сервера.
Example
```
{
  "status": "OK"
}
```

Type: object

result

Type: EacVerificationResultDTO

Результат выполнения запроса.

Example

{
  "verificationResult": "ACCEPTED",
  "attemptsLeft": 0
}

Example

{
  "result": {
    "verificationResult": "ACCEPTED",
    "attemptsLeft": 0
  }
}

ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Type: string

Enum: OK, ERROR

ApiResponse

Стандартная обертка для ответов сервера.

Name

Description

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

Example

{
  "status": "OK"
}

EacVerificationStatusType

Статус проверки кода подтверждения:

ACCEPTED — код верный.
REJECTED — код неверный.
NEED_UPDATE — Маркет отправит новый код. Значение возвращается, если превышено количество попыток отправки кода.

Type: string

Enum: ACCEPTED, REJECTED, NEED_UPDATE

EacVerificationResultDTO

Результат выполнения запроса.

Name

Description

attemptsLeft

Type: integer

Количество оставшихся попыток проверки кода.

Возвращается, если магазин отправил некорректный код.

Когда все попытки будут исчерпаны, код обновится.

verificationResult

Type: EacVerificationStatusType

Статус проверки кода подтверждения.

Статус проверки кода подтверждения:

ACCEPTED — код верный.
REJECTED — код неверный.
NEED_UPDATE — Маркет отправит новый код. Значение возвращается, если превышено количество попыток отправки кода.

Enum: ACCEPTED, REJECTED, NEED_UPDATE

Example

{
  "verificationResult": "ACCEPTED",
  "attemptsLeft": 0
}

400 Bad Request

Запрос содержит неправильные данные. Подробнее об ошибке

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: ApiErrorResponse

Стандартная обертка для ошибок сервера.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

ApiErrorDTO

Общий формат ошибки.

Name

Description

code

Type: string

Код ошибки.

Example: example

message

Type: string

Описание ошибки.

Example: example

Example

{
  "code": "example",
  "message": "example"
}

ApiErrorResponse

Стандартная обертка для ошибок сервера.

Type: object

All of 2 types

Type: ApiResponse

Стандартная обертка для ответов сервера.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: ApiErrorDTO[] | null

Список ошибок.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

401 Unauthorized

В запросе не указаны данные для авторизации. Подробнее об ошибке

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: ApiErrorResponse

Стандартная обертка для ошибок сервера.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

403 Forbidden

Данные для авторизации неверны или доступ к ресурсу запрещен. Подробнее об ошибке

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: ApiErrorResponse

Стандартная обертка для ошибок сервера.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

404 Not Found

Запрашиваемый ресурс не найден. Подробнее об ошибке

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: ApiErrorResponse

Стандартная обертка для ошибок сервера.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

420 Method Failure

Превышено ограничение на доступ к ресурсу. Подробнее об ошибке

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: ApiErrorResponse

Стандартная обертка для ошибок сервера.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

500 Internal Server Error

Внутренняя ошибка Маркета. Подробнее об ошибке

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: ApiErrorResponse

Стандартная обертка для ошибок сервера.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Была ли статья полезна?

Статусы проверки кодов маркировки

Удаление товаров из заказа