開発者ポータルでできること
レシートローラーの開発者ポータルでできることを概観します。REST APIによるデータ取得・操作、Webhookによるリアルタイムイベント受信を組み合わせて、外部システムから店舗・ユーザーデータを連携できます。
利用開始までの流れ
レシートローラーの開発者ポータル利用開始までの流れを説明します。店舗ユーザーとして登録し、スタータープラン以上であれば、別途の開発者申請なしですぐにアプリ登録とAPI実装を始められます。
営業時間API(Business Hours API)の使い方
レシートローラーの営業時間API(/api/v1/stores/{storeId}/business-hours)のガイドです。曜日ごとの営業時間の取得・更新、特例営業日(臨時休業・営業時間変更)の登録、店舗の就業可能時間(シフト作成時の上限となる業務時間)の設定、現在営業中かどうかの判定までを解説します。
開発者向けヘルプ目次
レシートローラー開発者向けヘルプ目次です。開発者申請、アプリケーション登録、OAuth認証とスコープ、実装ガイド(ウォレットアプリ・店舗向けWebhook・Survey API)、データ領域別ガイド、運用とセキュリティ、コミュニティ、トラブルシューティングまでをまとめています。
エラーコードとリトライ指針
レシートローラーAPIが返すHTTPステータスコードとエラーコードの一覧、リトライすべきケース、リトライ間隔の指針を解説します。
アプリを新規作成する
レシートローラーの開発者ポータルで新しいアプリ(OAuthクライアント)を登録する具体的な手順を説明します。入力項目・バリデーション・作成後のクレデンシャル表示・よくあるエラーまでをカバーします。
Webhookが届かない
Webhookが受信エンドポイントに届かないときの原因切り分け。エンドポイント設定・購読イベント・到達性・署名検証失敗・ファイアウォールなどを順に確認する手順を解説します。
販売管理API(Orders / OMS API)の使い方
レシートローラーの販売管理API(/api/v1/orders)でビジネスアカウント配下の受注をCRUD操作するためのガイドです。注文の作成・更新・状態遷移(確認・処理中・キャンセル)・削除と、Android/iOSアプリやサーバー連携向けのフローをまとめます。
利用できるデータ領域
レシートローラーの開発者ポータルから取得できるデータ領域を一覧で説明します。取引・商品・在庫・受注・顧客・クーポン・SNS・広告・個人ユーザーデータなど、各領域に含まれる内容と取得方法、必要なスコープをまとめています。
商品管理API(Products API)の使い方
レシートローラーの商品管理API(/api/v1/products)でビジネスアカウント配下の商品をCRUD操作するためのガイドです。Android/iOSアプリやサーバー連携でPIM(商品マスター)を読み書きする際の入門記事です。
リクエストとレスポンスの基本(JSON)
レシートローラーAPIのリクエスト形式、必須ヘッダー、レスポンス構造、ページネーション、フィルタリング、日時形式の規則を解説します。
予約管理API(Reservations API)の使い方
レシートローラーの予約管理API(/api/v1/reservations)のガイドです。予約のCRUD・ステータス更新、予約枠(スロット)の取得・作成・一括生成、店舗レイアウトに登録された席(テーブル・個室・カウンター)の取得、予約統計までを解説します。
ProductDto リファレンス
レシートローラーの商品マスタ(PIM)である ProductDto の全フィールドを解説します。POS(Square)からの商品カタログ同期、原価・店舗別価格・バリエーション・プレオーダーなどの構造をまとめています。
利用目的・接続先(POS/EC/分析など)の申告
レシートローラーの開発者ポータルでアプリを登録する際に申告する「利用目的」と「接続先カテゴリ」(POS/EC/分析/CRM/OMS/WMS/SNS/その他)の意味、選び方、変更時の注意、User系スコープ審査との関連を解説します。
User系スコープの審査申請
レシートローラーで一般消費者のデータ(user.* スコープ)を扱うアプリに必要な審査申請の流れ、提出書類、審査基準、審査期間、よくある差し戻し理由を解説します。
ビジネスアカウント・店舗・POS端末の一覧を取得する
レシートローラーのモバイルアプリ/サーバーアプリから、ユーザーが所属するビジネスアカウント、その配下の店舗、各店舗のPOS端末をREST APIで一覧する手順をまとめます。
Webhookの登録方法
レシートローラーの開発者ポータルでWebhookエンドポイントを登録する手順、購読イベントの選び方、テスト配信、複数エンドポイントの使い分け、削除と一時停止の方法を解説します。
商品マスター(PIM)・カテゴリデータ
レシートローラーの商品マスター(PIM)・カテゴリ・バリエーションのデータ構造、CRUD操作、SKU管理、ECとの同期パターンを解説します。
代表的なAPI例
レシートローラーAPIの代表的なエンドポイントの呼び出し例(レシート取得・店舗一覧・商品作成・Webhook登録)をcurlコマンドで紹介します。