コンシューマー向け
ユーザークーポンAPI
コンシューマー（エンドユーザー）向けのクーポン取得APIです。ユーザーがお気に入り登録している店舗のクーポン一覧と、個別クーポン詳細の取得に対応しています。OAuth 2.0のuser.coupons.readスコープが必要です。
api/v1/user/coupons
APIリファレンスで確認
エンドポイント一覧
| メソッド | パス | 説明 | レスポンス |
|---|---|---|---|
| GET |
/api/v1/user/coupons/
|
クーポン一覧を取得（お気に入り店舗から）
ユーザーのお気に入り店舗のアクティブなクーポンを一括取得します。有効期限が近い順に返します。スコープ: user.coupons.read
|
200 401 403 |
| GET |
/api/v1/user/coupons/{storeId}/{couponId}
|
クーポン詳細を取得
店舗IDとクーポンIDを指定して単一クーポンの詳細を取得します。スコープ: user.coupons.read
|
200 404 401 |
エンドポイント詳細
ユーザーのお気に入り店舗のアクティブなクーポンを一括取得します。有効期限が近い順に返します。スコープ: user.coupons.read
完全パス：
GET /api/v1/user/coupons/
レスポンスコード：
200
401
403
店舗IDとクーポンIDを指定して単一クーポンの詳細を取得します。スコープ: user.coupons.read
完全パス：
GET /api/v1/user/coupons/{storeId}/{couponId}
レスポンスコード：
200
404
401
リクエスト例
リクエスト
GET /api/v1/user/coupons
Authorization: Bearer {access_token}
レスポンス
[
{
"storeId": "store-abc",
"storeName": "ファミリーマート 新宿店",
"couponId": "cpn-001",
"name": "コーヒー100円引き",
"code": "COFFEE100",
"discountType": "Fixed",
"discountValue": 100,
"validUntil": "2026-04-30T23:59:59Z",
"isExpired": false,
"isFullyUsed": false
}
]
認証について
このAPIを利用するには、Authorization: Bearer {access_token} ヘッダーが必要です。
トークンの取得方法は認証ガイドをご確認ください。