preorders.php¶

В этой статье

Методы API

preorders/add

preorders/check

preorders/count_admin

preorders/count_customer

preorders/delete

preorders/description

preorders/email

preorders/list_admin

preorders/list_customer

preorders/notify

preorders/notify_confirm

preorders/validate_cancel_token

preorders/view

Модуль управления предзаказами: создание, удаление, проверка статуса и уведомления клиентов

Методы API¶

Метод	Действие	Описание
`add`	создание предзаказа	Создает новый предзаказ для клиента.
`check`	выполнение задачи по расписанию	Запуск системной задачи проверки предзаказов. Метод является устаревшим (retired) и вызывается планировщиком.
`count_admin`	получение количества предзаказов (админ)	Возвращает общее количество предзаказов в системе для администратора.
`count_customer`	подсчет предзаказов клиента	Возвращает количество предзаказов текущего авторизованного клиента.
`delete`	удаление предзаказа	Удаляет предзаказ с учетом подтверждения отмены.
`description`	получение описания предзаказа	Возвращает текстовое описание для конкретного предзаказа.
`email`	отправка email уведомления	Инициирует отправку электронного письма по предзаказу.
`list_admin`	получение списка предзаказов (админ)	Возвращает полный список всех предзаказов системы для администратора.
`list_customer`	получение списка предзаказов клиента	Возвращает список предзаказов текущего авторизованного клиента.
`notify`	уведомление клиента	Отправляет уведомление клиенту о статусе предзаказа.

preorders/add¶

Создает новый предзаказ для клиента.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `add`
token	✅	string	Токен авторизации

Пример запроса

curl -s "https://invapi.hostkey.ru/preorders.php" -X POST \
--data "action=add" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"action": "add",
"data": {
"id": 12345,
"status": "pending",
"amount": {
"EUR": 49.99,
"RUB": 4500
},
"created_at": "2024-05-20T12:00:00Z"
}
}

Примеры ошибок

{
"code": -1,
"message": "Action is not recognized"
}

preorders/check¶

Запуск системной задачи проверки предзаказов. Метод является устаревшим (retired) и вызывается планировщиком.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: check

Пример запроса

curl -s "https://invapi.hostkey.ru/preorders.php" -X POST \
--data "action=check"

Пример успешного ответа

{
"result": "OK",
"action": "check",
"data": {
"status": "success",
"processed_count": 0,
"timestamp": "2024-05-20T12:00:00Z"
}
}

Примеры ошибок

{
"code": -1,
"message": "Internal server error"
}

preorders/count_admin¶

Возвращает общее количество предзаказов в системе для администратора.

HTTP-метод: POST

Параметры:

action	✅	string	Идентификатор метода: `count_admin`
token	✅	string	Токен авторизации

Пример запроса

curl -s "https://invapi.hostkey.ru/preorders.php" -X POST \
--data "action=count_admin" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"action": "count_admin",
"data": {
"count": 125
}
}

Примеры ошибок

{
"code": -1,
"message": "Action is not recognized"
}

preorders/count_customer¶

Возвращает количество предзаказов текущего авторизованного клиента.

HTTP-метод: GET

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `count_customer`
token	✅	string	Токен авторизации

Пример запроса

curl -s "https://invapi.hostkey.ru/preorders.php" -X GET \
--data "action=count_customer" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"action": "count_customer",
"data": {
"count": 5
}
}

Примеры ошибок

{
"code": -1,
"message": "Action is not recognized"
}

preorders/delete¶

Удаляет предзаказ с учетом подтверждения отмены.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `delete`
token	✅	string	Токен авторизации

Пример запроса

curl -s "https://invapi.hostkey.ru/preorders.php" -X POST \
--data "action=delete" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"action": "delete",
"data": {
"deleted_id": 12345,
"status": "cancelled"
}
}

Примеры ошибок

{
"code": -1,
"message": "Action is not recognized"
}

preorders/description¶

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

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `description`
token	✅	string	Токен авторизации
params[id]	✅	integer	ID предзаказа

Пример запроса

curl -s "https://invapi.hostkey.ru/preorders.php" -X POST \
--data "action=description" \
--data "token=HOSTKEY_TOKEN" \
--data "params[id]=12345"

Пример успешного ответа

{
"result": "OK",
"action": "description",
"data": {
"description": "Описание заказа №12345"
}
}

Примеры ошибок

{
"code": -1,
"message": "Action is not recognized"
}

preorders/email¶

Инициирует отправку электронного письма по предзаказу.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `email`
token	✅	string	Токен авторизации
params[id]	✅	integer	ID предзаказа для отправки письма

Пример запроса

curl -s "https://invapi.hostkey.ru/preorders.php" -X POST \
--data "action=email" \
--data "token=HOSTKEY_TOKEN" \
--data "params[id]=VALUE"

Пример успешного ответа

{
"result": "OK",
"action": "email",
"data": {
"status": "sent"
}
}

Примеры ошибок

{
"code": -1,
"message": "Action is not recognized"
}

preorders/list_admin¶

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

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `list_admin`
token	✅	string	Токен авторизации

Пример запроса

curl -s "https://invapi.hostkey.ru/preorders.php" -X POST \
--data "action=list_admin" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"action": "list_admin",
"data": {
"items": [
{
"id": 1024,
"customer_id": 55,
"status": "active",
"created_at": "2024-03-20T12:00:00Z"
}
]
}
}

Примеры ошибок

{
"code": -1,
"message": "Action is not recognized"
}

preorders/list_customer¶

Возвращает список предзаказов текущего авторизованного клиента.

HTTP-метод: GET

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `list_customer`
token	✅	string	Токен авторизации

Пример запроса

curl -s "https://invapi.hostkey.ru/preorders.php" -X GET \
--data "action=list_customer" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"action": "list_customer",
"data": {
"items": [
{
"id": 101,
"status": "active",
"amount": {
"EUR": 29.99,
"RUB": 3000
}
},
{
"id": 102,
"status": "pending",
"amount": {
"EUR": 59.99,
"RUB": 6000
}
}
]
}
}

Примеры ошибок

{
"code": -1,
"message": "Action is not recognized"
}

preorders/notify¶

Отправляет уведомление клиенту о статусе предзаказа.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `notify`
token	✅	string	Токен авторизации

Пример запроса

curl -s "https://invapi.hostkey.ru/preorders.php" -X POST \
--data "action=notify" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"action": "notify",
"data": {
"status": "sent",
"message_id": "msg_98765"
}
}

Примеры ошибок

{
"code": -1,
"message": "Action is not recognized"
}

preorders/notify_confirm¶

Подтверждает получение или прочтение уведомления по предзаказу.

HTTP-метод: POST

Параметры:

action	✅	string	Идентификатор метода: `notify_confirm`
token	✅	string	Токен авторизации

Пример запроса

curl -s "https://invapi.hostkey.ru/preorders.php" -X POST \
--data "action=notify_confirm" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"action": "notify_confirm",
"data": {
"status": "confirmed"
}
}

Примеры ошибок

{
"code": -1,
"message": "Action is not recognized"
}

preorders/validate_cancel_token¶

Проверяет валидность специального токена для отмены предзаказа.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `validate_cancel_token`
token	❌	string	Токен авторизации для выполнения запроса
cancel_token	✅	string	Специальный токен отмены предзаказа

Пример запроса

curl -s "https://invapi.hostkey.ru/preorders.php" -X POST \
--data "action=validate_cancel_token" \
--data "cancel_token=VALUE"

Пример успешного ответа

{
"result": "OK",
"action": "validate_cancel_token",
"data": {
"valid": true,
"preorder_id": 505
}
}

Примеры ошибок

{
"code": -1,
"message": "Invalid token"
}

preorders/view¶

Возвращает детальную информацию о конкретном предзаказе.

HTTP-метод: POST

Параметры:

action	✅	string	Идентификатор метода: view
token	✅	string	Токен авторизации
params[id]	✅	integer	ID предзаказа для просмотра

Пример запроса

curl -s "https://invapi.hostkey.ru/preorders.php" -X POST \
--data "action=view" \
--data "token=HOSTKEY_TOKEN" \
--data "params[id]=123"

Пример успешного ответа

{
"result": "OK",
"action": "view",
"data": {
"id": 123,
"status": "pending",
"customer_id": 456,
"total_amount": 99.99,
"currency": "EUR"
}
}

Примеры ошибок

{
"code": -1,
"message": "Preorder not found"
}