Products API

The Best Buy Developer API provides a simple, REST-based interface for our entire product catalog-past and present. This includes pricing, availability, specifications, descriptions, and images for more then one million current and historical products. In addition, we offer full archives, updated daily, to make it easier to establish our full catalog locally. Most product information is updated near real-time including product pricing.

PLEASE NOTE: Music and movie data may be used only where an ability to purchase the related music or movies from BESTBUY.COM is provided to end users. Developers using music and movie data to redirect to BESTBUY.COM must become members of the Best Buy Affiliate Program to allow the sale of music and movies through BESTBUY.COM under the terms of the Affiliate Program.

How-Tos

Some examples of how to search and return product information include:

For additional information on writing queries please refer to our search tutorial.:

Search for products based on a description or SKU

To search based on description, you can use one of our description attributes including longDescription, shortDescription, description or name. To search based on SKU there is a single SKU attribute. In the example below we are searching the longDescription for iPhone*. We have appended iPhone with a wildcard * so we can search for iPhones with any suffix. We also are looking for any products that have a SKU with a value of 7619002, note the or |. Finally, you may notice in our example we have updated the number of results that can be returned per page to be 15 and to return page 5 of the total 184 pages. Additional information on how to specify the number of results that should be returned per page and which page to return can be found in our Pagination section.

Return to Products API How-Tos

#request:
http://api.remix.bestbuy.com/v1/products(longDescription=iPhone*|sku=7619002)?show=sku,name&pageSize=15&page=5&apiKey=YourAPIKey&format=json

#response:
{ "from": 61, "to": 75, "total": 2753, "currentPage": 5, "totalPages": 184, "queryTime": "0.010", "totalTime": "0.045", "partial": false, "canonicalUrl": "/v1/products(longDescription=\"iPhone*\"|sku=7619002)?show=sku,name&page=5&format=json&apiKey=YourAPIKey", "products": [ { "sku": 1752654, "name": "Apple - iPhone 4s 8GB Cell Phone - White (AT&T)" }, { "sku": 1761045, "name": "Apple - iPhone 4s 8GB Cell Phone - White (Verizon Wireless)" }, { "sku": 1729354, "name": "Apple - iPhone 5c 16GB Cell Phone - Green (AT&T)" }, { "sku": 1752291, "name": "Apple - iPhone 5c 16GB Cell Phone - Blue (AT&T)" }, ...
#request:
http://api.remix.bestbuy.com/v1/products(longDescription=iPhone*|sku=7619002)?show=sku,name&pageSize=15&page=5&apiKey=YourAPIKey

#response:
<?xml version="1.0" encoding="UTF-8"?> <?xml-stylesheet href="/v1/xsl/xml_pretty_printer.xsl" type="text/xsl"?> <products currentPage="5" totalPages="184" from="61" to="75" total="2753" queryTime="0.004" totalTime="0.039" canonicalUrl="/v1/products(longDescription=&quot;iPhone*&quot;|sku=7619002)?show=sku,name&amp;page=5&amp;apiKey=YourAPIKey" partial="false"> <product> <sku>1752654</sku> <name>Apple - iPhone 4s 8GB Cell Phone - White (AT&amp;T)</name> </product> <product> <sku>1761045</sku> <name>Apple - iPhone 4s 8GB Cell Phone - White (Verizon Wireless)</name> </product> <product> <sku>1729354</sku> <name>Apple - iPhone 5c 16GB Cell Phone - Green (AT&amp;T)</name> </product> <product> <sku>1752291</sku> <name>Apple - iPhone 5c 16GB Cell Phone - Blue (AT&amp;T)</name> </product> ...

Search for products based on review criteria

To search based on review criteria you can use the customerReviewAverage and/or the customerReviewCount. You can also limit the product information returned using our show functionality. HINT: You can specify any additional attributes as part of your search or information return using most attributes in the Products API. In the example below we are searching for all products that have a customer review average greater then four and a customer review count greater then 100. In addition, we are limiting the product information returned to just be customer review average, customer review count, name, sku and forcing a format of json (default is xml when using the Products API).

Return to Products API How-Tos

#request:
http://api.remix.bestbuy.com/v1/products(customerReviewAverage>=4&customerReviewCount>100)?show=customerReviewAverage,customerReviewCount,name,sku&format=json&apiKey=YourAPIKey

#response:
[ { "customerReviewAverage": "4.1", "customerReviewCount": 411, "name": "Insignia™ - Soundbar Home Theater Speaker System", "sku": 4841342 }, { "customerReviewAverage": "4.3", "customerReviewCount": 411, "name": "Sunpak - PlatinumPlus 6000PG 61\" Tripod", "sku": 1205204 }
#request:
http://api.remix.bestbuy.com/v1/products(customerReviewAverage>=4&customerReviewCount>100)?show=customerReviewAverage,customerReviewCount,name,sku&apiKey=YourAPIKey

#response:
<product> <customerReviewAverage>4.1</customerReviewAverage> <customerReviewCount>411</customerReviewCount> <name>Insignia™ - Soundbar Home Theater Speaker System</name> <sku>4841342</sku> </product> <product> <customerReviewAverage>4.3</customerReviewAverage> <customerReviewCount>411</customerReviewCount> <name>Sunpak - PlatinumPlus 6000PG 61&quot; Tripod</name> <sku>1205204</sku> </product>

Search for products based on a list of attribute values

To search for products based on list of attribute values, we recommend using the in operator. Most attributes can be used with the in operator. The most common attribute used is SKU. Using the in operator will also help to avoid Query Per Second errors (QPS). Additional information is available in our Rate Limit section. In the example below use the in operator to search for products any products that are a part of the list of SKUs.

Return to Products API How-Tos

#request:
http://api.remix.bestbuy.com/v1/products(sku in(43900,2088495,7150065))?apiKey=YourAPIKey

#response:
{ ... "products": [ { "sku": 43900, "name": "Duracell - AAA Batteries (4-Pack)", "regularPrice": 5.49, "salePrice": 5.49 }, { "sku": 7150065, "name": "Dynex™ - AAA Batteries (48-Pack)", "regularPrice": 11.49, "salePrice": 11.49 }, { "sku": 2088495, "name": "Energizer - MAX AAA Batteries (8-Pack) - Silver", "regularPrice": 6.99, "salePrice": 6.99 } ] }
#request:
http://api.remix.bestbuy.com/v1/products(sku in(43900,2088495,7150065))?apiKey=YourAPIKey

#response:
... <product> <sku>43900</sku> <name>Duracell - AAA Batteries (4-Pack)</name> <regularPrice>5.49</regularPrice> <salePrice>5.49</salePrice> </product> <product> <sku>7150065</sku> <name>Dynex™ - AAA Batteries (48-Pack)</name> <regularPrice>11.49</regularPrice> <salePrice>11.49</salePrice> </product> <product> <sku>2088495</sku> <name>Energizer - MAX AAA Batteries (8-Pack) - Silver</name> <regularPrice>6.99</regularPrice> <salePrice>6.99</salePrice> </product> </products>

Using the Keyword Search to find products:

Using our Keyword Search functionality you can search across several common attributes using a single call. These attributes include:

  • name
  • manufacturer
  • shortDescription
  • longDescription
  • features.feature
  • details.value

In the example below we use Keyword Search to find all products that contain "touchscreen" and "apple" as part of the Keyword Search attributes. We then limit those products to those that are currently selling for under 500 dollars AND are only within the Computer and Tablet category. HINT: Use our Categories API to find different categories.

Return to Products API How-Tos

#request:
http://api.remix.bestbuy.com/v1/products((search=touchscreen&search=apple)&salePrice<500&categoryPath.id=pcmcat209000050006)?show=name,sku,salePrice&format=json&apiKey=YourAPIKey

#response:
{ ... "products": [ { "name": "Apple® - iPad® mini with Wi-Fi + Cellular - 16GB - (AT&T) - Silver/White", "sku": 7476075, "salePrice": 379.99 }, { "name": "Apple® - iPad® mini with Wi-Fi + Cellular - 16GB - (Sprint) - Black", "sku": 7009533, "salePrice": 375.99 }, { "name": "Apple® - iPad® mini with Wi-Fi + Cellular - 16GB - (Sprint) - Silver/White", "sku": 7009712, "salePrice": 379.99 }, ...
#request:
http://api.remix.bestbuy.com/v1/products((search=touchscreen&search=apple)&salePrice<500&categoryPath.id=pcmcat209000050006)?show=name,sku,salePrice&format=xml&apiKey=YourAPIKey

#response:
... <product> <name>Asus - MeMO Pad 7 - 8GB - Black</name> <sku>8770005</sku> <salePrice>89.99</salePrice> </product> <product> <name>DigiLand - 10.1&quot; - 16GB - Black</name> <sku>8610249</sku> <salePrice>69.99</salePrice> </product> <product> <name>DigiLand - 7&quot; - 8GB - Black</name> <sku>8610212</sku> <salePrice>49.99</salePrice> </product> ...

Detail

The Best Buy Detail attributes contains a wealth of knowledge about Best Buy products. The intention of these attributes is to provide product descriptions, dimensions, accessories and reviews.

Attribute List

Hint: if you would like additional information about an attribute including examples, detailed descriptions and any special considerations when using the attribute please click on the attribute name.

NameDescriptionType
accessories.skucollection of SKUs that could be an accessory to originating SKUlong
colorproduct colorstring
conditionidentifies if the product is new, refurbished or pre-ownedstring
customerReviewAverageaverage "score" or ratings as submitted by reviewersfloat
customerReviewCountnumber of customer reviewsinteger
customerTopRatedidentifies if the product is top rated based on the ratingsboolean
depthproduct depth (inches)string
descriptionproduct descriptionstring
details.namecollection of details about productstring
details.valuecollection of values that support the productstring
digitalidentifies if product is available in a digital formatboolean
features.featurecollection of product featuresstring
formatidentifies media product formatstring
frequentlyPurchasedWith.skucollection of SKUs that are frequently purchased with originating SKUlong
heightproduct height (inches)string
includedItemList.includedItemcollection of items included with productstring
longDescriptiondetailed product descriptionstring
longDescriptionHtmldetailed product description (HTML formatting)string
manufacturerproduct manufacturerstring
modelNumbermanufacturer product model numberstring
nameproduct namestring
preownedidentifies if product has been previously owned (used)boolean
quantityLimitmaximum quantity of product that can be orderedinteger
relatedProducts.skucollection of SKUs that are similar to originating SKUlong
releaseDatedate the product was releaseddate
shortDescriptionbrief product descriptionstring
shortDescriptionHtmlbrief product description (HTML formatting)string
skuBest Buy unique product identifierlong
upcUniversal Product Code (UPC)string
warrantyLabormanufacture labor warranty descriptionstring
warrantyPartsmanufacture parts warranty descriptionstring
weightproduct weightstring
widthproduct width (inches)string

accessories.sku

The accessories.sku attributes provides a collection of SKUs that could be an accessory to the originating SKU.

Type
long
Related Attributes
sku
Example
"8758114"
Back To Attributes

color

The color attribute identifies the color of a product.

Type
string
Notes
Applies when type=hardgood
Example
"black, white, multi, silver, stainless-steel, blue, red, gray, pink, clear, brown, green, purple, silver/black"
Back To Attributes

condition

The condition attribute identifies if a product is new, refurbished or previously owned.

Type
string
Notes
Applies when type=hardgood
Related Attributes
preowned
Example
"new, refurbished and pre-owned"
Back To Attributes

customerReviewAverage

The customerReviewAverage attribute provides an average of all the ratings submitted for a product by reviewers.The customer can rate the product on a scale of 1-5 where 5 is the highest. Ratings may be returned using decimals (example 3.5).

Type
float
Notes
Please also see the Reviews API for additional information
Related Attributes
customerReviewCount
Example
"4.8"
Back To Attributes

customerReviewCount

The customerReviewCount attribute provides the total number of reviews collected.

Type
integer
Notes
Please also see the Reviews API for additional information
Related Attributes
customerReviewAverage
Example
"12"
Back To Attributes

customerTopRated

The customerTopRated attribute identifies if the product is top rated, based on the ratings given by the reviewers. If the Avg rating >= 4.5 and Qty of ratings >= 15, customerTopRated is set to be "true", else is set to "false".

Type
boolean
Related Attributes
customerReviewAverage,customerReviewCount
Example
"true, false"
Back To Attributes

depth

The depth attribute provides the depth of a product using inches.

Type
string
Notes
Applies when type=hardgood
Related Attributes
height, width, weight
Example
"3.1" "
Back To Attributes

description

The description attribute provides a description of a product.

Type
string
Related Attributes
longDescription, longDescriptionHtml, shortDescription, shortDescriptionHtml
Example
"35 mm SLR, body only, lenses separate"
Back To Attributes

details.name

The details.name attribute provides a collection of details about a product. For example the details.name could include information on whether a camera has zoom.

Type
string
Related Attributes
details.value, features.feature
Example
"Megapixels (Effective), Megapixels (Total), Image Resolution, Optical Zoom"
Back To Attributes

details.value

The details.value attribute provides a collection of details about a product. For example the details.name could include the number of Megapixels or amount of zoom for camera.

Type
string
Related Attributes
details.name, features.feature
Example
"18.0, Up to 640 x 480, 35mm equivalent 18-135mm"
Back To Attributes

digital

The digital attribute identifies if a product is available in a digital format for download.

Type
boolean
Notes
Default value=false
Related Attributes
type
Example
"true, false"
Back To Attributes

features.feature

The features.feature attribute provides a collection of product features.

Type
string
Related Attributes
details.name, details.value
Example
"Captures images and video of activity. So you can clearly document moving subjects."
Back To Attributes

height

The height attribute provides the height of a product in inches.

Type
string
Notes
May return multiple heights like "Subwoofer: 11"; satellites: 9.4" each"
Related Attributes
depth, weight, width
Example
"4.2" "
Back To Attributes

includedItemList.includedItem

The includedItemList.includedItem attribute provides a collection of items included with purchase of a product.

Type
string
Example
"Canon EOS 60D Digital SLR Camera, EF-S 18-135mm IS lens, Battery pack, Battery charger"
Back To Attributes

longDescription

The longDescription attribute provides a detailed description about a product.

Type
string
Related Attributes
longDescriptionHtml, shortDescription, shortDescriptionHtml, description
Example
"This 18.0-megapixel digital SLR camera includes an EF-S18-135mm image-stabilized lens for capturing stunning images from a distance and a 3" Vari-Angle Clear View LCD monitor for framing and reviewing your shots."
Back To Attributes

longDescriptionHtml

The longDescription attribute provides a detailed description about a product with HTML formatting (if applicable.)

Type
string
Related Attributes
longDescription, shortDescription, shortDescriptionHtml, description
Example
"The 1.5" color screen and 28 infrared LEDs on this Barska BG11753 6.0MP trail camera allow you to capture and view images and videos during the day or at night. A water-resistant casing guards the camera against moisture damage."
Back To Attributes

modelNumber

The modelNumber attribute represents the model identifier for a product as identified by the Manufacturer.

Type
string
Example
"4460B004"
Back To Attributes

name

The name attribute provides the name of a product.

Type
string
Example
"Canon - EOS 60D DSLR Camera with 18-135mm IS Lens - Black"
Back To Attributes

preowned

The preowned attribute identifies if a product is previously owned (used.)

Type
boolean
Notes
Default value preowned=false. This applies when type=hargood or game.
Example
"true, false"
Back To Attributes

quantityLimit

The quantityLimit attribute identifies the maximum quantity of a product that can be purchased by a customer.

Type
integer
Example
"25"
Back To Attributes

releaseDate

The releaseDate attribute identifies the release date of a product to the general public from the publisher.

Type
date
Example
"2009-05-03T22:43:10"
Back To Attributes

shortDescription

The shortDescription attribute provides a brief description of a product.

Type
string
Related Attributes
shortDescriptionHtml, longDescription, longDescriptionHtml, description
Example
"EF 18-135mm Lens included; 3" Vari-Angle LCD monitor; DIGIC 4 imaging processor; PictBridge compatible"
Back To Attributes

shortDescriptionHtml

The shortDescription attribute provides a brief description of a product with HTML formatting (if applicable.)

Type
string
Related Attributes
shortDescription, longDescription, longDescriptionHtml, description
Example
"EF 18-135mm Lens included; 3" Vari-Angle LCD monitor; DIGIC 4 imaging processor; PictBridge compatible"
Back To Attributes

sku

The sku attribute provides a unique identifier for products sold by Best Buy.

Type
long
Notes
Highly used attribute for searching for products at Best Buy
Example
"1221963"
Back To Attributes

upc

The UPC attribute refers to the universal product code that is widely used by manufacturers to identify their products

Type
string
Example
"013803129113"
Back To Attributes

warrantyLabor

The warrantyLabor attribute provides a description of the manufacturer's warranty specifically regarding labor.

Type
string
Related Attributes
warrantyParts
Example
"Lifetime limited"
Back To Attributes

warrantyParts

The warrantyParts attribute provides a description of the manufacturer's warranty specifically regarding parts.

Type
string
Related Attributes
warrantyLabor
Example
"30 days"
Back To Attributes

weight

The weight attribute provides the weight of a product.

Type
string
Notes
May return multiple weights like "Keyboard: 9.2 oz.; stand: 6.5 oz."
Related Attributes
height, depth, width
Example
"1.7 lbs."
Back To Attributes

width

The width attribute provides the width of a product in inches.

Type
string
Notes
May return multiple widths like "Subwoofer: 9.5"; satellites: 4.9" each"
Related Attributes
height, depth, weight
Example
"1.6" "
Back To Attributes

Pricing and Sales Ranking

As part of the Best Buy Pricing attributes we make it easy to identify the product price, if a product is on sale, how much you can save and even when we made our last pricing changes. We also provide sales ranking over given time periods so you can have an idea of the best-sellers.

For additional information on writing queries please refer to our search tutorial.

Attribute List

Hint: if you would like additional information about an attribute including examples, detailed descriptions and any special considerations when using the attribute please click on the attribute name.

NameDescriptionType
bestSellingRankranks products by number of units soldinteger
dollarSavingsidentifies amount savedcurrency
lowPriceGuaranteeidentifies if a product qualifies for the Best Buy low price guaranteeboolean
onSaleidentifies if sale price is less than regular priceboolean
percentSavingsidentifies the percent saved between the regularPrice and salePricefloat
priceRestrictionidentifies if product price has display restriction requirementsstring
priceUpdateDatedate and time product price was last updateddate
priceWithPlan.newTwoYearPlanmobile phone price when purchased with new 2-year plancurrency
priceWithPlan.upgradeTwoYearPlanmobile phone price when purchased with 2-year upgrade plancurrency
priceWithPlan.newTwoYearPlanSalePricemobile phone sale price when purchased with 2-year plancurrency
priceWithPlan.upgradeTwoYearPlanSalePricemobile phone sale price when purchased with 2-year upgrade plancurrency
priceWithPlan.newTwoYearPlanRegularPricemobile phone price when purchased with new 2-year plancurrency
priceWithPlan.upgradeTwoYearPlanRegularPricemobile phone price when purchased with 2-year upgrade plancurrency
regularPriceproduct's regular selling pricecurrency
salePricecurrent item selling pricecurrency
salesRankLongTermsales rank over past 5-21 daysinteger
salesRankMediumTermsales rank over past 2-4 daysinteger
salesRankShortTermsales rank over past dayinteger
tradeInValueestimated value of product trade incurrency

bestSellingRank

The bestSellingRank attribute represents the rank of this product by the number of units sold across all products based on both in-store and online sales.

Type
integer
Notes
Some top-ranked products may be available in-store only and will not be included in Products API results
Example
"12"
Back To Attributes

dollarSavings

The dollarSavings attribute identifies the amount that will be saved based on the salePrice.

Type
currency
Notes
Calculated field: regularPrice - salePrice; applies when type=hardgood
Related attributes
regularPrice, salePrice, onSale
Example
"29.99"
Back To Attributes

onSale

The onSale attribute is a calculated field based on a comparison of regularPrice and salePrice. If the salePrice is less than the regularPrice, the onSale attribute will return 'true'. If salePrice is equal to regularPrice, then the onSale attribute will return 'false'.

Type
boolean
Notes
Calculated field: salePrice < regularPrice
Related attributes
salePrice, regularPrice, dollarSavings
Example
"true, false"
Back To Attributes

percentSavings

The percentSavings attribute identifies the percent saved between the regularPrice and the salePrice.

Type
float
Related attributes
regularPrice, salePrice
Example
"16.67"
Back To Attributes

priceRestriction

The priceRestriction attribute identifies if there are pricing restriction requirements related to the display of the sale price of a product. The MAP restriction identifies the Minimum Advertised Price. This means the actual selling price may not be shown until the product is added to the cart. The ICR restricts identifies the In-Checkout Rebate price. This means the actual selling price may not be shown until the customer is ready to checkout. For those products that have MAP or ICR display restrictions, the lowest salePrice will only show to those developers that have a privileged key. There are guidelines for displaying these values that you should have received along with your privileged key. If you don't have a privileged key then these requirements will not apply to you.

Type
string
Notes
If the priceRestriction field is ICR or MAP the salePrice may be the same as the regularPrice. If you are referring customers to BESTBUY.COM or Commerce Express for check-out all pricing display requirements will be handled for you. The customer will be shown and charged the lowest price as part of check-out.
Example
"MAP, ICR"
Back To Attributes

priceUpdateDate

The priceUpdateDate attribute identifies the date and time the product price was last updated.

Type
date
Related attributes
regularPrice, salePrice
Example
"2009-05-03T22:43:10"
Back To Attributes

priceWithPlan.newTwoYearPlan

The priceWithPlan.newTwoYearPlan attribute is returned as part of a mobile phone plan collection. The priceWithPlan.newTwoYearPlan identifies the mobile phone price when purchased with a new 2-year plan.

Type
currency
Notes
Applies to: Mobile Phones
Example
"99.99"
Back To Attributes

priceWithPlan.upgradeTwoYearPlan

The priceWithPlan.upgradeTwoYearPlan attribute is returned as part of a mobile phone plan collection. The priceWithPlan.upgradeTwoYearPlan identifies the mobile phone price when purchased as part of an upgrade plan.

Type
currency
Notes
Applies to: Mobile Phones
Example
"199.99"
Back To Attributes

priceWithPlan.newTwoYearPlanSalePrice

The priceWithPlan.newTwoYearPlanSalePrice attribute is returned as part of a mobile phone plan collection. The priceWithPlan.newTwoYearPlanSalePrice identifies the mobile sale phone price when purchased with a new 2-year plan.

Type
currency
Notes
Applies to: Mobile Phones
Example
"99.99"
Back To Attributes

priceWithPlan.upgradeTwoYearPlanSalePrice

The priceWithPlan.upgradeTwoYearPlanSalePrice attribute is returned as part of a mobile phone plan collection. The priceWithPlan.upgradeTwoYearPlanSalePrice identifies the mobile phone sale price when purchased as part of an upgrade plan.

Type
currency
Notes
Applies to: Mobile Phones
Example
"199.99"
Back To Attributes

priceWithPlan.newTwoYearPlanRegularPrice

The priceWithPlan.newTwoYearPlanRegularPrice attribute is returned as part of a mobile phone plan collection. The priceWithPlan.newTwoYearPlanRegularPrice identifies the mobile phone price when purchased with a new 2-year plan.

Type
currency
Notes
Applies to: Mobile Phones
Example
"199.99"
Back To Attributes

priceWithPlan.upgradeTwoYearPlanRegularPrice

The priceWithPlan.upgradeTwoYearPlanRegularPrice attribute is returned as part of a mobile phone plan collection. The priceWithPlan.upgradeTwoYearPlanRegularPrice identifies the mobile phone price when purchased as part of an upgrade plan.

Type
currency
Notes
Applies to: Mobile Phones
Example
"199.99"
Back To Attributes

regularPrice

The regularPrice attribute identifies the product's regular selling price.

Type
currency
Related attributes
salePrice
Example
"1299.99"
Back To Attributes

salePrice

The salePrice attribute identifies the current selling price of a product.

Type
currency
Notes
The salePrice may return true even though the salePrice=regularPrice. This is due the actual sale price not being returned due to pricing restrictions. The customer will see the actual sale price as part of the check out process. See the priceRestriction attribute for additional information.
Related attributes
regularPrice, dollarSavings, onSale, percentSavings, priceRestriction
Example
"999.99"
Back To Attributes

salesRankLongTerm

The salesRankLongTerm attribute provides the sales ranking for a product sold over the past 2-21 days based on both in-store and online sales.

Type
integer
Notes
Some top-ranked products may be available in-store only and will not be included in Products API results
Related attributes
salesRankShortTerm, salesRankMediumTerm
Example
"733"
Back To Attributes

salesRankMediumTerm

The salesRankMediumTerm attribute provides the sales ranking for a product sold over the past 2-4 days based on both in-store and online sales.

Type
integer
Notes
Some top-ranked products may be available in-store only and will not be included in Products API results
Related attributes
salesRankShortTerm, salesRankLongTerm
Example
"250"
Back To Attributes

salesRankShortTerm

The salesRankShortTerm attribute provides the sales ranking for a product sold over the past day based on both in-store and online sales.

Type
integer
Notes
Some top-ranked products may be available in-store only and will not be included in Products API results
Related attributes
salesRankMediumTerm, salesRankLongTerm
Example
"100"
Back To Attributes

tradeInValue

The tradeInValue attributes identifies the estimated value for a product trade-in. The actual value will be determined upon review by a Best Buy store employee.

Type
currency
Example
"0.25"
Back To Attributes

Availability and Delivery

The Availability and Delivery attributes provide insight into which products can be purchased online, which products can be picked up in stores and what is the cost to ship a product.

For additional information on writing queries please refer to our search tutorial.

Attribute List

Hint: if you would like additional information about an attribute including examples, detailed descriptions and any special considerations when using the attribute please click on the attribute name.

NameDescriptionType
freeShippingidentifies if a product qualifies for free shippingboolean
friendsAndFamilyPickupidentifies if a product is eligible for friends and family pickupboolean
homeDeliveryidentifies if a product must be fulfilled using home delivery instead of shippingboolean
inStoreAvailabilityidentifies if a product is available for purchase in a Best Buy storeboolean
inStoreAvailabilityTextadditional information regarding inStoreAvailabilitystring
inStoreAvailabilityTextHtmladditional information regarding inStoreAvailability (HTML formatting)string
inStoreAvailabilityUpdateDateprovides date and time inStoreAvailability last updateddate
inStorePickupidentifies if a product can be purchased online and picked up in a storeboolean
onlineAvailabilityidentifies if a product can be purchased onlineboolean
onlineAvailabilityTextadditional information regarding online availabilitystring
onlineAvailabilityTextHtmladditional information regarding online availability (HTML formatting)string
onlineAvailabilityUpdateDateprovides date and time onlineAvailability was last updateddate
orderableidentifies the product ordering statusstring
shipping.groundprovides ground (otherwise known as "standard") shipping costscurrency
shipping.nextDayprovides next day (otherwise known as "express") shipping costscurrency
shipping.secondDayprovides second day (otherwise known as "expedited") shipping costscurrency
shipping.vendorDeliveryprovides vendor delivery shipping costscurrency
shippingCostprovides product's lowest shipping costscurrency
shippingWeightidentifies product's shipping weight (pounds)string
specialOrderidentifies whether a product will require special handling for deliveryboolean

freeShipping

The freeShipping attribute identifies if a product qualifies for the Best Buy free shipping program.

Type
boolean
Example
"true, false"
Back To Attributes

homeDelivery

The homeDelivery attribute identifies if a product must be fulfilled using home delivery instead of being shipped.

Type
boolean
Notes
If homeDelivery=true then shipping is not an option
Example
"true, false"
Back To Attributes

inStoreAvailability

The inStoreAvailability attribute identifies if a product is available for purchase in a Best Buy store.

Type
boolean
Related Attributes
inStoreAvailabilityText, inStoreAvailabilityTextHtml, inStoreAvailabilityUpdateDate
Example
"true, false"
Back To Attributes

inStoreAvailabilityText

The inStoreAvailabilityText provides descriptive text about whether a product is available to be purchased in a Best Buy store.

Type
string
Related Attributes
inStoreAvailability, inStoreAvailabilityTextHtml, inStoreAvailabilityUpdateDate
Example
"Store Pickup: Available at most stores"
Back To Attributes

inStoreAvailabilityTextHtml

The inStoreAvailabilityTextHtml provides descriptive text with HTML formatting about whether a product is available to be purchased in a Best Buy store.

Type
string
Related Attributes
inStoreAvailability, inStoreAvailabilityText, inStoreAvailabilityUpdateDate
Example
"Store Pickup: Available at most stores"
Back To Attributes

inStoreAvailabilityUpdateDate

The inStoreAvailabilityUpdateDate identifies the date and time the inStoreAvailability attribute was last updated.

Type
date
Related Attributes
inStoreAvailability, inStoreAvailabilityText, inStoreAvailabilityTextHtml
Example
"2009-05-03T22:43:10"
Back To Attributes

inStorePickup

The inStorePickup attribute identifies if a product can be purchased online and picked up in a store.

Type
boolean
Example
"true, false"
Back To Attributes

onlineAvailability

The onlineAvailability attribute identifies whether a product can be purchased online.

Type
boolean
Related Attributes
onlineAvailabilityText, onlineAvailabilityTextHtml, onlineAvailabilityUpdateDate
Example
"true, false
Back To Attributes

onlineAvailabilityText

The onlineAvailabilityText provides descriptive text about whether a product is available to be purchased online.

Type
string
Related Attributes
onlineAvailability, onlineAvailabilityTextHtml, onlineAvailabilityUpdateDate
Example
"Shipping: Usually leaves our warehouse in 1 business day"
Back To Attributes

onlineAvailabilityTextHtml

The onlineAvailabilityTextHtml provides descriptive text with HTML formatting about whether a product is available to be purchased online.

Type
string
Related Attributes
onlineAvailability, onlineAvailabilityText, onlineAvailabilityUpdateDate
Example
"Shipping: Usually leaves our warehouse in 1 business day"
Back To Attributes

onlineAvailabilityUpdateDate

The onlineAvailabilityUpdateDate identifies the date and time the onlineAvailability attribute was last updated.

Type
date
Related Attributes
onlineAvailability, onlineAvailabilityText, onlineAvailabilityTextHtml
Example
"2010-12-09T05:48:17"
Back To Attributes

orderable

The orderable attribute provides additional information about the product ordering status. The available statuses include Available, ComingSoon, InStoreOnly, NotOrderable, PreOrder, SpecialOrder, SoldOut. The Available status identifies products that are available for sale (does not determine if they are for sale exclusively online or in a store.) The ComingSoon status identifies products that are coming but not yet ready for sale. The InStoreOnly attribute identifies products that can only be purchased in a store (see inStoreAvailability for more information.) The NotOrderable status identifies product that are available for sale at this time. The PreOrder status identifies products that are available for purchased but will not be fulfilled (or shipped) until a later date. The SpecialOrder status identifies those products that require special delivery (see the SpecialOrder attribute for more details.) The SoldOut status identifies products that are not currently available for sale because they have been sold out.

Type
string
Notes
The orderable must be equal to Available, SpecialOrder or PreOrder to be purchased through the BESTBUY.COM website. If orderable is equal to any other statuses the product cannot be purchased online at this time
Example
"Available, SoldOut, SpecialOrder"
Back To Attributes

shipping.ground

The shipping.ground attribute is a part of a collection of shipping values; specifically providing ground otherwise known as "standard" shipping costs.

Type
currency
Related Attributes
shipping.secondDay, shipping.nextDay, shipping.vendorDelivery, shippingCost
Example
"5.49"
Back To Attributes

shipping.nextDay

The shipping.nextDay attribute is a part of a collection of shipping values; specifically providing next day otherwise known as "express" shipping costs.

Type
currency
Related Attributes
shipping.ground, shipping.secondDay, shipping.vendorDelivery, shippingCost
Example
"28.50"
Back To Attributes

shipping.secondDay

The shipping.secondDay attribute is a part of a collection of shipping values; specifically providing second day otherwise known as "expedited" shipping costs.

Type
currency
Related Attributes
shipping.ground, shipping.nextDay, shipping.vendorDelivery, shippingCost
Example
"18.50"
Back To Attributes

shipping.vendorDelivery

The shipping.vendorDelivery attribute is a part of a collection of shipping values; specifically providing vendor delivery shipping costs.

Type
currency
Related Attributes
shipping.ground, shipping.nextDay, shipping.secondDay, shippingCost
Example
"58.50"
Back To Attributes

shippingCost

The shippingCost attribute provides a product's lowest shipping cost.

Type
currency
Notes
This value could represent ground, next day or second day shipping options
Related Attributes
shipping.ground, shipping.secondDay, shipping.nextDay, shipping.vendorDelivery
Example
"19.99"
Back To Attributes

specialOrder

The specialOrder attribute identifies whether a product will have special handling for fulfillment and delivery. An example of special handling instructions could include message such as “We cannot deliver to P.O. boxes or APO/FPO addresses.”

Type
boolean
Related Attributes
orderable
Example
"true, false"
Back To Attributes

Images

The Images attributes provide multiple images for a product. These include large, small, side images and even interactive 360 degree images.

For additional information on writing queries please refer to our search tutorial.

Attribute List

Hint: if you would like additional information about an attribute including examples, detailed descriptions and any special considerations when using the attribute please click on the attribute name.

NameShort DescriptionType
accessoriesImageURL of accessories imagestring
alternateViewsImageURL of alternate imagestring
angleImageURL of product's angle imagestring
backViewImageURL of rear imagestring
energyGuideImageURL of product's EnergyGuide imagestring
imageURL of BESTBUY.COM product detail page imagestring
largeFrontImageURL of large front imagestring
largeImageURL of large imagestring
leftViewImageURL of left imagestring
mediumImageURL of medium imagestring
remoteControlImageURL of remote control imagestring
rightViewImageURL of right imagestring
spin360UrlURL of 360-degree imagestring
thumbnailImageURL of image used on BESTBUY.COM listing pagesstring
topViewImageURL of top imagestring

Links

The Links attributes provide a way for you to redirect customers to a BESTBUY.COM product detail page or create a BESTBUY.COM cart on their behalf while including the product in the cart. For our affiliate partners we provide this same functionality but use a special link so you can get credit for your sale. Additional information on the affiliate program can be found here.

For additional information on writing queries please refer to our search tutorial.

Attribute List

Hint: if you would like additional information about an attribute including examples, detailed descriptions and any special considerations when using the attribute please click on the attribute name.

NameDescriptionType
addToCartUrlprovides URL to BESTBUY.COM with item in cartstring
linkShareAffiliateAddToCartUrlprovides URL to BESTBUY.COM with item in cart; only populated if participating in affiliate programstring
linkShareAffiliateUrlprovides URL to BESTBUY.COM product detail page; only populated if participating in affiliate programstring
mobileUrlprovides URL to BESTBUY.COM mobile phone version of the product detail pagestring
urlprovides URL to BESTBUY.COM product detail pagestring

linkShareAffiliateAddToCartUrl

The linkShareAffilitateAddToCartUrl attribute is for those participating in the Best Buy affiliate program. Affiliates add their (LID) to their query request and the URL generated will direct the customer to the BESTBUY.COM with this item in their cart and credit the affiliate with the sale.

Type
string
Notes
Attribute is not querable; Must specify LinkShare ID in query. LID="yourLinkShareAffiliateId"
Example
"(URL generated at run time)"
Back To Attributes

linkShareAffiliateUrl

The linkShareAffilitateUrl attribute is for those participating in the Best Buy affiliate program. Affiliates add their (LID) to their query request and the URL generated will direct the customer to the BESTBUY.COM product detail page and credit the affiliate with the sale.

Type
string
Notes
Attribute is not querable; Must specify LinkShare ID in query. LID="yourLinkShareAffiliateId"
Example
"(URL generated at run time)"
Back To Attributes

Categorizations

Best Buy provides multiple ways to group products based on your needs.

The department, class and subclass attributes provide categorization structure or groupings of products. These attributes are returned as separate attributes but are related. The department attribute provides the more general categorization while the class and subclass attributes narrow the focus to be more specific. The class and subclass attributes are less volatile than category attributes and are the recommended attributes for grouping products.

The categoryPath attributes provide a hierarchal view of a product returned as a collection. The collections start with the most general categorization, while subsequent categories narrow to be more specific. The number of categories returned can be 3+ layers deep. The products within the categories also tend to be slightly more volatile than department, class and subclass groupings.

The list attributes are used for specific events like Valentine's day. These lists are curated by a Best Buy merchant teams for customer visibility for a specific event or purpose.

For additional information on writing queries please refer to our search tutorial.

Attribute List

Hint: if you would like additional information about an attribute including examples, detailed descriptions and any special considerations when using the attribute please click on the attribute name.

NameDescriptionType
categoryPath.idreturns category idsstring
categoryPath.namereturns category namesstring
classclass namestring
classIdclass identifiersinteger
departmentdepartment namestring
departmentIddepartment identifiersinteger
lists.endDatereturns the end date shown in liststring
lists.listIdreturns the name shown in liststring
lists.startDatereturns start date shown in liststring
subclasssubclass namestring
subclassIdsubclass identifierinteger

categoryPath.id

The categoryPath.id attribute is part of a hierarchical structure used to group similar products together. This product will return a collection of one to many children of all categories a product is associated with in the form of the category id

Type
string
Example
"cat00000"
Back To Attributes

categoryPath.name

The categoryPath.name attribute is part of a hierarchical structure used to group similar products together. This product will return a collection of one to many children of all the categories a product is associated with in the form of the category name

Type
string
Example
"Digital SLR Cameras"
Back To Attributes

class

The class attribute is a method of grouping similiar products together using a name or description. For examples classes are used to return all digital cameras.

Type
string
Example
"DSLR DIGITAL SLR"
Back To Attributes

classId

The classId attribute is a method of grouping similiar products together using an ID. For examples classes are used to return all digital cameras.

Type
integer
Example
"363"
Back To Attributes

department

The department attribute returns the Best Buy department name a product is associated with.

Type
string
Example
"PHOTO/COMMODITIES"
Back To Attributes

lists.endDate

The lists.endDate attribute represent the end date that the product would be associated to a list. Lists represent a curated group of products that are grouped together by Best Buy using a common identifier. Lists are returned as a collection including a list name, lists.listId, start and end date. An example of a list would be HolidayBuyingGuide2014.

Type
string
Example
"11/1/2011"
Back To Attributes

lists.listId

The lists.listId attribute provides an identifier for the list. Lists represent a curated group of products that are grouped together by Best Buy using a common identifier. Lists are returned as a collection including a list name lists.listId, start and end date. An example of a list would be HolidayBuyingGuide2014.

Type
string
Example
"HolidayGifts2011"
Back To Attributes

lists.startDate

The lists.startDate attribute represent the start date that the product would be associated to a list. Lists represent a curated group of products that are grouped together by Best Buy using a common identifier. Lists are returned as a collection including a list name lists.listId, start and end date. An example of a list would be HolidayBuyingGuide2014.

Type
string
Example
"11/1/2011"
Back To Attributes

subclass

The subclass attribute is related to the class attribute and provides a more specific grouping of the data. The subclass attribute provides the subclass name for that grouping.

Type
string
Example
"DSLR CAMERAS"
Back To Attributes

subclassId

The subclassId attribute is related to the class attribute and provides a more specific grouping of the data. The subclass attribute provides the subclass ID for that grouping.

Type
integer
Example
"205"
Back To Attributes

Offers and Deals

The Best Buy offer attributes provide a comprehensive view into all of the deals at Best Buy. This includes what is in our Sunday circular (also available online) and our "Deal of the Day," to name a few. We provide images and offer descriptions to further support you when listing Best Buy products. Offer information is grouped together in a collection. Each product can have one or more offers associated to it. Each offer has an identifier, start/end dates and any supporting information.

For additional information on writing queries, please refer to our search tutorial.

Attribute List

Hint: if you would like additional information about an attribute including examples, detailed descriptions and any special considerations when using the attribute please click on the attribute name.

NameDescriptionType
offers.endDateoffer end datedate
offers.headingoffer descriptionstring
offers.idoffer identifierstring
offers.imageUrlURL of image associated to offerstring
offers.startDateoffer start datedate
offers.textadditional offer informationstring
offers.typeoffer typestring
offers.urlURL of offer information on BESTBUY.COMstring

offers.endDate

The offers.endDate attribute is returned as part of a collection and identifies the end date an offer will be available for this product.

Type
date
Example
"2012-10-12"
Back To Attributes

offers.heading

The offers.heading attribute is returned as part of a collection and identifies a name for an offer.

Type
string
Example
"Hit CDs Starting at $8.99"
Back To Attributes

offers.id

The offers.id attribute is returned as part of a collection and provides an identifier for an offer.

Type
string
Notes
Each offer can only have a single identifier
Example
"promo252500050006"
Back To Attributes

offers.startDate

The offers.startDate attribute is returned as part of a collection and identifies the start date an offer will be available for this product.

Type
date
Example
"2012-10-12"
Back To Attributes

offers.text

The offers.text attribute is returned as part of a collection and provides additional information for an offer.

Type
string
Example
"Free Shipping, On Sale, Free 8x8 Photo Book: Find Out How "
Back To Attributes

offers.type

Offer types can include the following: Special offers identified by Best Buy marketing managers. Featured offers consist of a set of special offers as defined by the BESTBUY.COM marketing teams. Weekly digital inserts identify products that are a part of weekly insert that can be found in a Sunday newspaper (this information is also available on http://www.bestbuy.com under "Weekly Deals".) Typically there are between 400-1000 products that are a part of our weekly digital inserts. "Deal of the Day" consists of a small group of products being promoted for one day only.

Type
string
Example
"special_offer, featured_offer, digital_insert, deal_of_the_day"
Back To Attributes

GeekSquad Plans/Services

The GeekSquad plans and service attributes provide both a high-level overview of the GeekSquad plans that can be purchased for a product and also provide the details for a specific service plan. Additional information about GeekSquad can be found on the GeekSquad website

If you would like to find out the high-level information about GeekSquad protection plans available for a product, the attributes include:

  • protectionPlans.name
  • protectionPlans.productId
  • protectionPlans.regularPrice
  • protectionPlans.salePrice
  • protectionPlans.sku
  • protectionPlans.term
  • protectionPlans.type

Some examples of how to return available GeekSquad protection plans for a product include:

If you would like to find out more information about a specific GeekSquad protection plan, this can be done by looking at the protectionPlans.sku that is returned for a product. You can also look at overall detailed protection plans available by looking at type="blacktie". Keep in mind that not all plans can be purchased for all products. We systematically identify what plans can be associated to a product by looking at the department/class/subclass of a product and its price. The price must be between the protectionPlanHighPrice and the protectionPlanLowPrice. The attributes that will describe a detailed plan include:

  • protectionPlanDetails.states
  • protectionPlanDetails.termsAndConditions
  • protectionPlanHighPrice
  • protectionPlanLowPrice
  • protectionPlanTerm
  • protectionPlanType

Some examples of how to return GeekSquad protection plan details include:

For additional information on writing queries please refer to our search tutorial.

Attribute List

Hint: if you would like additional information about an attribute including examples, detailed descriptions and any special considerations when using the attribute please click on the attribute name.

NameDescriptionType
protectionPlans.namename of a protection plan that is associated to this product; returns as part of a collection of GeekSquad protection plansstring
protectionPlans.productIdproduct id for a protection plan that is associated to a product; returns as part of a collection of GeekSquad protection planslong
protectionPlans.regularPriceregular price for a protection plan that is associated to a product; returns as part of a collection of GeekSquad protection planscurrency
protectionPlans.salePricecurrent price of a protection plan that is associated to a product; returns as part of a collection of GeekSquad protection planscurrency
protectionPlans.skuSKU for a protection plan that is associated to a product; returns as part of a collection of GeekSquad protection planslong
protectionPlans.termlength of coverage of the protection plan that is associated to a product; returns as part of a collection of GeekSquad protection plansstring
protectionPlans.typetype of a protection plan that is associated to a product; returns as part of a collection of GeekSquad protection plansstring
protectionPlanDetails.statesstates in which this protection plan is validstring
protectionPlanDetails.termsAndConditionsterms and conditions for a protection plan; valid for a specific GeekSquad protection planstring
protectionPlanHighPriceupper limit of selling price for product being covered within a protection plan; valid for a specific GeekSquad protection plancurrency
protectionPlanLowPricelower limit of selling price for product being covered by protection plan; valid for a specific GeekSquad protection plancurrency
protectionPlanTermlength of protection plan; valid for a specific GeekSquad protection planstring
protectionPlanTypetype of protection plan; valid for a specific GeekSquad protection planstring

protectionPlans.name

The attribute protectionPlans.Name identifies the name of the GeekSquad protection plan that is associated to originating SKU. Returns as part of a collection identifying high level information about a plan for a particular SKU. There can be multiple plans per product.

Type
string
Notes
Applies when type=hardgood
Example
"2-Year Protection Plan - Geek Squad"
Back To Attributes

protectionPlans.productId

The attribute protectionPlans.productId identifies the ID of the GeekSquad protection plan that is associated to originating SKU. Returns as part of a collection identifying high level information about a plan for a particular SKU. There can be multiple plans per product.

Type
long
Notes
Applies when type=hardgood
Example
"1218318237605"
Back To Attributes

protectionPlans.regularPrice

The attribute protectionPlans.regularPrice identifies the regular price of the GeekSquad protection plan that is associated to originating SKU. Returns as part of a collection identifying high level information about a plan for a particular SKU. There can be multiple plans per product.

Type
currency
Notes
Applies when type=hardgood
Example
"14.99"
Back To Attributes

protectionPlans.salePrice

The attribute protectionPlans.salePrice identifies the sale price of the GeekSquad protection plan that is associated to originating SKU. Returns as part of a collection identifying high level information about a plan for a particular SKU. There can be multiple plans per product.

Type
currency
Notes
Applies when type=hardgood
Example
"10.99"
Back To Attributes

protectionPlans.sku

The attribute protectionPlans.sku identifies the SKU of the GeekSquad protection plan that is associated to originating SKU. Returns as part of a collection identifying high level information about a plan for a particular SKU. There can be multiple plans per product.

Type
long
Notes
Applies when type=hardgood; returns sku of protection plan not originating sku
Example
"9973107"
Back To Attributes

protectionPlans.term

The attribute protectionPlans.term identifies the term of the GeekSquad protection plan that is associated to originating SKU. Returns as part of a collection identifying high level information about a plan for a particular SKU. There can be multiple plans per product.

Type
string
Notes
Applies when type=hardgood
Example
"3YR"
Back To Attributes

protectionPlans.type

The attribute protectionPlans.type identifies the type of the GeekSquad protection plan that is associated to originating SKU. Returns as part of a collection identifying high level information about a plan for a particular SKU. There can be multiple plans per product.

Type
string
Notes
Applies when type=hardgood
Example
"PSP-PRP, MAGNOLIA HOME THEATER"
Back To Attributes

protectionPlanDetails.states

The attribute protectionPlanDetails.state identifies the supporting states for originating GeekSquad protection plan. This attribute is used to provide a detailed explanation for the originating GeekSquad protection plan. There is one detailed explanation of the Terms and Conditions per GeekSquad protection plan SKU.

Type
string
Notes
Applies when type=BlackTie
Example
"MN, TX, AK"
Back To Attributes

protectionPlanDetails.termsAndConditions

The attribute protectionPlanDetails.termsAndConditions identifies all terms and conditions associated to the originating GeekSquad protection plan. This attribute is used to provide a detailed explanation for the originating GeekSquad protection plan. There is one detailed explanation per GeekSquad protection plan SKU.

Type
string
Notes
Applies when type=BlackTie
Example
"AIG WarrantyGuard, Inc. P.O. Box 9312Minneapolis, MN 55440-93121-888-539-6883 Throughout this Product Replacement Plan ("Plan") the words "we," "us" and "our" refer to the Oblig"
Back To Attributes

protectionPlanHighPrice

The attribute protectionPlanHighPrice identifies the upper limit of the selling price of the product to which the GeekSquad Protection Plan is associated. This attribute is used to provide a detailed explanation for the originating GeekSquad protection plan.

Type
currency
Notes
Applies when type=BlackTie
Example
"999.99"
Back To Attributes

protectionPlanLowPrice

The attribute protectionPlanLowPrice identifies the lower limit of the selling price of the product to which the GeekSquad Protection Plan is associated. This attribute is used to provide a detailed explanation for the originating GeekSquad protection plan.

Type
currency
Notes
Applies when type=BlackTie
Example
"900.00"
Back To Attributes

protectionPlanTerm

The attribute protectionPlanTerm identifies the term (length) of the originating GeekSquad protection plan. This attribute is used to provide a detailed explanation for the originating GeekSquad protection plan.

Type
string
Notes
Applies when type=BlackTie
Example
"3YR"
Back To Attributes

protectionPlanType

The attribute protectionPlanType identifies the type of protection plan associated to the originating GeekSquad protection plan. This attribute is used to provide a detailed explanation for the originating GeekSquad protection plan.

Type
string
Notes
Applies when type=BlackTie
Example
"PSP-PRP"
Back To Attributes

Request/Response Examples

Identify which GeekSquad protection plans can be associated to a product

Return to GeekSquad Plans/Service Overview

#request:
http://api.remix.bestbuy.com/v1/products(sku=9993374)?show=protectionPlanDetails.states,protectionPlanDetails.termsAndConditions,protectionPlanHighPrice,protectionPlanLowPrice,protectionPlanTerm,protectionPlanType&format=json&apiKey=YourAPIKey

#response:
... { "protectionPlanDetails": [ { "states": [ { "state": "OK" }, { "state": "AR" }, { ... "termsAndConditions": "<!-- 1218015769944 -->\n<!-- INIC_71 core tvs 06012011 -->\n<!-- START Black Tie Top -->\n<!-- Start BTP/BBP Links -->\n<style type=\"text/css\">\n#btpbbp_links{margin-top:20px}\n#btpbbp_links a{font-weight:bold;text-decoration:none;line-height:20px}\n#btpbbp_links a:hover{text-decoration:underline}\n.btptitle{font-weight:bold;text-transform:uppercase}\n</style>\n<div id=\"btpbbp_links\">\n<a href=\"#blacktie\">Geek Squad Protection Plan Terms &amp; Conditions</a></div>\n<!-- End BTP/BBP Links -->\n<a name=\"blacktie\"></a>\n\n<!-- "protectionPlanLowPrice": 250.00, "protectionPlanTerm": "3YR", "protectionPlanType": "PSP-PRP" ...
#request:
http://api.remix.bestbuy.com/v1/products(sku=9993374)?show=protectionPlanDetails.states,protectionPlanDetails.termsAndConditions,protectionPlanHighPrice,protectionPlanLowPrice,protectionPlanTerm,protectionPlanType&format=xml&apiKey=YourAPIKey

#response:
... <protectionPlanDetail> <states> <state>OK</state> <state>AR</state> <state>NY</state> <state>VA</state> <state>AK</state> <state>AZ</state> <state>CA</state> <state>NC</state> <state>MS</state> </states> <termsAndConditions>&lt;!-- 1218015769944 --&gt; &lt;!-- INIC_71 core tvs 06012011 --&gt; &lt;!-- START Black Tie Top --&gt; &lt;!-- Start BTP/BBP Links --&gt; &lt;style type=&quot;text/css&quot;&gt; #btpbbp_links{margin-top:20px} #btpbbp_links a{font-weight:bold;text-decoration:none;line-height:20px} #btpbbp_links a:hover{text-decoration:underline} .btptitle{font-weight:bold;text-transform:uppercase} &lt;/style&gt; &lt;div id=&quot;btpbbp_links&quot;&gt; &lt;a href=&quot;#blacktie&quot;&gt;Geek Squad Protection Plan Terms &amp;amp; Conditions&lt;/a&gt;&lt;/div&gt; &lt;!-- End BTP/BBP Links --&gt; &lt;a name=&quot;blacktie&quot;&gt;&lt;/a&gt; &lt;!-- END Black Tie Top --&gt; &lt;div class=&quot;fixedjackedcode&quot;&gt; &lt;p class=&quot;btptitle&quot;&gt;Geek Squad Protection Plan&lt;/p&gt; &lt;p&gt;Terms &amp; Conditions&lt;/p&gt; &lt;p&gt;This is a legal contract (hereinafter referred to as the &quot;Plan&quot;). By purchasing it, you understand that it is a legal contract and acknowledge that you have ... <protectionPlanHighPrice>299.99</protectionPlanHighPrice> <protectionPlanLowPrice>250.00</protectionPlanLowPrice> <protectionPlanTerm>3YR</protectionPlanTerm> <protectionPlanType>PSP-PRP</protectionPlanType> </product> </products>

Provide full details for a specific service plan

Return to GeekSquad Plans/Service Overview

#request:
http://api.remix.bestbuy.com/v1/products(sku=9993374)?show=protectionPlanDetails.states,protectionPlanDetails.termsAndConditions,protectionPlanHighPrice,protectionPlanLowPrice,protectionPlanTerm,protectionPlanType&format=json&apiKey=YourAPIKey

#response:
{ "products": [ { "protectionPlanDetails": [ { "states": [ { "state": "OK" }, { "state": "AR" } ], "termsAndConditions": "<!-- 1218015769944 -->\n<!-- INIC_71 core tvs 06012011 -->\n<!-- START Black Tie Top -->\n<!-- Start BTP/BBP Links -->\n<style type=\"text/css\">\n#btpbbp_links{margin-top:20px}\n#btpbbp_links a{font-weight:bold;text-decoration:none;line-height:20px}\n#btpbbp_links a:hover{text-decoration:underline}\n.btptitle{font-weight:bold;text-transform:uppercase}\n</style>\n<div id=\"btpbbp_links\">\n<a href=\"#blacktie\">Geek Squad Protection Plan Terms &amp; Conditions</a></div>\n<!-- End BTP/BBP Links -->\n<a name=\"blacktie\"></a>\n\n<!-- END Black Tie Top -->\n<div class=\"fixedjackedcode\"> \n <p class=\"btptitle\">Geek Squad Protection Plan</p> <p>Terms & Conditions</p> <p>This is a legal contract (hereinafter referred to as the \"Plan\"). By purchasing it, you understand that it is a legal contract and acknowledge that you have had the opportunity to read the terms and conditions set forth herein. This Plan and your purchase receipt, containing the effective date and expiration date of your Plan, and the product purchase ..." } ], "protectionPlanHighPrice": 299.99, "protectionPlanLowPrice": 250.00, "protectionPlanTerm": "3YR", "protectionPlanType": "PSP-PRP" } ] }
#request:
http://api.remix.bestbuy.com/v1/products(sku=9993374)?show=protectionPlanDetails.states,protectionPlanDetails.termsAndConditions,protectionPlanHighPrice,protectionPlanLowPrice,protectionPlanTerm,protectionPlanType&apiKey=YourAPIKey

#response:
<product> <protectionPlanDetails> <protectionPlanDetail> <states> <state>OK</state> <state>AR</state> <state>NY</state> <state>VA</state> <state>AK</state> <state>AZ</state> <state>CA</state> <state>NC</state> <state>MS</state> </states> <termsAndConditions>&lt;!-- 1218015769944 --&gt; &lt;!-- INIC_71 core tvs 06012011 --&gt; &lt;!-- START Black Tie Top --&gt; &lt;!-- Start BTP/BBP Links --&gt; &lt;style type=&quot;text/css&quot;&gt; #btpbbp_links{margin-top:20px} #btpbbp_links a{font-weight:bold;text-decoration:none;line-height:20px} #btpbbp_links a:hover{text-decoration:underline} .btptitle{font-weight:bold;text-transform:uppercase} &lt;/style&gt; &lt;div id=&quot;btpbbp_links&quot;&gt; &lt;a href=&quot;#blacktie&quot;&gt;Geek Squad Protection Plan Terms &amp;amp; Conditions&lt;/a&gt;&lt;/div&gt; &lt;!-- End BTP/BBP Links --&gt; &lt;a name=&quot;blacktie&quot;&gt;&lt;/a&gt; &lt;!-- END Black Tie Top --&gt; &lt;div class=&quot;fixedjackedcode&quot;&gt; &lt;p class=&quot;btptitle&quot;&gt;Geek Squad Protection Plan&lt;/p&gt; &lt;p&gt;Terms &amp; Conditions&lt;/p&gt; &lt;p&gt;This is a legal contract (hereinafter referred to as the &quot;Plan&quot;). By purchasing it, you understand that it is a legal contract and acknowledge that you have had the opportunity to read the terms and conditions set forth herein. This Plan and your purchase receipt, &lt;!-- /1218015769886 --&gt;</termsAndConditions> </protectionPlanDetail> </protectionPlanDetails> <protectionPlanHighPrice>299.99</protectionPlanHighPrice> <protectionPlanLowPrice>250.00</protectionPlanLowPrice> <protectionPlanTerm>3YR</protectionPlanTerm> <protectionPlanType>PSP-PRP</protectionPlanType> </product>

Listing Products

We offer various metadata to support you when listing Best Buy products. This information will include information such as if a product is active, if it is new or refurbished or the type of product (music, movie, hardgood, bundle, game, blacktie, or software) to name a few.

For additional information on writing queries please refer to our search tutorial.

Attribute List

Hint: if you would like additional information about an attribute including examples, detailed descriptions and any special considerations when using the attribute please click on the attribute name.

NameDescriptionType
activeidentifies if product is currently supported in the BESTBUY.COM catalogboolean
activeUpdateDatedate and time the active attribute was last changeddate
bundledIn.skureturns collection of bundle sku identifiers that include this productlong
itemUpdateDateupdate timestamp of any change to this productdate
members.skureturns collection of skus within a bundlelong
newidentifies if the product was added within last 30 daysboolean
secondaryMarketidentifies if product is a secondary market productboolean
startDatedate Best Buy began selling productdate
typeidentifies Best Buy product typestring

active

The active attribute identifies if products are currently supported in the BESTBUY.COM catalog. If you want inactive products you must specify active=false or for a mix of active and inactive products use active=*.

Type
boolean
Notes
Default value active=true
Related attributes
activeUpdateDate
Example
"true, false"
Back To Attributes

activeUpdateDate

The activeUpdateDate attribute provides the date and time the active attribute was last changed.

Type
date
Related attributes
active
Example
"2009-03-04T01:42:47"
Back To Attributes

bundledIn.sku

The bundledIn.sku attribute is used to identify a bundle of products that includes this product.

Type
long
Notes
Can be used across multiple types
Example
"9999160000000000"
Back To Attributes

members.sku

The members.sku attribute identifies those SKUs that a return product is associated with.

Type
long
Notes
Applies when type=bundle
Related attributes
Related to bundledIn.sku
Example
"3199341"
Back To Attributes

new

The new attribute identifies if the product was added within the last 30 days.

Type
boolean
Notes
Calculated field: startDate<30 days ago
Related attributes
startDate
Example
"true, false"
Back To Attributes

secondaryMarket

The secondaryMarket attributes identifies if product is a secondary market product.

Type
boolean
Notes
Applies when type=hardgood
Example
"true, false"
Back To Attributes

startDate

The startDate attribute identifies the date that Best Buy began selling this product.

Type
date
Related attributes
new
Example
"2013-09-01"
Back To Attributes

type

The type attribute identifies the "type" of product being sold. There are seven types of products including: hardgood, music, movie, game, blackTie, software and bundle. The "hardgood" type represents products that are not of type music, movie, game, blackTie, software or bundle. The "music" type will include music products that are both material and digital (downloadable.) An example of type=music product would include a Beethoven CD. The "movie" type represents products that can also be material and digital (downloadable.) An example of type=movie would include a Batman DVD. The "game" will include game products that also can be material and digital (download.) An example of type=game would include SkyLander SwapForce. The "blacktie" type represents extended warranty services provided by the Best Buy GeekSquad team. An example of type=blacktie would include 1-Year Accidental Damage Protection Plan - Geek Squad. The "software" type represents products that can also be material and digital (download.) An example would include Adobe Acrobat. The "bundle" represents a grouping of products. They can be both material and digital. An example would include a bundle of a computer desktop, a monitor and virus protection.

Type
string
Example
"music, movie, hardgood, bundle, game, blackTie, software"
Back To Attributes

Best Buy Specific Attributes

The Best Buy specific attributes are those attributes that are most useful for internal Best Buy specific projects. Questions about the use of these attributes can be directed to our Best Buy Developer API Team via email at developer@bestbuy.com.

For additional information on writing queries please refer to our search tutorial.

Attribute List

Hint: if you would like additional information about an attribute including examples, detailed descriptions and any special considerations when using the attribute please click on the attribute name.

NameDescriptionType
bestBuyItemIdBest Buy product identifierlong
collectionBest Buy collection to which a product is assignedstring
listingIdMarketplace product listing IDstring
marketplaceidentifies if product is part of the Best Buy Marketplace programboolean
productIdproduct identifier that groups products with similar names and typeslong
productTemplateproduct data-modeling template used by Best Buy to collect product informationstring
sellerIdMarketplace seller IDstring
sourceproduct sourcestring

bestBuyItemId

The bestBuyItemId attribute is an internal Best Buy product identifier. Used as part of the product description page on BESTBUY.COM.

Type
long
Example
"1517429"
Back To Attributes

collection

The collection attribute is used to group specialized groups of products together such as Magnolia Home Theater products or Only @ Best Buy products.

Type
string
Notes
Collections are used in BESTBUY.COM navigation
Example
"Best Buy Exclusive, Small Business, Refurbished"
Back To Attributes

listingId

The listId is the Best Buy Marketplace listing ID used for Marketplace products.

Type
string
Notes
Applies when marketplace=true
Related attributes
marketplace, sellerId
Example
"B202845632"
Back To Attributes

marketplace

Identifies if product is part of the Best Buy Marketplace program. Additional information about the Best Buy Marketplace program can be found at the Best Buy Marketplace site.

Type
boolean
Notes
Default value marketplace=false
Related attributes
listingId, marketplace, sellerId,
Example
"true, false"
Back To Attributes

productId

The productId attribute groups products with similar names and types

Type
long
Notes
Explanation: The DVD, Blu-ray, and Widescreen versions of a specific movie might have the same productId but different skus.
Example
"1218237703503"
Back To Attributes

productTemplate

The productTemplate attribute provides a product data-modeling template used by Best Buy to collect product information.

Type
string
Example
"Digital_Camera_Accessory, Entertainment_Furniture, Printers, Video_Game_Software"
Back To Attributes

sellerId

The sellerId attribute identifies the seller of a Marketplace item.

Type
string
Notes
Applies when marketplace=true
Related attributes
listingId, marketplace
Example
"15329835"
Back To Attributes

Best Buy logo

We do not support your browser. Neither does Microsoft.

We're glad that you're excited about Best Buy's APIs. However, you're using a browser that's too old to view our new developer site. We encourage you to switch to a newer browser, preferably a recent version of Chrome, Firefox, or Internet Explorer.