Developer
Test ModeTest Mode Sign In Get started
DeveloperDeveloper / Angebote APIOffers API

Angebote APIOffers API

Erstelle und verwalte digitale Angebote, die Alternative zu Papier-Prospekten. Angebote erscheinen in der BEEP!-App auf der Discover-Seite des Stores.

Create and manage digital offers, the alternative to paper flyers. Offers appear in the BEEP! app on the store's Discover page.

⚠️
Angebote-Endpoints erfordern mindestens das GO-Paket.

POST /api/v1/createOffer

Erstellt ein neues Angebot für einen Store. Das Angebot wird nach Erstellung sofort in der App sichtbar.

Creates a new offer for a store. The offer becomes immediately visible in the app after creation.

ParameterTypPflichtBeschreibung
storeIdstringJaStore-ID
titlestringJaTitel des Angebots (max. 100 Zeichen)
descriptionstringNeinBeschreibung (max. 500 Zeichen)
originalPricenumberJaOriginalpreis in Cent
offerPricenumberJaAngebotspreis in Cent
validFromstringJaISO 8601 Startdatum
validUntilstringJaISO 8601 Enddatum
productIdstringNeinVerknüpfung mit bestehendem Produkt
imageUrlstringNeinURL des Angebotsbildes
200 OK
{ "success": true, "offerId": "offer_a1b2c3d4", "status": "active", "createdAt": "2026-02-27T10:00:00.000Z" }

POST /api/v1/updateOffer

Aktualisiert ein bestehendes Angebot. Nur übergebene Felder werden geändert (Partial Update).

Updates an existing offer. Only passed fields are changed (partial update).

ParameterTypPflichtBeschreibung
offerIdstringJaID des zu aktualisierenden Angebots
titlestringNeinNeuer Titel
offerPricenumberNeinNeuer Angebotspreis (Cent)
validUntilstringNeinNeues Enddatum

POST /api/v1/deleteOffer

Löscht ein Angebot. Das Angebot verschwindet sofort aus der App.

Deletes an offer. The offer disappears immediately from the app.

ParameterTypPflichtBeschreibung
offerIdstringJaID des Angebots

POST /api/v1/getManagerOffers

Listet alle Angebote eines Stores auf (aktiv, abgelaufen, geplant).

Lists all offers for a store (active, expired, scheduled).

ParameterTypPflichtBeschreibung
storeIdstringJaStore-ID
statusstringNein"active", "expired", "scheduled" (Default: alle)
💡
In der Sandbox werden Angebote nicht tatsächlich erstellt. Die Response enthält immer "_sandbox": true und Mock-Daten.