6 筆
2026-04-27
api
reference
swagger
openapi
community
API 參考與文件的閱讀方式
說明 ReceiptRoller 的開發者向文件的構成與分別使用。開發者幫助、API 頂頁、Swagger 基底的 API 參考、開發者社群的 4 個入口，以及可用於 AI 助手或程式碼生成工具的 OpenAPI 規格（openapi/v1.json）的取得方法。
2026-05-29
PosTransactionDto
交易資料
綱要
參考
API
Smaregi
Square
POS串接
PosTransactionDto 規格 — 交易資料的欄位參考
解說 ReceiptRoller 處理的交易資料正規模型 PosTransactionDto 的所有欄位。依識別碼、日期時間、金額、明細、付款、員工、狀態、CRM 串接各類別，彙整欄位名稱、型別、意義，以及各 POS 供應商的填入方式，是給開發者與外部系統串接負責人的參考。Smaregi、Square 雙方的對應文章也會參照本文。
2026-05-29
CRM
顧客
資料模型
參考
POS串接
CrmCustomerDto 參考
解說 ReceiptRoller 顧客主檔 CrmCustomerDto 的所有欄位。從 POS（Smaregi、Square）匯入的顧客資訊會正規化為此模型。
2026-05-29
員工
從業人員
資料模型
參考
POS串接
StaffDto 參考
解說 ReceiptRoller 員工（Staff）主檔 StaffDto 的所有欄位。彙整與 POS（Square Team / Smaregi）的關聯、店鋪指派、雇用型態等結構。
2026-05-29
PIM
商品
資料模型
參考
POS串接
ProductDto 參考
解說 ReceiptRoller 商品主檔（PIM）ProductDto 的所有欄位。彙整來自 POS（Square）的商品目錄同步，以及原價、各店鋪價格、變體、預購等結構。
2026-04-27
Webhook
事件
API
即時串接
Webhook 的概要
解說 ReceiptRoller 的 Webhook 所投放的主要事件種類、應該使用 Webhook 而非輪詢的理由、投放形式（HTTPS POST + JSON）、投放保證的思考方式。