コンテンツにスキップ
スマレジ・プラットフォームAPI 仕様書

セール商品登録

POST
/bargain/{bargain_id}/products

セール商品情報を登録します。

対象プラン

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

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
bargain_id
required
string

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

Request Body

Section titled “Request Body ”
object
targetDivision
required
対象区分

1:カテゴリー, 2:商品, 3:グループコード

string
Allowed values: 1 2 3
targetId
required
対象ID

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

string
<= 255 characters
division
required
割引区分

1:割引 2:値引 3:価格指定

string
Allowed values: 1 2 3
value
required
値

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

string format: int
<= 9999999999
Example
{
  "targetDivision": "1",
  "targetId": "string",
  "division": "1",
  "value": "1234567890"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

取得成功

object
bargainProductId

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

string
bargainId

セールID

string
targetDivision

1:カテゴリー, 2:商品, 3:グループコード

string
targetId

カテゴリーID, 商品ID, グループコードのいずれか

string
division

1:割引 2:値引 3:価格指定

string
value

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

string
insDateTime

登録時・更新時の日時

string
updDateTime

登録時・更新時の日時

string
Example
{
  "bargainProductId": "string",
  "bargainId": "string",
  "targetDivision": "string",
  "targetId": "string",
  "division": "string",
  "value": "string",
  "insDateTime": "string",
  "updDateTime": "string"
}

400

Section titled “400 ”
  • targetDivision=1かつtargetIdに一致する部門が存在しない場合
  • targetDivision=2かつtargetIdに一致する商品が存在しない場合
  • targetDivision=3かつtargetIdに一致するグループコードの商品が存在しない場合
  • 同一データの重複している場合
  • 割引率のチェックエラー
object
type
required
string
title
required
string
detail
string
status
integer
Examples
{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "targetId:[171] 部門IDは存在しません",
  "status": 400
}