代表的なAPI例

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・クライアント生成

言語別の公式SDKは提供していません。代わりに、全エンドポイントの定義をOpenAPI（Swagger）形式で公開しています。

https://receiptroller.io/openapi/v1.json

このURLをAIコーディングアシスタントに渡す、または openapi-generator・NSwag・Kiota などのコード生成ツールに取り込むと、型付きのAPIクライアントを自動生成できます。手書きで実装する場合も、OAuth 2.0 と JSON HTTP に対応した汎用ライブラリ（axios、Requests、HttpClient等）でそのまま実装できます。

コミュニティで開発されているサンプルコードは開発者コミュニティで共有されています。