マーケティング担当者向け
クーポン・キャンペーンAPI
クーポンの発行・配布・利用履歴を管理します。キャンペーンやグループ単位での管理、利用検証・消込にも対応しています。
api/v1/store/coupons
APIリファレンスで確認
エンドポイント一覧
| メソッド | パス | 説明 | レスポンス |
|---|---|---|---|
| GET |
/api/v1/store/coupons/{id}
|
クーポン詳細を取得
割引タイプや条件を含むクーポンの詳細を取得します。
|
200 |
| POST |
/api/v1/store/coupons/
|
クーポンを作成・更新
コード、割引内容、有効期間を指定してクーポンを作成・更新します。
|
200 |
| DELETE |
/api/v1/store/coupons/{id}
|
クーポンを削除
クーポンレコードを削除します。
|
204 |
| POST |
/api/v1/store/coupons/../couponredemptions/verify
|
クーポン有効性を検証
クーポンコードが有効か、期限内か、利用条件を満たしているか確認します。
|
200 400 404 |
| POST |
/api/v1/store/coupons/../couponredemptions/redeem
|
クーポンを消込
クーポンを利用済みにし、トランザクション詳細を記録します。
|
200 400 |
エンドポイント詳細
割引タイプや条件を含むクーポンの詳細を取得します。
完全パス：
GET /api/v1/store/coupons/{id}
レスポンスコード：
200
コード、割引内容、有効期間を指定してクーポンを作成・更新します。
完全パス：
POST /api/v1/store/coupons/
レスポンスコード：
200
クーポンレコードを削除します。
完全パス：
DELETE /api/v1/store/coupons/{id}
レスポンスコード：
204
クーポンコードが有効か、期限内か、利用条件を満たしているか確認します。
完全パス：
POST /api/v1/store/coupons/../couponredemptions/verify
レスポンスコード：
200
400
404
クーポンを利用済みにし、トランザクション詳細を記録します。
完全パス：
POST /api/v1/store/coupons/../couponredemptions/redeem
レスポンスコード：
200
400
リクエスト例
リクエスト
POST /api/v1/store/couponredemptions/verify
Authorization: Bearer {access_token}
{
"couponCode": "SPRING2025",
"storeId": "store-001"
}
レスポンス
{
"valid": true,
"couponId": "cpn-123",
"discountType": "percentage",
"discountValue": 10,
"expiresAt": "2025-12-31T23:59:59Z"
}
認証について
このAPIを利用するには、Authorization: Bearer {access_token} ヘッダーが必要です。
トークンの取得方法は認証ガイドをご確認ください。