preorders.php¶

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

Методы API¶

Метод	Действие	Описание
`add`	создание предзаказа	Создает новый предзаказ для клиента.
`check`	проверка статуса	Проверяет текущее состояние предзаказов.
`count_customer`	подсчет предзаказов клиента	Возвращает количество предзаказов текущего авторизованного клиента.
`delete`	удаление предзаказа	Удаляет предзаказ с учетом подтверждения отмены.
`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¶

Проверяет текущее состояние предзаказов.

HTTP-метод: GET

Параметры:

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

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

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

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

{
"result": "OK",
"action": "check",
"data": {
"status": "active",
"last_update": "2024-05-20T12:00:00Z"
}
}

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

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

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/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"
}