Transactions
Operations related to transactions
All endpoints require a JWT Bearer token in the Authorization header.
POST /v1/transactions/aggregated
Get aggregated transaction data
Request body (required)
Read-only Aggregation parameters for transaction data
Field | Type | Required | Description |
|---|---|---|---|
|
| No | The match stage of the aggregation pipeline |
|
| No | The group stage of the aggregation pipeline |
|
| No | The project stage of the aggregation pipeline |
|
| No | The sort stage of the aggregation pipeline |
|
| No | The limit stage of the aggregation pipeline |
|
| No | The skip stage of the aggregation pipeline |
|
| No | The lookup stage of the aggregation pipeline |
|
| No | The unwind stage of the aggregation pipeline |
|
| No | The count stage of the aggregation pipeline |
Responses
Status | Description |
|---|---|
| Successfully retrieved aggregated transaction data |
POST /v1/transactions/data-summary
Get transaction data summary by UTC day (end-inclusive)
Request body (required)
Filters for transaction data summary. Days are computed in UTC and the end date is end-inclusive
Field | Type | Required | Description |
|---|---|---|---|
|
| Yes | List of store IDs to include in the summary |
|
| Yes | Start date/time. UTC day computation uses this lower bound inclusive. |
|
| Yes | End date/time (inclusive). |
|
| Yes | Currency code (server-enforced AvailableCurrencies enum) |
Responses
Status | Description |
|---|---|
| Successfully retrieved per-day transaction data summary |