購買・レシートデータ連携
レシート
購買
データ連携
API
この記事の対象
レシートローラーの中核データである購買・レシート情報を連携したい開発者向けです。
レシートローラーの中核データである購買・レシート情報を連携したい開発者向けです。
レシートローラーで最も中心にあるデータがレシート(receipt)です。1回の決済が1レシートに対応し、複数の明細(item)を持ちます。POSや自社決済システムから発行され、店舗系・User系の両方のスコープでアクセスできます。
主なフィールド
| フィールド | 内容 |
|---|---|
id | レシートID(rcp_) |
store_id | 発行店舗 |
issued_at | 発行時刻 |
total_amount | 合計金額(最小通貨単位) |
tax_amount | 消費税額 |
currency | 通貨コード |
payment_method | 支払方法(cash / credit_card / qr / etc) |
status | issued / voided / refunded |
customer_id | 紐付け顧客(任意) |
items[] | 明細配列 |
関連スコープ
receipt.read— 店舗のレシート読み取りreceipt.write— レシートの新規発行・取消user.receipts.read— 一般消費者本人のレシート(要審査)user.receipts.write— 本人のレシートにメモ・タグ追加(要審査)
取得パターン
店舗オーナーとして取得
GET /v1/receipts?store_id=str_abc123&issued_after=2026-04-01
Authorization: Bearer {店舗トークン}
消費者本人として取得
GET /v1/me/receipts?limit=20
Authorization: Bearer {ユーザートークン}
Webhookイベント
receipt.issued— 発行receipt.voided— 取消receipt.refunded— 返金receipt.updated— 内容更新(補足追加など)
よくあるユースケース
- 会計連携:日次でレシートを取得して会計ソフトに登録
- 消費者向けレシート管理アプリ:本人レシートを家計簿アプリに同期
- BI集計:時間帯別・商品別の売上分析
- 不正検知:返金率の異常値検知
注意点
- 明細を含むレシートはペイロードが大きいため、一覧取得時は明細を含めない(
?expand=itemsで明示時のみ含む) - 取消・返金された場合、元レシートは残り
statusが変わる。集計時はstatusを必ず参照 - 金額は税込・税抜の両方が
total_amount/subtotalとして提供される
関連ガイド
公開日: 2026-04-27
更新日: 2026-04-27
カテゴリ
タグ
API (8)
Webhook (8)
api (6)
oauth (5)
トラブル (5)
OAuth (4)
getting-started (4)
アプリ登録 (4)
app-registration (3)
webhook (3)