Generate a report
Request a report generation run and return it. report_type selects the kind of report and the parameters it accepts. The run is created pending; generation happens asynchronously. When an identical request is already in flight or recently completed, that existing run is returned instead of starting a new one. Requires write:reports.
Body·
- report
_parameters requiredThe parameters of the report to generate.
report_typeselects the kind of report and the other fields it accepts.Parameters for a
seller_financial_reportrun.- report
_type Discriminatorconst:seller_financial_reportrequiredThe type of report these parameters describe.
- endType: stringFormat: date-timenullable
_date Include only transactions completed before this time. Defaults to one week after
start_date, or to the current hour when neither end is given. - startType: stringFormat: date-timenullable
_date Include only transactions completed at or after this time. Defaults to one week before
end_date.
Responses
- application/json
- 422
The report parameters are not valid.
curl https://api.whatnot.com/seller-api/rest/v2/reports \
--request POST \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--data '{
"report_parameters": {
"end_date": "2026-09-08T00:00:00.000Z",
"report_type": "seller_financial_report",
"start_date": "2026-09-01T00:00:00.000Z"
}
}'
{
"created_at": "2026-09-20T18:30:00.000Z",
"id": "0199a7c2-3f4e-7a1b-9c2d-4e5f6a7b8c9d",
"report_parameters": {
"end_date": "2026-09-08T00:00:00.000Z",
"report_type": "seller_financial_report",
"start_date": "2026-09-01T00:00:00.000Z"
},
"report_type": "seller_financial_report",
"status": "pending",
"updated_at": "2026-09-20T18:30:00.000Z"
}