コンテンツにスキップ

値引/割引区分一覧取得

GET
/discount_divisions

値引/割引区分の一覧を取得します。

対象プラン

  • スタンダード
  • プレミアム
  • プレミアムプラス
  • フードビジネス
  • リテールビジネス
fields
array

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

sort
string

並び順(カンマ区切りで指定可)

指定可能なパラメータ

  • discountDivision:値引/割引区分
  • displaySequence:表示順
limit
integer

上限数

page
integer

ページ

discount_division
string

値引/割引区分:値引/割引区分を一意に識別する番号であり、管理画面の[設定]→[販売設定]→[値引区分] / [割引区分]のページで確認できる「ID」に該当する。
※取引時、小計値引/割引区分または単品値引/割引区分に対して指定可能。

award_type
string
Allowed values: 1 2

1:値引、2:割引

display_flag
string
Allowed values: 0 1

有効/無効:端末で表示するかを設定。(0:無効、1:有効)

取得成功

Array<object>
object
discountDivision

値引/割引区分:値引/割引区分を一意に識別する番号であり、管理画面の[設定]→[販売設定]→[値引区分] / [割引区分]のページで確認できる「ID」に該当する。
※取引時、小計値引/割引区分または単品値引/割引区分に対して指定可能。

string
awardType

1:値引、2:割引

string
discountDivisionName

値引/割引区分名称

string
displaySequence

表示順

string
displayFlag

有効/無効:端末で表示するかを設定。(0:無効、1:有効)

string
insDateTime

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

string
updDateTime

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

string
Example
[
{
"discountDivision": "string",
"awardType": "string",
"discountDivisionName": "string",
"displaySequence": "string",
"displayFlag": "string",
"insDateTime": "string",
"updDateTime": "string"
}
]