APIリファレンスとドキュメントの見方
レシートローラーの開発者向けドキュメントの構成と使い分けを説明します。開発者ヘルプ・APIトップページ・SwaggerベースのAPIリファレンス・開発者コミュニティの4つの入り口と、AIアシスタントやコード生成ツールで使えるOpenAPI仕様(openapi/v1.json)の取得方法を案内します。
営業時間API(Business Hours API)の使い方
レシートローラーの営業時間API(/api/v1/stores/{storeId}/business-hours)のガイドです。曜日ごとの営業時間の取得・更新、特例営業日(臨時休業・営業時間変更)の登録、店舗の就業可能時間(シフト作成時の上限となる業務時間)の設定、現在営業中かどうかの判定までを解説します。
利用開始までの流れ
レシートローラーの開発者ポータル利用開始までの流れを説明します。店舗ユーザーとして登録し、スタータープラン以上であれば、別途の開発者申請なしですぐにアプリ登録とAPI実装を始められます。
User系スコープの審査申請
レシートローラーで一般消費者のデータ(user.* スコープ)を扱うアプリに必要な審査申請の流れ、提出書類、審査基準、審査期間、よくある差し戻し理由を解説します。
商品管理API(Products API)の使い方
レシートローラーの商品管理API(/api/v1/products)でビジネスアカウント配下の商品をCRUD操作するためのガイドです。Android/iOSアプリやサーバー連携でPIM(商品マスター)を読み書きする際の入門記事です。
SNS Webhookバイパス(LINEなど外部SNSのWebhook転送)
レシートローラーがLINE等のSNSプラットフォームから受け取ったWebhookを、店舗側の同意のもとで開発者アプリへ転送する「SNS Webhookバイパス」機能の仕組み、設定方法、署名の取り扱い、注意点を解説します。
アクセス制御と監査ログ
レシートローラー連携アプリ運用におけるアクセス制御の設計、最小権限、監査ログの取り方、定期レビューの実施方法を解説します。
従業員管理API(Staff API)の使い方
レシートローラーの従業員管理API(/api/v1/staff)でビジネスアカウント配下の従業員(スタッフ)をCRUD操作するためのガイドです。Square Team Member 互換のフィールド(カナ名、複数業務割当、給与構造)に対応しています。
利用目的・接続先(POS/EC/分析など)の申告
レシートローラーの開発者ポータルでアプリを登録する際に申告する「利用目的」と「接続先カテゴリ」(POS/EC/分析/CRM/OMS/WMS/SNS/その他)の意味、選び方、変更時の注意、User系スコープ審査との関連を解説します。
売上実績API(Sales API)の使い方
レシートローラーの売上実績API(/api/v1/sales/*)の概要と、ビジネスアカウント・店舗・POS端末・期間でのフィルタ方法をまとめます。実際のレスポンス構造(KpiValue 入れ子型)と averageTicket・トークン有効期限(8時間)まで網羅した、Android/iOS のモバイルアプリやサーバー連携で 売上ダッシュボードを実装するための入門ガイドです。
リクエストとレスポンスの基本(JSON)
レシートローラーAPIのリクエスト形式、必須ヘッダー、レスポンス構造、ページネーション、フィルタリング、日時形式の規則を解説します。
販売管理API(Orders / OMS API)の使い方
レシートローラーの販売管理API(/api/v1/orders)でビジネスアカウント配下の受注をCRUD操作するためのガイドです。注文の作成・更新・状態遷移(確認・処理中・キャンセル)・削除と、Android/iOSアプリやサーバー連携向けのフローをまとめます。
商品マスター(PIM)・カテゴリデータ
レシートローラーの商品マスター(PIM)・カテゴリ・バリエーションのデータ構造、CRUD操作、SKU管理、ECとの同期パターンを解説します。
在庫データ連携
レシートローラーの在庫データの構造、複数倉庫管理、入出庫履歴、Webhookによるリアルタイム同期、WMS連携パターンを解説します。
CrmCustomerDto リファレンス
レシートローラーの顧客マスタである CrmCustomerDto の全フィールドを解説します。POS(スマレジ・Square)から取り込まれた顧客情報がこのモデルに正規化されます。
レート制限とスロットリング
レシートローラーAPIのレート制限の単位、プラン別の上限、レスポンスヘッダーの読み方、429に当たらないための実装パターンを解説します。
データ保護(匿名化・暗号化)の考え方
レシートローラー連携アプリでのデータ保護の考え方、暗号化(保管時・通信時)、匿名化・仮名化のテクニック、削除ポリシーを解説します。
サポートへの問い合わせ(技術連携)
レシートローラー開発者向けサポートの種類、問い合わせ前のチェックリスト、効率的に解決を進めるための情報添付テンプレートを解説します。
ネイティブモバイルアプリ向けガイド: 複数ビジネスアカウントアクセスと OAuth フロー
Android / iOS のネイティブアプリ向け実装ガイド。アプリ登録時に「認可時に1つのビジネスアカウントへトークンを紐付ける」をオフにすると、user-scoped OAuth トークンが発行されます。/api/v1/me/organizations + ?organizationId= パターンで複数ビジネスアカウントを横断アクセスできます。