可利用的資料領域

ReceiptRoller 是橫斷地管理店鋪、品牌處理的零售資料的平台。從開發者入口，可依目的以 REST API、Webhook 串接以下的資料領域。

各領域的取得需要對應的 OAuth 權限範圍。權限範圍的完整一覽與取得限制請參閱 OAuth 權限範圍一覽與利用可否。

1. 交易、收據資料

經由 POS、EC、自家應用程式發生的交易，與其關聯的電子收據的資料。是 ReceiptRoller 中最常被處理的核心資料。

• 含的主要資料 — 交易 ID、店鋪 ID、交易日時、小計／稅額／合計、支付方法、明細行（商品名、數量、單價、稅區分）、折扣套用資訊、收據發行狀態（已發行、已退款、取消）
• 取得方法 — API（交易紀錄的參照、特定交易的取得）／Webhook（發行、更新事件的即時通知）
• 必要的權限範圍 — 從店鋪端是 store.orders.*，從使用者端是 user.receipts.read（需審查）
• 主要的使用案例 — 對自家伺服器的收據串接、錢包應用程式的收據檢視、記帳應用程式的自動匯入

2. 商品資料（PIM）

店鋪處理的商品主檔，與商品關聯的屬性、類別、變體資訊。是相當於商品資訊管理（Product Information Management）的領域。

• 含的主要資料 — 商品 ID、SKU、JAN 碼、商品名、說明、價格、稅區分、類別、屬性（尺寸、顏色等）、變體、圖片 URL、公開狀態
• 取得方法 — API（一覽取得、個別取得、建立、更新、刪除）、CSV 批次匯入／匯出
• 必要的權限範圍 — store.products.read / store.products.write
• 主要的使用案例 — 與外部商品主檔系統的雙向同步、與 EC 的商品資訊串接、從公司內 CMS 的批次更新

3. 庫存資料

商品的庫存數量，與入出貨、貨架移動等的交易資料。對應 WMS 串接或多地點庫存管理。

• 含的主要資料 — 商品 ID、店鋪 ID、地點、現有庫存數、預約庫存、入貨預定數、入出貨紀錄
• 取得方法 — API（庫存照會、庫存調整）
• 必要的權限範圍 — store.inventory.read
• 主要的使用案例 — 與外部 WMS 的庫存同步、EC 網站的庫存數顯示、店鋪間的庫存移動管理

4. 訂單資料

處理 EC、預約、店頭訂購等發生的訂單，與出貨、取消等的狀態變化。

• 含的主要資料 — 訂單 ID、訂單日時、顧客 ID、配送對象、訂單明細、訂單狀態（未確定、確定、已出貨、取消）、支付狀態
• 取得方法 — API（訂單一覽、詳細、狀態更新）／Webhook（訂單建立、狀態變更事件）
• 必要的權限範圍 — store.orders.read / store.orders.write
• 主要的使用案例 — 與 OMS 的串接、對自家配送系統的出貨指示、訂單儀表板

5. 顧客資料、CRM

店鋪掌握的顧客檔案、基於購買紀錄的分群、忠誠度等的 CRM 資料。

• 含的主要資料 — 顧客 ID、基本屬性（名字、電子郵件、電話、地址）、購買紀錄摘要、最終來店日、購買頻度、累計購買額、分群（VIP、常客等）、排名
• 取得方法 — API（顧客一覽、詳細、分群定義）
• 必要的權限範圍 — store.customers.read，CRM 分群是 crm.profiles.read / crm.segments.read
• 主要的使用案例 — 與外部 MA 工具的顧客同步、自家 BI 的分群分析、鎖定投放的準備

6. 優惠券、促銷資料

店鋪發行的優惠券、活動設定、投放實績、利用實績等的促銷關聯資料。

• 含的主要資料 — 優惠券 ID、名稱、折扣類型（百分比／固定金額）、折扣值、有效期間、最大利用次數、投放狀況、利用次數、套用的交易
• 取得方法 — API（優惠券的建立、更新、參照）
• 必要的權限範圍 — store.coupons.read / store.coupons.write
• 主要的使用案例 — 從行銷工具的優惠券批次發行、投放效果的報告串接、與外部優惠券系統的統合

7. 店鋪、商業帳戶資料

店鋪的基本資訊、營業時間、地址、聯絡處、商業帳戶配下的店鋪一覽等。串接應用程式端進行店鋪單位的設定或顯示時會需要。

• 含的主要資料 — 店鋪 ID、店鋪名、地址、電話號碼、營業時間、店鋪類型、商業帳戶 ID、店鋪狀態（營業中、休業中等）
• 取得方法 — API（店鋪一覽、詳細）
• 必要的權限範圍 — Store 系 API 有串接對象店鋪的許可即可參照
• 主要的使用案例 — 店鋪一覽的自家 UI 顯示、基於營業時間的自動控制、店鋪別報告生成

8. 店鋪傳單資料

店鋪公開的數位傳單的中繼資料與內容。以掃描器的自動收集、店鋪負責人的手動上傳兩者以統一資料模型處理。

• 含的主要資料 — 傳單 ID、店鋪 ID、標題、有效期間、PDF/圖片 URL、OCR 抽出完的文字、AI 摘要、類別、公開狀態
• 取得方法 — API（傳單一覽、詳細、建立、更新）
• 必要的權限範圍 — store.flyers.read / store.flyers.write
• 主要的使用案例 — 自家應用程式的傳單顯示、傳單比較服務、使用 AI 摘要的商品搜尋

9. SNS、分析資料

經由店鋪的 SNS 帳戶串接取得的貼文、觀眾、表現資料，與店鋪營運的各種分析快照。

• 含的主要資料 — SNS 貼文 ID、公開日時、本文、媒體 URL、平台表單、參與度（讚、留言、觸及）、觀眾屬性（年齡、性別、地區）、分析快照（銷售、來店、施策效果）
• 取得方法 — API（貼文一覽、分析資料參照）
• 必要的權限範圍 — sns.content.read / sns.audience.read / analytics.read
• 主要的使用案例 — 對公司內 BI 的 SNS 表現串接、多店鋪的橫斷報告、使用分析資料的施策最適化

10. 零售媒體（廣告日誌）資料

在店鋪內數位看板或電子收據上投放的廣告的投放實績、效果測定資料。

• 含的主要資料 — 廣告活動 ID、投放端末 ID、投放日時、曝光數、點擊、轉換（與交易的關聯）、收益摘要
• 取得方法 — API（投放日誌、收益報告參照）
• 必要的權限範圍 — analytics.read（零售媒體固有權限範圍依序擴張預定）
• 主要的使用案例 — 廣告主向報告、與收益管理工具的串接、效果測定儀表板

11. 個人使用者資料（需審查）

持有 ReceiptRoller 帳戶的個人使用者，在自身的同意下可串接的資料。從記帳應用程式、錢包應用程式、消費者向服務利用。

• 含的主要資料 — 使用者基本資訊、收到的全收據（多店鋪橫斷）、月次支出摘要、依類別支出、我的最愛店鋪、取得完的優惠券
• 取得方法 — API（OAuth 2.0 授權碼流程，使用者同意必須）
• 必要的權限範圍 — user.profile.* / user.receipts.read / user.spending.* / user.coupons.read / user.favorites.*
• 主要的使用案例 — 錢包型行動應用程式、記帳應用程式、家計支出的自動記帳、我的最愛店鋪的優惠券推播通知

12. 問卷（Survey）資料

店鋪實施的問卷活動與回答資料。以 QR 碼、URL、電子收據嵌入等的路徑收集回答。

• 含的主要資料 — 活動 ID、公開 URL 權杖、提問項目、回答資料、回答日時、回答路徑（QR、連結、收據嵌入）、連動優惠券
• 取得方法 — Survey API（公開端點、回答發送、配布對象設定）
• 必要的權限範圍 — 從店鋪端的管理今後整備預定。回答發送的公開 API 是權杖基底
• 主要的使用案例 — 來店後的 NPS 調查、購買後的滿足度問卷、對回答賦與獎勵
• 相關指南 — Survey API and receipt embed（英文）

資料取得方法的彙整

資料領域的組合例

實際的服務中組合多個領域的資料使用的情況很多。舉代表性的例子。

• 自家 POS 串接應用程式 — 交易資料（Webhook 接收）＋ 商品資料（同步）＋ 庫存資料（更新）
• 記帳行動應用程式 — 個人使用者收據 ＋ 月次支出摘要 ＋ 我的最愛店鋪的優惠券
• 店鋪行銷工具 — 顧客、CRM 資料 ＋ 交易紀錄 ＋ 優惠券投放 ＋ 效果測定（分析）
• 商品比較、傳單應用程式 — 店鋪傳單 ＋ 商品資料 ＋ 店鋪資料
• 廣告主向儀表板 — 零售媒體投放日誌 ＋ 交易資料（轉換關聯）＋ 觀眾屬性

相關指南

• 開發者入口可做的事（API、Webhook）
• OAuth 權限範圍一覽與利用可否
• 店鋪向：以自家應用程式發行數位收據、以 Webhook 通知的指南
• 錢包應用程式向：以 OAuth 取得使用者的收據的指南
• 返回開發者向幫助目次