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

部門一覧取得

GET
/categories

部門情報一覧を取得します。

対象プラン

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

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
fields
array

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

sort
string

並び順（カンマ区切りで指定可）

指定可能なパラメータ

  • categoryId：部門ID
  • categoryCode：部門コード
  • level：階層レベル
  • displaySequence：表示順
  • updDateTime：更新日時
limit
integer

上限数

page
integer

ページ

category_code
string

部門コード

level
string
Allowed values: 1 2 3

階層レベル

Responses

Section titled “ Responses ”

200

Section titled “200 ”

取得成功

Array<object>
object
categoryId

部門ID：数字9桁以内。

string
categoryCode

部門コード：半角英数記号20文字以内。

string
categoryName

部門名：85文字以内。

string
categoryAbbr

部門名略称：85文字以内。

string
displaySequence

表示順：数字9桁以内。

string
displayFlag

端末表示：スマレジ端末に表示するか否かの判定。 (0:表示しない、1:表示する)

string
taxDivision

税区分：商品価格の消費税の扱いに関する設定。 （0:内税、1:外税、2:非課税）

string
pointNotApplicable

ポイント対象：ポイント対象にするか否かの設定。（0:ポイント対象、1:ポイント対象外）

string
taxFreeDivision

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

string
reduceTaxId

軽減税率ID（税設定）：軽減税率設定画面で設定した軽減税率ID、または、下記の軽減税率ID。標準税率の場合はnull。
軽減:10000001 (特定商品の軽減税率適用）
選択[標準]:10000002（状態による適用[適用しない]）
選択[軽減]:10000003（状態による適用[適用する]）
選択[選択]:10000004（状態による適用[都度選択する]）

string
color

端末表示カラー：端末に表示するカラー。（HTMLカラーコード形式）例) #000000

string
categoryGroupId

部門グループ：部門グループID。部門グループがない場合は空白。

string
parentCategoryId

親部門：親部門ID。親部門がない場合は空白。

string
level

階層レベル：階層レベルは1〜3。親部門が未設定の場合は1。

string
tag

タグ：85文字以内。複数ある場合は、カンマで区切り。

string
insDateTime

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

string
updDateTime

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

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