従業員管理API(Staff API)の使い方
レシートローラーの従業員管理API(/api/v1/staff)でビジネスアカウント配下の従業員(スタッフ)をCRUD操作するためのガイドです。Square Team Member 互換のフィールド(カナ名、複数業務割当、給与構造)に対応しています。
StaffDto リファレンス
レシートローラーのスタッフ(従業員)マスタである StaffDto の全フィールドを解説します。POS(Square Team / スマレジ)との関連付け、店舗アサイン、雇用形態などの構造をまとめています。
営業時間API(Business Hours API)の使い方
レシートローラーの営業時間API(/api/v1/stores/{storeId}/business-hours)のガイドです。曜日ごとの営業時間の取得・更新、特例営業日(臨時休業・営業時間変更)の登録、店舗の就業可能時間(シフト作成時の上限となる業務時間)の設定、現在営業中かどうかの判定までを解説します。
OAuthスコープ一覧と利用可否
レシートローラーのOAuth APIで利用できるスコープの一覧と、各スコープがどの種類のアプリに付与されるかを説明します。User系スコープの審査要件、Store系とUser系を混在できない理由、LIFFアプリからの利用方法もカバーします。
予約管理API(Reservations API)の使い方
レシートローラーの予約管理API(/api/v1/reservations)のガイドです。予約のCRUD・ステータス更新、予約枠(スロット)の取得・作成・一括生成、店舗レイアウトに登録された席(テーブル・個室・カウンター)の取得、予約統計までを解説します。
開発者向けヘルプ目次
レシートローラー開発者向けヘルプ目次です。開発者申請、アプリケーション登録、OAuth認証とスコープ、実装ガイド(ウォレットアプリ・店舗向けWebhook・Survey API)、データ領域別ガイド、運用とセキュリティ、コミュニティ、トラブルシューティングまでをまとめています。
再送・順序・冪等性の設計
レシートローラーWebhookの再送ポリシー、配信順序が保証されない理由、event_idを使った冪等性の実装、デッドレターの扱い、よくあるアンチパターンを解説します。
CrmCustomerDto リファレンス
レシートローラーの顧客マスタである CrmCustomerDto の全フィールドを解説します。POS(スマレジ・Square)から取り込まれた顧客情報がこのモデルに正規化されます。
アプリケーション登録とは
レシートローラーのアプリケーション登録の概念を説明します。OAuthクライアントとしてアプリを登録することで、クライアントID・シークレット・リダイレクトURIが発行され、API・Webhook連携を始められます。
PosTransactionDto 仕様 — 取引データのフィールドリファレンス
レシートローラーが扱う取引データの正規モデル PosTransactionDto の全フィールドを解説します。識別子・日時・金額・明細・支払い・スタッフ・ステータス・CRM 連携の各カテゴリーごとに、フィールド名・型・意味・各 POS ベンダーからの埋め方をまとめた、開発者および外部システム連携担当者向けのリファレンスです。スマレジ・Square 双方のマッピング記事からも参照されます。
本番運用のベストプラクティス
レシートローラー連携アプリを本番運用するためのベストプラクティス(環境分離、監視、デプロイ、障害対応、ドキュメント整備)を解説します。
User系スコープの審査申請
レシートローラーで一般消費者のデータ(user.* スコープ)を扱うアプリに必要な審査申請の流れ、提出書類、審査基準、審査期間、よくある差し戻し理由を解説します。
レート制限とスロットリング
レシートローラーAPIのレート制限の単位、プラン別の上限、レスポンスヘッダーの読み方、429に当たらないための実装パターンを解説します。
在庫データ連携
レシートローラーの在庫データの構造、複数倉庫管理、入出庫履歴、Webhookによるリアルタイム同期、WMS連携パターンを解説します。
帳票・請求関連データ(対応範囲)
レシートローラーが扱う帳票・請求関連データの対応範囲、税率レポート、インボイス制度対応、会計ソフト連携の指針を解説します。
サポートへの問い合わせ(技術連携)
レシートローラー開発者向けサポートの種類、問い合わせ前のチェックリスト、効率的に解決を進めるための情報添付テンプレートを解説します。
署名検証とセキュリティ
レシートローラーWebhookのHMAC-SHA256署名検証の仕組み、検証コードのサンプル(Node.js / Python / C#)、リプレイ攻撃対策、シークレットの安全な管理方法を解説します。
User系スコープでapp_not_approvedが返る
User系スコープを使うとapp_not_approvedエラーが返る場合の確認手順。サンドボックス枠での開発、審査申請、サンドボックス本番化の流れを解説します。
利用できるデータ領域
レシートローラーの開発者ポータルから取得できるデータ領域を一覧で説明します。取引・商品・在庫・受注・顧客・クーポン・SNS・広告・個人ユーザーデータなど、各領域に含まれる内容と取得方法、必要なスコープをまとめています。
ビジネスアカウント・店舗・POS端末の一覧を取得する
レシートローラーのモバイルアプリ/サーバーアプリから、ユーザーが所属するビジネスアカウント、その配下の店舗、各店舗のPOS端末をREST APIで一覧する手順をまとめます。