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"
}

---