レート制限とスロットリング
レシートローラーAPIのレート制限の単位、プラン別の上限、レスポンスヘッダーの読み方、429に当たらないための実装パターンを解説します。
アクセストークンの取得と更新
レシートローラーAPIで使うアクセストークンとリフレッシュトークンの取得方法、有効期限、更新手順、エラー時の対処を解説します。
StaffDto リファレンス
レシートローラーのスタッフ(従業員)マスタである StaffDto の全フィールドを解説します。POS(Square Team / スマレジ)との関連付け、店舗アサイン、雇用形態などの構造をまとめています。
ProductDto リファレンス
レシートローラーの商品マスタ(PIM)である ProductDto の全フィールドを解説します。POS(Square)からの商品カタログ同期、原価・店舗別価格・バリエーション・プレオーダーなどの構造をまとめています。
CrmCustomerDto リファレンス
レシートローラーの顧客マスタである CrmCustomerDto の全フィールドを解説します。POS(スマレジ・Square)から取り込まれた顧客情報がこのモデルに正規化されます。
エラーコードとリトライ指針
レシートローラーAPIが返すHTTPステータスコードとエラーコードの一覧、リトライすべきケース、リトライ間隔の指針を解説します。
ネイティブモバイルアプリ向けガイド: 複数ビジネスアカウントアクセスと OAuth フロー
Android / iOS のネイティブアプリ向け実装ガイド。アプリ登録時に「認可時に1つのビジネスアカウントへトークンを紐付ける」をオフにすると、user-scoped OAuth トークンが発行されます。/api/v1/me/organizations + ?organizationId= パターンで複数ビジネスアカウントを横断アクセスできます。
403/401が返る(権限・スコープ)
API呼び出しで401や403が返るときの原因切り分け。トークン無効・スコープ不足・店舗アクセス権なし・User系審査未通過などの典型ケースを解説します。
ビジネスアカウント・店舗・POS端末の一覧を取得する
レシートローラーのモバイルアプリ/サーバーアプリから、ユーザーが所属するビジネスアカウント、その配下の店舗、各店舗のPOS端末をREST APIで一覧する手順をまとめます。
在庫管理API(Inventory / WMS API)の使い方
レシートローラーの在庫管理API(Inventory / WMS API)の実装ガイドです。ロケーション単位の在庫照会・調整・移動履歴の取得方法、必要な OAuth スコープ、Shopify 連携時の自動反映、MCP ツール(wms_get_stock / wms_adjust_stock など)からの利用方法を解説します。
OAuthスコープ一覧と利用可否
レシートローラーのOAuth APIで利用できるスコープの一覧と、各スコープがどの種類のアプリに付与されるかを説明します。User系スコープの審査要件、Store系とUser系を混在できない理由、LIFFアプリからの利用方法もカバーします。
営業時間API(Business Hours API)の使い方
レシートローラーの営業時間API(/api/v1/stores/{storeId}/business-hours)のガイドです。曜日ごとの営業時間の取得・更新、特例営業日(臨時休業・営業時間変更)の登録、店舗の就業可能時間(シフト作成時の上限となる業務時間)の設定、現在営業中かどうかの判定までを解説します。
販売管理API(Orders / OMS API)の使い方
レシートローラーの販売管理API(/api/v1/orders)でビジネスアカウント配下の受注をCRUD操作するためのガイドです。注文の作成・更新・状態遷移(確認・処理中・キャンセル)・削除と、Android/iOSアプリやサーバー連携向けのフローをまとめます。
店舗内メディアディスプレイAPI(Display API)の使い方
レシートローラーの店舗内 Android ディスプレイ向け API(/api/v1/displays/*)の概要とペアリング・ハートビート・プレイリスト取得・再生実績報告の手順をまとめます。Android キオスクや店舗サイネージ端末でメディアループを再生するアプリを実装するための入門ガイドです。
売上実績API(Sales API)の使い方
レシートローラーの売上実績API(/api/v1/sales/*)の概要と、ビジネスアカウント・店舗・POS端末・期間でのフィルタ方法をまとめます。実際のレスポンス構造(KpiValue 入れ子型)と averageTicket・トークン有効期限(8時間)まで網羅した、Android/iOS のモバイルアプリやサーバー連携で 売上ダッシュボードを実装するための入門ガイドです。
従業員管理API(Staff API)の使い方
レシートローラーの従業員管理API(/api/v1/staff)でビジネスアカウント配下の従業員(スタッフ)をCRUD操作するためのガイドです。Square Team Member 互換のフィールド(カナ名、複数業務割当、給与構造)に対応しています。
商品管理API(Products API)の使い方
レシートローラーの商品管理API(/api/v1/products)でビジネスアカウント配下の商品をCRUD操作するためのガイドです。Android/iOSアプリやサーバー連携でPIM(商品マスター)を読み書きする際の入門記事です。