API documentation (eng) - datawizio/pythonAPI GitHub Wiki

Downloading Dump

DW.download_data Downloads the data about a client.

Getting data

DW.get_client_info Returns information about a client. Shows the client's name, name of his chain store, date of the first and the last receipt of a client in the chain.

DW.get_shops Returns information about a shop: name of the shop, address, location on the map and geographic position.

DW.get_product Returns information about a product: name of the product, stock-keeping unit, bar-code, code of the category, units of measurement.

DW.get_products_sale Returns data about sales of chosen products during a given period. Shows the turnover of products during the given period, quantity of sold products, stock, self-cost. The results are grouped by days, weeks, months, and years.

DW.get_category Returns a category or a category tree. Shows the name of a chosen category, list of products belonging to it, parent and child category.

DW.get_categories_sale Returns data about sales of chosen categories during a given period. Shows the turnover of products during a given period, quantity of sold products, stock, its production cost. The results are grouped by days, weeks, months, and years.

DW.get_receipt Returns information about the receipt, shows the list of products in the receipt, name and cost of every product, total cost of purchasing and time of its making.

DW.get_receipts Returns information about receipts, shows list of products in every receipt, name and cost of a product in every receipt, cost of receipts and their issuing time.

DW.get_products_stock Returns data about stock.

DW.get_categories_stock Returns data about stock grouped by categories.

DW.get_lost_sales Returns data about lost sales.

DW.get_sales_plan Returns data about sales plans.

DW.get_sales Returns information about sales.

DW.get_sale_info Returns information about particular sales.

DW.get_sales_dynamics Returns data about dynamics of product sales.

DW.get_loyalty_sales Returns data about sales considering loyalty program clients.

Manage user

Auth.generate_secret Generates signature used to get access the API

Utils

DW.get_pairs Returns pairs for categories and products, credibility and support for every pair.

DW.search Searching by names of categories or products.

DW.id2name Returns names of categories or products.

DW.name2id Returns identifier of categories or products.

DW.get_parent Returns parent categories of a certain level.

Loyalty

DW.get_loyalty_customer Returns data about loyalty program clients.