返礼品を検索する
GET/api/v1/items
検索語・カテゴリ・比べるグループ・自治体・寄付額の範囲で返礼品を探します。単価(1kgあたりの寄付額など)の安い順にも並べられます。取得から24時間以内の掲載中の品だけを返します。
| パラメーター | 指定 | 内容 |
|---|---|---|
q | q・genre・group・municipality のいずれかは必須 | 検索語(商品名に含む語)。空白で区切るとすべてを含む品(AND、5語まで)。例: 米 5kg |
genre | 同上 | カテゴリ(楽天のジャンルID)。下の階層のジャンルも含む。例: 110472(お米)、110428(牛肉)。/api/v1/groups の category_id でも分かります |
group | 同上 | 比べるグループ(/api/v1/groups の key)。同じ品目・同じ条件の品だけに絞る。例: 110428:beef_class=和牛|form=生肉(精肉) |
municipality | 同上 | 自治体名の一部・自治体コード(6桁)・店舗コードのいずれか |
min_price | 任意 | 寄付額の下限(円) |
max_price | 任意 | 寄付額の上限(円) |
sort | 任意 | reviews(レビュー件数順・既定)/ rating(評価順)/ price_asc(寄付額の安い順)/ price_desc(高い順)/ updated(更新順)/ unit_price(単価の安い順) |
unit | 任意(sort=unit_price のとき) | 単価の単位。kg / L / m / 個:袋 のように。省略すると、条件に合う品で最も多い単位 |
limit | 任意 | 件数。1〜20(既定10) |
offset | 任意 | 何件目から返すか。0〜100 |
例: https://furusato-live.jp/api/v1/items?genre=110472&max_price=10000&sort=unit_price
- sort=unit_price は、比べられる品(comparison_group がある品)のうち、外れ値を除いた正確な単価のある品だけを並べます。
- 条件の違う品(和牛と輸入牛、生肉と加工品など)を同じ物差しで比べないよう、単価で並べるときは group で絞ることをおすすめします。group を指定しないときは、応答の facets.groups に候補のグループ(件数の多い順、items_url 付き)が入ります。