waybills.php¶

В этой статье

Методы API

waybills/add

waybills/add_barcodes

waybills/add_history

waybills/add_rows

waybills/complete

waybills/delete

waybills/delete_barcodes

waybills/delete_rows

waybills/fail

waybills/fail_rows

waybills/finalize

waybills/history

waybills/history_rows

waybills/list

waybills/list_barcodes

waybills/list_rows

waybills/modify

waybills/modify_hardware

waybills/modify_rows

waybills/rocket_channels

waybills/send_rocket_message

waybills/show

waybills/update

waybills/update_rows

API модуль управления накладными (waybills): создание, редактирование, управление деталями, штрих-кодами и историей событий.

Методы API¶

Метод	Действие	Описание
`add`	создание накладной	Создает новую накладную на основе переданных параметров фильтрации.
`add_barcodes`	добавление штрих-кодов	Добавляет массив штрих-кодов к существующей накладной.
`add_history`	добавление записи в историю	Добавляет примечание (запись) в историю накладной.
`add_rows`	добавление строк в накладную	Добавляет новые строки (детали) в существующую накладную.
`complete`	завершение накладной	Переводит накладную в статус завершенной.
`delete`	удаление накладной	Удаляет накладную.
`delete_barcodes`	удаление штрих-кодов	Удаляет указанные штрих-коды из накладной.
`delete_rows`	удаление строк	Устанавливает статус DELETED для указанных строк накладной.
`fail`	установка ошибки накладной	Устанавливает статус FAILED для всей накладной.
`fail_rows`	установка ошибки на строки	Устанавливает статус FAILED для указанных строк накладной.
`finalize`	финализация накладной	Завершает процесс обработки накладной.
`history`	получение истории накладной	Возвращает историю событий для указанной накладной или по фильтрам.
`history_rows`	получение детальной истории строк	Возвращает историю изменений конкретных строк накладной.
`list`	получение списка накладных	Возвращает список накладных с применением фильтров.
`list_barcodes`	получение списка штрих-кодов	Возвращает список штрих-кодов, соответствующих заданным фильтрам.
`list_rows`	получение строк накладной	Возвращает список строк (деталей) конкретной накладной.
`modify`	изменение накладной	Обновляет данные существующей накладной.
`modify_hardware`	модификация оборудования	Выполняет аппаратную модификацию накладной (добавление/удаление компонентов).
`modify_rows`	изменение строк накладной	Синхронизирует статус строк накладной, переводя их в режим ручного управления (MANUAL).
`rocket_channels`	получение каналов Rocket	Возвращает список доступных каналов отправки сообщений в зависимости от локации.
`send_rocket_message`	отправка сообщения в Rocket	Отправляет уведомление через каналы Rocket для указанной накладной.
`show`	получение информации о накладной	Возвращает подробную информацию о конкретной накладной по её ID.
`update`	обновление накладной	Обновляет основные данные существующей накладной.
`update_rows`	обновление строк в деталях накладной	Обновляет набор строк (деталей) внутри указанной накладной.

waybills/add¶

Создает новую накладную на основе переданных параметров фильтрации.

HTTP-метод: POST

Параметры:

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

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

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

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

{
"result": "OK",
"module": "waybills",
"action": "add",
"waybill": {
"id": 123,
"status": "active",
"created_at": "2024-05-20T12:00:00Z"
}
}

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

{
"code": -1,
"message": "Authorization error, token is invalid"
}

waybills/add_barcodes¶

Добавляет массив штрих-кодов к существующей накладной.

HTTP-метод: POST

Параметры:

action	✅	string	Идентификатор метода: `add_barcodes`
token	✅	string	Токен авторизации
id	✅	integer	ID накладной
rows	✅	`array<string>`	Массив штрих-кодов или JSON-строка с массивом

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

curl -s "https://invapi.hostkey.ru/waybills.php" -X POST \
--data "action=add_barcodes" \
--data "token=HOSTKEY_TOKEN" \
--data "id=12345" \
--data "rows[]=1234567890" \
--data "rows[]=0987654321"

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

{
"result": "OK",
"module": "waybills",
"action": "add_barcodes",
"waybill_barcodes": [
{
"barcode": "1234567890",
"status": "active"
}
]
}

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

{
"code": -1,
"message": "Must provide source set"
}

waybills/add_history¶

Добавляет примечание (запись) в историю накладной.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `add_history`
token	✅	string	Токен авторизации
id	❌	integer	ID накладной (waybill ID)
message	❌	string	Текст сообщения для истории

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

curl -s "https://invapi.hostkey.ru/waybills.php" -X POST \
--data "action=add_history" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123" \
--data "message=Your message here"

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

{
"result": "OK",
"module": "waybills",
"action": "add_history",
"history": [
{
"id": 50,
"message": "Note added manually",
"created_at": "2024-05-20T15:30:00Z"
}
]
}

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

{
"code": -1,
"message": "Authorization error"
}

waybills/add_rows¶

Добавляет новые строки (детали) в существующую накладную.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: add_rows
token	✅	string	Токен авторизации
id	✅	integer	ID накладной
rows	✅	`array<string>`	Массив данных для новых строк

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

curl -s "https://invapi.hostkey.ru/waybills.php" -X POST \
--data "action=add_rows" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123" \
--data "rows[]=row_data_1" \
--data "rows[]=row_data_2"

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

{
"result": "OK",
"module": "waybills",
"action": "add_rows",
"waybill_rows": [
{
"id": 10,
"name": "Item Row",
"status": "active"
}
]
}

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

{
"code": -1,
"message": "Must provide source set"
}

waybills/complete¶

Переводит накладную в статус завершенной.

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/waybills.php" -X POST \
--data "action=complete" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123"

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

{
"result": "OK",
"module": "waybills",
"action": "complete",
"waybill": {
"id": 123,
"status": "completed"
}
}

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

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

waybills/delete¶

Удаляет накладную.

HTTP-метод: POST

Параметры:

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

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

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

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

{
"result": "OK",
"module": "waybills",
"action": "delete",
"waybill": {
"id": 123,
"status": "deleted"
}
}

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

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

waybills/delete_barcodes¶

Удаляет указанные штрих-коды из накладной.

HTTP-метод: POST

Параметры:

action	✅	string	Идентификатор метода: `delete_barcodes`
token	✅	string	Токен авторизации
id	❌	integer	ID накладной
rows	✅	`array<string>`	Массив ID штрих-кодов для удаления

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

curl -s "https://invapi.hostkey.ru/waybills.php" -X POST \
--data "action=delete_barcodes" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123" \
--data "rows[]=barcode1" \
--data "rows[]=barcode2"

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

{
"result": "OK",
"module": "waybills",
"action": "delete_barcodes",
"waybill_barcodes": []
}

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

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

waybills/delete_rows¶

Устанавливает статус DELETED для указанных строк накладной.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `delete_rows`
token	✅	string	Токен авторизации
id	❌	integer	ID накладной
rows	❌	`array<string>`	Массив ID строк для удаления. Принимает несколько значений: rows[]=val1&rows[]=val2

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

curl -s "https://invapi.hostkey.ru/waybills.php" -X POST \
--data "action=delete_rows" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123" \
--data "rows[]=10" \
--data "rows[]=11"

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

{
"result": "OK",
"module": null,
"action": "delete_rows",
"waybill_rows": [
{
"id": 10,
"status": "DELETED"
}
]
}

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

{
"code": -1,
"message": "Ошибка выполнения операции"
}

waybills/fail¶

Устанавливает статус FAILED для всей накладной.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: fail
token	✅	string	Токен авторизации
id	❌	integer	ID накладной (принимается из POST или GET)

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

curl -s "https://invapi.hostkey.ru/waybills.php" -X POST \
--data "action=fail" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123"

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

{
"result": "OK",
"module": "waybills",
"action": "fail",
"waybill": {
"id": 123,
"status": "FAILED"
}
}

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

{
"code": -1,
"message": "Ошибка выполнения операции"
}

waybills/fail_rows¶

Устанавливает статус FAILED для указанных строк накладной.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: fail_rows
token	✅	string	Токен авторизации
id	❌	integer	ID накладной
rows	❌	`array<string>`	Массив ID строк для обработки. Принимает несколько значений: rows[]=val1&rows[]=val2

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

curl -s "https://invapi.hostkey.ru/waybills.php" -X POST \
--data "action=fail_rows" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123" \
--data "rows[]=50" \
--data "rows[]=51"

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

{
"result": "OK",
"module": null,
"action": "fail_rows",
"waybill_rows": [
{
"id": 50,
"status": "FAILED"
}
]
}

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

{
"code": -1,
"message": "Ошибка выполнения операции"
}

waybills/finalize¶

Завершает процесс обработки накладной.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: finalize
token	✅	string	Токен авторизации
id	❌	integer	ID накладной (принимается из POST или GET)

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

curl -s "https://invapi.hostkey.ru/waybills.php" -X POST \
--data "action=finalize" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123"

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

{
"result": "OK",
"module": "waybills",
"action": "finalize",
"waybill": {
"id": 123,
"status": "completed"
}
}

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

{
"code": -1,
"message": "Ошибка выполнения операции"
}

waybills/history¶

Возвращает историю событий для указанной накладной или по фильтрам.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: history
token	✅	string	Токен авторизации
id	❌	`array<integer>`	ID накладной. Принимает несколько значений: id[]=1&id[]=2
type	❌	`array<string>`	Тип события в истории. Принимает несколько значений: type[]=val1&type[]=val2
date_from	❌	string	Дата начала истории (ISO-дата)

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

curl -s "https://invapi.hostkey.ru/waybills.php" -X POST \
--data "action=history" \
--data "token=HOSTKEY_TOKEN" \
--data "id[]=1" \
--data "id[]=2" \
--data "type[]=val1" \
--data "type[]=val2" \
--data "date_from=2024-05-20T00:00:00Z"

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

{
"result": "OK",
"module": "wb",
"action": "history",
"history": [
{
"id": 1,
"type": "note",
"created_at": "2024-05-20T12:00:00Z",
"message": "History log entry"
}
]
}

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

{
"code": -1,
"message": "Ошибка получения истории"
}

waybills/history_rows¶

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

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `history_rows`
token	✅	string	Токен авторизации
id	❌	`array<integer>`	ID накладной. Принимает несколько значений: id[]=1&id[]=2
type	❌	`array<string>`	Тип события в истории. Принимает несколько значений: type[]=val1&type[]=val2
date_from	❌	string	Дата начала истории (ISO-дата)
eq_id	❌	`array<integer>`	ID оборудования. Принимает несколько значений: eq_id[]=1&eq_id[]=2
location	❌	string	Код локации (например, NL, DE)

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

curl -s "https://invapi.hostkey.ru/waybills.php" -X POST \
--data "action=history_rows" \
--data "token=HOSTKEY_TOKEN" \
--data "id[]=1" \
--data "id[]=2" \
--data "type[]=update" \
--data "eq_id[]=5"

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

{
"result": "OK",
"module": null,
"action": "history_rows",
"history": [
{
"id": 101,
"type": "update",
"created_at": "2024-05-20T15:30:00Z",
"eq_id": 5,
"location": "NL"
}
]
}

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

{
"code": -1,
"message": "Ошибка получения истории строк"
}

waybills/list¶

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

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `list`
token	✅	string	Токен авторизации
deleted	❌	boolean	Включать удаленные накладные в список. По умолчанию false.
date	❌	`array<string>`	Диапазон дат или конкретная дата. Принимает несколько значений: date[]=2024-01-01&date[]=2024-01-31
date_from	❌	string	Дата начала периода (ISO-дата)
date_to	❌	string	Дата окончания периода (ISO-дата)

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

curl -s "https://invapi.hostkey.ru/waybills.php" -X POST \
--data "action=list" \
--data "token=HOSTKEY_TOKEN" \
--data "date[]=2024-01-01" \
--data "date[]=2024-01-31"

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

{
"result": "OK",
"module": "waybills",
"action": "list",
"waybills": [
{
"id": 500,
"name": "Waybill #123",
"status": "active",
"created_at": "2024-01-15T10:30:00Z"
}
]
}

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

{
"code": -1,
"message": "Empty search parameters disallowed"
}

waybills/list_barcodes¶

Возвращает список штрих-кодов, соответствующих заданным фильтрам.

HTTP-метод: POST

Параметры:

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

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

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

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

{
"result": "OK",
"module": "waybills",
"action": "list_barcodes",
"waybill_barcodes": [
{
"id": 123,
"barcode": "ABC-123456",
"status": "active"
}
]
}

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

{
"code": -1,
"message": "Empty search parameters disallowed"
}

waybills/list_rows¶

Возвращает список строк (деталей) конкретной накладной.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `list_rows`
token	✅	string	Токен авторизации
waybill_id	❌	integer	ID накладной для фильтрации
id	❌	integer	ID строки (детали)
deleted	❌	boolean	Показывать удаленные записи. Допустимые значения: true, false.

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

curl -s "https://invapi.hostkey.ru/waybills.php" -X POST \
--data "action=list_rows" \
--data "token=HOSTKEY_TOKEN" \
--data "waybill_id=123"

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

{
"result": "OK",
"module": "waybills",
"action": "list_rows",
"waybill_rows": [
{
"id": 456,
"name": "Row Item",
"status": "active"
}
]
}

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

{
"code": -1,
"message": "Empty search parameters disallowed"
}

waybills/modify¶

Обновляет данные существующей накладной.

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/waybills.php" -X POST \
--data "action=modify" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123"

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

{
"result": "OK",
"action": "modify",
"waybill": {
"id": 123,
"status": "active"
}
}

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

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

waybills/modify_hardware¶

Выполняет аппаратную модификацию накладной (добавление/удаление компонентов).

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `modify_hardware`
token	✅	string	Токен авторизации
id	✅	integer	ID накладной для модификации
additions	❌	`array<string>`	Список добавляемых компонентов (массив объектов)
deletions	❌	`array<string>`	Список удаляемых компонентов (массив объектов)

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

curl -s "https://invapi.hostkey.ru/waybills.php" -X POST \
--data "action=modify_hardware" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123" \
--data "additions[]=component1" \
--data "additions[]=component2" \
--data "deletions[]=old_component"

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

{
"id": 123,
"waybills": [
{
"id": 456,
"status": "active"
}
]
}

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

{
"code": -1,
"message": "ID can't be empty"
}

waybills/modify_rows¶

Синхронизирует статус строк накладной, переводя их в режим ручного управления (MANUAL).

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `modify_rows`
token	✅	string	Токен авторизации
id	❌	integer	ID накладной
rows	❌	`array<string>`	Список ID строк для модификации

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

curl -s "https://invapi.hostkey.ru/waybills.php" -X POST \
--data "action=modify_rows" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123" \
--data "rows[]=789" \
--data "rows[]=790"

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

{
"result": "OK",
"module": "waybills",
"action": "modify_rows",
"waybill_rows": [
{
"id": 789,
"status": "manual"
}
]
}

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

{
"code": -1,
"message": "Error during row modification"
}

waybills/rocket_channels¶

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

HTTP-метод: POST

Параметры:

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

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

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

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

{
"result": "OK",
"module": null,
"action": "rocket_channels",
"channels": [
{
"id": 1,
"name": "Main Channel"
}
]
}

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

null

waybills/send_rocket_message¶

Отправляет уведомление через каналы Rocket для указанной накладной.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `send_rocket_message`
token	✅	string	Токен авторизации
id	✅	integer	ID накладной для отправки сообщения
channels	❌	`array<string>`	Список каналов для отправки. Принимает несколько значений: channels[]=val1&channels[]=val2

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

curl -s "https://invapi.hostkey.ru/waybills.php" -X POST \
--data "action=send_rocket_message" \
--data "token=HOSTKEY_TOKEN" \
--data "id=12345" \
--data "channels[]=val1" \
--data "channels[]=val2"

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

{
"result": "OK",
"module": "waybills",
"action": "send_rocket_message"
}

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

{
"code": 400,
"message": "Please provide waybill ID"
}

waybills/show¶

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

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `show`
token	✅	string	Токен авторизации
id	❌	integer	ID накладной для отображения
deleted	❌	boolean	Флаг отображения удаленных накладных в результатах поиска.

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

curl -s "https://invapi.hostkey.ru/waybills.php" -X POST \
--data "action=show" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123"

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

{
"result": "OK",
"action": "show",
"waybill": {
"id": 123,
"status": "active",
"created_at": "2024-05-20T12:00:00Z",
"total_amount": 150.5,
"currency": {
"EUR": 138.0,
"USD": 165.0
}
}
}

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

{
"code": -404,
"message": "Waybill wb:123 not found"
}

waybills/update¶

Обновляет основные данные существующей накладной.

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/waybills.php" -X POST \
--data "action=update" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123"

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

{
"result": "OK",
"action": "update",
"waybill": {
"id": 123,
"status": "active",
"updated_at": "2024-05-21T10:30:00Z"
}
}

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

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

waybills/update_rows¶

Обновляет набор строк (деталей) внутри указанной накладной.

HTTP-метод: POST

Параметры:

action	✅	string	Идентификатор метода: `update_rows`
token	✅	string	Токен авторизации
id	❌	integer	ID накладной для обновления строк
rows	❌	`array<string>`	Массив данных для обновления строк. Принимает несколько значений: rows[]=val1&rows[]=val2

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

curl -s "https://invapi.hostkey.ru/waybills.php" -X POST \
--data "action=update_rows" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123" \
--data "rows[]=val1" \
--data "rows[]=val2"

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

{
"result": "OK",
"module": null,
"action": "update_rows",
"waybill_rows": [
{
"id": 501,
"name": "Row Item 1",
"status": "active"
},
{
"id": 502,
"name": "Row Item 2",
"status": "pending"
}
]
}

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

{
"code": -1,
"message": "Database error during update"
}