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.
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.
| Parameter | Typ | Pflicht | Beschreibung |
|---|---|---|---|
storeId | string | Ja | Store-ID |
title | string | Ja | Titel des Angebots (max. 100 Zeichen) |
description | string | Nein | Beschreibung (max. 500 Zeichen) |
originalPrice | number | Ja | Originalpreis in Cent |
offerPrice | number | Ja | Angebotspreis in Cent |
validFrom | string | Ja | ISO 8601 Startdatum |
validUntil | string | Ja | ISO 8601 Enddatum |
productId | string | Nein | Verknüpfung mit bestehendem Produkt |
imageUrl | string | Nein | URL des Angebotsbildes |
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).
| Parameter | Typ | Pflicht | Beschreibung |
|---|---|---|---|
offerId | string | Ja | ID des zu aktualisierenden Angebots |
title | string | Nein | Neuer Titel |
offerPrice | number | Nein | Neuer Angebotspreis (Cent) |
validUntil | string | Nein | Neues 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.
| Parameter | Typ | Pflicht | Beschreibung |
|---|---|---|---|
offerId | string | Ja | ID des Angebots |
POST /api/v1/getManagerOffers
Listet alle Angebote eines Stores auf (aktiv, abgelaufen, geplant).
Lists all offers for a store (active, expired, scheduled).
| Parameter | Typ | Pflicht | Beschreibung |
|---|---|---|---|
storeId | string | Ja | Store-ID |
status | string | Nein | "active", "expired", "scheduled" (Default: alle) |
"_sandbox": true und Mock-Daten.