Category Queries

What does it do?
The categories query will allow you to traverse throught the different bestbuy.com categories. You will also be able to perform product searches based on categories.
The Categories API
           Base URL: http://api.remix.bestbuy.com/{version}/category
          Curent Version: V1
          HTTP Method: GET
Default Queries:
If you run a query without setting the optional parameters, this is what happens:
  • Returns in XML Format. For all attributes see Parameter [format]
  • Sorted by category > id. [sort]
  • All possible attributes are shown by default. [show]
  • Results will be page 1 of X. 10 results per page.[page]
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: id, name
Comma delimited
sort no String Value
Attribute.{SORT METHOD}
Methods: desc, asc
Basic Examples
#1 This is the most basic query that will return page 1 of all categories.
          http://api.remix.bestbuy.com/v1/categories?apiKey={YourApiKey}
#2 This query changes the same #1 query format from the default XML to JSON.
          http://api.remix.bestbuy.com/v1/categories?format=json&apiKey={YourApiKey}
#3 This query changed the same #1 query to the third page.
          http://api.remix.bestbuy.com/v1/categories?page=3&apiKey={API KEY HERE}
#4 This query changes the same #1 query from the default all attributes to a subset of attributes.
          http://api.remix.bestbuy.com/v1/categories?show=id,name&apiKey={API KEY HERE}
#5 This query changes the same #1 query to sort by the region attribute in descending manner.
          http://api.remix.bestbuy.com/v1/categories?sort=name.desc&apiKey={API KEY HERE}
Filtering Functions
You can essentially filter by any active category Attribute. List of Attributes here {Link Coming Soon}
Function Required Options
Operators Supported: =, >, <, <=, >=, !=
categories() no String Value
categories({attribute} in()) no String Value
Comma Seperated

Examples for categories()
#1 This filter pulls any categories that would match Gift Center.
          http://api.remix.bestbuy.com/v1/categories(name='Gift Center')?apiKey={API KEY HERE}
Examples for categories({attribute} in())
#1 This filter pulls all categories that match abcat0010000,abcat0104000,pcmcat152100050016.
          http://api.remix.bestbuy.com/v1/categories(id in(abcat0010000,abcat0104000,pcmcat152100050016))?apiKey={API KEY HERE}

version 4 as of 6 months ago by Bryan Brandau - Remix Team

Comments