オプショングループ取得

GET

/product_option_groups/{product_option_group_id}

• サンドボックス
• 本番

指定されたオプショングループを取得します。

対象プラン

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

Authorizations

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

Parameters

Path Parameters

product_option_group_id

required

string

オプショングループID

Query Parameters

fields

array

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

with_products

string

default: none

Allowed values: all none

オプショングループ商品情報を付加するか(付加する場合はall, しない場合はnone)

Responses

200

取得成功

Array<object>

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"
    }
  }
]

404

• 指定されたIDが存在しない場合

object

type

required

string

title

required

string

detail

string

status

integer

Examples

{
  "type": "about:blank",
  "title": "NotFound",
  "detail": "指定されたIDのリソースが見つかりません",
  "status": 404
}