Rest API documentation (rus) - datawizio/pythonAPI GitHub Wiki

Введение
Общее описание сервиса Datawiz BI. А также основных его команд, ресурсов и данных.

Аутентификация пользователя
Опис процесса и процедуры проверки личности пользователя.

Список магазинов
Это список названий магазинов сети клиента и их идентификаторы. С помощью ресурса можно получить доступ "только для чтения" к списку магазинов. Удалять магазины через REST API нельзя. При необходимости добавить/удалить магазин из сервиса обращайтесь к администратору сервиса.

Список кассовых терминалов для каждого из магазинов
Это список терминалов обслуживания покупателей применительно к каждому магазину торговой сети, который дает возможность получить доступ к списку кассовых терминалов, а также добавлять в справочник новые терминалы.

Справочник категорий товаров
Это иерархический список категорий товаров, который дает возможность получить доступ к списку категорий товаров, а также добавлять в справочник новые категории и удалять ненужные.

Справочник единиц измерения товаров
Это список единиц измерение товаров. С помощью ресурса можно получить доступ к списку единиц измерения товаров, а также добавлять в справочник новые ед.измерения.

Справочник по товарам
Это список названий товаров и их идентификаторов. С помощью этого ресурса можно получить доступ к списку товаров, а также добавлять в справочник новые товары.

Список клиентов, участвующих в программе лояльности
Это список покупателей, зарегистрировавшихся в программе лояльности сети магазинов. С помощью которого можно получить доступ к списку клиентов, участвующих в программе лояльности, а также добавлять в справочник новых учасников программы.

Справочник кассиров
Это общий список кассиров сети магазинов, с которым можно получить доступ к списку кассиров, а также добавлять в справочник новые данные.

Список чеков
Это список кассовых чеков. Каждый чек включает в себя список товарных позиций. С помощью которого можно получить доступ к списку чеков, а также добавлять новые чеки.

Список цен
Это список цен товаров магазинов сети клиента. С помощью которого можно получить доступ к списку цен на товари магазинов. А также добавлять новые цены.

Список остатков
Это перечень остатков товаров магазинов сети клиента. С помощью которого можно получить доступ к списку остатков товаров. А также добавлять информацию об остатках.

Список поставщиков товара
Это список всех поставщиков, с которыми были или ведутся торговые отношения.

Список документов на заказ продукта
Это документ, который составляется магазином во время заказа товаров в поставщиков или производителя. Он включает название товара, артикул, штрих-код, единицы измерения, цену и количество товара.

Список документов на получение товара
Это накладная, в которой указаны данные на поставленный поставщиком товар в магазин. В накладной указывается название товара, штрих-код, цена, количество.

Список документов на перемещение товара
Это документ с указанными деталями по поводу перемещения товара между складами и магазинами.

Справочник контрагентов
Это Справочник всех контрагентов, с которыми были или ведутся торговые отношения.

Список категорийных менеджеров
Это список категорийных менеджеров, которые работают в магазинах сети клиента.

Список акций
Это список акций, которые происходили или происходят в магазинах сети клиента.

Список брендов
Это список брендов, которые присутствуют в сети.

Список возвратов поставщикам
Содержит документы возвратов товара поставщикам.

Список документов оплаты полученного товара
Содержит документы о оплате полученного товара.

Список документов инвентаризации
Содержит документы инвентаризации.

Список документов оприходований (в результате инвентаризации)
Содержит документы оприходований.

Список документов списаний
Содержит документы списаний.

Список типов списаний Содержит словарь типов списаний.

Продажи категорий Содержит данные о категориях по основым показателям

Продажи товаров Содержит данные о товарах по основым показателям

Остатки по категориям Содержит данные об остатках по категориям

Остатки по товарам Содержит данные об остатках по товарам

Продажи программы лояльности Содержит данные о продажах программы лояльности

Клиенты программы лояльности Содержит данные о клиентах программы лояльности

Акции Содержит агрегированные данные о акциях

Информация о акции Содержит данные об акционных продуктах

Динамика акций Содержит данные о динамике акций

Анализ корзин Содержит типичные корзины покупателей в торговой сети

Трафик клиентов Содержит данные о трафике клиентов в магазине, а также дает возможность добавлять новый трафик

Товары поставщиков Содержит данные о товарах поставщиков, а также дает возможность добавлять новые

Загрузка данных на сервис
Это функции для управления загрузкой данных на сервис.