開發者向幫助目次
API
OAuth
Webhook
驗證
權限範圍
開發者向幫助
在 ReceiptRoller 的開發者向入口，可以將購入、銷售、廣告、庫存等零售資料以 REST API 與 Webhook 串接。作為店鋪使用者登錄，只要是 Starter 方案以上，無需另行的開發者申請即可立刻開始應用程式登錄與 API 實作。
開始之前
- 開發者入口可做的事（API、Webhook）
- 可利用的資料領域（購入、商品、庫存、廣告日誌等）
- 利用開始為止的流程（店鋪登錄 → Starter 方案 → 應用程式登錄）
- API 參考與文件的閱讀方式
應用程式登錄
驗證與憑證
實作指南（依使用案例）
- 錢包應用程式向：以 OAuth 取得使用者的收據的指南
- 店鋪向：以自家應用程式發行數位收據、以 Webhook 通知的指南
- 原生行動應用程式向：多商業帳戶存取與 OAuth 流程
- 取得商業帳戶、店鋪、POS 端末的一覽
- 銷售實績 API（Sales API）的使用方法
- 商品管理 API（Products API）的使用方法
- 販售管理 API（Orders / OMS API）的使用方法
- 庫存管理 API（Inventory / WMS API）的使用方法
- 員工管理 API（Staff API）的使用方法
- 營業時間 API（Business Hours API）的使用方法
- 店鋪資訊 API（Store Information API：取得、更新）的使用方法
- 預約管理 API（Reservations API）的使用方法
- 交易一覽 API（Transactions API：POS＋OMS 統合饋送）的使用方法
- 商店應用程式 內容 API（公告、頁面、營業資訊）的使用方法
- Survey API and receipt embed（英文）
API 基礎
資料領域別指南
Webhook（事件串接）
- Webhook 的概要（購入事件等）
- Webhook 的登錄方法
- 簽章驗證與安全性
- 重送、順序、冪等性的設計
- 監視與失敗時的對應
- SNS Webhook 旁路（LINE 等外部 SNS 的 Webhook 轉發）
運用與安全性
社群
疑難排解
發布日: 2026-03-05
更新日: 2026-07-06
標籤
API (22)
OAuth (15)
Android (10)
iOS (9)
Webhook (8)
api (7)
oauth (5)
POS串接 (4)
getting-started (4)
參考 (4)
相關文章
-
店鋪資訊 API（Store Information API）的使用方式說明如何以 REST API 取得、更新店鋪的基本資訊（店鋪名稱、店鋪類別、聯絡方式、地址）。可從員工應用程式等以權杖驗證的用戶端實作店鋪資訊的編輯畫面。
-
店內媒體顯示器 API（Display API）的使用方式ReceiptRoller 店內 Android 顯示器 API（/api/v1/displays/*）的概要，以及配對、心跳、播放清單取得、播放實績回報的步驟彙整。這是為在 Android 電子看板或店內數位看板端末播放媒體循環而實作應用程式的入門指南。
-
交易一覽 API（Transactions API：POS＋OMS 整合摘要）的使用方式ReceiptRoller 的 Transactions API 是將收銀營業額（PosTransactions）與銷售管理訂單（OmsOrders）整合為單一摘要的唯讀 API。在 Android／iOS 應用程式中一覽顯示「整個商業帳戶的交易」時，即為入口。
-
營業額實績 API（Sales API）的使用方式彙整 ReceiptRoller 營業額實績 API（/api/v1/sales/*）的概要，以及依商業帳戶、店鋪、POS 端末、期間的篩選方法。這是一份涵蓋實際回應結構（KpiValue 巢狀型）與 averageTicket、權杖有效期限（8 小時）在內，為在 Android／iOS 行動應用程式或伺服器串接實作營業額儀表板的入門指南。
-
銷售管理 API（Orders / OMS API）的使用方式這是使用 ReceiptRoller 銷售管理 API（/api/v1/orders）對商業帳戶底下的訂單進行 CRUD 操作的指南。彙整訂單的建立、更新、狀態轉移（確認、處理中、取消）、刪除，以及適用於 Android／iOS 應用程式或伺服器串接的流程。