錢包應用程式向:以 OAuth 取得使用者的收據的指南
解說從 iOS、Android、LINE Mini App 等錢包型應用程式,在使用者同意下取得 ReceiptRoller 的購買收據的方法。涵蓋 OAuth 2.0 驗證、收據 API、Webhook 串接。
利用目的、串接對象(POS/EC/分析等)的申告
解說在 ReceiptRoller 的開發者入口登錄應用程式時申告的「利用目的」與「串接對象類別」(POS/EC/分析/CRM/OMS/WMS/SNS/其他)的意義、選法、變更時的注意、與 User 系權限範圍審查的關聯。
商品管理 API(Products API)的使用方式
這是使用 ReceiptRoller 商品管理 API(/api/v1/products)對商業帳戶底下的商品進行 CRUD 操作的指南。適用於在 Android/iOS 應用程式或伺服器串接讀寫 PIM(商品主檔)時的入門文章。
員工管理 API(Staff API)的使用方式
這是使用 ReceiptRoller 員工管理 API(/api/v1/staff)對商業帳戶底下的員工(Staff)進行 CRUD 操作的指南。支援與 Square Team Member 互通的欄位(假名、多工作分配、薪資結構)。
SNS Webhook 旁路(LINE 等外部 SNS 的 Webhook 轉發)
解說 ReceiptRoller 將從 LINE 等 SNS 平台接收到的 Webhook,在店鋪端同意下轉發至開發者應用程式的「SNS Webhook 旁路」功能的機制、設定方法、簽章的處理、注意事項。
庫存管理 API(Inventory / WMS API)的使用方式
ReceiptRoller 庫存管理 API(Inventory / WMS API)的實作指南。解說以據點(倉庫、店鋪後場、賣場)為單位的庫存查詢、調整、異動紀錄取得方法,必要的 OAuth 權限範圍,Shopify 串接時的自動反映,以及從 MCP 工具(wms_get_stock / wms_adjust_stock 等)的使用方式。
開發者入口可做的事
概觀 ReceiptRoller 的開發者入口可做的事。組合 REST API 的資料取得、操作與 Webhook 的即時事件接收,可從外部系統串接店鋪、使用者資料。
代表性的 API 範例
以 curl 命令介紹 ReceiptRoller API 代表性端點的呼叫範例(收據取得、店鋪一覽、商品建立、Webhook 登錄)。
店鋪資訊 API(Store Information API)的使用方式
說明如何以 REST API 取得、更新店鋪的基本資訊(店鋪名稱、店鋪類別、聯絡方式、地址)。可從員工應用程式等以權杖驗證的用戶端實作店鋪資訊的編輯畫面。
OAuth 權限範圍一覽與利用可否
說明 ReceiptRoller 的 OAuth API 可利用的權限範圍的一覽,與各權限範圍被授予哪種類型的應用程式。也涵蓋 User 系權限範圍的審查要件、Store 系與 User 系無法混在的理由、從 LIFF 應用程式的利用方法。
商品主檔(PIM)、類別資料
解說 ReceiptRoller 的商品主檔(PIM)、類別、變體的資料結構、CRUD 操作、SKU 管理、與 EC 的同步模式。
StaffDto 參考
解說 ReceiptRoller 員工(Staff)主檔 StaffDto 的所有欄位。彙整與 POS(Square Team / Smaregi)的關聯、店鋪指派、雇用型態等結構。
ProductDto 參考
解說 ReceiptRoller 商品主檔(PIM)ProductDto 的所有欄位。彙整來自 POS(Square)的商品目錄同步,以及原價、各店鋪價格、變體、預購等結構。