預約管理 API(Reservations API)的使用方式
ReceiptRoller 預約管理 API(/api/v1/reservations)的指南。解說預約的 CRUD、狀態更新,預約框(時段)的取得、建立、整批產生,店鋪版面所登錄的座位(桌位、包廂、吧台)的取得,以及預約統計。
店內媒體顯示器 API(Display API)的使用方式
ReceiptRoller 店內 Android 顯示器 API(/api/v1/displays/*)的概要,以及配對、心跳、播放清單取得、播放實績回報的步驟彙整。這是為在 Android 電子看板或店內數位看板端末播放媒體循環而實作應用程式的入門指南。
商品主檔(PIM)、類別資料
解說 ReceiptRoller 的商品主檔(PIM)、類別、變體的資料結構、CRUD 操作、SKU 管理、與 EC 的同步模式。
銷售管理 API(Orders / OMS API)的使用方式
這是使用 ReceiptRoller 銷售管理 API(/api/v1/orders)對商業帳戶底下的訂單進行 CRUD 操作的指南。彙整訂單的建立、更新、狀態轉移(確認、處理中、取消)、刪除,以及適用於 Android/iOS 應用程式或伺服器串接的流程。
資料保護(匿名化、加密)的思維
解說 ReceiptRoller 串接應用程式的資料保護思維、加密(保管時、通信時)、匿名化、假名化的技巧,以及刪除政策。
營業時間 API(Business Hours API)的使用方式
ReceiptRoller 營業時間 API(/api/v1/stores/{storeId}/business-hours)的指南。解說每個星期的營業時間的取得與更新、特別營業日(臨時歇業、營業時間變更)的登錄、店鋪的可營業時間(排班建立時的上限業務時間)的設定,以及目前是否營業中的判定。
員工管理 API(Staff API)的使用方式
這是使用 ReceiptRoller 員工管理 API(/api/v1/staff)對商業帳戶底下的員工(Staff)進行 CRUD 操作的指南。支援與 Square Team Member 互通的欄位(假名、多工作分配、薪資結構)。
ProductDto 參考
解說 ReceiptRoller 商品主檔(PIM)ProductDto 的所有欄位。彙整來自 POS(Square)的商品目錄同步,以及原價、各店鋪價格、變體、預購等結構。
Webhook 的登錄方法
解說在 ReceiptRoller 的開發者入口登錄 Webhook 端點的步驟、訂閱事件的選法、測試投放、多端點的分開運用、刪除與暫停的方法。
API 參考與文件的閱讀方式
說明 ReceiptRoller 的開發者向文件的構成與分別使用。開發者幫助、API 頂頁、Swagger 基底的 API 參考、開發者社群的 4 個入口,以及可用於 AI 助手或程式碼生成工具的 OpenAPI 規格(openapi/v1.json)的取得方法。
SNS Webhook 旁路(LINE 等外部 SNS 的 Webhook 轉發)
解說 ReceiptRoller 將從 LINE 等 SNS 平台接收到的 Webhook,在店鋪端同意下轉發至開發者應用程式的「SNS Webhook 旁路」功能的機制、設定方法、簽章的處理、注意事項。