> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kameleoon.com/llms.txt
> Use this file to discover all available pages before exploring further.

# コレクションの取得

> Kameleoon Product Recommendation API から、構成済みの商品コレクションとその HTML テンプレートを取得します。

このサービスは商品コレクションエンドポイントへのアクセスを提供します。

### HTTP リクエスト

```
GET https://api.products.kameleoon.com/collection/{%collection_id%}
```

<Note>
  商品 `collection_id` は、ダッシュボードの Product Collections セクションで確認できます。構成済みのコレクションは、ID 番号とともにそこに一覧表示されています。
</Note>

### クエリパラメーター

| パラメーター        | 型      | 必須    | 説明                                                                                                                                                                                                                                                                     |
| ------------- | ------ | ----- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `shop_id`     | String | True  | ストアキー。Kameleoon アプリの **Recommendations** > **Settings** > **Store settings** で確認できます。キーについては、カスタマーサクセスマネージャーにもお問い合わせいただけます。                                                                                                                                            |
| `did`         | String | False | デバイス ID。この ID は `KameleoonProducts_device_id` クッキーで確認でき、このエンドポイントを呼び出す前にバックエンドから取得できます。                                                                                                                                                                                |
| `location`    | String | False | ユーザーの所在地。                                                                                                                                                                                                                                                              |
| `external_id` | String | False | システムまたは CRM 内でユーザーに関連付けられた一意の識別子。(Kameleoon VisitorCode との正確なマッチングを確保するには、ID を最初に Kameleoon カスタムデータとして保存する必要があります。このカスタムデータを設定する際は、Use this custom data as a unique identifier for cross-device matching オプションを必ず有効にして、ID が両システム間でユーザーアクティビティをリンクするために使用されるようにしてください)。 |

### API レスポンス

| 名前         | 型                | 説明                                                               |
| ---------- | ---------------- | ---------------------------------------------------------------- |
| `products` | Array of objects | 商品に関する情報の配列。各オブジェクトは[次のプロパティ](#products-オブジェクト配列のフィールドリスト)を持ちます。 |
| `html`     | String           | コレクション作成時に選択された HTML テンプレート                                      |

### `products` オブジェクト配列のフィールドリスト

| プロパティ                    | 説明                                                  |
| ------------------------ | --------------------------------------------------- |
| `name`                   | 商品名                                                 |
| `url`                    | 商品ページへの完全な URL                                      |
| `category_ids`           | 関連するカテゴリ ID のリスト                                    |
| `barcode`                | 商品のバーコードまたは一意の識別子                                   |
| `vendor_code`            | ベンダーまたはブランドコード                                      |
| `brand`                  | ブランド名                                               |
| `leftovers`              | 在庫タイプを示します(例: "lot"、"single" など)                    |
| `rating`                 | 商品評価                                                |
| `fashion_feature`        | ファッション機能または対象オーディエンス(例: 子供、女性)                      |
| `fashion_wear_type`      | ファッションアイテムのタイプ(例: 靴、衣服)                             |
| `fashion_original_sizes` | 元々利用可能だったサイズ                                        |
| `picture`                | デフォルトの画像 URL                                        |
| `categories`             | 商品カテゴリ(配列)。[次のプロパティ](#categories-配列のプロパティリスト)を持ちます。 |
| `price_formatted`        | 文字列としてフォーマットされた商品価格(例: "\$ 70")                     |
| `price_full_formatted`   | 文字列としてフォーマットされた商品の完全な価格(例: "\$ 70.00")              |
| `price`                  | 数値としての商品価格                                          |
| `price_full`             | 数値としての商品の完全な価格                                      |
| `image_url`              | メイン画像 URL                                           |
| `image_url_handle`       | メイン画像への相対パス                                         |
| `image_url_resized`      | サイズ別にリサイズされた画像 URL を含むオブジェクト                        |
| `url_handle`             | 商品ページへの相対パス                                         |
| `currency`               | 通貨記号(例: "\$")                                       |
| `_id`                    | 内部の一意の識別子                                           |
| `id`                     | 商品 ID(多くの場合バーコードと同じ)                                |
| `stock_quantity`         | 利用可能な在庫数量                                           |
| `fashion_colors`         | 商品で利用可能な色                                           |
| `params`                 | 商品属性を表すキー/値のペアのリスト(例: サイズ、色)                        |
| `group_id`               | 商品が属するグループの ID                                      |

### `categories` 配列のプロパティリスト

| プロパティ        | 説明                               |
| ------------ | -------------------------------- |
| `id`         | カテゴリ ID                          |
| `parent_id`  | (オプション)親カテゴリの ID(該当する場合)         |
| `url`        | カテゴリの完全な URL                     |
| `name`       | カテゴリ名                            |
| `level`      | カテゴリレベル(例: "1" = 親、"2" = サブカテゴリ) |
| `url_handle` | カテゴリへの相対 URL パス                  |