Bỏ qua

OrderHi Partner API

Open Beta. OrderHi Partner API đang trong giai đoạn beta mở và có sẵn rộng rãi cho các merchant đã đăng ký gói. Quyền truy cập vẫn được cấp thủ công và các chi tiết vẫn có thể thay đổi. Vui lòng gửi yêu cầu truy cập đến [email protected].

Với Partner API, các nhà phát triển có Onlineshop riêng có thể đưa đơn hàng vào OrderHi Kasse và theo dõi trạng thái của chúng.

Có thể làm gì?

  • Đưa đơn hàng vào: Đơn hàng từ shop của bạn (tự đến lấy, giao hàng hoặc tại chỗ, đã thanh toán hoặc tiền mặt) vào thẳng OrderHi Kasse và màn hình bếp, không cần nhập lại.
  • Theo dõi trạng thái: Mỗi đơn hàng đi qua received → accepted → in_preparation → awaiting_collection → completed. Bạn truy vấn trạng thái qua API hoặc nhận qua webhook.
  • Webhook: Các sự kiện như order.accepted, order.completed, order.cancelled hay order.refunded được gửi, có chữ ký (HMAC-SHA256), đến URL HTTPS của bạn.
  • Hủy đơn: Đơn hàng chưa được chấp nhận có thể hủy qua API.
  • Gửi lại an toàn: external_order_id và Idempotency-Key giúp gửi lại yêu cầu mà không bị trùng.
  • Ánh xạ sản phẩm: sku_ref ánh xạ sản phẩm của bạn vào nhóm thuế của Kasse, không cần quản lý danh mục trong OrderHi.

Bắt đầu

  1. Gửi yêu cầu truy cập qua email tới [email protected]. Quyền truy cập được cấp thủ công.
  2. Chủ cửa hàng nhận khóa API (bearer token) và đăng ký URL webhook trong Cổng khách hàng doanh nghiệp.
  3. Gửi đơn hàng bằng POST /v1/orders tới https://api.orderhi.com.

Tài liệu kỹ thuật đầy đủ với mọi endpoint, trường dữ liệu và ví dụ có tại developers.orderhi.com.

Xử lý lỗi

Lỗi được trả về ở định dạng application/problem+json. Mỗi loại lỗi có một trang riêng với nguyên nhân và cách khắc phục: Các loại lỗi của Partner API.