Product Attributes - General

 

Products API - Product Reference Information

Attribute Name

Type

Queryable

Filtered

Multiple

Released

Definition

Examples

Notes

active

Boolean

Queryable

Default=true

Single

Legacy

Does bestbuy.com currently sell the product?

Example(s): true, false

activeUpdateDate

date

Queryable

Not Filtered

Single

Legacy

Active status change timestamp

Example(s): 2009-03-04T01:42:47

bestBuyItemId

long

Queryable

Not Filtered

Single

Legacy

Best Buy product identifier

Example(s): 1517429

bestSellingRank

integer

Queryable

Not Filtered

Single

2012/02

Weighted average of salesRankXxxTerm

Example(s): 12

bundledIn.sku

long

Queryable

Not Filtered

Multiple

Legacy

The sku of a bundle that includes this product

Example(s): 9999158800050018

categoryPath.id

string

Queryable

Not Filtered

Multiple

Legacy

Best Buy category ID

Example(s): abcat0401005

categoryPath.name

string

Queryable

Not Filtered

Multiple

Legacy

Best Buy category name

Example(s): Digital SLR Cameras

class

string

Queryable

Not Filtered

Single

Legacy

BBY class name

Example(s): DSLR DIGITAL SLR

classId

integer

Queryable

Not Filtered

Single

Legacy

BBY class ID

Example(s): 363

collection

string

Queryable

Not Filtered

Single

2012/02

The collection to which the product is assigned

Example(s): Best Buy Exclusive, Small Business, Refurbished

Collections are used in bestbuy.com navigation

department

string

Queryable

Not Filtered

Single

Legacy

BBY department Name

Example(s): PHOTO/COMMODITIES

departmentId

integer

Queryable

Not Filtered

Single

Legacy

BBY department ID

Example(s): 5

itemUpdateDate

date

Queryable

Not Filtered

Single

Legacy

Product update timestamp

Example(s): 2011-05-01T00:15:13

listingId

string

Queryable

Not Filtered

Single

2011/09

Marketplace product listing ID

Example(s): B202845632

Applies to: Marketplace products

lists.endDate

string

Queryable

Not Filtered

Single

2011/11

Last date product is on list

Example(s): 11/1/2011

lists.listId

string

Queryable

Not Filtered

Single

2011/12

List name

Example(s): HolidayGifts2011

lists.startDate

string

Queryable

Not Filtered

Single

2011/13

First date product is on list

Example(s): 12/31/2011

marketplace

Boolean

Queryable

Default=false

Single

Legacy

Is this a marketplace product?

Example(s): true, false

Applies to: Marketplace products

members.sku

long

Queryable

Not Filtered

Multiple

Legacy

skus included in a bundle

Example(s): 9225377

Applies to: Bundles

modelNumber

string

Queryable

Not Filtered

Single

Legacy

BBY product model number

Example(s): EOS 60D Kit with 18-135mm Lens

name

string

Queryable

Not Filtered

Single

Legacy

Product name

Example(s): Canon EOS 60D 18.0-Megapixel Digital SLR Camera - Black

new

Boolean

Queryable

Not Filtered

Single

Legacy

Calculated field: startDate < 30 days ago

Example(s): true, false

productId

long

Queryable

Not Filtered

Single

Legacy

ID of products with same basic name and type

Example(s): 1218237703503

Explanation: The DVD, Blu-ray, and Widescreen versions of a specific movie might have the same productId, but different skus. The soundtrack album for that movie (type=music) will have a different productId.

salesRankLongTerm

integer

Queryable

Not Filtered

Single

Legacy

Sales rank over the past 5 - 21 days

Example(s): 733

salesRankMediumTerm

integer

Queryable

Not Filtered

Single

Legacy

Sales rank over the past 2 - 4 days

Example(s): 290

salesRankShortTerm

integer

Queryable

Not Filtered

Single

Legacy

Sales rank over the past day

Example(s): 129

secondaryMarket

Boolean

Queryable

Not Filtered

Single

2011/07

Secondary market product?

Example(s): true, false

Applies to: HardGoods

sellerId

string

Queryable

Not Filtered

Single

2011/09

ID of marketplace product seller

Example(s): 15329835

Applies to: Marketplace products

sku

long

Queryable

Not Filtered

Single

Legacy

Best Buy’s unique product identifier

Example(s): 1221963

source

string

Queryable

Default=bestbuy

Single

Legacy

Product source

Example(s): bestbuy

With sale of Napster, "bestbuy" is the only value.

startDate

date

Queryable

Not Filtered

Single

Legacy

Date Best Buy began selling product

Example(s): 2010-08-26

subclass

string

Queryable

Not Filtered

Single

Legacy

BBY subclass name

Example(s): DSLR CAMERAS

subclassId

integer

Queryable

Not Filtered

Single

Legacy

BBY subclass ID

Example(s): 205

type

string

Queryable

Not Filtered

Single

Legacy

Product type

Example(s): Music, Movie, HardGood, Bundle, Game, BlackTie, Software

upc

string

Queryable

Not Filtered

Single

Legacy

Universal Product Code

Example(s): 013803129113

 

Products API - Product Information

Attribute Name

Type

Queryable

Filtered

Multiple

Released

Definition

Examples

Notes

accessories.sku

long

Queryable

Not Filtered

Multiple

Legacy

sku of product accessory

Example(s): 8758114

color

string

Queryable

Not Filtered

Single

Legacy

Product color

Example(s): Black

Applies to: HardGoods

condition

string

Queryable

Not Filtered

Single

Legacy

Specifies if product is new or refurbished

Example(s): New, Refurbished

Applies to: HardGoods

customerReviewAverage

float

Queryable

Not Filtered

Single

Legacy

Customer review average

Example(s): 4.8

customerReviewCount

integer

Queryable

Not Filtered

Single

Legacy

Number of customer reviews submitted

Example(s): 182

depth

string

Queryable

Not Filtered

Single

Legacy

Product depth

Example(s): 3.2", Tuner: 2"

description

string

Queryable

Not Filtered

Single

Legacy

Product features

Example(s): 35 mm SLR, body only, lenses separate

details.name

string

Queryable

Not Filtered

Multiple

Legacy

Detail name

Example(s): Lens Features

details.value

string

Queryable

Not Filtered

Multiple

Legacy

Detail information

Example(s): 18-135mm (16 elements in 12 groups)

digital

Boolean

Queryable

Default=false

Single

2011/04

Product is available by download only?

Example(s): true, false

features.feature

string

Queryable

Not Filtered

Multiple

Legacy

Product features

Example(s): Canon DIGIC 4 imaging processor Provides great picture quality...

format

string

Queryable

Not Filtered

Single

Legacy

Media product format

Example(s): CD-ROM, DVD

frequentlyPurchasedWith.sku

long

Queryable

Not Filtered

Multiple

Legacy

Other products frequently purchased with displayed product

Example(s): 1048591

height

string

Queryable

Not Filtered

Single

Legacy

Item height (inches)

Example(s): 18.25", 16-1/4"

includedItemList.includedItem

string

Queryable

Not Filtered

Multiple

Legacy

List of items included with product

Example(s): Wide strap, lens cap, lens dust cap, eyecup, EOS Solution Disk

longDescription

string

Queryable

Not Filtered

Single

Legacy

Detailed product description

Example(s): 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.

longDescriptionHtml

string

Queryable

Not Filtered

Single

Legacy

Detailed product description (HTML formatting)

Example(s): 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.

manufacturer

string

Queryable

Not Filtered

Single

Legacy

Product manufacturer

Example(s): canon

preowned

Boolean

Queryable

Default=false

Single

2011/05

Is the product preowned (used)?

Example(s): true, false

productTemplate

string

Queryable

Not Filtered

Single

2013/02

Product data-modeling template used by BBY to store product information

Example(s): Digital_Camera_Accessory, Entertainment_Furniture, Printers, Video_Game_Software

quantityLimit

integer

Queryable

Not Filtered

Single

Legacy

Maximum number orderable

Example(s): 25

relatedProducts.sku

long

Queryable

Not Filtered

Multiple

Legacy

sku of products similar to base product

Example(s): 1980124

releaseDate

date

Queryable

Not Filtered

Single

Legacy

Date the product was released

Example(s): 2009-05-03T22:43:10

shortDescription

string

Queryable

Not Filtered

Single

Legacy

Brief product description

Example(s): EF 18-135mm Lens included; 3" Vari-Angle LCD monitor; DIGIC 4 imaging processor; PictBridge compatible

shortDescriptionHtml

string

Queryable

Not Filtered

Single

Legacy

Brief product description (HTML formatting)

Example(s): EF 18-135mm Lens included; 3" Vari-Angle LCD monitor; DIGIC 4 imaging processor; PictBridge compatible

warrantyLabor

string

Queryable

Not Filtered

Single

Legacy

Labor warranty description

Example(s): Lifetime limited

warrantyParts

string

Queryable

Not Filtered

Single

Legacy

Parts warranty description

Example(s): 30 days

weight

string

Queryable

Not Filtered

Single

Legacy

Product weight

Example(s): 1.7 lbs.

width

string

Queryable

Not Filtered

Single

Legacy

Product width

Example(s): 1.6", Suction pedestal: 4-1/2"; disc: 2-1/2"

 

Products API - Price

Attribute Name

Type

Queryable

Filtered

Multiple

Released

Definition

Examples

Notes

dollarSavings

dollar

Queryable

Not Filtered

Single

Legacy

regularPrice - sale-Price (Hardgoods only)

Example(s): 29.99

Applies to: HardGoods

offers.endDate

date

Queryable

Not Filtered

Multiple

2012/09

Date offer ends

Example(s): 2012-10-12

Can have multiple offers per product, but only one ID per offer

offers.heading

string

Queryable

Not Filtered

Multiple

2012/10

Offer description

Example(s): Hit CDs Starting at $8.99

Can have multiple offers per product, but only one ID per offer

offers.id

string

Queryable

Not Filtered

Multiple

Legacy

Special offer ID

Example(s): FS, OS, promo175700050000

Can have multiple offers per product, but only one ID per offer

offers.imageUrl

string

Queryable

Not Filtered

Multiple

2012/11

URL of image bestbuy.com uses with the offer

Example(s): http://images.bestbuy.com/BestBuy_US/en_US/images/abn/2013/mm/fo/fo_muhits0113.gif

Can have multiple offers per product, but only one ID per offer

offers.startDate

date

Queryable

Not Filtered

Multiple

2012/12

Date offer starts

Example(s): 2012-10-01

Can have multiple offers per product, but only one ID per offer

offers.text

string

Queryable

Not Filtered

Multiple

Legacy

Special-order description, or additional featured-offer details

Example(s): Free Shipping, On Sale, Free 8x8 Photo Book: Find Out How

Can have multiple offers per product, but only one description (.text) per offer

offers.type

string

Queryable

Not Filtered

Multiple

2012/13

Type of offer

Example(s): special_offer, featured_offer, digital_insert, deal_of_the_day

Can have multiple offers per product, but only one ID per offer

offers.url

string

Queryable

Not Filtered

Multiple

Legacy

URL of special-offer image

Example(s): http://www.bestbuy.com/site/olspage.jsp?type=category&id=pcmcat224200050001

Can have multiple offers per product, but only one URL per offer

onSale

Boolean

Queryable

Not Filtered

Single

Legacy

Is salePrice < regularPrice?

Example(s): true, false

priceRestriction

string

Queryable

Not Filtered

Single

2012/08

If populated, type of price restriction product is under

Example(s): MAP, ICR

percentSavings

string

Queryable

Not Filtered

Single

2013/05

sample text here

lowPriceGuarantee

string

Queryable

Not Filtered

Single

2013/05

sample text here

priceUpdateDate

date

Queryable

Not Filtered

Single

Legacy

Price update timestamp

Example(s): 2009-03-03T00:09:48

priceWithPlan.newTwoYearPlan

dollar

Queryable

Not Filtered

Single

2012/07

Mobile phone price when purchased with new two-year plan

Example(s): 99.99

Applies to: Mobile phones

priceWithPlan.upgradeTwoYearPlan

dollar

Queryable

Not Filtered

Single

2012/08

Mobile phone price when purchased with two-year upgrade plan

Example(s): 129.99

Applies to: Mobile phones

regularPrice

dollar

Queryable

Not Filtered

Single

Legacy

Regular product selling price

Example(s): 1299.99

salePrice

dollar

Queryable

Not Filtered

Single

Legacy

Current item selling price

Example(s): 999.99

 

Products API - Delivery (including Availability and Shipping)

Attribute Name

Type

Queryable

Filtered

Multiple

Released

Definition

Examples

Notes

freeShipping

Boolean

Queryable

Not Filtered

Single

Legacy

Product has free shipping?

Example(s): true, false

friendsAndFamilyPickup

Boolean

Queryable

Not Filtered

Single

Legacy

Product available for friends & family pickup?

Example(s): true, false

homeDelivery

Boolean

Queryable

Not Filtered

Single

Legacy

If "true", product cannot be shipped; must schedule home delivery

Example(s): true, false

inStoreAvailability

Boolean

Queryable

Not Filtered

Single

Legacy

Available to be purchased in a store

Example(s): true, false

inStoreAvailabilityText

string

Queryable

Not Filtered

Single

Legacy

Additional information regarding inStoreAvailability

Example(s): Store Pickup: Available at most stores

inStoreAvailabilityTextHtml

string

Queryable

Not Filtered

Single

Legacy

Additional information regarding inStoreAvailability (HTML formatting)

Example(s): Store Pickup: Available at most stores

inStoreAvailabilityUpdateDate

date

Queryable

Not Filtered

Single

Legacy

inStoreAvailability update timestamp

Example(s): 2010-09-19T00:59:13

inStorePickup

Boolean

Queryable

Not Filtered

Single

Legacy

If true, product can be purchased on line and picked up in a store

Example(s): true, false

onlineAvailability

Boolean

Queryable

Not Filtered

Single

Legacy

Product can be purchased on line?

Example(s): true, false

onlineAvailabilityText

string

Queryable

Not Filtered

Single

Legacy

Additional information regarding online availability

Example(s): Shipping: Usually leaves our warehouse in 1 business day

onlineAvailabilityTextHtml

string

Queryable

Not Filtered

Single

Legacy

Additional information regarding online availability (HTML formatting)

Example(s): Shipping: Usually leaves our warehouse in 1 business day

onlineAvailabilityUpdateDate

date

Queryable

Not Filtered

Single

Legacy

Time online availability was last updated

Example(s): 2010-12-09T05:48:17

orderable

string

Queryable

Not Filtered

Single

Legacy

Product ordering status

Example(s): Available, SoldOut, SpecialOrder

shipping.ground

dollar

Queryable

Not Filtered

Single

2011/06

Product shipping cost - ground ("standard") (dollars)

Example(s): 5.49

shipping.nextDay

dollar

Queryable

Not Filtered

Single

2011/06

Product shipping cost - next-day delivery ("express") (dollars)

Example(s): 23.67

shipping.secondDay

dollar

Queryable

Not Filtered

Single

2011/06

Product shipping cost - second-day delivery ("expedited") (dollars)

Example(s): 15.95

shipping.vendorDelivery

dollar

Queryable

Not Filtered

Single

2011/06

Product shipping cost - vendor delivery (dollars)

Example(s): 69.95

shippingCost

dollar

Queryable

Not Filtered

Single

Legacy

Product's lowest shipping cost (dollars)

Example(s): 19.99

shippingWeight

string

Queryable

Not Filtered

Single

Legacy

Shipping weight (pounds)

Example(s): 5.061

specialOrder

Boolean

Queryable

Not Filtered

Single

Legacy

Product available by special order only?

Example(s): true, false

 

Products API - Images

Attribute Name

Type

Queryable

Filtered

Multiple

Released

Definition

Examples

Notes

accessoriesImage

string

Queryable

Not Filtered

Single

Legacy

URL of accessories image

Example(s): http://images.bestbuy.com/BestBuy_US/images/products/9387/9387086aca.jpg

alternateViewsImage

string

Queryable

Not Filtered

Single

Legacy

URL of alternate image

Example(s): http://images.bestbuy.com/BestBuy_US/images/products/1221/1221963cv1a.jpg

angleImage

string

Queryable

Not Filtered

Single

Legacy

URL of product's angle image

Example(s): http://images.bestbuy.com/BestBuy_US/images/products/7870/7870949_ra.jpg

backViewImage

string

Queryable

Not Filtered

Single

Legacy

URL of rear image

Example(s): http://images.bestbuy.com/BestBuy_US/images/products/1221/1221963_ba.jpg

energyGuideImage

string

Queryable

Not Filtered

Single

Legacy

URL of product's EnergyGuide image

Example(s): http://images.bestbuy.com/BestBuy_US/images/products/9851/9851816_eg.jpg

Applies to: Appliances

image

string

Queryable

Not Filtered

Single

Legacy

URL of product detail page image

Example(s): http://images.bestbuy.com/BestBuy_US/images/products/1221/1221963_sc.jpg

largeFrontImage

string

Queryable

Not Filtered

Single

Legacy

URL of large front image

Example(s): http://images.bestbuy.com/BestBuy_US/images/products/1221/1221963_sa.jpg

largeImage

string

Queryable

Not Filtered

Single

Legacy

URL of large image

Example(s): http://images.bestbuy.com/BestBuy_US/images/products/1221/1221963_sb.jpg

leftViewImage

string

Queryable

Not Filtered

Single

Legacy

URL of left image

Example(s): http://images.bestbuy.com/BestBuy_US/images/products/1221/1221963le.jpg

mediumImage

string

Queryable

Not Filtered

Single

Legacy

URL of medium image

Example(s): http://images.bestbuy.com/BestBuy_US/images/products/1221/1221963fp.gif

remoteControlImage

string

Queryable

Not Filtered

Single

Legacy

URL of remote control image

Example(s): http://images.bestbuy.com/BestBuy_US/images/products/9215/9215217rca.jpg

rightViewImage

string

Queryable

Not Filtered

Single

Legacy

URL of right image

Example(s): http://images.bestbuy.com/BestBuy_US/images/products/7870/7870949ria.jpg

spin360Url

string

Queryable

Not Filtered

Single

Legacy

URL of 360-degree image

Example(s): http://images.bestbuy.com/BestBuy_US/en_US/images/global/360/360pop.html?sku=1221963

thumbnailImage

string

Queryable

Not Filtered

Single

Legacy

URL of image used on listing pages

Example(s): http://images.bestbuy.com/BestBuy_US/images/products/1221/1221963_s.gif

topViewImage

string

Queryable

Not Filtered

Single

Legacy

URL of top image

Example(s): http://images.bestbuy.com/BestBuy_US/images/products/2089/2089051_ta.jpg

 

Products API - Links

Attribute Name

Type

Queryable

Filtered

Multiple

Released

Definition

Examples

Notes

addToCartUrl

string

Not queryable

Not Filtered

Single

Legacy

bestbuy.com cart URL with item in cart

Example(s): http://www.bestbuy.com/site/olspage.jsp?id=pcmcat152200050035&type=category&cmp=RMX&ky=2iqqZuxRmmQwrXfqEU4dvlbYYdXFvbflW&qvsids=1221963

linkShareAffiliateAddToCartUrl

string

Not queryable

Not Filtered

Single

Legacy

bestbuy.com cart URL with item in cart and affiliate information

Example(s): (URL generated at run time)

Must specify LinkShare ID in query.  LID= <yourLinkShareAffiliateId>

linkShareAffiliateUrl

string

Not queryable

Not Filtered

Single

Legacy

Product description page URL with affiliate information

Example(s): (URL generated at run time)

Must specify LinkShare ID in query.  LID= <yourLinkShareAffiliateId>

mobileUrl

string

Not queryable

Not Filtered

Single

Legacy

URL of mobile phone version of bestbuy.com product page

Example(s): http://m.bestbuy.com/r/1218237703503/1221963/

url

string

Queryable

Not Filtered

Single

Legacy

bestbuy.com product detail page URL

Example(s): http://www.bestbuy.com/site/Canon+-+EOS+60D+18.0-Megapixel+Digital+SLR+Camera+-+Black/1221963.p?id=1218237703503&skuId=1221963&cmp=RMX&ky=2iqqZuxRmmQwrXfqEU4dvlbYYdXFvbflW

 

Products API - Plans

Attribute Name

Type

Queryable

Filtered

Multiple

Released

Definition

Examples

Notes

buybackPlans.name

string

Queryable

Not Filtered

Single

Legacy

Buy-back plan name

Example(s): 2-Year Buy Back Plan

Applies to: HardGoods

buybackPlans.productId

 

Queryable

Not Filtered

Single

2011/11

Product ID of buy-back plan

Example(s): 1218338413719

Applies to: HardGoods

buybackPlans.regularPrice

dollar

Queryable

Not Filtered

Single

2011/12

Regular price of buy-back plan

Example(s): 24.98

Applies to: HardGoods

buybackPlans.salePrice

dollar

Queryable

Not Filtered

Single

2011/13

Current selling price of buy-back plan

Example(s): 19.98

Applies to: HardGoods

buybackPlans.sku

long

Queryable

Not Filtered

Single

Legacy

sku of buy-back plan

Example(s): 2490462

Applies to: HardGoods

buybackPlans.type

string

Queryable

Not Filtered

Single

Legacy

Buy-back plan type

Example(s): PSP-PRP

Applies to: HardGoods

protectionPlanDetails.states

string

Queryable

Not Filtered

Multiple

Legacy

States in which protection plan is valid

Example(s): MN, TX, AK

Applies to: BlackTie

protectionPlanDetails.termsAndConditions

string

Queryable

Not Filtered

Multiple

Legacy

Protection plan terms and conditions

Example(s): 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 Obligor...

Applies to: BlackTie

protectionPlanHighPrice

dollar

Queryable

Not Filtered

Single

Legacy

Highest product price in protection plan price band

Example(s): 999.99

Applies to: BlackTie

protectionPlanLowPrice

dollar

Queryable

Not Filtered

Single

Legacy

Lowest product price in protection plan price band

Example(s): 900.00

Applies to: BlackTie

protectionPlans.name

string

Queryable

Not Filtered

Single

2011/09

Name of product's protection plan

Example(s): 2-Year Protection Plan - Geek Squad

protectionPlans.productId

long

Queryable

Not Filtered

Single

2011/09

Product IDct's protection plan

Example(s): 1218318237605

protectionPlans.regularPrice

dollar

Queryable

Not Filtered

Single

2011/09

Regular price of product's protection plan

Example(s): 14.99

This is the plan price, not the product price. Can have multiple protection plans per product, but only one price per plan

protectionPlans.salePrice

dollar

Queryable

Not Filtered

Single

2011/09

Current selling price of product's protection plan

Example(s): 14.99

This is the plan price, not the product price. Can have multiple protection plans per product, but only one price per plan

protectionPlans.sku

long

Queryable

Not Filtered

Single

Legacy

sku of product's protection plan

Example(s): 9973107

Applies to: HardGoods

Can have multiple protection plans per product, but only one sku per plan

protectionPlans.term

string

Queryable

Not Filtered

Single

Legacy

Length of product's protection plan

Example(s): 3YR

Applies to: HardGoods

Can have multiple protection plans per product, but only one term per plan

protectionPlans.type

string

Queryable

Not Filtered

Single

Legacy

Type of product's protection plan

Example(s): PSP-PRP, MAGNOLIA HOME THEATER

Applies to: HardGoods

Can have multiple protection plans per product, but only one type per plan

protectionPlanTerm

string

Queryable

Not Filtered

Single

Legacy

Protection plan length

Example(s): 1YR

Applies to: BlackTie

protectionPlanType

string

Queryable

Not Filtered

Single

Legacy

Protection plan type

Example(s): PSP-PRP, MAGNOLIA HOME THEATER

Applies to: BlackTie