クーポン一覧取得

Authorizations

AppAccessToken
pos.transactions:read
UserAccessToken
pos.transactions:read

Query Parameters

fields

array

検索パラメータ（カンマ区切りで指定可）
Response項目を指定可能
※一部項目(withで指定する項目、2階層目以降の項目)については指定不可

sort

string

並び順（カンマ区切りで指定可）

指定可能なパラメータ

couponId：クーポンID
updDateTime：更新日時

limit

integer

上限数

page

integer

ページ

serial_number

string

シリアル番号：端末側でのクーポンの入力に用いられます。

award_type

string

Allowed values: 1 2 3 P1 P2 P3 P4 M1 M2 M3 M4

特典タイプ：そのクーポンのタイプ。（1：値引、2：割引、3：商品付与、P1：0ポイント、P2：ポイント指定（上書き）、P3：ポイント追加（加算）、P4：ポイントN倍、M1：0マイル、M2：マイル指定（上書き）、M3：マイル追加（加算）、M4：マイルN倍）

apply_condition_division

string

Allowed values: 0 1

適用条件区分：クーポンの使用条件のうち、対象商品が含まれている必要があるか指定します。（0：全適用、1：対象商品が含まれる場合のみ適用）

start_date

date

利用可能開始日：クーポンの有効期限（開始日）[YYYY-MM-DD]

end_date

date

利用可能終了日：クーポンの有効期限（終了日）。[YYYY-MM-DD]

applicable-from

date

利用可能期間(From)：applicable-from から applicable-to までの期間で利用可能なクーポンを検索したい場合に指定します。[YYYY-MM-DD]

applicable-to

date

利用可能期間(To)：applicable-from から applicable-to までの期間で利用可能なクーポンを検索したい場合に指定します。[YYYY-MM-DD]

coupon_division

string

Allowed values: 0 1

クーポン区分：クーポン区分（0：通常、1：giftee）
※ 1:giftee は、プレミアムプラスプラン以上でのみ指定可能です。

200

取得成功

Array<object>

object

couponId

クーポンID

string

couponName

クーポン名

string

couponDivision

クーポン区分：クーポン区分（0：通常、1：giftee）

string

serialNumber

シリアル番号：端末側でのクーポンの入力に用いられます。

string

summary

概要

string

awardType

特典タイプ：そのクーポンのタイプ。（1：値引、2：割引、3：商品付与、P1：0ポイント、P2：ポイント指定（上書き）、P3：ポイント追加（加算）、P4：ポイントN倍、M1：0マイル、M2：マイル指定（上書き）、M3：マイル追加（加算）、M4：マイルN倍）

string

awardValue

特典値：特典タイプに応じた値を設定。

特典タイプ	設定値
1：値引	値引き額[円]
2：割引	割引率[%]
3：商品付与	0固定
P1：0ポイント	0固定
P2：ポイント指定（上書き）	ポイント数
P3：ポイント追加（加算）	差分ポイント数
P4：ポイントN倍	ポイントへ乗算する値
M1：0マイル	0固定
M2：マイル指定（上書き）	マイル数
M3：マイル追加（加算）	差分マイル数
M4：マイルN倍	マイルへ乗算する値

string

applyConditionDivision

適用条件区分：クーポンの使用条件のうち、対象商品が含まれている必要があるか指定します。（0：全適用、1：対象商品が含まれる場合のみ適用）

string

minTargetPrice

最低対象金額

string

maxTargetPrice

最高対象金額

string

startDate

利用可能開始日：クーポンの有効期限（開始日）。[YYYY-MM-DD]

string

endDate

利用可能終了日：クーポンの有効期限（終了日）。[YYYY-MM-DD]

string

combineDivision

併用区分：クーポン利用時に他クーポンとの併用が可能か否かを指定します。（1：併用不可、2：一部のクーポン(3:併用可能)と併用可能、3：併用可能）

string

insDateTime

作成日時：登録時の日時。[YYYY-MM-DDThh:mm:ssTZD]

string

updDateTime

更新日時：登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]

string

Example

[
  {
    "couponId": "string",
    "couponName": "string",
    "couponDivision": "string",
    "serialNumber": "string",
    "summary": "string",
    "awardType": "string",
    "awardValue": "string",
    "applyConditionDivision": "string",
    "minTargetPrice": "string",
    "maxTargetPrice": "string",
    "startDate": "string",
    "endDate": "string",
    "combineDivision": "string",
    "insDateTime": "string",
    "updDateTime": "string"
  }
]

403

プレミアムプラスプラン未満で、クーポン区分に 1:giftee を指定した場合

object

type

required

string

title

required

string

detail

string

status

integer

Examples

{
  "type": "about:blank",
  "title": "Forbidden",
  "detail": "[couponDivision] ご利用の契約では 1:giftee は指定できません。",
  "status": 403
}

クーポン一覧取得

対象プラン

Authorizations

Parameters

Query Parameters

Responses

200

Example

403

Examples