検索結果の取得 - Kameleoon Documentation

GET

Retrieve search results

curl --request GET \
  --url https://api.products.kameleoon.com/search

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.products.kameleoon.com/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.products.kameleoon.com/search"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.products.kameleoon.com/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "search_query": "<string>",
  "search_query_original": "<string>",
  "collections": [
    {}
  ],
  "categories": [
    {
      "id": "<string>",
      "name": "<string>",
      "url": "<string>",
      "url_handle": "<string>",
      "count": 123,
      "parent": "<string>",
      "alias": "<string>"
    }
  ],
  "filters": {},
  "html": "<string>",
  "price_range": {
    "min": 123,
    "max": 123
  },
  "price_ranges": [
    {
      "from": 123,
      "to": 123,
      "count": 123
    }
  ],
  "price_median": 123,
  "products": [
    {
      "name": "<string>",
      "url": "<string>",
      "url_handle": "<string>",
      "category_ids": [
        "<string>"
      ],
      "categories": [
        {
          "id": "<string>",
          "url": "<string>",
          "name": "<string>",
          "level": "<string>",
          "url_handle": "<string>"
        }
      ],
      "barcode": "<string>",
      "vendor_code": "<string>",
      "brand": "<string>",
      "leftovers": "<string>",
      "rating": 123,
      "fashion_feature": "<string>",
      "fashion_gender": "<string>",
      "fashion_wear_type": "<string>",
      "fashion_sizes": [
        "<string>"
      ],
      "fashion_original_sizes": [
        "<string>"
      ],
      "fashion_colors": [
        "<string>"
      ],
      "picture": "<string>",
      "price_formatted": "<string>",
      "price_full_formatted": "<string>",
      "price": 123,
      "price_full": 123,
      "image_url": "<string>",
      "image_url_handle": "<string>",
      "image_url_resized": {},
      "currency": "<string>",
      "_id": "<string>",
      "id": "<string>",
      "stock_quantity": 123,
      "params": [
        {
          "key": "<string>",
          "values": [
            "<string>"
          ]
        }
      ],
      "group_id": "<string>",
      "description": "<string>",
      "is_new": true,
      "old_price": "<string>",
      "sales_rate": 123,
      "relative_sales_rate": 123
    }
  ],
  "products_total": 123,
  "search_query_redirects": [
    {
      "query": "<string>",
      "redirect_link": "<string>",
      "deep_link": "<string>"
    }
  ],
  "brands": [
    {
      "name": "<string>",
      "picture": "<string>",
      "count": 123
    }
  ],
  "clarification": true,
  "requests_count": 123,
  "queries": [
    {
      "name": "<string>",
      "url": "<string>",
      "url_handle": "<string>",
      "score": 123
    }
  ],
  "industrial_filters": {
    "fashion_sizes": [
      {
        "size": "<string>",
        "count": 123
      }
    ],
    "colors": [
      {
        "color": "<string>",
        "count": 123
      }
    ]
  }
}

Kameleoon Search サービスは 2 種類の検索を提供します。

即時検索(タイプアヘッド検索): ユーザーが検索クエリを入力するたびに結果を表示および更新します。
完全検索: ユーザーが検索クエリを送信した後に完全でフィルタリングされた検索結果を返します。

両方のオプションは同じエンドポイントを使用します。検索タイプを指定するには type パラメーターを使用します。

クエリパラメーター

これらのクエリパラメーターは完全検索と即時検索の両方に適用されます。追加のパラメーターは完全検索でのみ使用してください。

パラメーター	型	必須	説明
`did`	String	True	デバイス ID。`KameleoonProducts_device_id` クッキーからこの ID を取得します。このエンドポイントを呼び出す前に、バックエンドから取得してください。“Recently Viewed” や “Recommended for You” など、過去のデバイスデータに依存するフィルターまたはアルゴリズムを使用する場合にのみ `did` を提供します。
`sid`	String	True	一時的なユーザーセッション ID。`KameleoonProducts_session_code` クッキーからこの ID を取得します。このエンドポイントを呼び出す前に、バックエンドから取得してください。“Recently Viewed” や “Recommended for You” など、過去のユーザーデータに依存するフィルターまたはアルゴリズムを使用する場合にのみ `sid` を提供します。
`shop_id`	String	True	ストアキー。Kameleoon アプリの Recommendations > Settings > Store settings で確認できます。必要に応じてカスタマーサクセスマネージャーにキーをお問い合わせください。
`type`	String	True	検索タイプを指定します: `instant_search` または `full_search`。
`search_query`	String	True	現在の検索クエリ。
`locations`	List	Optional	場所 ID のカンマ区切りリスト。

追加のクエリパラメーター(完全検索のみ)

これらの追加パラメーターは完全検索リクエスト(type=full_search)で使用してください。

パラメーター	型	必須	説明
`limit`	Integer	Optional	API が返す結果の最大数。
`offset`	Integer	Optional	結果のオフセット。
`category_limit`	Integer	Optional	サイドバーフィルターのカテゴリの最大数。
`categories`	List	Optional	フィルタリング用のカテゴリのカンマ区切りリスト。
`extended`	Integer or empty	Optional	商品結果の拡張情報を追加します。サポートされる値: `1` または空。`1` の場合、API はすべての商品情報を返します。空の場合、API は商品 ID のみを返します。Kameleoon は完全検索の場合これを `1` に設定することをお勧めします。
`sort_by`	String	Optional	ソートパラメーター。サポートされる値: `popular`、`price`、`discount`、`sales_rate`、`date`。
`order`	String	Optional	ソート方向: `asc`(昇順)または `desc`(降順)。デフォルトは `desc` です。
`brands`	List	Optional	フィルタリング用のブランドのカンマ区切りリスト。
`filters`	String	Optional	フィルターパラメーターを含むエスケープされた JSON 文字列。例: `{"bluetooth":["yes"],"offers":["15% cashback"],"weight":["1.6"]}`
`price_min`	Integer	Optional	最低価格。
`price_max`	Integer	Optional	最高価格。
`colors`	List	Optional	色のカンマ区切りリスト。
`exclude`	List	Optional	検索結果から除外する商品 ID のカンマ区切りリスト。

レスポンス(即時検索)

名前	型	説明
`search_query`	string	検索クエリ。
`categories`	array	カテゴリ情報。各オブジェクトには次のプロパティが含まれます: `id` – カテゴリ ID (string) `name` – カテゴリ名 (string) `url` – カテゴリ URL (string) `count` – カテゴリ内の商品数 (number)
`filters`	array	フィルター情報。各オブジェクトには次のプロパティが含まれます: `filter` – 次のプロパティを含むフィルターオブジェクト: `count` – これらのパラメーターにマッチする商品の合計数 (number) `values` – 次のプロパティを含む値オブジェクトの配列: `value` – 値ラベル (string) `count` – このパラメーターを持つ商品の数 (number)
`html`	string	商品ブロックの HTML コード。Kameleoon の個人アカウントでテンプレートをカスタマイズします。
`price_range`	object	商品価格の最小値と最大値。次のプロパティが含まれます: `min` – 最低価格 (number) `max` – 最高価格 (number)
`products`	array	商品情報。各オブジェクトには次のプロパティが含まれます: `description` – 商品の説明 (string) `url` – 商品の絶対 URL (string) `url_handle` – 商品の相対 URL (string) `picture` – Kameleoon ストレージ内の商品画像 URL (string) `name` – 商品名 (string) `price` – 商品価格 (integer) `price_full` – 商品価格 (float) `price_formatted` – 通貨付きの商品価格 (string) `price_full_formatted` – 通貨付きフォーマット済み商品価格 (string) `image_url` - Kameleoon ストレージ内の商品画像の絶対 URL (string) `image_url_handle` - Kameleoon ストレージ内の商品画像の相対 URL (string) `image_url_resized` - リサイズされた画像 URL の配列 `currency` – 商品の通貨 (string) `id` – 商品 ID (string) `old_price` – 商品の以前の価格 (string、デフォルトは 0) `old_price_full` – 商品の以前の価格 (float) `old_price_formatted` – 通貨付きの商品の以前の価格 (string) `old_price_full_formatted` – 通貨付きフォーマット済み商品の以前の価格 (string) リクエストに `extended` を含めた場合の追加プロパティ: `id` – カテゴリ ID (string) `name` – カテゴリ名 (string) `parent_id` – 親カテゴリ ID (string) `url` - カテゴリ URL `category_ids` - 商品カテゴリ ID (array)
`search_query_redirects`	array	リダイレクト情報。各オブジェクトには次のプロパティが含まれます: `query` – 検索クエリ (string) `redirect_link` – リダイレクト用 URL (string) `deep_link` – モバイルアプリ用 URL (string)
`products_total`	number	商品の合計数。

レスポンス(完全検索)

名前	型	説明
`brands`	array	ブランド情報。各オブジェクトには次のプロパティが含まれます: `name` – ブランド名 (string) `picture` – ブランド画像 URL (string)
`categories`	array	カテゴリ情報。各オブジェクトには次のプロパティが含まれます: `alias` – カテゴリエイリアス (string) `id` – カテゴリ ID (string) `name` – カテゴリ名 (string) `parent` – 親カテゴリ ID (string) `url` – カテゴリ URL (string)
`filters`	array	フィルター情報。各オブジェクトには次のプロパティが含まれます: `filter` – 次のプロパティを含むフィルターオブジェクト: `count` – これらのパラメーターにマッチする商品の合計数 (number) `values` – `value` (string) と `count` (number) を含む値オブジェクト
`html`	string	商品ブロックの HTML コード。Kameleoon の個人アカウントでテンプレートをカスタマイズします。
`price_range`	object	商品価格の最小値と最大値。次のプロパティが含まれます: `min` – 最低価格 (number) `max` – 最高価格 (number)
`products`	array	商品情報。各オブジェクトには次のプロパティが含まれます: `brand` – 商品ブランド (string) `currency` – 商品通貨 (string) `id` – 商品 ID (string) `is_new` – 商品プロパティ (boolean、デフォルトは null) `name` – 商品名 (string) `old_price` – 商品の以前の価格 (string、デフォルトは 0) `picture` – Kameleoon ストレージ内の商品画像 URL (string) `price` – 商品価格 (number) `price_formatted` – 通貨付きの商品価格 (string) `url` – 商品 URL (string) リクエストに `extended` を含めた場合の追加プロパティ: `barcode` – 商品のバーコード (string) `categories` – 商品カテゴリ (array)。`id`、`name`、`parent` ID が含まれます。 `params` – パラメーター情報。各オブジェクトには `key` (string) と `values` (array) が含まれます。
`products_total`	number	商品の合計数。
`search_query`	string	検索クエリ。

クエリパラメータ

did

string

必須

Device ID. Get this ID from the KameleoonProducts_device_id cookie. Retrieve it from the backend before calling this endpoint. Only provide did when using filters or algorithms that rely on historical device data, such as "Recently Viewed" or "Recommended for You."

sid

string

必須

Temporary user session ID. Get this ID from the KameleoonProducts_session_code cookie. Retrieve it from the backend before calling this endpoint. Only provide sid when using filters or algorithms that rely on historical user data, such as "Recently Viewed" or "Recommended for You."

shop_id

string

必須

Store Key. Find this in Recommendations > Settings > Store settings in the Kameleoon app. Contact your Customer Success Manager for the key if necessary.

type

enum<string>

必須

Specifies the search type.

利用可能なオプション:

instant_search,

full_search

search_query

string

必須

Current search query.

locations

string[]

Comma-separated list of location IDs.

limit

integer

Maximum number of results the API returns. Full search only.

offset

integer

Result offset. Full search only.

category_limit

integer

Maximum number of categories for the sidebar filter. Full search only.

レスポンス

200 - application/json

Matching products for the search query. Verified against a live response on 2026-09-24. The exact response shape depends on type: instant search additionally returns queries, and full search additionally returns brands, price_ranges, price_median, and (with extended=1) industrial_filters.

Response shape verified against a live response on 2026-09-24. Fields kept from the original reference but not observed in that sample (search_query_redirects) may still appear conditionally. queries was observed for instant search; industrial_filters was observed for full search with extended=1.

search_query

string

The search query, as processed by Kameleoon.

search_query_original

string

The search query exactly as submitted.

collections

object[]

Matching product collections, if any.

categories

object[]

Category facet information.

Show child attributes

filters

object

A map of filter name (for example, "Color", "Size") to that filter's aggregation. Verified against a live response on 2026-09-24; the original reference documented filters as an array, but the API actually returns an object keyed by filter name.

Show child attributes

html

string

HTML code for the product block. Customize the template in the Kameleoon personal account.

price_range

object

Show child attributes

price_ranges

object[]

Distribution of products across price ranges. Full search only.

Show child attributes

price_median

number

Median product price. Full search only.

products

object[]

Matching products.

Show child attributes

products_total

number

Total number of matching products.

search_query_redirects

object[]

Redirect information, when a matching redirect rule is configured. Not observed in the live sample; kept from the original reference.

Show child attributes

brands

object[]

Brand facet information. Full search only.

Show child attributes

clarification

boolean

Whether Kameleoon is asking for query clarification (for example, offering suggested queries) rather than returning a confident result set.

requests_count

integer

Number of search requests counted for this query in the current session.

queries

object[]

Suggested/corrected queries. Instant search only.

Show child attributes

industrial_filters

object

Aggregated fashion-specific filter facets. Full search only, returned when extended=1.

Show child attributes

⌘I

Retrieve search results

curl --request GET \
  --url https://api.products.kameleoon.com/search

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.products.kameleoon.com/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.products.kameleoon.com/search"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.products.kameleoon.com/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "search_query": "<string>",
  "search_query_original": "<string>",
  "collections": [
    {}
  ],
  "categories": [
    {
      "id": "<string>",
      "name": "<string>",
      "url": "<string>",
      "url_handle": "<string>",
      "count": 123,
      "parent": "<string>",
      "alias": "<string>"
    }
  ],
  "filters": {},
  "html": "<string>",
  "price_range": {
    "min": 123,
    "max": 123
  },
  "price_ranges": [
    {
      "from": 123,
      "to": 123,
      "count": 123
    }
  ],
  "price_median": 123,
  "products": [
    {
      "name": "<string>",
      "url": "<string>",
      "url_handle": "<string>",
      "category_ids": [
        "<string>"
      ],
      "categories": [
        {
          "id": "<string>",
          "url": "<string>",
          "name": "<string>",
          "level": "<string>",
          "url_handle": "<string>"
        }
      ],
      "barcode": "<string>",
      "vendor_code": "<string>",
      "brand": "<string>",
      "leftovers": "<string>",
      "rating": 123,
      "fashion_feature": "<string>",
      "fashion_gender": "<string>",
      "fashion_wear_type": "<string>",
      "fashion_sizes": [
        "<string>"
      ],
      "fashion_original_sizes": [
        "<string>"
      ],
      "fashion_colors": [
        "<string>"
      ],
      "picture": "<string>",
      "price_formatted": "<string>",
      "price_full_formatted": "<string>",
      "price": 123,
      "price_full": 123,
      "image_url": "<string>",
      "image_url_handle": "<string>",
      "image_url_resized": {},
      "currency": "<string>",
      "_id": "<string>",
      "id": "<string>",
      "stock_quantity": 123,
      "params": [
        {
          "key": "<string>",
          "values": [
            "<string>"
          ]
        }
      ],
      "group_id": "<string>",
      "description": "<string>",
      "is_new": true,
      "old_price": "<string>",
      "sales_rate": 123,
      "relative_sales_rate": 123
    }
  ],
  "products_total": 123,
  "search_query_redirects": [
    {
      "query": "<string>",
      "redirect_link": "<string>",
      "deep_link": "<string>"
    }
  ],
  "brands": [
    {
      "name": "<string>",
      "picture": "<string>",
      "count": 123
    }
  ],
  "clarification": true,
  "requests_count": 123,
  "queries": [
    {
      "name": "<string>",
      "url": "<string>",
      "url_handle": "<string>",
      "score": 123
    }
  ],
  "industrial_filters": {
    "fashion_sizes": [
      {
        "size": "<string>",
        "count": 123
      }
    ],
    "colors": [
      {
        "color": "<string>",
        "count": 123
      }
    ]
  }
}

API

​クエリパラメーター

​追加のクエリパラメーター(完全検索のみ)

​レスポンス(即時検索)

​レスポンス(完全検索)

クエリパラメータ

レスポンス

クエリパラメーター

追加のクエリパラメーター(完全検索のみ)

レスポンス(即時検索)

レスポンス(完全検索)