APIリファレンスとドキュメントの見方
レシートローラーの開発者向けドキュメントの構成と使い分けを説明します。開発者ヘルプ・APIトップページ・SwaggerベースのAPIリファレンス・開発者コミュニティの4つの入り口と、AIアシスタントやコード生成ツールで使えるOpenAPI仕様(openapi/v1.json)の取得方法を案内します。
PosTransactionDto 仕様 — 取引データのフィールドリファレンス
レシートローラーが扱う取引データの正規モデル PosTransactionDto の全フィールドを解説します。識別子・日時・金額・明細・支払い・スタッフ・ステータス・CRM 連携の各カテゴリーごとに、フィールド名・型・意味・各 POS ベンダーからの埋め方をまとめた、開発者および外部システム連携担当者向けのリファレンスです。スマレジ・Square 双方のマッピング記事からも参照されます。
CrmCustomerDto リファレンス
レシートローラーの顧客マスタである CrmCustomerDto の全フィールドを解説します。POS(スマレジ・Square)から取り込まれた顧客情報がこのモデルに正規化されます。
ProductDto リファレンス
レシートローラーの商品マスタ(PIM)である ProductDto の全フィールドを解説します。POS(Square)からの商品カタログ同期、原価・店舗別価格・バリエーション・プレオーダーなどの構造をまとめています。
StaffDto リファレンス
レシートローラーのスタッフ(従業員)マスタである StaffDto の全フィールドを解説します。POS(Square Team / スマレジ)との関連付け、店舗アサイン、雇用形態などの構造をまとめています。
購買・レシートデータ連携
レシートローラーが扱う購買・レシートデータの構造、取得方法、関連スコープ、Webhook、よくあるユースケースを解説します。
商品管理API(Products API)の使い方
商品API(/api/v1/products)の一覧・取得・作成・PATCHとPUTによる更新・論理削除・画像アップロードを、項目名と注意点つきで説明します。
商品マスタを自社システムと同期する
手元のCSV・JSONを読み、SKUで照合して商品を作成・差分更新するNode.jsスクリプトを、商品APIで作ります。
Webhookで新しい売上を受け取り、Slackに通知する
receipt.created Webhookを登録し、Node.jsで署名検証と重複除去をしてSlackに売上を投稿するまでを手順で説明します。
エンドポイントとバージョニング
レシートローラーAPIのベースURL、バージョニング方針、廃止予告の流れ、現行バージョンの確認方法を解説します。
監視と失敗時の対応
Webhookの有効状態・最終送信日時・配信ログの見方と、自動で無効になったことに気づいて復旧し、抜けた期間をAPIで補う方法を説明します。
エラーコードとリトライ指針
レシートローラーAPIのエラー時のステータスコードと本文の形、トークンエンドポイントのエラー、送り直してよいケースと方法を説明します。
はじめてのAPI呼び出し:アプリ登録から取引一覧の取得まで
OAuth認可コードフロー(PKCE)でトークンを取得し、ビジネスアカウントを確認して取引一覧を取得、トークンを更新するまでを通して行います。
Webhookの登録方法
開発者ポータルの画面とAPIでWebhookを登録する手順、購読イベントの選び方、テスト送信、変更・一時停止・削除の方法を説明します。
予約管理API(Reservations API)の使い方
予約管理APIで予約の取得・作成・変更・時間変更、予約枠の生成、メニューの空き時刻、予約設定、席、月次件数を扱う方法です。
店舗の予約を自社のカレンダーに表示する
予約管理APIで店舗の7日分の予約を取得し、Node.jsでiCalendar(.ics)ファイルに書き出してカレンダーに表示する手順です。