Zum Inhalt

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.cancelled oder order.refunded werden signiert (HMAC-SHA256) an Ihre HTTPS-URL gesendet.
  • Stornieren: Noch nicht angenommene Bestellungen können Sie per API stornieren.
  • Sicher wiederholbar: Mit external_order_id und Idempotency-Key lassen sich Anfragen gefahrlos erneut senden.
  • Artikel zuordnen: Über sku_ref werden Ihre Produkte den Steuergruppen der Kasse zugeordnet, ohne Katalog-Pflege in OrderHi.

So starten Sie

  1. Zugang per E-Mail an [email protected] anfragen. Die Freischaltung erfolgt manuell.
  2. Der Händler erhält einen API-Schlüssel (Bearer Token) und hinterlegt im Geschäftskundenportal die Webhook-URL.
  3. Bestellungen per POST /v1/orders an https://api.orderhi.com senden.

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.