利用できるデータ領域

レシートローラーは、店舗・ブランドが扱うリテールデータを横断的に管理するプラットフォームです。開発者ポータルからは、目的に応じて以下のデータ領域を REST API・Webhook で連携できます。

各領域の取得には対応するOAuthスコープが必要です。スコープの完全な一覧と取得制限はOAuthスコープ一覧と利用可否をご覧ください。

1. 取引・レシートデータ

POSやEC、自社アプリ経由で発生した取引と、それに紐づく電子レシートのデータです。レシートローラーで最もよく扱われるコアデータです。

• 含まれる主なデータ — 取引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. 個人ユーザーデータ（要審査）

レシートローラーアカウントを持つ個人ユーザーが、自身の同意のもとで連携できるデータです。家計簿アプリ・ウォレットアプリ・コンシューマー向けサービスから利用します。

• 含まれる主なデータ — ユーザー基本情報・受け取った全レシート（複数店舗横断）・月次支出サマリー・カテゴリ別支出・お気に入り店舗・取得済みクーポン
• 取得方法 — 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で取得するガイド
• 開発者向けヘルプ目次に戻る