Search
The search portion of the API is considered BETA and is subject to change at anytime. Updates/Changes will be announced via our blog.
What does it do?
What does it do?
The search portion of the API allows you find the products you are looking for in a more accurate and better way. Through the features you can get relevancy results or a custom search using biased results.
The Product API
Base URL: http://api.remix.bestbuy.com/{version}/products
Curent Version: V1
HTTP Method: GET
Base URL: http://api.remix.bestbuy.com/{version}/products
Curent Version: V1
HTTP Method: GET
Default Queries:
If you run a query without setting the optional parameters, this is what happens:
Attributes
Each query URL will have required and optional parameters that must be included to complete a query.
| Parameters | Required | Options |
|---|---|---|
| apiKey | yes | String Value For more information, see Requesting a Key. |
| format | no | String Value json or xml |
| page | no | Positive Integer Value |
| show | no | String Value Specify string of "all" or Product Attributes Example: sku,name,url Comma delimited |
| sort | no | String Value Attribute.{SORT METHOD} Methods: desc, asc |
The search portion of the API is considered BETA and is subject to change at anytime. Updates/Changes will be announced via our blog.
How search works in the API
How search works in the API
- Search terms are wildcarded
- Terms are looked for in attributes name and description. A 1.5x weight is placed on name and a .75x weight is placed on descriptions. This means you will see that terms that "hit" in the name attribute cause the result to rise higher in the result list.
| Basic Examples |
|---|
| #1 This is the most basic query that will return page 1 of all products that match our "digital photo printer" search term. http://api.remix.bestbuy.com/v1/products(search=digital%20photo%20printer)?apiKey={YourApiKey} |
| #2 This query changes the same #1 query format from the default XML to JSON. http://api.remix.bestbuy.com/v1/products(search=digital%20photo%20printer)?format=json&apiKey={YourApiKey} |
| #3 This query changed the same #1 query to the third page. http://api.remix.bestbuy.com/v1/products(search=digital%20photo%20printer)?page=3&apiKey={API KEY HERE} |
| #4 This query changes the same #1 query from the subset attributes to ALL attributes. http://api.remix.bestbuy.com/v1/products(search=digital%20photo%20printer)?show=all&apiKey={API KEY HERE} |
