店舗情報API(Store Information API)の使い方
店舗の基本情報(店舗名・店舗種別・連絡先・住所)を取得・更新する REST API のガイドです。スタッフアプリなどのトークン認証クライアントから店舗情報の編集を実装できます。
取引一覧API(Transactions API:POS+OMS統合フィード)の使い方
レシートローラーのTransactions APIは、レジ売上(PosTransactions)と販売管理注文(OmsOrders)を1つのフィードに統合した読み取り専用APIです。Android/iOSアプリで「ビジネスアカウント全体の取引」を一覧表示する際の入り口になります。
販売管理API(Orders / OMS API)の使い方
レシートローラーの販売管理API(/api/v1/orders)でビジネスアカウント配下の受注をCRUD操作するためのガイドです。注文の作成・更新・状態遷移(確認・処理中・キャンセル)・削除と、Android/iOSアプリやサーバー連携向けのフローをまとめます。
営業時間API(Business Hours API)の使い方
レシートローラーの営業時間API(/api/v1/stores/{storeId}/business-hours)のガイドです。曜日ごとの営業時間の取得・更新、特例営業日(臨時休業・営業時間変更)の登録、店舗の就業可能時間(シフト作成時の上限となる業務時間)の設定、現在営業中かどうかの判定までを解説します。
予約管理API(Reservations API)の使い方
レシートローラーの予約管理API(/api/v1/reservations)のガイドです。予約のCRUD・ステータス更新、予約枠(スロット)の取得・作成・一括生成、店舗レイアウトに登録された席(テーブル・個室・カウンター)の取得、予約統計までを解説します。
商品管理API(Products API)の使い方
レシートローラーの商品管理API(/api/v1/products)でビジネスアカウント配下の商品をCRUD操作するためのガイドです。Android/iOSアプリやサーバー連携でPIM(商品マスター)を読み書きする際の入門記事です。
在庫管理API(Inventory / WMS API)の使い方
レシートローラーの在庫管理API(Inventory / WMS API)の実装ガイドです。ロケーション単位の在庫照会・調整・移動履歴の取得方法、必要な OAuth スコープ、Shopify 連携時の自動反映、MCP ツール(wms_get_stock / wms_adjust_stock など)からの利用方法を解説します。
APIリファレンスとドキュメントの見方
レシートローラーの開発者向けドキュメントの構成と使い分けを説明します。開発者ヘルプ・APIトップページ・SwaggerベースのAPIリファレンス・開発者コミュニティの4つの入り口と、AIアシスタントやコード生成ツールで使えるOpenAPI仕様(openapi/v1.json)の取得方法を案内します。
従業員管理API(Staff API)の使い方
レシートローラーの従業員管理API(/api/v1/staff)でビジネスアカウント配下の従業員(スタッフ)をCRUD操作するためのガイドです。Square Team Member 互換のフィールド(カナ名、複数業務割当、給与構造)に対応しています。
店舗内メディアディスプレイAPI(Display API)の使い方
レシートローラーの店舗内 Android ディスプレイ向け API(/api/v1/displays/*)の概要とペアリング・ハートビート・プレイリスト取得・再生実績報告の手順をまとめます。Android キオスクや店舗サイネージ端末でメディアループを再生するアプリを実装するための入門ガイドです。
売上実績API(Sales API)の使い方
レシートローラーの売上実績API(/api/v1/sales/*)の概要と、ビジネスアカウント・店舗・POS端末・期間でのフィルタ方法をまとめます。実際のレスポンス構造(KpiValue 入れ子型)と averageTicket・トークン有効期限(8時間)まで網羅した、Android/iOS のモバイルアプリやサーバー連携で 売上ダッシュボードを実装するための入門ガイドです。
代表的なAPI例
レシートローラーAPIの代表的なエンドポイントの呼び出し例(レシート取得・店舗一覧・商品作成・Webhook登録)をcurlコマンドで紹介します。
ストアアプリ コンテンツAPI(お知らせ・ページ・営業情報)の使い方
ストアアプリのコンテンツ(お知らせ・ページ・マニフェスト・営業情報・会員証設定)を取得する /api/v1/apps/{shopId}/* の使い方です。shopId はビジネスアカウント ID と同一であること、ビジネスアカウント単位コンテンツと店舗単位コンテンツの違い、認証の扱いを解説します。
リクエストとレスポンスの基本(JSON)
レシートローラーAPIのリクエスト形式、必須ヘッダー、レスポンス構造、ページネーション、フィルタリング、日時形式の規則を解説します。
開発者ポータルでできること
レシートローラーの開発者ポータルでできることを概観します。REST APIによるデータ取得・操作、Webhookによるリアルタイムイベント受信を組み合わせて、外部システムから店舗・ユーザーデータを連携できます。
アクセストークンの取得と更新
レシートローラーAPIで使うアクセストークンとリフレッシュトークンの取得方法、有効期限、更新手順、エラー時の対処を解説します。
利用開始までの流れ
レシートローラーの開発者ポータル利用開始までの流れを説明します。店舗ユーザーとして登録し、スタータープラン以上であれば、別途の開発者申請なしですぐにアプリ登録とAPI実装を始められます。
エンドポイントとバージョニング
レシートローラーAPIのベースURL、バージョニング方針、廃止予告の流れ、現行バージョンの確認方法を解説します。
ネイティブモバイルアプリ向けガイド: 複数ビジネスアカウントアクセスと OAuth フロー
Android / iOS のネイティブアプリ向け実装ガイド。アプリ登録時に「認可時に1つのビジネスアカウントへトークンを紐付ける」をオフにすると、user-scoped OAuth トークンが発行されます。/api/v1/me/organizations + ?organizationId= パターンで複数ビジネスアカウントを横断アクセスできます。