.. _report-types-label: Report Types ============ The following table lists all available report types, their identifiers, descriptions, and sample request payloads for the ``parameters`` field in :ref:`reportTrigger-label`. FBF Reports ----------- Monthly Warehouse Inventory Reconciliation (MIR Report) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ **Identifier:** ``mir_ledger`` Reconciled and finalized inventory movement report for a particular month. The report can be generated after the 7th of the previous month for the chosen warehouse. It includes all inventory movement and reconciliation details. All variances in the warehouse are accounted for, and Seller Protection Fund (SPF) Auto-Claim details are surfaced on a pay or recovery basis of inventory disposition. **Sample request payload:** .. code-block:: json {"warehouse_id": "blr_wfld", "month": "May", "year": 2023} +----------------+--------+--------------------------------------------------+ | Attribute | Type | Description | +================+========+==================================================+ |``warehouse_id``| String | A valid Flipkart warehouse ID. | +----------------+--------+--------------------------------------------------+ |``month`` | String | Month value, for example ``May``. | +----------------+--------+--------------------------------------------------+ |``year`` | Int | Valid year value. | +----------------+--------+--------------------------------------------------+ Warehouse Stock Ledger ~~~~~~~~~~~~~~~~~~~~~~ **Identifier:** ``stock_ledger`` Detailed day-to-day record of all seller stock transactions at the chosen warehouse, such as inwards, order dispatches, returns, and recalls. Used to track movement of seller inventory at a quantity level. **Sample request payload:** .. code-block:: json {"warehouse_id": "blr_wfld", "from_date": "2023-04-02", "to_date": "2023-04-06"} +----------------+--------+--------------------------------------------------+ | Attribute | Type | Description | +================+========+==================================================+ |``warehouse_id``| String | A valid Flipkart warehouse ID. | +----------------+--------+--------------------------------------------------+ | ``from_date`` | Date | Start date in ``yyyy-MM-dd`` format. | +----------------+--------+--------------------------------------------------+ | ``to_date`` | Date | End date in ``yyyy-MM-dd`` format. | +----------------+--------+--------------------------------------------------+ Settlement Reports ------------------ Warehouse Stranded Inventory Report ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ **Identifier:** ``stranded_inventory_report`` Provides information about seller inventory that is currently stranded or inactive in a warehouse. Helps identify products that are not actively listed or available for sale, along with reasons for inactivation, quantities, pricing, and actions taken. **Sample request payload:** .. code-block:: json {"from_date": "2023-05-02", "to_date": "2023-06-02"} +----------------+--------+--------------------------------------------------+ | Attribute | Type | Description | +================+========+==================================================+ | ``from_date`` | String | Start date. | +----------------+--------+--------------------------------------------------+ | ``to_date`` | String | End date. | +----------------+--------+--------------------------------------------------+ Warehouse Current Inventory Report ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ **Identifier:** ``current_inventory_report`` Provides information about all available seller products in a warehouse, including product details, availability, pricing, brand, and inventory management stages. **Sample request payload:** .. code-block:: json {"from_date": "2023-05-02", "to_date": "2023-06-02"} +----------------+--------+--------------------------------------------------+ | Attribute | Type | Description | +================+========+==================================================+ | ``from_date`` | String | Start date. | +----------------+--------+--------------------------------------------------+ | ``to_date`` | String | End date. | +----------------+--------+--------------------------------------------------+ Warehouse Unsellable Inventory Report ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ **Identifier:** ``unsellable_inventory_report`` Provides information about seller inventory marked as unsellable in a warehouse. **Sample request payload:** .. code-block:: json {"from_date": "2023-05-02", "to_date": "2023-06-02"} +----------------+--------+--------------------------------------------------+ | Attribute | Type | Description | +================+========+==================================================+ | ``from_date`` | String | Start date. | +----------------+--------+--------------------------------------------------+ | ``to_date`` | String | End date. | +----------------+--------+--------------------------------------------------+ GSTR Report ~~~~~~~~~~~ **Identifier:** ``gst_returns_report`` Monthly GST returns report with summary information for filing GSTR-1 and GSTR-8 returns. **Sample request payload:** .. code-block:: json {"from_date": "2023-05-02", "to_date": "2023-06-02"} Sales Report ~~~~~~~~~~~~ **Identifier:** ``sales_ledger`` Start here to check all sales over a time period. Use for posting sales and paying sales taxes. Monthly sales based on customer invoice. **Sample request payload:** .. code-block:: json {"from_date": "2023-05-02", "to_date": "2023-06-02"} Settled Transaction Report ~~~~~~~~~~~~~~~~~~~~~~~~~~ **Identifier:** ``settled_transaction_ledger`` Monthly settled transaction report containing details of all transactions settled during a given date range. Includes Orders, PLA, TDS, SPF, Storage, and Recall. **Sample request payload:** .. code-block:: json {"from_date": "2023-05-02", "to_date": "2023-06-02"} Financial Year Report ~~~~~~~~~~~~~~~~~~~~~ **Identifier:** ``financial_year_ledger`` Financial year transactions and activities report. **Sample request payload:** .. code-block:: json {"from_date": "2023-05-02", "to_date": "2023-06-02"} FBF Orders Report ~~~~~~~~~~~~~~~~~ **Identifier:** ``fbf_orders_report`` Detailed insights into sales fulfilled through FBF, including order-level sales data, quantities sold, order dates, and fulfillment status. .. note:: * **Data availability:** Last 15 days only. * **Request duration:** Maximum 3 days per request. **Sample request payload:** .. code-block:: json {"from_date": "2025-06-22", "to_date": "2025-06-25"} Orders Report ~~~~~~~~~~~~~ **Identifier:** ``orders_report`` Detailed information on all orders and evaluation of past fulfilment performance. **Sample request payload:** .. code-block:: json {"from_date": "2025-02-01", "to_date": "2025-06-30"} Returns Report ~~~~~~~~~~~~~~ **Identifier:** ``returns_report`` Detailed information on all returns and reverse shipment status. .. note:: Returns data is available for the past one year, up to today's date. **Sample request payload:** .. code-block:: json {"from_date": "2024-07-02", "to_date": "2025-07-02"} Commission Invoice Report ~~~~~~~~~~~~~~~~~~~~~~~~~ **Identifier:** ``commission_invoice_report`` Access monthly commission invoices since April 2015, including credit and debit notes. .. note:: A single request can pull a maximum duration of 1 month. **Sample request payload:** .. code-block:: json {"from_date": "2025-05-01", "to_date": "2025-05-30"} Commission Invoice Transaction Details Report ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ **Identifier:** ``commission_invoice_transaction_report`` Download all transactions used to generate commission invoices for a given month. .. note:: Available for any month of the ongoing year that has passed. **Sample request payload:** .. code-block:: json {"from_date": "2025-05-01", "to_date": "2025-05-30"} Profit and Loss Report ~~~~~~~~~~~~~~~~~~~~~~ **Identifier:** ``profit_loss_report`` Complete clarity of profit or loss for orders received during the selected time period. For best maturity of returns and SPF, request the report after the 15-day return window is over. .. note:: A single request can pull a maximum of less than 31 days of data. **Sample request payload:** .. code-block:: json {"from_date": "2025-05-01", "to_date": "2025-05-30"} Date-Range Report Parameters ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Reports that accept ``from_date`` and ``to_date`` use the same parameter structure: +----------------+--------+--------------------------------------------------+ | Attribute | Type | Description | +================+========+==================================================+ | ``from_date`` | String | Start date. | +----------------+--------+--------------------------------------------------+ | ``to_date`` | String | End date. | +----------------+--------+--------------------------------------------------+ Warehouse Names =============== +-------------------------------+------------------+ | Warehouse Name | Warehouse ID | +===============================+==================+ | Bilaspur Warehouse | ``bil`` | +-------------------------------+------------------+ | Binola Warehouse | ``binola`` | +-------------------------------+------------------+ | Bangalore Whitefield Warehouse| ``blr_wfld`` | +-------------------------------+------------------+ | Delhi Warehouse | ``del`` | +-------------------------------+------------------+ | Kolkata Warehouse | ``kol`` | +-------------------------------+------------------+ | Malur BTS Warehouse | ``malur_bts`` | +-------------------------------+------------------+ | Kolkata Uluberia BTS | ``ulub_bts`` | +-------------------------------+------------------+ | Mumbai Bhiwandi Warehouse | ``mum_bndi`` | +-------------------------------+------------------+