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

オプショングループ登録

POST
/product_option_groups

オプショングループを登録します。

対象プラン

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

Authorizations

Section titled “Authorizations ”

Request Body

Section titled “Request Body ”
object
productOptionGroupName
required
オプショングループ名

オプショングループ名

string
<= 85 characters
conditionId
required
条件ID

条件ID。(0：条件なし、1：全体、2：部門毎)

string
Allowed values: 0 1 2
max
適用条件の上限

適用条件の上限：条件IDが 1：全体、2：部門毎 のときは必須。

string format: int
>= 1 <= 999
min
適用条件の下限

適用条件の下限：条件IDが 1：全体、2：部門毎 のときは必須。

string format: int
<= 999
products
required
オプショングループ商品

オプショングループ商品：オプショングループ１件につき1件以上の登録必須。

Array<object>
object
productId
required
商品ID

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

string format: int
>= 1 <= 999999999999999
Example
{
  "productOptionGroupName": "string",
  "conditionId": "0",
  "max": "123",
  "min": "123",
  "products": [
    {
      "productId": "123456789012345"
    }
  ]
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

更新成功

object
productOptionGroupId

商品オプショングループID

string
productOptionGroupName

オプショングループ名

string
conditionId

条件ID。(0：条件なし、1：全体、2：部門毎)

string
max

適用条件の上限：条件IDが 1：全体、2：部門毎 のときは必須。

string
min

適用条件の下限：条件IDが 1：全体、2：部門毎 のときは必須。

string
syncDivision

作成区分。(0：通常、1：Waiter、2：本部、9：その他) （本部から同期処理で作成された場合2：本部で作成されます。）

string
insDateTime

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

string
updDateTime

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

string
products

オプショングループ商品

object
productOptionGroupId

商品オプショングループID

string
productId

商品ID

string
syncDivision

作成区分：作成区分。(0：通常、1：Waiter、2：本部、9：その他) （本部から同期処理で作成された場合2：本部で作成されます。）

string
insDateTime

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

string
updDateTime

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

string
Example
{
  "productOptionGroupId": "string",
  "productOptionGroupName": "string",
  "conditionId": "string",
  "max": "string",
  "min": "string",
  "syncDivision": "string",
  "insDateTime": "string",
  "updDateTime": "string",
  "products": {
    "productOptionGroupId": "string",
    "productId": "string",
    "syncDivision": "string",
    "insDateTime": "string",
    "updDateTime": "string"
  }
}

400

Section titled “400 ”
  • 下限数が上限数を上回っている場合
  • 条件IDが 1：全体、2：部門毎 のときで、上限数と下限数が設定されていない場合
  • 条件IDが 0：条件なし のときで、上限数か下限数が設定されている場合
  • 指定された商品が存在しない場合
  • 商品が１件も指定されなかった場合
  • 指定された商品がオプション商品でない場合
  • 指定された商品が重複する場合
  • 本部商品が指定された場合
object
type
required
string
title
required
string
detail
string
status
integer
Examples
{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "下限数は上限数以下の数を入力してください。",
  "status": 400
}