Store APIsReports
Create report
Queues an asynchronous report. The response returns immediately with status: PENDING; poll GET /reports/:reportId or wait for the merchant email. Periods cannot exceed 90 days. Requires the REPORTS_WRITE scope.
AuthorizationBearer <token>
Bearer token authentication. Pass the secret directly in the Authorization header. Token secrets start with sk_.
In: header
Path Parameters
storeId*string
Length
12 <= length <= 48Header Parameters
idempotency-key?string
Length
8 <= length <= 32Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/stores/stringstring/reports/" \ -H "Content-Type: application/json" \ -d '{ "type": "PAYMENT_ACTIVITY", "periodStart": "2019-08-24T14:15:22Z", "periodEnd": "2019-08-24T14:15:22Z" }'{ "ok": true, "data": { "id": "rpt_8h4t6sqzy3x9w5n2k1m0vqbf", "type": "PAYMENT_ACTIVITY", "status": "SUCCEEDED", "formats": [ "CSV", "JSON" ], "periodStart": "2026-04-01T00:00:00.000Z", "periodEnd": "2026-05-01T00:00:00.000Z", "rowCount": 1247, "sizeBytes": 412980, "durationMs": 8412, "errorMessage": null, "requestedByAccountId": null, "requestedByTokenId": "stk_4tzcbfp2v8q1mzwxj5h0r1n", "startedAt": "2026-05-22T10:00:00.100Z", "completedAt": "2026-05-22T10:00:08.512Z", "createdAt": "2026-05-22T10:00:00.000Z", "updatedAt": "2026-05-22T10:00:08.512Z" }}