カテゴリマスタ情報全取得

/category_list [GET]

基本情報

概要

全てのカテゴリ情報を取得します。

URL

https://{HOST}/{CID}/v1/category_list

※Rakuten RapidAPIでは提供しておりません

出力形式

  • JSON

対応言語

  • ja

出力順

  • 弊社独自の調整をしており、必ずしもコード順とはなりません

諸注意事項

・返却データが 100KB 程度と大きめです。短期間で頻繁にリクエストするような使い方は避けてください。
・カテゴリは定期的に再編されます。小項目と細項目のキャッシュは非推奨です。

パラメータ

なし

リクエスト例

  • 全てのカテゴリを取得
/category_list

レスポンス

名称 レスポンス名 型名 配列 説明
カテゴリ情報 items Categoryオブジェクト カテゴリ情報のまとまり

Categoryオブジェクト

名称 レスポンス名 型名 配列 説明
カテゴリコード code 文字列
カテゴリ名 name 文字列
カテゴリ名の読み仮名 ruby 文字列 多言語で利用いただいている場合は出力されない
カテゴリコードのレベル level 文字列 large, middle, small, detail の4階層
子要素 children Categoryオブジェクト 検索したカテゴリの下位カテゴリ群の情報をまとめたオブジェクト

Categoryオブジェクト(子要素がない場合)

名称 レスポンス名 型名 配列 説明
カテゴリコード code 文字列
カテゴリ名 name 文字列
カテゴリ名の読み仮名 ruby 文字列 多言語で利用いただいている場合は出力されない
カテゴリコードのレベル level 文字列 large, middle, small, detail の4階層

レスポンス例

{
    "items": [
        {
            "code": "01",
            "name": "遊ぶ/趣味",
            "ruby": "あそぶしゅみ",
            "level": "large",
            "children": [
                {
                    "code": "0101",
                    "name": "レジャー/アウトドア",
                    "ruby": "れじゃーあうとどあ",
                    "level": "middle",
                    "children": [
                        {
                            "code": "0101001",
                            "name": "遊園地/テーマパーク",
                            "ruby": "ゆうえんちてーまぱーく",
                            "level": "small",
                            "children": [
                                {
                                    "code": "0101001001",
                                    "name": "遊園地/テーマパーク",
                                    "ruby": "ゆうえんちてーまぱーく",
                                    "level": "detail"
                                }
                            ]
                        },
                        {
                            "code": "0101013",
                            "name": "プール",
                            "ruby": "ぷーる",
                            "level": "small",
                            "children": [
                                {
                                    "code": "0101013001",
                                    "name": "プール",
                                    "ruby": "ぷーる",
                                    "level": "detail"
                                }
                            ]
                        },
                        ・・・
                    ]
                }
                ・・・
            ]
        },
        {
            ・・・
        }
    ]
}