StaffDto リファレンス
レシートローラーのスタッフ(従業員)マスタである StaffDto の全フィールドを解説します。POS(Square Team / スマレジ)との関連付け、店舗アサイン、雇用形態などの構造をまとめています。
APIリファレンスとドキュメントの見方
レシートローラーの開発者向けドキュメントの構成と使い分けを説明します。開発者ヘルプ・APIトップページ・SwaggerベースのAPIリファレンス・開発者コミュニティの4つの入り口と、AIアシスタントやコード生成ツールで使えるOpenAPI仕様(openapi/v1.json)の取得方法を案内します。
代表的なAPI例
レシートローラーAPIの代表的なエンドポイントの呼び出し例(レシート取得・店舗一覧・商品作成・Webhook登録)をcurlコマンドで紹介します。
ProductDto リファレンス
レシートローラーの商品マスタ(PIM)である ProductDto の全フィールドを解説します。POS(Square)からの商品カタログ同期、原価・店舗別価格・バリエーション・プレオーダーなどの構造をまとめています。
403/401が返る(権限・スコープ)
API呼び出しで401や403が返るときの原因切り分け。トークン無効・スコープ不足・店舗アクセス権なし・User系審査未通過などの典型ケースを解説します。
リクエストとレスポンスの基本(JSON)
レシートローラーAPIのリクエスト形式、必須ヘッダー、レスポンス構造、ページネーション、フィルタリング、日時形式の規則を解説します。
取引一覧API(Transactions API:POS+OMS統合フィード)の使い方
レシートローラーのTransactions APIは、レジ売上(PosTransactions)と販売管理注文(OmsOrders)を1つのフィードに統合した読み取り専用APIです。Android/iOSアプリで「ビジネスアカウント全体の取引」を一覧表示する際の入り口になります。
サポートへの問い合わせ(技術連携)
レシートローラー開発者向けサポートの種類、問い合わせ前のチェックリスト、効率的に解決を進めるための情報添付テンプレートを解説します。
Webhookの概要
レシートローラーのWebhookで配信される主要なイベント種別、ポーリングではなくWebhookを使うべき理由、配信形式(HTTPS POST + JSON)、配信保証の考え方を解説します。
売上実績API(Sales API)の使い方
レシートローラーの売上実績API(/api/v1/sales/*)の概要と、ビジネスアカウント・店舗・POS端末・期間でのフィルタ方法をまとめます。実際のレスポンス構造(KpiValue 入れ子型)と averageTicket・トークン有効期限(8時間)まで網羅した、Android/iOS のモバイルアプリやサーバー連携で 売上ダッシュボードを実装するための入門ガイドです。
アクセストークンの取得と更新
レシートローラーAPIで使うアクセストークンとリフレッシュトークンの取得方法、有効期限、更新手順、エラー時の対処を解説します。
ストアアプリ コンテンツAPI(お知らせ・ページ・営業情報)の使い方
ストアアプリのコンテンツ(お知らせ・ページ・マニフェスト・営業情報・会員証設定)を取得する /api/v1/apps/{shopId}/* の使い方です。shopId はビジネスアカウント ID と同一であること、ビジネスアカウント単位コンテンツと店舗単位コンテンツの違い、認証の扱いを解説します。
PosTransactionDto 仕様 — 取引データのフィールドリファレンス
レシートローラーが扱う取引データの正規モデル PosTransactionDto の全フィールドを解説します。識別子・日時・金額・明細・支払い・スタッフ・ステータス・CRM 連携の各カテゴリーごとに、フィールド名・型・意味・各 POS ベンダーからの埋め方をまとめた、開発者および外部システム連携担当者向けのリファレンスです。スマレジ・Square 双方のマッピング記事からも参照されます。
ウォレットアプリ向け:ユーザーのレシートをOAuthで取得するガイド
iOS・Android・LINE Mini Appなどのウォレット型アプリから、ユーザーの同意のもとで Receipt Roller の購買レシートを取得する方法を解説します。OAuth 2.0認証・レシートAPI・Webhook連携をカバーします。
リダイレクトURLの設定
レシートローラーの開発者ポータルで設定するリダイレクトURI(コールバックURL)の役割、登録ルール、開発・本番環境の使い分け、よくあるエラーと対処方法を解説します。
利用目的・接続先(POS/EC/分析など)の申告
レシートローラーの開発者ポータルでアプリを登録する際に申告する「利用目的」と「接続先カテゴリ」(POS/EC/分析/CRM/OMS/WMS/SNS/その他)の意味、選び方、変更時の注意、User系スコープ審査との関連を解説します。