Product/Search

Description

Gets up to 30 products by keywords, genre or product id. Each product can be sold by one or multiple sellers and each shop can have a different price for them.

Resource URL

https://app.rakuten.co.jp/services/api/Product/Search/20140305

Resource Information

Auth Type App Key
Affiliation Support Yes

Parameters

App ID (string)

The Application ID that identifies your application. You can get it from https://webservice.rakuten.co.jp/.

Search keywords (string)

UTF-8 URL encoded string

The keyword parameter can have a maximum length of 128 single byte characters

The keyword parameter is delimited with single byte space characters. This defaults to an AND operation including all the keywords. To use OR instead set the orFlag to 1.

Each search keyword must be at least two single byte characters or one double byte character.

An exception is a minimum of two characters if the search keywords are using hiragana, katakana, or symbols.

Genre ID (string)

ID to specify a genre in Rakuten Ichiba.

Product ID (string)

ID of the product.

How many results to display on each page (integer)

An integer between 1 and 30.

Default Value: 30

Result page (integer)

An integer between 1 and 100.

Default Value: 1

Sort (string)

*UTF-8 URL encoding is required.

Valid Values:

  • standard Rakuten standard sort
  • -releaseDate
  • -seller
  • -satisfied

Default Value: standard

Minimum price (long)

An integer greater than 0 and less than 999,999,999

Maximum price (long)

An integer greater than 0 and less than 999,999,999

maxPrice must be larger than minPrice.

OR search flag (integer)

Choose between AND searches and OR searches when there are multiple keywords.

*It isn't possible to use a complex search condition like "(A and B) or C".

Valid Values:

  • 0 AND
  • 1 OR

Default Value: 0

Genre information flag (integer)

Valid Values:

  • 0 Do not get number of item in each genre.
  • 1 Get number of item in each genre.

Default Value: 0

Affiliate ID (string)

If this endpoint supports affiliation, here you can enter your affiliate ID. If you do, the links in the API response will include your affiliate ID.

Response format (string)

Format for the response output.

You can set this parameter to json or xml. JSON is usually the best option.

If you choose JSON, you can also set the callback parameter in order to use JSONP.

Valid Values:

  • json
  • xml

Default Value: json

Callback function name (string)

Function name to be used with the JSONP output

Please make sure you enter a UTF-8 URL encoded string, containing only a combination of alphanumeric characters, periods and underscores.

Choosing output fields (string)

By default API will return all the fields. You can specify what fields should be returned by using this parameter.

If you want to specify more than one parameter, please use comma (,) as separator.

For example, following request will only return itemName, itemPrice and itemUrl.

elements=itemName,itemPrice,itemUrl

Format version (integer)

Response format version.

If formatVersion=2 is set, the response format (JSON) will be improved.

In case of formatVersion=1:

The API response will return an array using the following format.

For example, you would need to use notation items[0].item.itemName to access itemName parameter.

{"items": [

{"item": {

"itemName": "a",

"itemPrice": 10

}},

{"item": {

"itemName": "b",

"itemPrice": 20

}}

]}

In case of formatVersion=2:

The API response will return an array using the following format.

For example, you would use the notation items[0].itemName to access the itemName parameter.

{"items": [

{

"itemName": "a",

"itemPrice": 10

},

{

"itemName": "b",

"itemPrice": 20

}

]}

Valid Values:

  • 1
  • 2

Default Value: 1

applicationId

App ID
string Required

The Application ID that identifies your application. You can get it from https://webservice.rakuten.co.jp/.

keyword

Search keywords
string At least one is required

UTF-8 URL encoded string

The keyword parameter can have a maximum length of 128 single byte characters

The keyword parameter is delimited with single byte space characters. This defaults to an AND operation including all the keywords. To use OR instead set the orFlag to 1.

Each search keyword must be at least two single byte characters or one double byte character.

An exception is a minimum of two characters if the search keywords are using hiragana, katakana, or symbols.

genreId

Genre ID
string At least one is required

ID to specify a genre in Rakuten Ichiba.

productId

Product ID
string At least one is required

ID of the product.

hits

How many results to display on each page
integer Optional

An integer between 1 and 30.

Default Value: 30

page

Result page
integer Optional

An integer between 1 and 100.

Default Value: 1

sort

Sort
string Optional

*UTF-8 URL encoding is required.

Valid Values:

  • standard Rakuten standard sort
  • -releaseDate
  • -seller
  • -satisfied

Default Value: standard

minPrice

Minimum price
long Optional

An integer greater than 0 and less than 999,999,999

maxPrice

Maximum price
long Optional

An integer greater than 0 and less than 999,999,999

maxPrice must be larger than minPrice.

orFlag

OR search flag
integer Optional

Choose between AND searches and OR searches when there are multiple keywords.

*It isn't possible to use a complex search condition like "(A and B) or C".

Valid Values:

  • 0 AND
  • 1 OR

Default Value: 0

genreInformationFlag

Genre information flag
integer Optional

Valid Values:

  • 0 Do not get number of item in each genre.
  • 1 Get number of item in each genre.

Default Value: 0

affiliateId

Affiliate ID
string Optional

If this endpoint supports affiliation, here you can enter your affiliate ID. If you do, the links in the API response will include your affiliate ID.

format

Response format
string Optional

Format for the response output.

You can set this parameter to json or xml. JSON is usually the best option.

If you choose JSON, you can also set the callback parameter in order to use JSONP.

Valid Values:

  • json
  • xml

Default Value: json

callback

Callback function name
string Optional

Function name to be used with the JSONP output

Please make sure you enter a UTF-8 URL encoded string, containing only a combination of alphanumeric characters, periods and underscores.

elements

Choosing output fields
string Optional

By default API will return all the fields. You can specify what fields should be returned by using this parameter.

If you want to specify more than one parameter, please use comma (,) as separator.

For example, following request will only return itemName, itemPrice and itemUrl.

elements=itemName,itemPrice,itemUrl

formatVersion

Format version
integer Optional

Response format version.

If formatVersion=2 is set, the response format (JSON) will be improved.

In case of formatVersion=1:

The API response will return an array using the following format.

For example, you would need to use notation items[0].item.itemName to access itemName parameter.

{"items": [

{"item": {

"itemName": "a",

"itemPrice": 10

}},

{"item": {

"itemName": "b",

"itemPrice": 20

}}

]}

In case of formatVersion=2:

The API response will return an array using the following format.

For example, you would use the notation items[0].itemName to access the itemName parameter.

{"items": [

{

"itemName": "a",

"itemPrice": 10

},

{

"itemName": "b",

"itemPrice": 20

}

]}

Valid Values:

  • 1
  • 2

Default Value: 1

Response Example

Request

https://app.rakuten.co.jp/services/api/Product/Search/20140305?applicationId=REPLACE_WITH_YOUR_APP_ID&keyword=列車&hits=5

Response
{
  "count": 2492,
  "page": 1,
  "first": 1,
  "last": 5,
  "hits": 5,
  "pageCount": 100,
  "Products": [
    {
      "Product": {
        "productId": "c6a423267274b6ae4fdba858dd1909a0",
        "productName": "アートディンク A列車で行こう9 Ver4.0 マスターズ コンプリートパック",
        "productNo": "",
        "brandName": "",
        "productUrlPC": "http://product.rakuten.co.jp/product/-/c6a423267274b6ae4fdba858dd1909a0/",
        "productUrlMobile": "http://m.product.rakuten.co.jp/product/c6a423267274b6ae4fdba858dd1909a0/",
        "affiliateUrl": null,
        "smallImageUrl": "http://thumbnail.image.rakuten.co.jp/ran/img/1001/0004/988/640/001/723/10010004988640001723_1.jpg?_ex=64x64",
        "mediumImageUrl": "http://thumbnail.image.rakuten.co.jp/ran/img/1001/0004/988/640/001/723/10010004988640001723_1.jpg?_ex=128x128",
        "productCaption": "",
        "releaseDate": "",
        "makerCode": "104988640",
        "makerName": "アートディンク",
        "makerNameKana": "アートデインク",
        "makerNameFormal": "株式会社アートディンク",
        "makerPageUrlPC": "http://product.rakuten.co.jp/category/-/211723/104988640/",
        "makerPageUrlMobile": "http://m.product.rakuten.co.jp/category/211723/104988640/",
        "itemCount": 15,
        "salesItemCount": 15,
        "usedExcludeCount": 15,
        "usedExcludeSalesItemCount": 15,
        "maxPrice": 19057,
        "salesMaxPrice": 19057,
        "usedExcludeMaxPrice": 19057,
        "usedExcludeSalesMaxPrice": 19057,
        "minPrice": 14790,
        "salesMinPrice": 14790,
        "usedExcludeMinPrice": 14790,
        "usedExcludeSalesMinPrice": 14790,
        "averagePrice": 17078,
        "reviewCount": 2,
        "reviewAverage": 4.5,
        "reviewUrlPC": "http://product.rakuten.co.jp/product/-/c6a423267274b6ae4fdba858dd1909a0/review/",
        "reviewUrlMobile": "http://m.product.rakuten.co.jp/product/c6a423267274b6ae4fdba858dd1909a0/review/",
        "rank": 13,
        "rankTargetGenreId": "211706",
        "rankTargetProductCount": 5248,
        "genreId": "211723",
        "genreName": "その他",
        "ProductDetails": []
      }
    },
    {
      "Product": {
        "productId": "fa5c46cab237a304b4d32b730bea7807",
        "productName": "アンパンマントロッコ DK-7127",
        "productNo": "DK-7127",
        "brandName": "",
        "productUrlPC": "http://product.rakuten.co.jp/product/-/fa5c46cab237a304b4d32b730bea7807/",
        "productUrlMobile": "http://m.product.rakuten.co.jp/product/fa5c46cab237a304b4d32b730bea7807/",
        "affiliateUrl": null,
        "smallImageUrl": "http://thumbnail.image.rakuten.co.jp/ran/img/1001/0004/971/404/308/664/10010004971404308664_1.jpg?_ex=64x64",
        "mediumImageUrl": "http://thumbnail.image.rakuten.co.jp/ran/img/1001/0004/971/404/308/664/10010004971404308664_1.jpg?_ex=128x128",
        "productCaption": "",
        "releaseDate": "",
        "makerCode": "104971404",
        "makerName": "アガツマ",
        "makerNameKana": "アガツマ",
        "makerNameFormal": "株式会社アガツマ",
        "makerPageUrlPC": "http://product.rakuten.co.jp/category/-/101198/104971404/",
        "makerPageUrlMobile": "http://m.product.rakuten.co.jp/category/101198/104971404/",
        "itemCount": 25,
        "salesItemCount": 18,
        "usedExcludeCount": 25,
        "usedExcludeSalesItemCount": 18,
        "maxPrice": 2669,
        "salesMaxPrice": 2298,
        "usedExcludeMaxPrice": 2669,
        "usedExcludeSalesMaxPrice": 2298,
        "minPrice": 1300,
        "salesMinPrice": 1300,
        "usedExcludeMinPrice": 1300,
        "usedExcludeSalesMinPrice": 1300,
        "averagePrice": 1884,
        "reviewCount": 1,
        "reviewAverage": 5,
        "reviewUrlPC": "http://product.rakuten.co.jp/product/-/fa5c46cab237a304b4d32b730bea7807/review/",
        "reviewUrlMobile": "http://m.product.rakuten.co.jp/product/fa5c46cab237a304b4d32b730bea7807/review/",
        "rank": 10169,
        "rankTargetGenreId": "207563",
        "rankTargetProductCount": 17707,
        "genreId": "101198",
        "genreName": "その他",
        "ProductDetails": []
      }
    },
    {
      "Product": {
        "productId": "94f5fffc35d5d45bc0c392d6e3d58f5e",
        "productName": "クイニーザップ ベビーカー イッパイツナゴウ EF200セット",
        "productNo": "",
        "brandName": "",
        "productUrlPC": "http://product.rakuten.co.jp/product/-/94f5fffc35d5d45bc0c392d6e3d58f5e/",
        "productUrlMobile": "http://m.product.rakuten.co.jp/product/94f5fffc35d5d45bc0c392d6e3d58f5e/",
        "affiliateUrl": null,
        "smallImageUrl": "http://thumbnail.image.rakuten.co.jp/ran/img/1001/0004/904/810/348/856/10010004904810348856_1.jpg?_ex=64x64",
        "mediumImageUrl": "http://thumbnail.image.rakuten.co.jp/ran/img/1001/0004/904/810/348/856/10010004904810348856_1.jpg?_ex=128x128",
        "productCaption": "",
        "releaseDate": "",
        "makerCode": "104904810",
        "makerName": "タカラトミー",
        "makerNameKana": "タカラトミー",
        "makerNameFormal": "株式会社タカラトミー",
        "makerPageUrlPC": "http://product.rakuten.co.jp/category/-/213553/104904810/",
        "makerPageUrlMobile": "http://m.product.rakuten.co.jp/category/213553/104904810/",
        "itemCount": 13,
        "salesItemCount": 4,
        "usedExcludeCount": 13,
        "usedExcludeSalesItemCount": 4,
        "maxPrice": 9490,
        "salesMaxPrice": 9490,
        "usedExcludeMaxPrice": 9490,
        "usedExcludeSalesMaxPrice": 9490,
        "minPrice": 2800,
        "salesMinPrice": 9074,
        "usedExcludeMinPrice": 2800,
        "usedExcludeSalesMinPrice": 9074,
        "averagePrice": 5753,
        "reviewCount": 1,
        "reviewAverage": 1,
        "reviewUrlPC": "http://product.rakuten.co.jp/product/-/94f5fffc35d5d45bc0c392d6e3d58f5e/review/",
        "reviewUrlMobile": "http://m.product.rakuten.co.jp/product/94f5fffc35d5d45bc0c392d6e3d58f5e/review/",
        "rank": 3176,
        "rankTargetGenreId": "551256",
        "rankTargetProductCount": 6862,
        "genreId": "213553",
        "genreName": "その他",
        "ProductDetails": [
          {
            "detail": {
              "name": "シリーズ名/愛称",
              "value": "プラレール"
            }
          },
          {
            "detail": {
              "name": "本体サイズ(H×W×D)mm",
              "value": "51×41×1120"
            }
          },
          {
            "detail": {
              "name": "対象年齢",
              "value": "3歳以上"
            }
          },
          {
            "detail": {
              "name": "使用乾電池",
              "value": "単2電池×1本(別売)"
            }
          }
        ]
      }
    },
    {
      "Product": {
        "productId": "11682ec5f5d5cad9c752cb799f973093",
        "productName": "めちゃモテ・サックスアルトサックス A列車で行こう",
        "productNo": "",
        "brandName": "",
        "productUrlPC": "http://product.rakuten.co.jp/product/-/11682ec5f5d5cad9c752cb799f973093/",
        "productUrlMobile": "http://m.product.rakuten.co.jp/product/11682ec5f5d5cad9c752cb799f973093/",
        "affiliateUrl": null,
        "smallImageUrl": "http://thumbnail.image.rakuten.co.jp/ran/img/1001/0004/580/218/866/361/10010004580218866361_1.jpg?_ex=64x64",
        "mediumImageUrl": "http://thumbnail.image.rakuten.co.jp/ran/img/1001/0004/580/218/866/361/10010004580218866361_1.jpg?_ex=128x128",
        "productCaption": "",
        "releaseDate": "2012年2月17日",
        "makerCode": "10458021886",
        "makerName": "ウィンズスコア",
        "makerNameKana": "ウインズスコア",
        "makerNameFormal": "株式会社ウィンズスコア",
        "makerPageUrlPC": "http://product.rakuten.co.jp/category/-/209332/10458021886/",
        "makerPageUrlMobile": "http://m.product.rakuten.co.jp/category/209332/10458021886/",
        "itemCount": 5,
        "salesItemCount": 5,
        "usedExcludeCount": 5,
        "usedExcludeSalesItemCount": 5,
        "maxPrice": 1080,
        "salesMaxPrice": 1080,
        "usedExcludeMaxPrice": 1080,
        "usedExcludeSalesMaxPrice": 1080,
        "minPrice": 1080,
        "salesMinPrice": 1080,
        "usedExcludeMinPrice": 1080,
        "usedExcludeSalesMinPrice": 1080,
        "averagePrice": 1080,
        "reviewCount": 0,
        "reviewAverage": 0,
        "reviewUrlPC": "http://product.rakuten.co.jp/product/-/11682ec5f5d5cad9c752cb799f973093/review/",
        "reviewUrlMobile": "http://m.product.rakuten.co.jp/product/11682ec5f5d5cad9c752cb799f973093/review/",
        "rank": 53068,
        "rankTargetGenreId": "209332",
        "rankTargetProductCount": 134669,
        "genreId": "209332",
        "genreName": "全般",
        "ProductDetails": []
      }
    },
    {
      "Product": {
        "productId": "673ba66b41abdc42e2c0be1091d58240",
        "productName": "A列車で行こう3D 3DS",
        "productNo": "CTRPAALJ",
        "brandName": "",
        "productUrlPC": "http://product.rakuten.co.jp/product/-/673ba66b41abdc42e2c0be1091d58240/",
        "productUrlMobile": "http://m.product.rakuten.co.jp/product/673ba66b41abdc42e2c0be1091d58240/",
        "affiliateUrl": null,
        "smallImageUrl": "http://thumbnail.image.rakuten.co.jp/ran/img/1001/0004/988/640/200/034/10010004988640200034_1.jpg?_ex=64x64",
        "mediumImageUrl": "http://thumbnail.image.rakuten.co.jp/ran/img/1001/0004/988/640/200/034/10010004988640200034_1.jpg?_ex=128x128",
        "productCaption": "鉄道会社の社長となり、都市開発を行うシリーズ最新作。列車や建物の種類が大幅に増加し、老朽化や主力資源、街並の変化など、時代の変遷を味わえる。",
        "releaseDate": "2014年02月13日",
        "makerCode": "104988640",
        "makerName": "アートディンク",
        "makerNameKana": "アートデインク",
        "makerNameFormal": "株式会社アートディンク",
        "makerPageUrlPC": "http://product.rakuten.co.jp/category/-/562905/104988640/",
        "makerPageUrlMobile": "http://m.product.rakuten.co.jp/category/562905/104988640/",
        "itemCount": 68,
        "salesItemCount": 33,
        "usedExcludeCount": 36,
        "usedExcludeSalesItemCount": 20,
        "maxPrice": 10890,
        "salesMaxPrice": 10890,
        "usedExcludeMaxPrice": 10890,
        "usedExcludeSalesMaxPrice": 10890,
        "minPrice": 3880,
        "salesMinPrice": 4082,
        "usedExcludeMinPrice": 3880,
        "usedExcludeSalesMinPrice": 4930,
        "averagePrice": 5207,
        "reviewCount": 18,
        "reviewAverage": 4.67,
        "reviewUrlPC": "http://product.rakuten.co.jp/product/-/673ba66b41abdc42e2c0be1091d58240/review/",
        "reviewUrlMobile": "http://m.product.rakuten.co.jp/product/673ba66b41abdc42e2c0be1091d58240/review/",
        "rank": 2174,
        "rankTargetGenreId": "553848",
        "rankTargetProductCount": 4870,
        "genreId": "562905",
        "genreName": "その他",
        "ProductDetails": [
          {
            "detail": {
              "name": "フリガナ",
              "value": "エーレッシャデイコウスリーディー"
            }
          },
          {
            "detail": {
              "name": "プラットフォーム",
              "value": "3DS"
            }
          },
          {
            "detail": {
              "name": "ジャンル",
              "value": "シミュレーション"
            }
          },
          {
            "detail": {
              "name": "テイスト",
              "value": "経営・鉄道"
            }
          },
          {
            "detail": {
              "name": "型番",
              "value": "CTRPAALJ"
            }
          },
          {
            "detail": {
              "name": "その他",
              "value": "ダウンロードコンテンツ対応"
            }
          },
          {
            "detail": {
              "name": "CEROレーティング",
              "value": "A 全年齢対象"
            }
          },
          {
            "detail": {
              "name": "プレイ人数",
              "value": "1人"
            }
          },
          {
            "detail": {
              "name": "ディレクター",
              "value": "飯塚正樹"
            }
          }
        ]
      }
    }
  ],
  "GenreInformation": {
    "parent": [],
    "current": [],
    "children": []
  }
}

Try It

Set the Parameters

  Show More Parameters

Request

https://app.rakuten.co.jp/services/api/Product/Search/20140305?applicationId=REPLACE_WITH_YOUR_APP_ID

Response