Developer Integration Guide
This guide is for external developers who connect their own systems to the Digital Retail Engine (DRE) — a webshop, a point-of-sale (POS) till, a mobile or self-checkout app, or an ERP/S4 backend that supplies item master data.
It describes how to call DRE from the outside: how to authenticate, which APIs exist, what the request and response payloads look like, and how the typical integration flows work end to end. It does not cover how DRE is built internally — you do not need that to integrate.
Looking for the business user manual instead (creating promotions, managing budgets, reading reports)? See the User Guide.
"POS" means any sales channel
The real-time evaluation API is called the POS Service (/pos/v2) for historical reasons, but it is channel-agnostic. A webshop checkout, a mobile app, a self-checkout kiosk, and a physical till are all points of sale — each sends a basket to the same evaluate/confirm endpoints. The optional channel field (e.g. IN_STORE, ONLINE, MOBILE) lets promotions target a specific channel, but the API and payloads are identical across channels. Do not read "POS" as "physical store only".
What you can integrate
| Integration | What it does | Start here |
|---|---|---|
| Sales channel (webshop, POS, mobile) | Get live promotion calculations for a basket and confirm the sale — for any channel | Sales-Channel Integration |
| Item master data | Push articles and prices into DRE from S/4HANA (DRFOUT) or via bulk import | Item Master-Data Integration |
| Promotion master data | Read and write promotions, coupons, and related data over a stable, versioned /api/v1 API | Webshop & Public API |
| Webhooks | Receive event notifications (promotion, coupon, campaign, budget changes) | Webhooks |
| Reporting | Pull promotion performance and analytics data | Reporting API |
Before you start
- Get access. Your DRE administrator subscribes to DRE on SAP BTP and assigns the integration roles your scenario needs. See Authentication for the role-to-scope mapping.
- Obtain credentials. Most APIs use XSUAA OAuth2 client-credentials tokens.
- Pick your flow. Follow Building an Integration for an end-to-end walkthrough, then drill into the API Reference for exact payloads.
API surfaces at a glance
Any real-time sales channel — webshop, POS, mobile — uses the POS Service to price a basket and confirm the sale. Master data flows in through Master Data Ingest (S/4HANA DRFOUT) or the Public API; DRE emits webhook events and exposes a Reporting API.
Continue with Getting Started → Integration overview.