DW.get_sales_plan (eng) - datawizio/pythonAPI GitHub Wiki

DW.get_sales_plan - returns information about sales plans

Parameters

  • date: datetime, str {"%Y-%m"}
  • category: int

    id of the category used for receiving results

  • shops: int, list

    id of the shop or a list of ids that will be used for selection

    • `by: str` 
                   {'qty': quantity of sales,
                'turnover': turnover,
                'receipts_qty': quantity of receipts 
                }

    type of table
    show: str, {'id', 'name', 'both'}
    type of results output for named columns
    on: str {'category', 'shops'}
    the parameter determines the character of results grouping (by categories or by shops)

    Returns

    Returns object 'DataFrame' in the format

    for on="shops"

    diff diff_percent estimate predicted real shop
    <data> <data> <data> <data> <data> <data>
    <data> <data> <data> <data> <data> <data>
    ...
    <data> <data> <data> <data> <data> <data>

    for on="category"

    category diff diff_percent estimate predicted real shop
    <data> <data> <data> <data> <data> <data> <data>
    <data> <data> <data> <data> <data> <data> <data>
    ...
    <data> <data> <data> <data> <data> <data> <data>

    Examples

    dw = datawiz.DW()
            dw.get_lost_sales(category = 68805,
				shops = [601, 641],
				date = datetime.date(2015, 8, 1),
				)

    Returns data about sales plans for the category 68805 in the period of August 2015 for shops [601, 641],

    Add a custom footer
    ⚠️ **GitHub.com Fallback** ⚠️