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

Introduction
General description of the service Datawiz BI. Description of commands, resources and data.

User authentication
Description of procedures and verify the identity of the user.

Shops list
It is list containing shop names of the client's network and corresponding identifiers. Allows to get access to read the list of shops.

List of point of sale terminals for each shop
It is a list of cash registers of each shop of the retail network. Allows to get access to the list of point-of-sale terminals and add new terminals to a Catalog.

Catalog of product categories
It is a hierarchic (tree) list of product categories. Allows to get access to the list of product categories and can add new categories or delete not needed ones from the catalog.

Catalog of measurement units
It is a list of measurement units of products. Allows to get access to the list of measurement units and add new units to a catalog.

Catalog of products
It is a list of product names and corresponding identifiers. With the help of /products/ resource one can get access to the list of products and add new data to a catalog.

List of clients taking part in loyalty program
It s a register of customers, who registered in loyalty program of the shop network. Allows to get access to the list of clients taking part in loyalty program and add new participants to the list.

Catalog of cashiers
It is a general list of cashiers of a shop network (not linked to one particular shop). Allows to get access to the list of cashiers and add new data to a catalog.

List of receipts
It is a list of sales receipts. Each receipt contains a list of product items. Allows to get access to the list of receipts and add new receipts to a catalog.

List of prices
It is a list of prices in shops of client's network. Allows to get access to the list of product prices and add new prices.

Inventory list
It is a list of all products remaining in client's shop network. Allows to get access to the list of inventory and to add information about inventory.

Suppliers of products
It is a list of all suppliers who worked or are still working with client.

Purchase documents
It is document made by shop when ordering goods from suppliers or manufacturers. They include product name, item number, bar code, measurement units, price and quantity.

Documents to receive products
It is delivery note containing data about products supplied to the shop. Delivery note also includes product name, bar code, price, quantity.

Documents to relocate products
It is document containing details about relocating goods between storing facilities and shops.

Documents to refund products
It is document containing details about refunding goods in the shop.

List of category managers
It is the list of category managers working in shop network.

List of sales
It is a list with all recent or past sales of a client's shop network.

List of brands
It is a list with all brands presented in a shop network

List of refunds to supplier
Contains the list of returns to supplier and add new returns.

List of pay order document
Contains the list of payments for received goods and add new pay orders.

List of receipt markers It is a list of markers used for a certain types of sales.

List of inventory documents Contains the list of stocktaking documents.

List of posting documents Contains the list of posting documents.

List of write-offs Contains the list of write-offs.

List of write-off types Contains the list of write-off types.

Upload data to service
Functions of data uploading management to service.