# Boogi Developer Docs

> Guides and the full API reference for Boogi API — Boogi's transaction enrichment & cashback APIs.

## Guides

### Get Started
- [Introduction](https://docs.boogi.io/guides/introduction): Welcome to the Boogi developer platform.
- [Quickstart](https://docs.boogi.io/guides/quickstart): Make your first API call in under five minutes.
- [Authentication](https://docs.boogi.io/guides/authentication): API keys, environments, and signing requests.

### Core Concepts
- [Core concepts](https://docs.boogi.io/guides/core-concepts): How end users, programs, offers, and cashback relate.
- [End users](https://docs.boogi.io/guides/end-users): Handling user enrollment onto the rewards program
- [Offers](https://docs.boogi.io/guides/offers): Catalogue, program, and personalised offer feeds.
- [Advertising events](https://docs.boogi.io/guides/advertising-events): Handling advertising events
- [Transaction enrichment](https://docs.boogi.io/guides/transaction-enrichment): Real-time and async enrichment flows.
- [Cashback lifecycle](https://docs.boogi.io/guides/cashback-lifecycle): How cashback objects move through states.

### Implementation guides
- [Getting started](https://docs.boogi.io/guides/getting-started): Getting started
- [User enrolment](https://docs.boogi.io/guides/user-enrolment): Implementation guide
- [Historical transaction sharing](https://docs.boogi.io/guides/historical-transaction-sharing): Historical transaction sharing
- [Ongoing transaction sharing](https://docs.boogi.io/guides/ongoing-transaction-sharing): Ongoing transaction sharing
- [Handling webhook notifications](https://docs.boogi.io/guides/webhooks): Receive real-time events from Boogi.
- [Displaying cashback offers](https://docs.boogi.io/guides/displaying-offers): Ongoing transaction sharing
- [Displaying cashback notications](https://docs.boogi.io/guides/displaying-cashback-notification): Ongoing transaction sharing
- [Handling support queries](https://docs.boogi.io/guides/handling-support): Handling support queries

### Production
- [Errors](https://docs.boogi.io/guides/errors): Error response shape, status codes, and retries.
- [Throughput & limits](https://docs.boogi.io/guides/rate-limits): Practical guidance for high-volume traffic.

## API reference

- [Full API reference (HTML)](https://docs.boogi.io/reference)
- [OpenAPI specification (JSON)](https://docs.boogi.io/openapi.json)
- [All documentation as plain text](https://docs.boogi.io/llms-full.txt)

## Endpoints

- POST /transaction-enrichment/sync — Enrich a transaction synchronously
- GET /transaction-enrichment/async — List async enrichment requests
- POST /transaction-enrichment/async — Submit transactions for async enrichment
- POST /support — Create a support ticket
- POST /end-user — Create an end user
- GET /end-user/{endUserId} — Get an end user
- POST /end-user/{endUserId} — Update an end user
- POST /end-user/{endUserId}/unlock/product/{voucherId} — Unlock voucher code
- POST /end-user/{endUserId}/assign/triggerBasedRule/{ruleEngineId} — Assign trigger rule to user
- POST /end-user/{endUserId}/assign/tier/{tierId} — Assign a tier to an end user
- POST /end-user/{endUserId}/assign/product/{productId} — Assign product to user
- POST /end-user/{endUserId}/assign/offer/{offerId} — Assign an offer to an end user
- POST /end-user/{endUserId}/account — Add an account to an end user
- POST /end-user/{endUserId}/account/{accountId} — Update an end user's account
- DELETE /end-user/{endUserId}/account/{accountId} — Delete an end user's account
- POST /end-user/{endUserId}/account/{accountId}/card — Add a card to an end user's account
- POST /end-user/{endUserId}/account/{accountId}/card/{cardId} — Update an end user's card
- DELETE /end-user/{endUserId}/account/{accountId}/card/{cardId} — Delete an end user's card
- POST /end-user/auth/token — Generate a single sign-on token for an end user
- POST /end-user/activate/offer/{offerId} — Activate an offer for an end user
- GET /cashback/{cashbackId} — Get cashback object by ID
- POST /cashback/{cashbackId} — Update cashback object manually
- POST /advertising/event — Record an advertising event
- POST /advertising/event/batch — Record an advertising event in batch
- GET /transaction-enrichment/async/{asyncId} — Get an async enrichment request by ID
- GET /recommended/served-offers/{endUserId} — Get served offers for a user
- GET /recommended/redeemed-offers/{endUserId} — Get redeemed offers for a user
- GET /recommended/hero-offers/{endUserId} — Get hero offers for a user
- GET /recommended/expired-offers/{endUserId} — Get expired offers for a user
- GET /recommended/activated-offers/{endUserId} — Get activated offers for a user
- GET /program/retailer — List program retailers
- GET /program/retailer/{retailerId} — Get a program retailer by ID
- GET /program/offer — List activated program offers
- GET /program/offer/{offerId} — Get an activated program offer by ID
- GET /program/offer-list/{userId} — List personalised offers for an end user
- GET /product/inventory — Get product inventory
- GET /product/inventory/{productId} — Get product by Id
- GET /end-user/{endUserId}/view/products — View assigned products
- GET /end-user/{endUserId}/view/availableTriggerBasedRules — View trigger-based rules
- GET /end-user/{endUserId}/view/availableSegmentBasedRules — View segment-based rules
- GET /customer-tier — List customer tiers
- GET /customer-tier/{id} — Get a customer tier by ID
- GET /catalogue/retailer — List catalogue retailers
- GET /catalogue/retailer/{retailerId} — Get a catalogue retailer by ID
- GET /catalogue/offer — List catalogue offers
- GET /catalogue/offer/{offerId} — Get a catalogue offer by ID
- GET /cashback — Get cashback objects
- GET /cashback/user/{userId} — Get cashback objects for a specific user
- DELETE /end-user/{endUserId}/remove/tier/{tierId} — Remove a tier from an end user
- DELETE /end-user/{endUserId}/remove/offer/{offerId} — Remove an offer from an end user