Overview
Use the Receipts API to export receipt submission data collected through Brij experiences, whether registration or rebate based experiences. Results include receipt metadata, extracted line items, vendor details, purchase totals, and submission status — giving you a complete view of consumer purchase behavior to power loyalty workflows, rebate reconciliation, and BI reporting.
- Method:
GET - JSON URL:
https://{{Base_URL}}/receipts/brand/export-json - XLSX URL:
https://{{Base_URL}}/receipts/brand/export - Auth:
Authorization: Bearer <your API key>(header)
There are two versions of this endpoint: one returns a JSON array of receipt records, and one returns a link to a downloadable .xlsx file. Use the JSON endpoint for programmatic integrations; use the XLSX endpoint for ad-hoc exports or spreadsheet-based reporting.
Benefits
- Export all receipt submissions for a given date range to power your own BI queries and dashboards.
- Run this nightly to keep your database up to date
- Run basket analysis on retail line item data to find common companion products and retail AOV per channel.
- Analyze consumer purchasing patterns across products, retailers, and geographies to build retail audiences.
- Feed CRM/CDP platforms with verified purchase data tied to various retail channels.
Request Parameters
| Parameter | Type | Required | Example | Notes |
|---|---|---|---|---|
startDate | string | No | 2025-04-01 | Filters by receipt upload date, not purchase date. ISO 8601 with timezone or YYYY-MM-DD. |
endDate | string | No | 2026-08-01 | Filters by receipt upload date, not purchase date. ISO 8601 with timezone or YYYY-MM-DD. |
scope | string | No | all | Either all (all receipts, also the default if omitted) or rebate (rebate-linked receipts only). |
⚠️ Note:
startDateandendDatefilter based on when the receipt was uploaded by the consumer, not the purchase date printed on the receipt.
Authentication
Generate your API key in the Brij platform under Settings → API Keys, then pass it as:
Authorization: Bearer <your-api-key>
Example Request (JSON)
curl --location 'https://{{Base_URL}}/receipts/brand/export-json?scope=all&startDate=2025-04-01' \
--header 'content-type: application/json' \
--header 'Authorization: Bearer <your-api-key>'Example Request (XLSX Download Link)
curl --location 'https://{{Base_URL}}/receipts/brand/export?startDate=2025-04-01&endDate=2026-08-01&scope=rebate' \
--header 'Authorization: Bearer <your-api-key>'💡 Tip: The XLSX endpoint returns a URL to a downloadable spreadsheet rather than raw JSON — useful for sharing exports with non-technical stakeholders.
Response Structure (JSON)
Each object in the response array includes:
| Field | Type | Description |
|---|---|---|
_id | string | Unique receipt submission ID |
brandId | string | Your Brij brand account ID, useful for grouping in Organizations w/ multiple brands |
slug | string | The Brij Experience slug the receipt was submitted through |
registrationID | rebateID | string | The ID tied to the specific customer registration or rebate, depending on the experience type used. Key label changes. |
status | string | Review status: approved, REVIEW_REQUIRED, or REJECTED |
url | string | Direct URL to the uploaded receipt image |
rawExtractedData | object | AI-extracted receipt data (see sub-fields below) |
timestamp | string (ISO 8601) | When the receipt was submitted by the consumer |
_createTimestamp | string (ISO 8601) | When the record was created in Brij database |
rawExtractedData sub-fields (all are optional and not always extractable from the receipt):
| Field | Type | Description |
|---|---|---|
date | string | Purchase date as printed on the receipt |
parsedDate | string (ISO 8601) | Purchase date normalized to ISO format |
lineItems | array | Purchased items, each with item, quantity, price, sku, priceUSD (when relevant) |
total | number | Total amount on the receipt |
subtotal | number | Subtotal before tax |
tax | number | Tax amount |
currency | string | Currency code (e.g., USD) |
vendorName | string | Retailer name |
vendorAddress / vendorCity / vendorState / vendorZip | string | Retailer location details |
receiptId | string | Receipt number from the vendor (when extractable) |
FAQ
What is the difference between the JSON and XLSX endpoints? The JSON endpoint (export-json) returns raw data as an array for programmatic use. The XLSX endpoint (export) returns a link to a downloadable spreadsheet, better for manual review or sharing internally.
Do the date filters use purchase date or upload date? Both startDate and endDate filter by the date the consumer uploaded the receipt to Brij — not the purchase date on the receipt itself.
What does the scope parameter do? scope=rebate limits results to receipts submitted as part of a rebate campaign. scope=all returns all receipt submissions.
How do I get my API key? API keys are generated in the Brij platform. Contact your Brij account manager if you need access or help with API authentication.