部門登録

POST

/categories

サンドボックス
本番

部門情報を登録します。

対象プラン

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

Authorizations

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

Request Body

object

categoryCode

部門コード

ユニーク値 部門コード

string

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

categoryName

required

部門名

部門名

string

<= 85 characters

categoryAbbr

部門名略称

部門名略称

string

<= 85 characters

displaySequence

表示番号

表示順序

string format: int

<= 999999999

displayFlag

表示フラグ

端末で表示するか判定
(0:表示しない、1:表示する)

string

default: 1

Allowed values: 0 1

taxDivision

税区分

商品単価の税区分 (0:税込、1:税抜、2:非課税)

string

Allowed values: 0 1 2

pointNotApplicable

ポイント対象区分

（0:ポイント対象、1:ポイント対象外）

string

Allowed values: 0 1

taxFreeDivision

免税区分

(0:対象外、1:一般品、2:消耗品)

string

Allowed values: 0 1 2

reduceTaxId

軽減税率ID

軽減税率ID
標準:null（または未設定）
軽減:10000001 (特定商品の軽減税率適用）
選択[標準]:10000002（状態による適用[適用しない]）
選択[軽減]:10000003（状態による適用[適用する]）
選択[選択]:10000004（状態による適用[都度選択する]）
上記以外の場合、カスタム軽減税率で登録されている軽減税率ID

※10000001〜10000004における軽減税率は日本国における軽減税率(8%)です。
※存在しない軽減税率IDを指定した場合エラー。

string format: int

color

端末表示カラー

端末表示カラー：#000000形式

string

<= 7 characters /#([0-9a-fA-F]{1,6})$/

categoryGroupId

部門グループID

部門グループID：部門グループID未設定の場合null

string format: int

parentCategoryId

親部門ID

親部門ID：親部門IDは階層レベル1〜2のもののみ指定可能。(3のものを指定した場合エラー)。
親部門IDがない場合はnull。
存在しない親部門IDを指定した場合エラー。

string format: int

tag

タグ

string

<= 85 characters

Example

{
  "categoryCode": "string",
  "categoryName": "string",
  "categoryAbbr": "string",
  "displaySequence": "123456789",
  "displayFlag": "0",
  "taxDivision": "0",
  "pointNotApplicable": "0",
  "taxFreeDivision": "0",
  "reduceTaxId": "10000001",
  "color": "string",
  "categoryGroupId": "1",
  "parentCategoryId": "1",
  "tag": "string"
}

Responses

200

更新成功

object

categoryId

部門ID：部門毎に付与するID

string

categoryCode

部門コード：部門コード

string

categoryName

部門名：部門名

string

categoryAbbr

部門名略称：部門名略称

string

displaySequence

表示番号：表示順序

string

displayFlag

表示フラグ：端末で表示するか判定
(0:表示しない、1:表示する)

string

Allowed values: 0 1

taxDivision

税区分：商品単価の税区分 (0:税込、1:税抜、2:非課税)

string

Allowed values: 0 1 2

pointNotApplicable

ポイント対象区分：（0:ポイント対象、1:ポイント対象外）

string

Allowed values: 0 1

taxFreeDivision

免税区分：(0:対象外、1:一般品、2:消耗品)

string

Allowed values: 0 1 2

reduceTaxId

軽減税率ID：軽減税率ID
標準:null
軽減:10000001 (特定商品の軽減税率適用）
選択[標準]:10000002（状態による適用[適用しない]）
選択[軽減]:10000003（状態による適用[適用する]）
選択[選択]:10000004（状態による適用[都度選択する]）

string

color

端末表示カラー：端末に表示するカラー

string

categoryGroupId

部門グループID：部門グループIDがない場合はnull

string

parentCategoryId

親部門ID：親部門IDがない場合はnull

string

level

階層レベル：親部門IDがある場合は2以上3以下 (3階層まで)

string

tag

タグ

string

insDateTime

作成日時：登録時の日時

string

updDateTime

更新日時：登録時・更新時の日時

string

Example

{
  "categoryId": "string",
  "categoryCode": "string",
  "categoryName": "string",
  "categoryAbbr": "string",
  "displaySequence": "string",
  "displayFlag": "0",
  "taxDivision": "0",
  "pointNotApplicable": "0",
  "taxFreeDivision": "0",
  "reduceTaxId": "10000001",
  "color": "string",
  "categoryGroupId": "string",
  "parentCategoryId": "string",
  "level": "string",
  "tag": "string",
  "insDateTime": "string",
  "updDateTime": "string"
}

400

入力チェックエラーの場合
親部門IDに階層レベル3のものが指定された場合

object

type

required

string

title

required

string

detail

string

status

integer

Examples

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "親部門IDに階層レベル3のものは指定できません",
  "status": 400
}