.. _rmapioverview-label:

=====================
Report Management API
=====================

The Reports API consists of two categories of reports:

**Settlement reports** — Used for sales, settlements, and reconciliation data.

**Fulfilled by Flipkart (FBF) reports** — Used for FBF inventory visibility, orders, and reconciliation data.

.. important::

   * Both Settlement and FBF reports are a **paid API service** by Flipkart. For commercial discussions please reach out `api-partner-support@flipkart.com <mailto:api-partner-support@flipkart.com>`_.
   * Reports API is accessible only via **3rd party tokens / partners**.
   * After you've gone through the documentation and want to test out the flows please reach out to `api-partner-support@flipkart.com <mailto:api-partner-support@flipkart.com>`_.

The Report Management APIs enable partners to generate and download various reports.

Terminology
===========

**Report Type**
  A predefined type of report provided by Flipkart's Report Management system. See :ref:`report-types-label`.

**Report**
  An instance of a report generation request, identified by a unique ``report_id``.

**Report Status**
  The current state of a report. Valid values:

  * ``TRIGGERED``
  * ``PROCESSING``
  * ``COMPLETED``
  * ``EXPIRED``
  * ``FAILED``

Life Cycle
==========

To generate a report, perform these three steps:

1. **Trigger Report Generation** — Initiate a report generation request using :ref:`reportTrigger-label`.
2. **Get Report Details** — Poll :ref:`getReportDetail-label` for the current status. When the report is ``COMPLETED``, the response includes the file download location.
3. **Download Report** — Download the report from the shared URL before it expires.

Settlement Reports
==================

+-----------------------------------------------+------------------------------------------+
| Report Name                                   | Identifier                               |
+===============================================+==========================================+
| GSTR Report                                   | ``gst_returns_report``                   |
+-----------------------------------------------+------------------------------------------+
| Sales Report                                  | ``sales_ledger``                         |
+-----------------------------------------------+------------------------------------------+
| Settled Transaction Report                    | ``settled_transaction_ledger``           |
+-----------------------------------------------+------------------------------------------+
| Financial Year Report                         | ``financial_year_ledger``                |
+-----------------------------------------------+------------------------------------------+
| Orders Report (FBF)                           | ``fbf_orders_report``                    | 
+-----------------------------------------------+------------------------------------------+
| Warehouse Stranded Inventory Report           | ``stranded_inventory_report``            |
+-----------------------------------------------+------------------------------------------+
| Warehouse Current Inventory Report            | ``current_inventory_report``             |
+-----------------------------------------------+------------------------------------------+
| Warehouse Unsellable Inventory Report         | ``unsellable_inventory_report``          |
+-----------------------------------------------+------------------------------------------+
| Returns Report                                | ``returns_report``                       |
+-----------------------------------------------+------------------------------------------+
| Orders Report                                 | ``orders_report``                        |
+-----------------------------------------------+------------------------------------------+
| Profit and Loss Report                        | ``profit_loss_report``                   |
+-----------------------------------------------+------------------------------------------+
| Date-Range Report Parameters                  | ``date_range_report_parameters``         |
+-----------------------------------------------+------------------------------------------+
| Commission Invoice Report                     | ``commission_invoice_report``            |
+-----------------------------------------------+------------------------------------------+
| Commission Invoice Transaction Details Report | ``commission_invoice_transaction_report``|
+-----------------------------------------------+------------------------------------------+

FBF Reports
===========

+----------------------------------------------------------+------------------+
| Report Name                                              | Identifier       |
+==========================================================+==================+
| Monthly Warehouse Inventory Reconciliation (MIR Report)  | ``mir_ledger``   |
+----------------------------------------------------------+------------------+
| Warehouse Stock Ledger                                   | ``stock_ledger`` |
+----------------------------------------------------------+------------------+

.. include:: ReportTypes.rst