APIドキュメント
レシートローラーのリテールメディアAPIを利用するための開発ガイドです。
購買データ、広告、売上、在庫、帳票などを連携し、リテールDXを支えるアプリを構築できます。
APIカタログ
購買・広告・CRM・AI・EC・店舗DXなど、すべての機能を統合したAPI群。
カテゴリ・利用対象で絞り込み、必要なAPIをすぐに探せます。
認証とアクセス
APIの利用にはOAuth 2.0 認可コードフローによる認証が必要です。
開発者がアプリを登録し、ビジネスオーナーがアクセスを許可すると、トークンを取得してAPIを呼び出せます。
GET /oauth/authorize ?client_id=YOUR_CLIENT_ID &redirect_uri=YOUR_REDIRECT_URI &response_type=code &scope=store.products.read &state=RANDOM_STATE → ビジネスオーナーが同意画面で許可 → redirect_uri?code=AUTH_CODE
POST /api/v1/auth/token
Content-Type: application/json
{
"grantType": "authorization_code",
"clientId": "YOUR_CLIENT_ID",
"clientSecret": "YOUR_SECRET",
"code": "AUTH_CODE",
"redirectUri": "YOUR_REDIRECT_URI"
}
→ accessToken + refreshToken を取得
取得したトークンはリクエストヘッダに設定して利用します：
Authorization: Bearer {access_token}
リクエスト例
以下は購買データを取得するAPIの例です。 商品名、価格、購入店舗、購入日時などを取得できます。
GET /api/v1/store/receipts/{id}
Authorization: Bearer {access_token}
{
"store": "Example Store",
"total": 842,
"items": [
{ "name": "コーヒーM", "price": 180 },
{ "name": "サンドイッチ", "price": 420 }
],
"timestamp": "2025-11-11T10:32:45Z"
}
全エンドポイントを見る（APIリファレンス）
OpenAPI仕様（マシンリーダブル）
全エンドポイントの定義をOpenAPI（Swagger）形式で公開しています。
AIコーディングアシスタントやコード生成ツールにこのURLを渡すだけで、
型付きAPIクライアントを自動生成できます。
https://receiptroller.io/openapi/v1.json
Webhookによるリアルタイム連携
購買や広告クリックなどのイベント発生時に、指定したURLへリアルタイムで通知します。
販促アプリや社内分析システムとの自動連携に利用できます。
POST /webhook/purchase
{
"event": "purchase.completed",
"receipt_id": "rcp-8421093",
"total": 842,
"timestamp": "2025-11-11T10:32:45Z"
}