開発者向けサポート

/categories

カテゴリ一覧情報です。クエリを使用して検索をすることができます。

必要権限

  • item

提供メソッド

GET

サンプル
リクエスト
GET /categories.json?select=CATEGORY_CD,CATEGORY_NAME
レスポンス
200 OK

[{"CATEGORY_CD": "cat01", "CATEGORY_NAME": "カテゴリ1"},
{"CATEGORY_CD": "cat02", "CATEGORY_NAME": "カテゴリ2"},
{"CATEGORY_CD": "cat03", "CATEGORY_NAME": "カテゴリ3"}]
リクエスト文説明
クエリーパラメータ

select
取得する列名を指定します。指定しない場合は CATEGORY_ID,CATEGORY_CD,CATEGORY_NAME,CATEGORY_IMAGE,CATEGORY_INFO,SEARCH_DISP_FLG,REGIST_KBN を指定した場合と同じ動作をします。
query
検索条件をJSON形式で指定します。詳細はデータアクセスAPIのページの共通パラメータを参照してください。
category_cd
指定したカテゴリコードが一致するカテゴリ情報を検索します。
result_count
検索結果の取得数を指定します。1～100で指定してください。未指定の場合、結果は20件分返します。
page
取得するページ番号 ((page-1)*resultCount)+1件目からpage*resultCount件目までのデータが取得対象となります。未指定の場合は1が指定されたものとして動作します。
get_type
取得内容を特定する種別です。指定可能な値は次の通りです。
parent
この要素を指定する場合、追加でcategory_id_listを指定して下さい。
category_id_listには[1,2,.....]の形で取得対象の基準となるカテゴリを指定してください。
指定されたカテゴリIDのカテゴリと親カテゴリ情報を第一階層まで遡って取得できます。selectパラメータのみ指定が可能です。

応答値説明
ボディー文字列

カテゴリ情報を格納したJSON値を返します。

POST

サンプル
リクエスト
POST categories.json

{"CATEGORY_CD":"CATEGORY_1","CATEGORY_NAME":"カテゴリ１","DISP_ORDER":1}
レスポンス
200 OK

{"result": "1"}
リクエスト文説明
ボディー文字列

カテゴリの情報を格納したJSON文字列。

応答値説明
ボディー文字列

カテゴリID