セール商品一覧取得

GET

/bargain/{bargain_id}/products

const url = 'https://api.smaregi.dev/TARGET-CONTRACT-ID/pos/bargain/example/products?target_division=1';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.smaregi.dev/TARGET-CONTRACT-ID/pos/bargain/example/products?target_division=1' \
  --header 'Authorization: Bearer <token>'

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

対象プラン

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

Authorizations

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

Parameters

Path Parameters

bargain_id

required

string

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

Query Parameters

fields

array

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

sort

string

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

指定可能なパラメータ

targetDivision：対象区分
targetId：対象ID

limit

integer

上限数

page

integer

ページ

target_division

string

Allowed values: 1 2 3

対象区分：(1:部門、2:商品、3:グループコード)

target_id

string

対象ID：部門ID, 商品ID, グループコードのいずれかを設定
※ ユーザーアクセストークンを利用する場合で商品IDを指定する場合、ユーザーの所属する店舗で販売している商品IDを指定してください。

Responses

200

取得成功

application/json

Array<object>

object

bargainProductId

セール商品ID：セールID、対象区分、対象ID の3つの値によって定まる一意なID

string

bargainId

セールID

string

targetDivision

対象区分：(1:部門、2:商品、3:グループコード)

string

Allowed values: 1 2 3

targetId

対象ID：部門ID, 商品ID, グループコードのいずれかを設定

string

division

割引区分：(1:割引 2:値引 3:価格指定)

string

Allowed values: 1 2 3

value

値：割引、値引き、価格指定の値

string

insDateTime

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

string

updDateTime

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

string

Example

[
  {
    "bargainProductId": "string",
    "bargainId": "string",
    "targetDivision": "1",
    "targetId": "string",
    "division": "1",
    "value": "string",
    "insDateTime": "string",
    "updDateTime": "string"
  }
]