moyskladapi 1.0.0rc1

Установка

Требуется Python 3.12+.

pip install moyskladapi

Примеры использования

Создание, обновление и удаление товара

import asyncio

from moyskladapi import MoyskladAPI
from moyskladapi.types import Product


async def main():
    async with MoyskladAPI(token="your_token_here") as api:
        product = await api.create_product(Product(name="Тестовый товар"))
        print(f"Создан: {product.name} [{product.id}]")

        product = await api.update_product(product.id, Product(description="Описание товара"))
        print(f"Описание: {product.description}")

        await api.delete_product(product.id)
        print("Удалён")


asyncio.run(main())

Фильтрация товаров

import asyncio

from moyskladapi import MoyskladAPI, F


async def main():
    async with MoyskladAPI(token="your_token_here") as api:
        results = await api.get_products(
            filters=[F.archived == False, F.weight > 1.0],
            expand="supplier",
            limit=10,
        )
        for p in results.rows:
            print(f"{p.name}  |  поставщик: {p.supplier.name if p.supplier else '—'}")


asyncio.run(main())

Остатки

import asyncio

from moyskladapi import MoyskladAPI


async def main():
    async with MoyskladAPI(token="your_token_here") as api:
        stock = await api.get_stock_current()
        low = [s for s in stock.rows if s.quantity and s.quantity < 5]
        print(f"Заканчиваются: {len(low)} позиций")


asyncio.run(main())

Постраничный обход

Методы iter_* обходят выборку лениво: страницы подгружаются по мере необходимости, а обработанные — освобождаются. Память не растёт с размером каталога, поэтому это способ по умолчанию.

import asyncio

from moyskladapi import MoyskladAPI


async def main():
    async with MoyskladAPI(token="your_token_here") as api:
        async for product in api.iter_products():
            print(product.name)


asyncio.run(main())

Если нужен готовый список, у методов get_* есть параметр auto_paginate — он проходит все страницы и возвращает их одним MetaArray:

everything = await api.get_products(auto_paginate=True)
print(f"Всего: {len(everything.rows)}")

Пользуйтесь им только для небольших выборок: все записи остаются в памяти одновременно. На каталоге в 20 000 товаров это около 23 МБ против 2 МБ у iter_products(), и дальше разница растёт линейно. Список из iter_* собирается одной строкой, если он действительно нужен:

everything = [product async for product in api.iter_products()]

Лента событий документа

import asyncio

from moyskladapi import MoyskladAPI
from moyskladapi.types import Note


async def main():
    async with MoyskladAPI(token="your_token_here") as api:
        order_id = "e4609c69-00bc-11ef-ac12-00120000001a"

        note = await api.create_note("customerorder", order_id, Note(description="Согласовано"))
        feed = await api.get_notes("customerorder", order_id)
        print(f"Событий: {len(feed.rows)}")

        await api.delete_note("customerorder", order_id, note.id)


asyncio.run(main())

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

import asyncio

from moyskladapi import MoyskladAPI, MoyskladAPIError
from moyskladapi.types import Product


async def main():
    async with MoyskladAPI(token="your_token_here") as api:
        try:
            await api.create_product(Product())
        except MoyskladAPIError as exc:
            print(f"HTTP {exc.http_status}: {exc}")
            for error in exc.errors:
                print(f"  код {error.code}: {error.error_message or error.error}")


asyncio.run(main())

Ответы с кодом 429 повторяются автоматически с учётом заголовка X-Lognex-Retry-TimeInterval (до BaseSession.MAX_RETRIES попыток).

Лицензия

MIT