OrderHi Partner API
Open beta. The OrderHi Partner API is in open beta and generally available to subscribed merchants. Access is still enabled manually, and details may still change. Please send access requests to [email protected].
The Partner API lets developers with their own online shop inject orders into the OrderHi POS and follow their status.
What is possible?
- Inject orders: Orders from your shop (pickup, delivery or in-house, prepaid or cash) arrive directly in the OrderHi POS and on the kitchen display, with no re-entry.
- Track status: Every order moves through
received→accepted→in_preparation→awaiting_collection→completed. You read the status via the API or receive it by webhook. - Webhooks: Events such as
order.accepted,order.completed,order.cancelledororder.refundedare sent, signed (HMAC-SHA256), to your HTTPS URL. - Cancel: Orders that have not been accepted yet can be cancelled via the API.
- Safe to retry:
external_order_idandIdempotency-Keymake it safe to resend requests. - Map products:
sku_refmaps your products to the POS tax groups, without maintaining a catalog in OrderHi.
Getting started
- Request access by email to [email protected]. Access is enabled manually.
- The merchant receives an API key (bearer token) and registers the webhook URL in the business customer portal.
- Send orders with
POST /v1/orderstohttps://api.orderhi.com.
The full technical reference with all endpoints, fields and examples is on developers.orderhi.com.
Error handling
Errors are reported in the application/problem+json format. Every kind of error has its own page with causes and solutions: Problem types of the Partner API.