代表的なAPI例
API
サンプル
curl
レシート取得
この記事の対象
APIを初めて触る開発者向けの動作確認用サンプル集です。実装言語に依存しないcurlで紹介します。
APIを初めて触る開発者向けの動作確認用サンプル集です。実装言語に依存しないcurlで紹介します。
すべての例で $TOKEN にアクセストークンが入っているものとします。完全な仕様はAPIリファレンス(Swagger)を参照してください。
1. 自分の店舗一覧を取得
curl https://api.receiptroller.io/v1/stores \ -H "Authorization: Bearer $TOKEN"
レスポンス
{
"object": "list",
"data": [
{
"id": "str_abc123",
"name": "渋谷店",
"currency": "JPY",
"created_at": "2025-12-01T00:00:00Z"
}
],
"has_more": false
}
2. 過去24時間のレシートを取得
curl "https://api.receiptroller.io/v1/receipts?store_id=str_abc123&issued_after=2026-04-26T00:00:00Z&limit=50" \ -H "Authorization: Bearer $TOKEN"
3. 個別レシートの明細を取得
curl https://api.receiptroller.io/v1/receipts/rcp_xyz789 \ -H "Authorization: Bearer $TOKEN"
レスポンス(一部)
{
"id": "rcp_xyz789",
"store_id": "str_abc123",
"issued_at": "2026-04-27T10:15:22Z",
"total_amount": 3850,
"tax_amount": 350,
"currency": "JPY",
"items": [
{
"product_id": "prd_a01",
"name": "コーヒー豆 200g",
"quantity": 1,
"unit_price": 1500,
"amount": 1500
},
{
"product_id": "prd_a02",
"name": "ドリッパー",
"quantity": 1,
"unit_price": 2000,
"amount": 2000
}
],
"payment_method": "credit_card"
}
4. 商品を新規作成
curl -X POST https://api.receiptroller.io/v1/products \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: 01HV6N3M2K9PQR" \
-d '{
"store_id": "str_abc123",
"sku": "COFFEE-200G-001",
"name": "コーヒー豆 エチオピア 200g",
"price": 1800,
"currency": "JPY",
"tax_rate": 0.10
}'
5. 在庫数を更新
curl -X PATCH https://api.receiptroller.io/v1/inventory/prd_a01 \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"quantity": 42,
"warehouse_id": "wh_main"
}'
6. Webhookエンドポイントを登録
curl -X POST https://api.receiptroller.io/v1/webhook_endpoints \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"url": "https://app.example.com/webhook",
"events": ["receipt.issued", "receipt.refunded"],
"description": "本番 - 在庫同期用"
}'
7. 自分のユーザー情報を取得(User系スコープ)
curl https://api.receiptroller.io/v1/me \ -H "Authorization: Bearer $USER_TOKEN"
※ $USER_TOKEN は user.profile スコープで取得した一般消費者のトークンです。
8. ユーザー本人のレシート一覧(User系スコープ)
curl "https://api.receiptroller.io/v1/me/receipts?limit=20" \ -H "Authorization: Bearer $USER_TOKEN"
言語別SDK・ライブラリ
2026年4月時点で公式SDKは提供していません。OAuth 2.0 と JSON HTTPに対応した汎用ライブラリ(axios、Requests、HttpClient等)でそのまま実装できます。
コミュニティで開発されているサンプルコードは開発者コミュニティで共有されています。
関連ガイド
公開日: 2026-04-27
更新日: 2026-04-27
カテゴリ
タグ
API (17)
OAuth (11)
Android (8)
Webhook (8)
iOS (7)
api (6)
oauth (5)
トラブル (5)
POS連携 (4)
getting-started (4)
関連記事
-
リクエストとレスポンスの基本(JSON)レシートローラーAPIのリクエスト形式、必須ヘッダー、レスポンス構造、ページネーション、フィルタリング、日時形式の規則を解説します。
-
ネイティブモバイルアプリ向けガイド: 複数ビジネスアカウントアクセスと OAuth フローAndroid / iOS のネイティブアプリ向け実装ガイド。アプリ登録時に「認可時に1つのビジネスアカウントへトークンを紐付ける」をオフにすると、user-scoped OAuth トークンが発行されます。/api/v1/me/organizations + ?organizationId= パターンで複数ビジネスアカウントを横断アクセスできます。
-
取引一覧API(Transactions API:POS+OMS統合フィード)の使い方レシートローラーのTransactions APIは、レジ売上(PosTransactions)と販売管理注文(OmsOrders)を1つのフィードに統合した読み取り専用APIです。Android/iOSアプリで「ビジネスアカウント全体の取引」を一覧表示する際の入り口になります。
-
PosTransactionDto 仕様 — 取引データのフィールドリファレンスレシートローラーが扱う取引データの正規モデル PosTransactionDto の全フィールドを解説します。識別子・日時・金額・明細・支払い・スタッフ・ステータス・CRM 連携の各カテゴリーごとに、フィールド名・型・意味・各 POS ベンダーからの埋め方をまとめた、開発者および外部システム連携担当者向けのリファレンスです。スマレジ・Square 双方のマッピング記事からも参照されます。
-
商品管理API(Products API)の使い方レシートローラーの商品管理API(/api/v1/products)でビジネスアカウント配下の商品をCRUD操作するためのガイドです。Android/iOSアプリやサーバー連携でPIM(商品マスター)を読み書きする際の入門記事です。