OrderHi Partner API
Open Beta. Die OrderHi Partner API befindet sich in einer offenen Beta und steht Händlern mit Abonnement allgemein zur Verfügung. Der Zugang wird weiterhin manuell freigeschaltet, und Details können sich noch ändern. Zugangsanfragen senden Sie bitte an [email protected].
Mit der Partner API können Entwickler mit einem eigenen Onlineshop Bestellungen in die OrderHi Kasse einspielen und deren Status verfolgen.
Was ist möglich?
- Bestellungen einspielen: Bestellungen aus Ihrem Shop (Abholung, Lieferung oder vor Ort, bezahlt oder bar) landen direkt in der OrderHi Kasse und auf dem Küchenbildschirm – ohne erneute Eingabe.
- Status verfolgen: Jede Bestellung durchläuft
received→accepted→in_preparation→awaiting_collection→completed. Sie fragen den Status per API ab oder erhalten ihn per Webhook. - Webhooks: Ereignisse wie
order.accepted,order.completed,order.cancelledoderorder.refundedwerden signiert (HMAC-SHA256) an Ihre HTTPS-URL gesendet. - Stornieren: Noch nicht angenommene Bestellungen können Sie per API stornieren.
- Sicher wiederholbar: Mit
external_order_idundIdempotency-Keylassen sich Anfragen gefahrlos erneut senden. - Artikel zuordnen: Über
sku_refwerden Ihre Produkte den Steuergruppen der Kasse zugeordnet, ohne Katalog-Pflege in OrderHi.
So starten Sie
- Zugang per E-Mail an [email protected] anfragen. Die Freischaltung erfolgt manuell.
- Der Händler erhält einen API-Schlüssel (Bearer Token) und hinterlegt im Geschäftskundenportal die Webhook-URL.
- Bestellungen per
POST /v1/ordersanhttps://api.orderhi.comsenden.
Die vollständige technische Referenz mit allen Endpunkten, Feldern und Beispielen finden Sie auf developers.orderhi.com.
Fehlerbehandlung
Fehler werden im Format application/problem+json gemeldet. Jede Fehlerart hat eine eigene Seite mit Ursachen und Lösungen: Fehlertypen der Partner API.