カテゴリオートコンプリート

/category/autocomplete [GET]

基本情報

概要

指定したワードに対するカテゴリ名の自動補完候補を取得します。

URL

https://{HOST}/{CID}/v1/category/autocomplete

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

出力形式

• JSON

対応言語

• ja

パラメータ

パラメータ名	必須	概要	型名	デフォルト値	上下限/選択値	備考
word	✔	検索ワード	文字列		最小：2文字 最大：50文字	検索したいカテゴリ名称 アラビア数字・漢数字はそのまま検索します

データの出力件数について

当APIでは、出力件数が一律20までとなります。

パラメータ構成例

• 「こn」で始まるカテゴリ名称の候補を検索

/category/autocomplete?word=こn

レスポンス

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

Categoryオブジェクト

名称	レスポンス名	型名	配列	説明
カテゴリコード一覧	categories	CategoryCodeオブジェクト	◯
カテゴリ名	name	文字列

CategoryCodeオブジェクト

名称	レスポンス名	型名	配列	説明
カテゴリコード	code	文字列
カテゴリコードのレベル	level	文字列		large, middle, small, detail の4階層

レスポンス例

{
    "items": [
        {
            "categories": [
                {
                    "code": "0201001",
                    "level": "small"
                }
            ],
            "name": "コンビニ"
        }
    ]
}