開発者向けヘルプ目次
API
OAuth
Webhook
認証
スコープ
開発者向けヘルプ
レシートローラーの開発者向けポータルでは、購買・売上・広告・在庫などのリテールデータを REST API と Webhook で連携できます。店舗ユーザーとして登録し、スタータープラン以上であれば、別途の開発者申請なしですぐにアプリ登録とAPI実装を始められます。
はじめに
- 開発者ポータルでできること（API・Webhook）
- 利用できるデータ領域（購買・商品・在庫・広告ログなど）
- 利用開始までの流れ（店舗登録 → スタータープラン → アプリ登録）
- APIリファレンスとドキュメントの見方
アプリケーション登録
認証とクレデンシャル
- API認証ガイド（OAuth 2.0 認可コードフロー）
- OAuthスコープ一覧と利用可否
- クライアントID・クライアントシークレットの管理
- アクセストークンの取得と更新
- シークレットのローテーションと安全な保管
実装ガイド（ユースケース別）
- ウォレットアプリ向け：ユーザーのレシートをOAuthで取得するガイド
- 店舗向け：自社アプリでデジタルレシートを発行・Webhookで通知するガイド
- ネイティブモバイルアプリ向け：複数ビジネスアカウントアクセスとOAuthフロー
- ビジネスアカウント・店舗・POS端末の一覧を取得する
- 売上実績API（Sales API）の使い方
- 商品管理API（Products API）の使い方
- 販売管理API（Orders / OMS API）の使い方
- 在庫管理API（Inventory / WMS API）の使い方
- 従業員管理API（Staff API）の使い方
- 営業時間API（Business Hours API）の使い方
- 予約管理API（Reservations API）の使い方
- 取引一覧API（Transactions API：POS＋OMS統合フィード）の使い方
- Survey API and receipt embed（英語）
APIの基本
データ領域別ガイド
Webhook（イベント連携）
- Webhookの概要（購買イベントなど）
- Webhookの登録方法
- 署名検証とセキュリティ
- 再送・順序・冪等性の設計
- 監視と失敗時の対応
- SNS Webhookバイパス（LINEなど外部SNSのWebhook転送）
運用とセキュリティ
コミュニティ
トラブルシューティング
公開日: 2026-03-05
更新日: 2026-06-10
カテゴリ
タグ
API (20)
OAuth (14)
Android (10)
iOS (9)
Webhook (8)
api (6)
oauth (5)
トラブル (5)
POS連携 (4)
getting-started (4)
関連記事
-
営業時間API（Business Hours API）の使い方レシートローラーの営業時間API（/api/v1/stores/{storeId}/business-hours）のガイドです。曜日ごとの営業時間の取得・更新、特例営業日（臨時休業・営業時間変更）の登録、店舗の就業可能時間（シフト作成時の上限となる業務時間）の設定、現在営業中かどうかの判定までを解説します。
-
リクエストとレスポンスの基本（JSON）レシートローラーAPIのリクエスト形式、必須ヘッダー、レスポンス構造、ページネーション、フィルタリング、日時形式の規則を解説します。
-
ネイティブモバイルアプリ向けガイド: 複数ビジネスアカウントアクセスと OAuth フローAndroid / iOS のネイティブアプリ向け実装ガイド。アプリ登録時に「認可時に1つのビジネスアカウントへトークンを紐付ける」をオフにすると、user-scoped OAuth トークンが発行されます。/api/v1/me/organizations + ?organizationId= パターンで複数ビジネスアカウントを横断アクセスできます。
-
取引一覧API（Transactions API：POS＋OMS統合フィード）の使い方レシートローラーのTransactions APIは、レジ売上（PosTransactions）と販売管理注文（OmsOrders）を1つのフィードに統合した読み取り専用APIです。Android／iOSアプリで「ビジネスアカウント全体の取引」を一覧表示する際の入り口になります。
-
PosTransactionDto 仕様 — 取引データのフィールドリファレンスレシートローラーが扱う取引データの正規モデル PosTransactionDto の全フィールドを解説します。識別子・日時・金額・明細・支払い・スタッフ・ステータス・CRM 連携の各カテゴリーごとに、フィールド名・型・意味・各 POS ベンダーからの埋め方をまとめた、開発者および外部システム連携担当者向けのリファレンスです。スマレジ・Square 双方のマッピング記事からも参照されます。