pyiiko

Python-библиотека для работы с API iiko ERP

Возможности

iiko Server API — on-premise установки (складской учёт, номенклатура, отчёты OLAP, сотрудники, накладные, EDI)
iiko Transport API — облачный API (организации, терминалы, доставки, города, улицы)
iiko Public Web API — облачный API нового поколения (документооборот, номенклатура, закупки)
Автоматический retry на 5xx ошибки (3 попытки с backoff)
Единая иерархия исключений: IikoError → IikoAuthError / IikoAPIError
Context manager для автоматического освобождения ресурсов
Type hints, PEP 561 py.typed

Установка

pip install Pyiiko

Требования: Python 3.9+

Быстрый старт

iiko Server (on-premise)

from Pyiiko import IikoServer

# Пароль передаётся в виде SHA1-хеша
server = IikoServer(
    ip="https://your-server.example.com:443",
    login="login",
    password="da39a3ee5e6b4b0d3255bfef95601890afd80709",
)

print(server.version())          # "7.8.9"
print(server.departments())      # XML с иерархией подразделений
print(server.products())         # XML с номенклатурой

Использование как context manager освобождает токен (лицензионный слот) автоматически:

with IikoServer(ip="...", login="...", password="...") as server:
    stores = server.stores()
    employees = server.employees()
# токен уничтожен, лицензия освобождена

Если токен уже получен — передайте его напрямую, чтобы не делать лишний запрос:

server = IikoServer(ip="https://...", token="your-existing-token")

iiko Public Web API

from Pyiiko import IikoWeb

client = IikoWeb(api_key="your-api-key")

# Список складов
stores = client.stores()

# Список продуктов с пагинацией
products = client.products(limit=100, offset=0)

# Экспорт приходных накладных
invoices = client.incoming_invoice_export(
    department_id="dept-guid-...",
    date_from="2024-01-01",
    date_to="2024-01-31",
)

# Список заказов на закупку
orders = client.orders_list({"storeId": 1, "limit": 50})

Передайте уже полученный токен, чтобы пропустить авторизацию:

client = IikoWeb(token={"token": "eyJ...", "expires_in": 9999999999})

iiko Transport (Cloud)

from Pyiiko import Transport

client = Transport(key="your-api-login-key")

orgs = client.organization()
terminals = client.terminal(org_id="org-guid-...")
cities = client.cities(org_id="org-guid-...")

Создание доставки:

order = {
    "organizationId": "org-guid-...",
    "order": {
        "phone": "+79001234567",
        "deliveryPoint": {"coordinates": {"latitude": 55.75, "longitude": 37.61}},
        "items": [{"productId": "product-guid-...", "amount": 1}],
    },
}
response = client.delivery_create(order_info=order)

Обработка ошибок

from Pyiiko import IikoServer, IikoAuthError, IikoAPIError

try:
    server = IikoServer(ip="...", login="user", password="wrong")
except IikoAuthError:
    print("Неверные учётные данные")

try:
    data = server.departments()
except IikoAPIError as e:
    print(f"Ошибка API: HTTP {e.status_code}")

Исключение	Когда возникает
`IikoError`	Базовый класс всех ошибок pyiiko
`IikoAuthError`	Неверный логин/пароль, пустой токен
`IikoAPIError`	Сервер вернул HTTP 4xx/5xx

Справочник методов

`IikoServer`

Метод	Описание
`version()`	Версия iiko сервера
`server_info()`	Информация о сервере и лицензии
`departments()`	Иерархия подразделений
`stores()`	Список складов
`groups()`	Группы и отделения
`terminals()`	Список терминалов
`terminals_search(anonymous, **kwargs)`	Поиск терминалов
`employees()`	Сотрудники
`products(includeDeleted)`	Номенклатура
`products_find(**kwargs)`	Поиск по номенклатуре
`suppliers()`	Поставщики
`suppliers_find(name, code)`	Поиск поставщиков
`suppliers_price(code, date)`	Прайс-лист поставщика
`events(**kwargs)`	События
`events_filter(body)`	События по фильтру XML
`olap(report, data_from, data_to, **kwargs)`	OLAP-отчёт v1
`olap2(body)`	OLAP-отчёт v2 (JSON)
`sales(departament, **kwargs)`	Отчёт по выручке
`product_expense(departament, **kwargs)`	Расход продуктов
`store_operation(**kwargs)`	Складские операции
`reports_balance(timestamp, **kwargs)`	Балансы по счетам
`invoice_in(**kwargs)`	Приходные накладные
`invoice_out(**kwargs)`	Расходные накладные
`invoice_number_in(current_year, **kwargs)`	Приходная накладная по номеру
`invoice_number_out(current_year, **kwargs)`	Расходная накладная по номеру
`production_doc(xml)`	Загрузка акта приготовления
`close_session(dateFrom, dateTo)`	Кассовые смены
`edi(edi, **kwargs)`	EDI заказы
`quit_token()`	Уничтожить токен / освободить лицензию

`Transport`

Метод	Описание
`organization()`	Список организаций
`terminal(org_id)`	Терминальные группы
`regions(org_id)`	Регионы доставки
`cities(org_id)`	Города
`streets_by_city(org_id, city)`	Улицы города
`delivery_create(order_info)`	Создать доставку
`check_create(order_info)`	Валидировать заказ перед созданием
`by_id(org_id, order_id)`	Доставка по ID
`by_delivery_date(org_id, delivery_date_from)`	Доставки по дате
`by_revision(org_id, revision)`	Доставки с ревизии

`IikoWeb`

Авторизация

Метод	Описание
`get_token()`	Получить новый Bearer-токен по API-ключу
`token()`	Вернуть текущий токен (dict)

Справочники (entities)

Метод	Описание
`stores()`	Список складов
`store(store_id)`	Склад по ID
`products(filters, limit, offset)`	Номенклатура
`product_categories(filters, limit, offset)`	Категории продуктов
`product_sizes(filters, limit, offset)`	Размеры продуктов
`users(filters, limit, offset)`	Пользователи
`payment_types(filters, limit, offset)`	Типы оплат
`cash_flow_categories(filters, limit, offset)`	Статьи ДДС

Номенклатура

Метод	Описание
`update_barcodes(payload)`	Обновить штрих-коды

Документооборот

Метод	Описание
`counteragents(department_id, type, limit, offset)`	Список контрагентов
`incoming_invoice_create(payload)`	Создать приходную накладную
`incoming_invoice_export(department_id, date_from, date_to, ...)`	Экспорт приходных накладных
`incoming_invoice_export_by_number(payload)`	Приходная накладная по номеру
`incoming_invoice_pay(payload)`	Провести оплату приходной накладной
`incoming_invoice_set_payment_date(payload)`	Установить дату оплаты
`incoming_invoice_update(payload)`	Обновить приходную накладную
`incoming_service_create(payload)`	Создать акт входящих услуг
`incoming_service_edit(payload)`	Изменить акт входящих услуг
`incoming_service_export(payload)`	Экспорт актов входящих услуг
`incoming_service_get(payload)`	Получить акт входящих услуг
`internal_transfer_create(payload)`	Создать внутреннее перемещение
`internal_transfer_edit(payload)`	Изменить внутреннее перемещение
`internal_transfer_export(payload)`	Экспорт внутренних перемещений
`internal_transfer_get_by_id(payload)`	Перемещение по ID
`internal_transfer_export_by_number(payload)`	Перемещение по номеру
`outgoing_invoice_create(payload)`	Создать расходную накладную
`outgoing_invoice_export(payload)`	Экспорт расходных накладных
`outgoing_invoice_export_by_number(payload)`	Расходная накладная по номеру
`outgoing_invoice_cost_prices(payload)`	Себестоимость по расходной накладной
`outgoing_invoice_pay(payload)`	Провести оплату расходной накладной
`outgoing_invoice_set_payment_date(payload)`	Установить дату оплаты
`outgoing_invoice_update(payload)`	Обновить расходную накладную
`outgoing_service_create(payload)`	Создать акт исходящих услуг
`outgoing_service_edit(payload)`	Изменить акт исходящих услуг
`outgoing_service_export(payload)`	Экспорт актов исходящих услуг
`outgoing_service_get(payload)`	Получить акт исходящих услуг
`production_doc_create(payload)`	Создать акт приготовления
`production_doc_edit(payload)`	Изменить акт приготовления
`production_doc_export(payload)`	Экспорт актов приготовления
`production_doc_get(payload)`	Получить акт приготовления
`sales_doc_create(payload)`	Создать акт реализации
`sales_doc_edit(payload)`	Изменить акт реализации
`sales_doc_export(payload)`	Экспорт актов реализации
`sales_doc_get(payload)`	Получить акт реализации
`writeoff_create(payload)`	Создать акт списания
`writeoff_edit(payload)`	Изменить акт списания
`writeoff_export(payload)`	Экспорт актов списания
`writeoff_get_by_id(payload)`	Акт списания по ID
`writeoff_export_by_number(payload)`	Акт списания по номеру

Закупки

Метод	Описание
`order_create(store_id, workflow_id, due_date, ...)`	Создать заказ на закупку
`order_get(order_id)`	Заказ на закупку по ID
`orders_list(payload)`	Список заказов на закупку
`order_add_products(payload)`	Добавить продукты в заказ
`order_select_supplier(payload)`	Выбрать поставщика для заказа
`order_task_status(task_id)`	Статус асинхронной задачи заказа
`order_select_units(payload)`	Выбрать единицы измерения для заказа
`workflow_activate(workflow_id)`	Активировать рабочий процесс
`workflow_deactivate(workflow_id)`	Деактивировать рабочий процесс
`workflow_get(workflow_id)`	Рабочий процесс по ID
`workflows_list(payload)`	Список рабочих процессов

Разработка

git clone https://github.com/gadzhi/pyiiko.git
cd pyiiko
python -m venv .venv && source .venv/bin/activate
pip install -e ".[dev]"
pytest --cov=Pyiiko

Тесты не требуют подключения к серверу — HTTP замокан через responses.

Подробности в CONTRIBUTING.md.

Changelog

Смотрите CHANGELOG.md.

Лицензия

Apache License 2.0

Name		Name	Last commit message	Last commit date
Latest commit History 115 Commits
Pyiiko		Pyiiko
docs		docs
tests		tests
.DS_Store		.DS_Store
.env.example		.env.example
.gitignore		.gitignore
CHANGELOG.md		CHANGELOG.md
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
README.md		README.md
pip-selfcheck.json		pip-selfcheck.json
pyproject.toml		pyproject.toml
pyvenv.cfg		pyvenv.cfg
requirements.txt		requirements.txt

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

pyiiko

Возможности

Установка

Быстрый старт

iiko Server (on-premise)

iiko Public Web API

iiko Transport (Cloud)

Обработка ошибок

Справочник методов

`IikoServer`

`Transport`

`IikoWeb`

Авторизация

Справочники (entities)

Номенклатура

Документооборот

Закупки

Разработка

Changelog

Лицензия

About

Uh oh!

Releases 1

Packages

Uh oh!

Uh oh!

Contributors

Uh oh!

Languages

Folders and files

Latest commit

History

Repository files navigation

pyiiko

Возможности

Установка

Быстрый старт

iiko Server (on-premise)

iiko Public Web API

iiko Transport (Cloud)

Обработка ошибок

Справочник методов

IikoServer

Transport

IikoWeb

Авторизация

Справочники (entities)

Номенклатура

Документооборот

Закупки

Разработка

Changelog

Лицензия

About

Topics

Resources

License

Contributing

Uh oh!

Stars

Watchers

Forks

Releases 1

Packages 0

Uh oh!

Uh oh!

Contributors

Uh oh!

Languages

`IikoServer`

`Transport`

`IikoWeb`

Packages