Developer
Test ModeTest Mode Sign In Get started
DeveloperDeveloper / Click & Collect APIClick & Collect API

Click & Collect APIClick & Collect API

Kunden bestellen Produkte in der BEEP!-App und holen sie im Store ab. Diese Endpoints verwalten den gesamten Click & Collect Workflow.

Customers order products in the BEEP! app and pick them up in store. These endpoints manage the entire Click & Collect workflow.

Click & Collect erfordert mindestens das GO-Paket.
Hinweis:Note: Die Click & Collect Endpoints sind aktuell nicht über das API-Gateway erreichbar. Click & Collect Bestellungen werden direkt über die BEEP! Cloud verwaltet. Die Sandbox simuliert die Responses. Im Live-Modus nutze die SDK-Integration. Gateway-Unterstützung ist für eine zukünftige Version geplant.Click & Collect endpoints are currently not available via the API Gateway. Click & Collect orders are managed directly via BEEP! Cloud. The sandbox simulates the responses. In live mode, use the SDK integration. Gateway support is planned for a future version.

POST /api/v1/submitClickCollectOrder

Erstellt eine Click & Collect Bestellung. Der Store erhält eine Push-Benachrichtigung in der Manager-App.

Creates a Click & Collect order. The store receives a push notification in the manager app.

ParameterTypPflichtBeschreibung
storeIdstringJaStore-ID
userIdstringJaKunden-ID
itemsarrayJaProdukte: [{ productId, quantity }]
pickupTimestringNeinGewünschte Abholzeit (ISO 8601)
notestringNeinKundennachricht (max. 250 Zeichen)
200 OK
{ "success": true, "orderId": "cc_order_x1y2z3", "status": "pending", "estimatedPickupAt": "2026-02-27T11:30:00.000Z" }

POST /api/v1/updateClickCollectStatus

Aktualisiert den Status einer Bestellung. Der Kunde wird per Push-Notification informiert.

Updates the status of an order. The customer is notified via push notification.

ParameterTypPflichtBeschreibung
orderIdstringJaBestell-ID
statusstringJa"confirmed", "ready", "picked_up", "cancelled"

AblaufFlow

1
BestellungOrder
Kunde wählt Produkte in der App.Customer selects products in the app. submitClickCollectOrder pending
2
BestätigungConfirmation
Store nimmt Bestellung an.Store accepts the order. updateClickCollectStatus confirmed
3
Bereit zur AbholungReady for pickup
Ware liegt bereit. Kunde erhält Push-Benachrichtigung.Order is packed. Customer receives push notification. updateClickCollectStatus ready
4
AbholungPickup
Kunde holt Ware im Store ab. Bestellung abgeschlossen.Customer collects the order in store. Order complete. updateClickCollectStatus picked_up
Bei Statusänderungen sendet BEEP! automatisch einen clickcollect.order- bzw. clickcollect.picked_up-Webhook an deinen konfigurierten Endpoint. Siehe Webhooks → Click & Collect.