search

GET /1/search

※ 2022年2月21日をもちまして新規受付を終了しました。

BASE全体の商品の検索結果を取得

※現在Search APIの1日の利用回数の上限は10000回に設定しています。

※非公開の商品は検索できません。

認証

client_idとclient_secretで認証します。

※Search APIを使用するには専用のclient_idとclient_secretが必要です。

リクエストパラメーター

Name	Description
client_id	Search API専用のクライアントID (必須)
client_secret	Search API専用のクライアントシークレット (必須)
q	検索キーワード。スペース区切りで複数指定 (必須)
sort	並び順。item_id、price、stock、order_count、modifiedのascまたはdesc (例: order_count desc,item_id asc) (デフォルト: BASEのおすすめ順)
start	取得するスタート位置 (デフォルト: 0)
size	取得件数 (デフォルト: 10, MAX: 50)
fields	検索対象のカラム (デフォルト: shop_name,title,detail,categories)
shop_id	ショップID (任意)

レスポンスの例

{
  "found":2,
  "start":0,
  "items":[
    {
      "item_id":1234,
      "title":"Tシャツ",
      "detail":"とってもオシャレなTシャツです。",
      "price":3900,
      "proper_price":null,
      "stock":10,
      "visible":1,
      "list_order":1,
      "identifier":null,
      
      "img1_origin":"https://base-ec2.akamaized.net/images/item/origin/45fc036c772c8469fa40396b2ef0fb9b.jpg",
      "img1_76":"https://baseec-img-mng.akamaized.net/images/item/origin/45fc036c772c8469fa40396b2ef0fb9b.jpg?imformat=generic&q=90&im=Resize,width=76,type=normal",
      "img1_146":"https://baseec-img-mng.akamaized.net/images/item/origin/45fc036c772c8469fa40396b2ef0fb9b.jpg?imformat=generic&q=90&im=Resize,width=146,type=normal",
      "img1_300":"https://baseec-img-mng.akamaized.net/images/item/origin/45fc036c772c8469fa40396b2ef0fb9b.jpg?imformat=generic&q=90&im=Resize,width=300,type=normal",
      "img1_500":"https://baseec-img-mng.akamaized.net/images/item/origin/45fc036c772c8469fa40396b2ef0fb9b.jpg?imformat=generic&q=90&im=Resize,width=500,type=normal",
      "img1_640":"https://baseec-img-mng.akamaized.net/images/item/origin/45fc036c772c8469fa40396b2ef0fb9b.jpg?imformat=generic&q=90&im=Resize,width=640,type=normal",
      "img1_sp_480":"https://baseec-img-mng.akamaized.net/images/item/origin/45fc036c772c8469fa40396b2ef0fb9b.jpg?imformat=generic&q=90&im=Resize,width=480,height=480,aspect=fill,type=downsize;Crop,width=480,height=480,gravity=Center",
      "img1_sp_640":"https://baseec-img-mng.akamaized.net/images/item/origin/45fc036c772c8469fa40396b2ef0fb9b.jpg?imformat=generic&q=90&im=Resize,width=640,height=640,aspect=fill,type=downsize;Crop,width=640,height=640,gravity=Center",

      "img2_origin":"https://base-ec2.akamaized.net/images/item/origin/2a4de4965fa23b7b89944199713a827e.jpg",
      "img2_76":"https://baseec-img-mng.akamaized.net/images/item/origin/2a4de4965fa23b7b89944199713a827e.jpg?imformat=generic&q=90&im=Resize,width=76,type=normal",
      "img2_146":"https://baseec-img-mng.akamaized.net/images/item/origin/2a4de4965fa23b7b89944199713a827e.jpg?imformat=generic&q=90&im=Resize,width=146,type=normal",
      "img2_300":"https://baseec-img-mng.akamaized.net/images/item/origin/2a4de4965fa23b7b89944199713a827e.jpg?imformat=generic&q=90&im=Resize,width=300,type=normal",
      "img2_500":"https://baseec-img-mng.akamaized.net/images/item/origin/2a4de4965fa23b7b89944199713a827e.jpg?imformat=generic&q=90&im=Resize,width=500,type=normal",
      "img2_640":"https://baseec-img-mng.akamaized.net/images/item/origin/2a4de4965fa23b7b89944199713a827e.jpg?imformat=generic&q=90&im=Resize,width=640,type=normal",
      "img2_sp_480":"https://baseec-img-mng.akamaized.net/images/item/origin/2a4de4965fa23b7b89944199713a827e.jpg?imformat=generic&q=90&im=Resize,width=480,height=480,aspect=fill,type=downsize;Crop,width=480,height=480,gravity=Center",
      "img2_sp_640":"https://baseec-img-mng.akamaized.net/images/item/origin/2a4de4965fa23b7b89944199713a827e.jpg?imformat=generic&q=90&im=Resize,width=640,height=640,aspect=fill,type=downsize;Crop,width=640,height=640,gravity=Center",

      "img3_origin":null,
      "img3_76":null,
      "img3_146":null,
      "img3_300":null,
      "img3_500":null,
      "img3_640":null,
      "img3_sp_480":null,
      "img3_sp_640":null,

      "img4_origin":null,
      "img4_76":null,
      "img4_146":null,
      "img4_300":null,
      "img4_500":null,
      "img4_640":null,
      "img4_sp_480":null,
      "img4_sp_640":null,

      "img5_origin":null,
      "img5_76":null,
      "img5_146":null,
      "img5_300":null,
      "img5_500":null,
      "img5_640":null,
      "img5_sp_480":null,
      "img5_sp_640":null,

      "modified":1355815892,
      "variations":[
        {
          "variation_id":11,
          "variation":"黒色",
          "variation_stock":6,
          "variation_identifier":null,
          "barcode":null
        },
        {
          "variation_id":12,
          "variation":"白色",
          "variation_stock":4,
          "variation_identifier":null,
          "barcode":null
        }
      ],

      "shop_id":"shop",
      "shop_name":"BASEショップ",
      "shop_url":"http://shop.thebase.in",

      "categories":[
        "Tシャツ",
        "オシャレ"
      ]
    },
    {
      "item_id":2234,
      "title":"奇抜なTシャツ",
      "detail":"とっても奇抜なTシャツです。",
      "price":4900,
      "proper_price":null,
      "stock":20,
      "visible":1,
      "list_order":1,
      "identifier":null,
      
      "img1_origin":"https://base-ec2.akamaized.net/images/item/origin/45fc036c772c8469fa40396b2ef0fb9b.jpg",
      "img1_76":"https://baseec-img-mng.akamaized.net/images/item/origin/45fc036c772c8469fa40396b2ef0fb9b.jpg?imformat=generic&q=90&im=Resize,width=76,type=normal",
      "img1_146":"https://baseec-img-mng.akamaized.net/images/item/origin/45fc036c772c8469fa40396b2ef0fb9b.jpg?imformat=generic&q=90&im=Resize,width=146,type=normal",
      "img1_300":"https://baseec-img-mng.akamaized.net/images/item/origin/45fc036c772c8469fa40396b2ef0fb9b.jpg?imformat=generic&q=90&im=Resize,width=300,type=normal",
      "img1_500":"https://baseec-img-mng.akamaized.net/images/item/origin/45fc036c772c8469fa40396b2ef0fb9b.jpg?imformat=generic&q=90&im=Resize,width=500,type=normal",
      "img1_640":"https://baseec-img-mng.akamaized.net/images/item/origin/45fc036c772c8469fa40396b2ef0fb9b.jpg?imformat=generic&q=90&im=Resize,width=640,type=normal",
      "img1_sp_480":"https://baseec-img-mng.akamaized.net/images/item/origin/45fc036c772c8469fa40396b2ef0fb9b.jpg?imformat=generic&q=90&im=Resize,width=480,height=480,aspect=fill,type=downsize;Crop,width=480,height=480,gravity=Center",
      "img1_sp_640":"https://baseec-img-mng.akamaized.net/images/item/origin/45fc036c772c8469fa40396b2ef0fb9b.jpg?imformat=generic&q=90&im=Resize,width=640,height=640,aspect=fill,type=downsize;Crop,width=640,height=640,gravity=Center",

      "img2_origin":"https://base-ec2.akamaized.net/images/item/origin/2a4de4965fa23b7b89944199713a827e.jpg",
      "img2_76":"https://baseec-img-mng.akamaized.net/images/item/origin/2a4de4965fa23b7b89944199713a827e.jpg?imformat=generic&q=90&im=Resize,width=76,type=normal",
      "img2_146":"https://baseec-img-mng.akamaized.net/images/item/origin/2a4de4965fa23b7b89944199713a827e.jpg?imformat=generic&q=90&im=Resize,width=146,type=normal",
      "img2_300":"https://baseec-img-mng.akamaized.net/images/item/origin/2a4de4965fa23b7b89944199713a827e.jpg?imformat=generic&q=90&im=Resize,width=300,type=normal",
      "img2_500":"https://baseec-img-mng.akamaized.net/images/item/origin/2a4de4965fa23b7b89944199713a827e.jpg?imformat=generic&q=90&im=Resize,width=500,type=normal",
      "img2_640":"https://baseec-img-mng.akamaized.net/images/item/origin/2a4de4965fa23b7b89944199713a827e.jpg?imformat=generic&q=90&im=Resize,width=640,type=normal",
      "img2_sp_480":"https://baseec-img-mng.akamaized.net/images/item/origin/2a4de4965fa23b7b89944199713a827e.jpg?imformat=generic&q=90&im=Resize,width=480,height=480,aspect=fill,type=downsize;Crop,width=480,height=480,gravity=Center",
      "img2_sp_640":"https://baseec-img-mng.akamaized.net/images/item/origin/2a4de4965fa23b7b89944199713a827e.jpg?imformat=generic&q=90&im=Resize,width=640,height=640,aspect=fill,type=downsize;Crop,width=640,height=640,gravity=Center",

      "img3_origin":null,
      "img3_76":null,
      "img3_146":null,
      "img3_300":null,
      "img3_500":null,
      "img3_640":null,
      "img3_sp_480":null,
      "img3_sp_640":null,

      "img4_origin":null,
      "img4_76":null,
      "img4_146":null,
      "img4_300":null,
      "img4_500":null,
      "img4_640":null,
      "img4_sp_480":null,
      "img4_sp_640":null,

      "img5_origin":null,
      "img5_76":null,
      "img5_146":null,
      "img5_300":null,
      "img5_500":null,
      "img5_640":null,
      "img5_sp_480":null,
      "img5_sp_640":null,

      "modified":1355815892,
      "variations":[],

      "shop_id":"shop",
      "shop_name":"BASEショップ",
      "shop_url":"http://shop.thebase.in",

      "categories":[
        "Tシャツ",
        "奇抜"
      ]
    }
  ]
}

解説

• item_id - 商品を識別するユニークなID
• price - 商品の値段 (税込み)
• proper_price - 商品の通常価格 (税込み)
• stock - 在庫数
• visible - 表示フラグ。1:表示、0:非表示
• list_order - 表示順
• identifier - 商品コード
• img1_origin - 商品画像1のオリジナルサイズ。オリジナル以外はバッチで作成されるため、存在しない場合があります。
• variations - バリエーション情報
  • variation_id - バリエーションを識別するユニークなID
  • variation - バリエーションの種類
  • variation_stock - バリエーションの在庫数
  • variation_identifier - バリエーションの種類コード
  • barcode - バリエーションのJAN/GTIN

エラーレスポンスの例

{
  "error":"auth_error",
  "error_description":"不正なクライアントです。"
}

{
  "error":"search_error",
  "error_description":"不正なパラメーターです。"
}

{
  "error":"day_api_limit",
  "error_description":"1日のAPIの利用上限を超えました。日付が変わってからもう一度アクセスしてください。"
}