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.
- 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.
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 Report Types.
- Report
- An instance of a report generation request, identified by a unique
report_id. - Report Status
The current state of a report. Valid values:
TRIGGEREDPROCESSINGCOMPLETEDEXPIREDFAILED
Life Cycle¶
To generate a report, perform these three steps:
- Trigger Report Generation — Initiate a report generation request using POST /reports/:reportTypeIdentifier.
- Get Report Details — Poll GET /reports/:reportId/detail for the current status. When the report is
COMPLETED, the response includes the file download location. - 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 |
Report Types¶
The following table lists all available report types, their identifiers, descriptions, and sample request payloads for the parameters field in POST /reports/:reportTypeIdentifier.
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:
{"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:
{"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:
{"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:
{"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:
{"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:
{"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:
{"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:
{"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:
{"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:
{"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:
{"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:
{"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:
{"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:
{"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:
{"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 |