Create loyalty points export
Exports ordinary reward-coin history; XP and premium currency are excluded. Requires a community Bearer API key with customerSuccess permission and LOYALTY_EXPORTS_ENABLED=true. Personal keys are rejected. No per-key allowlist is required. Responses use Cache-Control: no-store; query parameters are rejected.
Creates an asynchronous CSV/JSON export for [start_at, end_at), with no maximum date-range duration. end_at must be after start_at and no later than acceptance. Required body: dataset=points_transactions, format=csv or json, start_at and end_at as UTC timestamps. Omit client_refs for all customers. Optional client_refs contains 1–1000 unique exact customer identifiers. Unknown or ambiguous selections fail the worker job. Empty ranges complete with zero rows.
Returns 202 for a new job and 200 for an idempotent replay. Idempotency-Key is required and scoped to community and API key ID; changed input returns 409. Only one active export per community; 429 includes Retry-After: 30. Retry ambiguous failures with the same key. Body limit: 1 MiB; unknown fields rejected. Coverage is observed_history_only.
CSV columns, in order: client_ref, event_id, recorded_at_utc, operation, points_delta. CSV downloads are named points-.csv, using the export creation time in Unix milliseconds. Use a new Idempotency-Key to generate a fresh file; replays return the original artifact. The Tradingroom export-history worker generates the file; poll status, then request the download link.
Request
Responses
curl --location 'https://adss-integration.returning.ai/apis/v1/loyalty-exports' \
--header 'Idempotency-Key: loyalty-export-20260901-csv' \
--header 'Content-Type: application/json' \
--data '{
"dataset": "points_transactions",
"format": "csv",
"start_at": "2026-09-01T00:00:00Z",
"end_at": "2026-09-02T00:00:00Z"
}'{
"meta": {
"status": "success",
"statusCode": 200,
"requestId": "req_example"
},
"message": "Loyalty export accepted success.",
"data": {
"export_id": "507f1f77bcf86cd799439012",
"status": "queued",
"dataset": "points_transactions",
"format": "csv",
"created_at": "2026-09-28T03:00:00.000Z",
"coverage": "observed_history_only"
}
}