Developers

Developers

  • BASE API
  • BASE Template

›Item

BASE API

  • はじめに
  • OAuth

    • oauth/authorize
    • oauth/access_token
    • oauth/refresh_token

    Users

    • users/me

    Item

    • items
    • items/search
    • items/detail
    • items/add
    • items/edit
    • items/delete
    • items/add_image
    • items/delete_image
    • items/edit_stock
    • items/delete_variation

    Category

    • categories
    • categories/add
    • categories/edit
    • categories/delete

    Item Category

    • item_categories/detail
    • item_categories/add
    • item_categories/delete

    Orders

    • orders
    • orders/detail
    • orders/edit_status

    Savings

    • savings

    Delivery Company

    • delivery_companies

    Search

    • search
    • search/refresh

items/search

GET /1/items/search

ショップ内の商品の検索結果を取得

※商品情報が全文検索用DBに反映されるまでに最大1時間ほどかかる場合があります。

scope

read_items

リクエストパラメーター

NameDescription
q検索キーワード。スペース区切りで複数指定。(必須)
fields検索対象のカラム。title、detail、categories、shop_nameを','区切りで複数指定。 (デフォルト: title,detail,categories)
order並び替え項目。list_order、modifiedのいずれか (任意 デフォルト: キーワードマッチ度順)
sort並び順。asc か desc のいずれか (任意 デフォルト: desc)
limitリミット (任意 デフォルト: 10, MAX: 100)
offsetオフセット (任意 デフォルト: 0, MAX 10000)

レスポンスの例

{
  "items":[
    {
      "item_id":1234,
      "title":"Tシャツ",
      "detail":"とってもオシャレなTシャツです。",
      "price":3900,
      "proper_price":null,
      "item_tax_type":1,
      "stock":10,
      "visible":1,
      "list_order":1,
      "identifier":null,
      "modified":1414731174,

      "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,

      "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
        }
      ],
      "options":[
        {
          "option_id":3,
          "option_name":"選択式オプション",
          "option_type":"select",
          "required":true,
          "list_order":3,
          "select":{
            "option_variations":[
              {
                "option_variation_id":5,
                "variation_name":"選択式項目その1",
                "price":100,
                "list_order":1
              },
              {
                "option_variation_id":6,
                "variation_name":"選択式項目その2",
                "price":200,
                "list_order":2
              }
            ]
          },
          "form":null
        },
        {
          "option_id":4,
          "option_name":"文字入れ式オプション",
          "option_type":"form",
          "required":false,
          "select":null,
          "list_order":4,
          "form":{
            "option_variation_id":7,
            "price":300,
            "free_text_description":"補足説明",
            "free_text_max_length":30,
            "list_order":1
          }
        }
      ]
    }
  ]
}

解説

  • item_id - 商品を識別するユニークなID
  • price - 商品の価格 (税込み)
  • title - 商品名
  • detail - 商品説明
  • proper_price - 商品の通常価格 (税込み)
  • item_tax_type - 商品の税率設定。1:標準税率、2:軽減税率
  • stock - 在庫数
  • visible - 表示フラグ。1:表示、0:非表示
  • list_order - 表示順
  • identifier - 商品コード
  • img1_origin - 商品画像1のオリジナルサイズ
  • variations - バリエーション情報
    • variation_id - バリエーションを識別するユニークなID
    • variation - バリエーションの種類
    • variation_stock - バリエーションの在庫数
    • variation_identifier - バリエーションの種類コード
    • barcode - バリエーションのJAN/GTIN
  • options - 商品オプション情報
    • option_id - 商品オプションを識別するユニークなID
    • option_name - 商品オプション名
    • option_type - 商品オプションのタイプ select:選択式, form:文字入れ式
    • required - 商品オプションが必須フラグ true:必須、false:任意
    • list_order - 商品オプション表示順
    • select - 選択式情報 (option_type = form の時は値が null )
      • option_variations
        • option_variation_id - 商品オプション項目を識別するユニークなID
        • variation_name - 商品オプション項目名
        • price - 商品オプション価格
        • list_order - 商品オプション項目表示順
    • form - 文字入れ式情報 (option_type = select の時は値が null )
      • option_variation_id - 商品オプション項目を識別するユニークなID
      • price - 商品オプション価格
      • free_text_description - 文字入れ式の補足説明
      • free_text_max_length - 文字入れ式の文字数制限
      • list_order - 商品オプション項目表示順

エラーレスポンスの例

{
  "error":"search_error",
  "error_description":"Request depth (10001) exceeded, limit=10000"
}
← itemsitems/detail →
  • scope
  • リクエストパラメーター
  • レスポンスの例
  • 解説
  • エラーレスポンスの例
  • API利用規約
  • デザインマーケット利用規約
© 2012-2025 BASE, Inc.