Report Management API Reference

The Report Management APIs enable a partner (3rd party aggregator) to trigger report generation, poll for report status, and download completed reports.

POST /reports/:reportTypeIdentifier

Description - The Report Trigger API initiates generation of a specific report type. Use the report type identifier from the Report Types table in the request path, and pass the corresponding parameters in the request body.

Request and Response Parameters

☰ SHOW | HIDE

URL: https://api.flipkart.net/reports/:reportTypeIdentifier

Path Variables

Parameter/Attribute	Requirement	Description
reportTypeIdentifier	Required	Unique identifier of the report type. See Report Types.

Request Body Parameters

Parameter	Requirement	Description
correlation_id	Optional	UUID string. Should be unique for each request.
parameters	Required	Report-specific parameters. Structure depends on the report type. Use {} if no parameters are required.

Sample Request

{
  "correlation_id": "59297562-eada-49c9-bdd1-447f778e5037",
  "parameters": {
    "from_date": "2023-05-02",
    "to_date": "2023-06-02"
  }
}

Response Body Parameters

Parameter	Requirement	Description
report_id	Required	Unique ID for the triggered report. Use this value to track status and download the report via GET /reports/:reportId/detail.

Sample Response

{
  "report_id": "R-01BX5ZZKBKACTAV9WEVGEMMVRY"
}

---

GET /reports/:reportId/detail

Description - Returns the current status of a triggered report. When the report status is COMPLETED, the response includes a download location and metadata such as URL expiry.

Request and Response Parameters

☰ SHOW | HIDE

URL: https://api.flipkart.net/reports/:reportId/detail

Path Variables

Parameter	Requirement	Description
reportId	Required	Report ID returned by POST /reports/:reportTypeIdentifier.

Response Body Parameters

Parameter	Requirement	Description
report_id	Required	Report ID from the path variable.
status	Required	Current report state. Valid values: TRIGGERED, PROCESSING, COMPLETED, EXPIRED, FAILED.
location	Optional	URI to download the report file. Present only when status is COMPLETED.
metadata	Optional	Additional report information. Typically present when status is COMPLETED.

Sample Response

{
  "report_id": "R-01BX5ZZKBKACTAV9WEVGEMMVRY",
  "status": "COMPLETED",
  "location": "https://api.flipkart.net/storage/reports/R-01BX5ZZKBKACTAV9WEVGEMMVRY?x_secret_key=<secret_key>",
  "metadata": {
    "expiry": "2023-05-05 23:59:59"
  }
}

Note

The shared report download URL has an expiration time. Download the report before the expiry timestamp in metadata.expiry.

---