バリューコマースAPI検索パラメータ一覧
バリューコマースAPIを利用した検索は、RESTfulのURLを使って行います。 全てのパラメータの文字コードはUTF-8です。
| パラメータ名 | 意味 | データタイプ | データの制限範囲 | 必須? | デフォルト値 | マッチタイプ | 無効の場合の動作 |
|---|---|---|---|---|---|---|---|
| token | VC によって発行されたパートナーのアクセスキー | 文字列 | 0-256 bytes | はい | マッチされない | 要求が無効 | |
| keyword | 検索するキーワード文字列 | 文字列 | 0〜256 bytes | いいえ*（以下参照） | トークン | 無視 | |
| category | 検索する商品カテゴリ | 文字列 | 0〜40 bytes、上記に定義されているカテゴリ名の1つ | いいえ*（以下参照） | 前方一致 | 無視 | |
| merchant | EC サイト名 | 文字列 | 0-256 bytes | いいえ*（以下参照） | 完全 | 結果なし | |
| sub_store | EC サイトのサブストアID | 文字列 | 0-256 bytes | いいえ*（以下参照） | 完全 | 無視 | |
| adult | アダルト商品を検索結果に含めるかどうか | 文字列 「y」 または「n」 | いいえ | 「n」 | 無視 | ||
| price_max | フィルタに使用する商品の最大価格 | 0 以上の浮動少数 | 0-999999999 | いいえ | 範囲 | 無視 | |
| price_min | フィルタに使用する商品の最小価格 | 0 以上の浮動少数 | 0-999999999 | いいえ | 範囲 | 無視 | |
| rate_max | フィルタに使用する最大報酬率 | 0 以上の浮動少数 | 0-100 | いいえ | 範囲 | 無視 | |
| rate_min | フィルタに使用する最小報酬率 | 0 以上の浮動少数 | 0-100 | いいえ | 範囲 | 無視 | |
| fixed_max | フィルタに使用する最大定額報酬料 | 0 以上の浮動少数 | 0-999999999 | いいえ | 範囲 | 無視 | |
| fixed_min | フィルタに使用する最小定額報酬料 | 0 以上の浮動少数 | 0-999999999 | いいえ | 範囲 | 無視 | |
| fee_max | フィルタに使用する最大報酬額 | 0 以上の浮動少数 | 0-999999999 | いいえ | 範囲 | 無視 | |
| fee_min | フィルタに使用する最小報酬額 | 0 以上の浮動少数 | 0-999999999 | いいえ | 範囲 | 無視 | |
| vcptn | 注文の際に入力するポイント システム パラメータ | 文字列 | 0-255 bytes | いいえ | 無視 | ||
| page | 表示する結果ページの番号 | 正の整数 | 1-1000 | いいえ | 1 | 無視 | |
| results_per_page | 1 ページに表示する結果件数 | 正の整数 | 1-100 | いいえ | 20 | 無視 | |
| sort_by | ソートに使用する属性 | 文字列 | 「price」、「fee」、または「score」 | いいえ | 「score」 | 無視 | |
| sort_order | ソート順（昇順または降順） | 文字列 | 「asc」または「desc」 | いいえ | 「desc」 | 無視 |
パラメータ中にkeyword、categoryまたはsub_storeの内、最低1つは有効な値が含まれている必要があります。
