クーポン設定
クーポン検索
概要
基本情報
- リクエストパス:
GET /setting/coupons
- JWTスコープ:
setting:coupon:index
- 必須個別JWTパラメータ:
なし
- レートリミット:
5 rps
query
| key |
説明 |
制約など |
| ids |
クーポンID |
整数のみ、カンマ区切りで複数指定可能 |
| apply_type |
適用タイプ |
- |
| channel |
適用チャネル |
- |
| status |
ステータス |
- |
| page |
ページ |
整数のみ、デフォルト:1 |
| limit |
1ページあたりの件数 |
整数のみ、デフォルト:50、最大: 250 |
例
GET /setting/coupons?apply_type=MANUAL&channel=sas&status=ACTIVE
[
{
"id": 1,
"code": "CPTKU68C1TDS",
"store": {
"id": 1,
"name": "本店"
},
"name": "販売割引20%OFF",
"apply_type": "MANUAL"
}
]
| key |
type |
説明 |
| *.id |
int |
クーポンID |
| *.code |
string |
クーポンコード |
| *.store |
object | null |
店舗 |
| *.store.id |
int |
店舗ID |
| *.store.name |
string |
店舗名 |
| *.name |
string |
クーポン名 |
| *.apply_type |
string |
適用タイプ |
- ステータス
ACTIVE 有効
SCHEDULED スケジュール済み
EXPIRED 期限切れ
- 適用タイプ
- 適用チャネル
bas 店頭買取
bad 宅配買取
sas 店頭販売