部門グループ登録

POST

/category_groups

• サンドボックス
• 本番

部門グループを登録します。

対象プラン

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

Authorizations

• AppAccessToken
  pos.products:write
• UserAccessToken
  pos.products:write

Request Body

object

categoryGroupCode

部門グループコード

部門グループコード

string

<= 10 characters /^[ -~]+$/

categoryGroupName

required

部門グループ名

部門グループ名

string

<= 85 characters

displaySequence

表示順

表示順

string format: int

<= 999999999

Example

{
  "categoryGroupCode": "string",
  "categoryGroupName": "string",
  "displaySequence": "123456789"
}

Responses

200

更新成功

object

categoryGroupId

部門グループID

string

categoryGroupCode

部門グループコード

string

categoryGroupName

部門グループ名

string

displaySequence

表示順

string

insDateTime

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

string

updDateTime

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

string

Example

{
  "categoryGroupId": "string",
  "categoryGroupCode": "string",
  "categoryGroupName": "string",
  "displaySequence": "string",
  "insDateTime": "string",
  "updDateTime": "string"
}

400

• 入力チェックエラーの場合
• 指定された部門グループコードが重複する場合

object

type

required

string

title

required

string

detail

string

status

integer

Examples

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "[categoryGroupCode]半角英数記号で入力して下さい",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "指定された部門グループコードは既に登録されています。",
  "status": 400
}