Метод: order
Метод служит для создания заказа на выпуск сертификата OZON.
URL
POST https://api-pvk.prostodar.ru/partner/ozon/order/
Описание
Метод позволяет создать заказ на выпуск сертификата OZON с указанным номиналом и сроком действия. Для выполнения запроса необходимо указать идентификатор запроса, данные партнера и сведения о сертификате.
Структура запроса
Пример запроса
Формат запроса:
POST https://api-pvk.prostodar.ru/partner/ozon/order/ ?partnerName=name &partnerPassword=password &requestId=some_request_id &nominalValue=1000 &termInMonths=12 &idPerson=idPerson &useAuthByCert=Y
Параметры запроса
| Параметр | Тип | Описание | Обязательный | Шифрование | Цвет |
|---|---|---|---|---|---|
partnerName |
string | Уникальное имя партнера | Да | Нет | |
partnerPassword |
string | Уникальный API пароль партнера | Да | Да | |
requestId |
string | Уникальный идентификатор запроса | Да | Да | |
nominalValue |
int | Номинал сертификата | Да | Да | |
termInMonths |
int | Срок действия сертификата в месяцах | Да | Да | |
idPerson |
string | Уникальный идентификатор лица, в адрес которого осуществлен выпуск вознаграждения | Да, если используется совместно с сервисом верификации ПД | Да | |
useAuthByCert |
string | Указывает на использование шифрования данных | Да | Нет |
Структура ответа
Пример успешного ответа
{
"status": "OK",
"message": "request successfully completed"
}
Параметры успешного ответа
| Параметр | Тип | Описание |
|---|---|---|
status |
string | Статус операции |
message |
string | Текстовое описание результата |
Пример ответа с ошибкой
{
"status": "PARTNER_LOGIN_IS_NOT_CORRECT",
"message": "Partner name or password is not correct"
}
Параметры ответа с ошибкой
| Параметр | Тип | Описание |
|---|---|---|
status |
string | Статус ошибки |
message |
string | Текстовое описание ошибки |
Возможные ошибки
| Статус | Текстовое описание ошибки | Описание |
|---|---|---|
PARTNER_LOGIN_IS_NOT_CORRECT |
Partner name or password is not correct | Партнер с таким логином и паролем не найден |
NOT_VALID_IP_PARTNER |
Partner IP is not correct | IP партнера некорректен |
ACCOUNT_IS_BLOCKED |
Account is blocked | Аккаунт заблокирован |
REQUEST_ID_ALREADY_EXISTS |
Request id already exists | Запрос с таким идентификатором уже существует |
NO_MONEY |
There are no funds on the balance sheet | Недостаточно средств для операции |
REQUEST_INCORRECTLY |
Invalid authorization is used | Ошибка в шифровании сертификатом |
SERVICE_UNAVAILABLE |
Service is temporarily unavailable. | Сервис временно недоступен |
INCORRECT_AMOUNT |
- | Некорректная сумма сертификата. Допустимый интервал от 50 до 100 000 руб (включительно), шаг 1 рубль. |
OZON_ERROR |
Значения аргументов. | Ошибка на стороне Озон. В сообщении указаны аргументы, в которых произошла ошибка. |
FIELD_IDPERSON_IS_NOT_CORRECT |
The field idPerson must be filled in | Поле idPerson должно быть заполнено. Актуально, когда данный сервис используется совместно с сервисом верификации ПД. |