セール一覧取得

GET

/bargain

• サンドボックス
• 本番

セール情報一覧を取得します。

対象プラン

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

Authorizations

• AppAccessToken
  pos.products:read
• UserAccessToken
  pos.products:read

Parameters

Query Parameters

fields

array

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

sort

string

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

指定可能なパラメータ

• bargainId：セールID：
• termStart：適用開始日時：[YYYY-MM-DD]
• termEnd：適用終了日時：[YYYY-MM-DD]

limit

integer

上限数

page

integer

ページ

bargain_id

string

セールID
※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗で実施されるセールIDを指定してください。

bargain_product_id

string

セール商品ID：
セールID、対象区分、対象ID の3つの値によって定まる一意なID
※ 対象区分(部門、商品、グループ)・対象ID(部門ID、商品ID、グループコード)

term_start

string

適用開始日時：[YYYY-MM-DD]

term_end

string

適用終了日時：[YYYY-MM-DD]

Responses

200

取得成功

Array<object>

object

bargainId

セールID：

string

bargainName

セール名称：

string

termStart

適用開始日時：[YYYY-MM-DD]

string

termEnd

適用終了日時：[YYYY-MM-DD]

string

insDateTime

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

string

updDateTime

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

string

Example

[
  {
    "bargainId": "string",
    "bargainName": "string",
    "termStart": "string",
    "termEnd": "string",
    "insDateTime": "string",
    "updDateTime": "string"
  }
]