Report Management APIs

APIs

Reports management APIs are available here

Overview

The Reports API consist of two category of reports

• Settlement reports: To be consumed for getting sales, settlements and reconciliation data. Settlement reports available -
  • GSTR Report
  • Sales Report
  • Settled Transaction Report
  • Financial Year Report
• Fulfilled by Flipkart (FBF) reports: To be consumed for FBF Inventory visibility, orders and reconciliation data. FBF reports available -
  • Monthly Warehouse Inventory Reconciliation(MIR Report)
  • Warehouse Stranded Inventory Report
  • Warehouse Inventory Report

Important

• Both Settlement & FBF reports will be a paid API service by Flipkart. For commercial discussions please reach out api-partner-support@flipkart.com
• Reports API will be accessible by only 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

Report Management APIs

The Report Management APIs enable a partner(3rd party aggregator) to get various reports.

• Report Management APIs
  • Terminology
    • Report Type
    • Report
    • Report Status
  • Life cycle
  • All report type:
  • Report Trigger API
  • Get Report API

Terminology

The following are the common terms used and their meaning

Report Type

A report type is a predefined type of reports which Flipkart is providing with a Report Management system(List of all report types given below).

Report

A report type is a predefined type of reports which Flipkart is providing with a Report Management system(List of all report types given below).

Report Status

A report status refers to current state of report below are the valid value of report status

• TRIGGERED
• PROCESSING
• COMPLETED
• EXPIRED
• FAILED

Life cycle

To generate a report, the following 3 steps are to be performed

• Trigger Report Generation: A report generation request should be initiated for the report of interest using the generation API
• Report Details: This will return the current status of the report. if report is completed then there will be a location of report file
• Download report: The report can be downloaded using the shared URL / from the shared location. Please note that the shared report URL will have an expiration associated with it and should be downloaded before that time

All report type:

Name	Identifier	Description	Sample request payload	Sample request payload attribute description
Monthly Warehouse Inventory Reconciliation(MIR Report)	mir_ledger	Reconciled and Finalized Inventory movement report for the particular month.The Report can be generated after 7th of previous month for the chosen warehouse. Report included all the inventory Moment and Reconciliation details of inventory. All Variances occurring in the warehouse have been accounted for and Seller Protection Fund (SPF) Auto-Claim details are surfaced, for both Pay or Recovery basis of inventory disposition	{"warehouse_id": "blr_wfld", "month": "May", "year": 2023}	warehouse_id: String, a valid warehouse id from flipkart month: String, A month value like May year: Int, valid year value
Warehouse Stranded Inventory Report	stranded_inventory_report	The stranded inventory Report provides information about inventory of a seller that is currently stranded or inactive in a particular warehouse. This report helps identify products that are not actively listed or available for sale, along with the reasons for their inactivation. It allows for effective inventory management by providing insights into stranded items, their quantities, pricing, and the actions taken to address the issue.	{"warehouse_id": "blr_wfld"}	warehouse_id: String, a valid warehouse id from flipkart
Warehouse Inventory Report	inventory_report	The Current Inventory Report provides crucial information about all the available products of a seller in a particular warehouse. This Report gives the whole view of Inventory as well as offers insights into product details, availability, pricing, brand, and various stages of inventory management, enabling effective monitoring and decision-making	{"warehouse_id": "blr_wfld"}	warehouse_id: String, a valid warehouse id from flipkart
GSTR Report	gst_returns_report	It's a report to get monthly GST returns. Contains summary information that can be used to file GSTR - 1 and GSTR - 8 returns	{"from_date": "2023-05-02","to_date": "2023-06-02"}	from_date: String, A start date value to_date: String, valid end date value
Sales Report	sales_ledger	Start Here! Check all your sales happened over a time period. Use it for posting your sales and paying your sales taxes. It's a report to get monthly sales based on customer invoice	{"from_date": "2023-05-02","to_date": "2023-06-02"}	from_date: String, A start date value to_date: String, valid end date value
Settled Transaction Report	settled_transaction_ledger	It's a report to get monthly settled transaction. Report containing details of all transactions settled during a given date range. Includes information for Orders, PLA, TDS, SPF, Storage and Recall.	{"from_date": "2023-05-02","to_date": "2023-06-02"}	from_date: String, A start date value to_date: String, valid end date value
Financial Year Report	financial_year_ledger	It's a report to get financial year transactions and activities	{"from_date": "2023-05-02","to_date": "2023-06-02"}	from_date: String, A start date value to_date: String, valid end date value

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