Skip to content

Latest commit

 

History

History
586 lines (464 loc) · 26.5 KB

CHANGELOG.md

File metadata and controls

586 lines (464 loc) · 26.5 KB
Raw

Change Log

All notable changes to the Best Buy API will be documented in this file.

R17.4 - 2017-10-01

Added

  • We have a new attribute set that will provide a broader range of product relationships – currently the data includes color and size relationships as well as some brand collections, though these relationship types will expand over time. The new attribute is productVariations and includes variations.name and variations.value by productVariations.sku.
  • The discs[].tracks) attribute set shows name and sequence for songs on the designated music SKU
  • Contract pricing for mobile devices (contracts[].type, contracts[].prices, contracts[].priceNote, etc): this attribute set reflects monthly pricing for activated devices such as mobile phones and tablets, including number of payments, current, and regular pricing

Changed

  • We are deprecating three attributes: relatedProducts, productFamilies, and frequentlyPurchasedWith. Data in these fields may already be stale. We will be deleting these attributes from the response document in early 2018: this is a change in our contract.
  • onlineAvailabilityText, onlineAvailabilityTextHtml, inStoreAvailabilityText, and inStoreAvailabilityTextHtml are deprecated fields. The data in these fields may not match availability on BestBuy.com and values are likely to become stale in the coming weeks.
  • Content changes will start flowing through our APIs that will replace our 10-digit SKUs (primarily used with digital products) to 7-digit SKUs. If you have logic in place based on SKU length, be aware of this change.

R17.3 - 2017-06-06

Added

R17.2 - 2017-04-03

Changed

  • The beta/products/<sku>/similar... endpoint is no longer active. Queries to this endpoint will 404. The source for that data was deprecated.

R17.1 - 2017-03-24

Changed

R16.5 - 2016-12-14

Changed

  • Searching for an unrecognized query parameters will no longer return a 400 error.
  • Product searches now include more useful information, including available offers and free items.
  • Querying a nested attribute such as mobile carrier terms or mobile plan features will no longer return a 500 error.
  • Searching strings containing special characters such as - or * will no longer return a 500 error.
  • We have expanded the number of products available when querying with friendsAndFamilyPickup.

R16.4 - 2016-06-30

Added

  • Expanding on the existing offers.type of digital_insert, gift_with_purchase is now also being exposed. This will help API consumers identify special deals where purchase of an item entitles the end-user to another item at a discount

Changed

  • Before this release, if an API query string included an unknown parameter the system would return an HTTP 400 error. Although some very intelligent API specs prefer the previous pattern (such as https://github.com/cloudfoundry/cc-api-v3-style-guide#query-parameters), we've made a change to ignore unknown parameters in hopes that applying the Robustness principle (https://en.wikipedia.org/wiki/Robustness_principle) to the API simplifies adoption of new parameters.
  • The API is working on reducing the number of similar URL fields in our results, with the goal of reducing from 8 fields to 2. This release is the first step in that effort, moving URLs from pointing to www.bestbuy.com/... to api.bestbuy.com/click... This change will enable future features not previously possible, such as expanded Add To Cart functionality and automatic attachment of affiliate codes. A newsletter and blog post will be released soon to elaborate on this change.

Bug Fix

  • From 6/16 through 6/23, several products in the API were returning addToCart as blank. This has been fixed.

R16.3 - 2016-05-30

Changed

  • Shipping cost will now be calculated based on shippingLevelsOfService serviceLevelId rather than serviceLevelName. Users will not see a difference in the response document.
  • Certain products available for presale have displayed a dummy releaseDate of 12/31/YYYY. To avoid customer confusion, this date will now pass as null.

R16.2 - 2016-03-01

Changed

We have deprecated the bestBuyItemID attribute. We will be deleting it throughout Best Buy systems and forcing the value for that attribute to an empty string.

R16.1 - 2016-01-01

Changed

Due to alterations in our source systems, the following changes have been made in our Products API:

  • Bundle SKUs (SKUs that include multiple products in the purchase, e.g., a DSLR camera, lens and case sold together where type=bundle) will not include shipping data in the response.
  • mobileUrl field is now a mirror of url. It should be considered deprecated and we advise consumers to update their code to no longer use it.
  • accessories attribute is now deprecated and will no longer contain suggested accessory SKUs.
  • bestBuyItemID is a deprecated attribute and will return a null value. This is a field that was hidden by default and should not impact many customers. Please use the sku identifier as a unique identifier for all Best Buy products.

R15.15 - 2015-10-01

Changed

  • Added shippingLevelsOfService attribute to Products API in accordance with changes made to shipping options on BESTBUY.COM
  • Updated shipping data is being delivered via the existing shipping attribute as well in order to minimize impact during the pre-holiday and holiday season
  • Current shipping attribute has been deprecated and will be removed

R15.14 - 2015-09-01

Changed

Notes

  • The Offer Transition project in Products API has completed and all offers of type special_offer have been restored.

R15.8 - 2015-08-01

Notes

  • Update on Offer Transition in the Products API: We are almost finished transitioning how the Products API receives offers. You may notice a temporary decrease in the number of offers available during this transition. Our plan is to provide full offers by the end of August.

R15.7 - 2015-07-01

Changed

  • Retired Featured Offers from Products API for reasons noted in R15.5
  • We continue to provide Special Offers, Deal of the Day Offers and Digital Insert Offers

R15.6 - 2015-06-01

Changed

  • Updated postal codes in Remix to include any new codes. Queries that include the Stores API may now return additional stores.

Notes

  • Possible data outage: Throughout July and August, product-offer information within Best Buy is being adjusted. There may be sporadic times when endpoints containing promotion information (e.g. “This item has free shipping.”) will be negatively impacted.

R15.5 - 2015-05-01

Changed

  • Updated the Product Offers Deal of the Day source
  • No longer populating Deal of the Day offers.text field, as it was determined to be repetitive
  • No longer publishing a SKU with a rank of 1 for the following attributes due to past confusion:
  • bestSellingRank
  • salesRankShortTerm
  • salesRankMediumTerm
  • salesRankLongTerm
  • Removed Featured Offers from Products API, as this data has evolved into landing pages on BESTBUY.COM instead of individual SKUs

R15.4 - 2015-04-01

Added

  • Address2 attribute to Stores API, providing additional address information for Best Buy stores

R15.3 - 2015-03-01

Added

  • Active Adventurer endpoint to the SmartList API, providing top-rated fitness and outdoor products
  • Categories API to the Query Builder tool, allowing queries based on:
  • All Categories
  • Top Level Categories
  • Search Categories by Name
  • Search Categories by Category Id

Changed

  • Removed mock 404, as we have improved our code enough to make it rare and extraneous
  • Now including pageSize and page as part of the Canonical URL in our response document. This will impact the following endpoints:
  • Open Box by Category
  • Open Box All SKUs

R15.2.1 - 2015-02-15

Added

  • SmartLists API to provide a guided shopping experience for the Connected Home endpoint and more

Changed

  • Replaced API Console with Query Builder, allowing user to create queries for most of our APIs
  • Updated Recommendations and Buying Options endpoints to return results for inactive SKUs, Categories and SubCategories

R15.2 - 2015-02-01

Added

  • Open Box List of SKUs to Buying Options API
  • Returns at most 100 SKUs
  • Added pre-owned value to condition attribute, to represent products that were previously owned and Best Buy received as part of a trade-in before reselling
  • Expands pre-owned to include all products of type hardgood in addition to game

Changed

  • Enhanced Trending Products endpoint in Recommendations API to allow searching by Category or Subcategory

R14.9 - 2015-01-01

Changed

  • Enhanced Open Box endpoint in Buying Options API to allow searching by Category or Subcategory
  • Renamed the Open Box Multi SKU endpoint to Open Box All SKUs
  • Removed arg from Buying Options and Recommendations endpoints, as the information was already available in the canonical URL

R14.8 - 2014-12-01

Added

  • Buying Options API Beta
  • Provides information about ship-from-store eligible Open Box products, including availability, condition and special pricing
  • New express value added to storeType attribute of Stores API to identify Best Buy Express kiosk locations
  • Also added attribute for instances where existing Best Buy Express address information is insufficient

Changed

  • Enhancements to Recommendations API
    • Added several attributes
    • Enhanced Most Popular Viewed endpoint to allow pulling top products by category or subcategory
    • Moved productLink attribute to links section and renamed it product

Fixed

  • Corrected reference to productsHardGood in Archives to productHardgood

R14.7 - 2014-10-01

Changed

  • Further Products API attributes to be deprecated, as per R14.6:
  • analogAudioInputs - Deprecated
  • avOutputs - Deprecated
  • brightnessNits - New Int
  • brightnessCdPerSqM - New Int
  • builtInDigitalCamera - will continue, and will be further expressed as New Booleans: frontFacingCameraand rearFacingCamera
  • frontFacingCamera - New boolean
  • rearFacingCamera - New boolean
  • builtForBluRay - Deprecated
  • builtInPlayer - Deprecated
  • capacityCuFt - will be supplemented with New Decimals capacityRefrigeratorCuFt and capacityFreshFoodCuFt
  • capacityFreezerCuFt - New Decimal
  • clock - Deprecated
  • combFilter - Deprecated
  • customSettings - Deprecated
  • cycleDescriptions - Deprecated
  • digitalAudioOutputs - Deprecated and replaced with New Int numberOfOpticalDigitalAudioOutputs and numberOfCoaxialDigitalAudioOutputs
  • digitalOutputs - Deprecated
  • digitalTuner - Deprecated
  • dolbyDigitalDecoder - Deprecated
  • dynamicContrastRatio - Deprecated and replaced with New Strings maximumContrastRatioDynamic and minimumContrastRatioDynamic
  • estimatedYearlyOperatingCosts - Deprecated (was a list of values) and replaced with New Int estimatedYearlyOperatingCostsUsd
  • fiveOneChannelInput - Deprecated
  • fiveOneChannelOutput - Deprecated
  • frontPanelAvInputs - Deprecated
  • frontSurroundPowerPerChannel - Deprecated
  • hdRadioCompatible - Deprecated
  • hdRadioReady - Deprecated
  • hdtvCompatibility - Deprecate
  • heightWithStandIn - Deprecated and replaced with New Decimal productHeightIn
  • maximumStandHeightIn - New Decimal
  • minimumStandHeightIn - New Decimal
  • standHeightIn - New Decimal
  • ipodDock - Deprecated
  • iphoneAccessory - Deprecated
  • lcdScreenSizeIn - Deprecated, users should rely on screenSizeIn
  • ledButtons - Deprecated
  • maximumPowerHandling - Deprecated
  • maximumResolutionHorizontalPx - Deprecated
  • maximumResolutionVerticalPx - Deprecated
  • mediaPort - Deprecated
  • mms - Deprecated
  • mp3PlaybackCapability - Deprecated
  • pcInputs - Deprecated, replaced with New Boolean pcInput
  • phonoInputs - Deprecated
  • powerSourceRatings - Deprecated
  • preampOutputs - Deprecated
  • rearSurroundPowerPerChannel - Deprecated
  • rfAntennaInputs - Deprecated, replaced with New Boolean rfAntennaInput
  • sanitationAllergyCycle - Deprecated, replaced with New Booleans sanitationCycle and allergyCycle
  • satelliteRadioReady - Deprecated
  • sdCardSlot - Deprecated
  • shelfSystemType - Deprecated
  • sixOneChannelInput - Deprecated
  • soundLeveler - Deprecated
  • soundType - Deprecated
  • speakerLocation - Deprecated
  • subwooferPowerWatts - Deprecated
  • subwooferSizeIn - Deprecated
  • surroundSoundDecoders - Deprecated
  • threeDPassThrough - Deprecated
  • thruTheDoorIceDispenser - Deprecated, replaced with throughTheDoorDispenser
  • thruTheDoorWaterDispenser - Deprecated, replaced with throughTheDoorDispenser
  • touchPadControls - Deprecated
  • waterFiltrationReplacementIndicatorLight - Deprecated
  • wattsPerChannel - Deprecated, replaced with wattsPerChannelRms

R14.6 - 2014-09-01

Changed

  • Updated various Products API attributes to make product data more consistent and easier to understand
  • These attributes will no longer appear as top-level on product data returned by the Products API
  • Data represented by these attributes may still be available in the details collection of relevant products, but the detail name, format and structure of the detail value may change
  • Some attributes will be gradually phased out
  • avOutputs
  • builtForBluRay
  • clock
  • customSettings
  • cycleDescriptions
  • digitalAudioInputs
  • digitalAudioOutputs
  • digitalOutputs
  • digitalTuner
  • dolbyDigitalDecoder
  • fiveOneChannelInput
  • fiveOneChannelOutput
  • hdtvCompatibility
  • sixOneChannelInput

Notes

  • Runtime responses from the Products API will continue to indicate that these attributes can be used​ for searching, even as the attributes slowly disappear from the product data. For instance, the top level attribute clock is being retired. Over time, the results of a search on clock=* will diminish. Eventually, that search will return no results. However, in the details of some products, you may find a detail named clockDisplay with a value of "Yes" or "No". In other products, you may find details named with other variations indicating clock with a variety of possible values. This will impact applications that provide filtering using the top level attributes. If an application provides filtering for whether products include a clock using the clock top level attribute, that filtering will cease to work as expected over time. This change should not cause such an application to produce an error or cease functioning.

  • The product data updates will also impact applications that display these attributes. In this example, the clock attribute will no longer display. If the application has hard-coded usage of the clock attribute, that application may produce errors or cease functioning.

R14.5 - 2014-07-01

Added

  • Recommendations API Beta endpoints:
  • similar - takes any hardgood or software SKU and returns the top products similar to it based on the number of product attributes that match
  • trendingViewed - returns what is hot right now on BESTBUY.COM by returning the top ten trending products based on product page views over a specific timeframe
  • mostPopular returns the most frequently viewed products across all of BESTBUY.COM based on page views (versus Trending Products that shows change in velocity)
  • alsoViewed returns the most frequently viewed products other customers viewed after the driver SKU

Notes

  • To access these new endpoints while they are in beta, please send your user name and key(s) to [email protected] and we will enable them for your existing API key(s). If you don't have an API key, visit our registration page first. The response returned from our Recommendations endpoints is similar to that of our Products API.

R14.4 - 2014-06-01

Added

  • New attribute to Products API
  • customerTopRated - indicates if a product is top-rated based on customer reviews
  • Two attributes to Stores API
  • storeType - provides information such as "Big Box" or "Mobile"
  • tradeIn - provides store trade-in policy and conditions for trading in products such as mobile phones and games

Changed

  • Updated data source for relatedProducts attribute to provide both more relevant related product information and data for more SKUs in our catalog

R14.3 - 2014-05-01

Changed

  • Unspecified operational updates

R14.2 - 2014-02-01

Added

  • productFamilies attributes to Products API, listing associated SKUs based on specified groupings (alternate color, for instance)

R14.1 - 2014-01-01

Changed

  • Deactivated Commission Junction links after converting to LinkShare, replaced with a 400 Bad Request error
  • Removed two attributes from Products API:
  • cjAffiliateUrl
  • cjAffiliateAddToCartUrl

R13.8 - 2013-11-01

Added

  • New hours attributes for Stores API
  • detailedHours.day - specific day of the week
  • detailedHours.date - provides the date of the day
  • detailedHours.open - store opening time for that day
  • detailedHours.close - store closing time for that day
  • gmtOffset
  • hoursAmPm - store open hrs for the entire week in AM/PM format

R13.7 - 2013-10-01

Changed

  • Added support for a facet=attribute,{number of facets} function for attributes which can be queried

R13.6 - 2013-09-01

Added

  • Products API attribute to indicate whether a SKU qualifies for a specific 9/12/13 free shipping promotion
  • Two Products API attributes for our new Affiliate Management Agency LinkShare
  • linkShareAffiliateUrl takes customer to PDP of the product and track referral credit
  • linkShareAffiliateAddToCartUrl initiates a bestbuy.com cart with the product in the cart and tracks referral/sales credit

Changed

  • Added support for a range(lower,upper) function for numeric and date attributes only
  • Added support for approximate searches on date-type and time attributes using tilde (~) operator

R13.5 - 2013-08-01

Changed

  • Added support for approximate searches on numeric attributes using the tilde (~) operator

R13.4 - 2013-07-01

Added

  • New Products API attributes
  • regular price and sale price for cell phones with plans for both new two year contracts and upgrades to clarify cell phone pricing
  • techSupportPlans attribute to associate Geek Squad Technical Support SKUs to the parent SKU

R13.3 - 2013-05-01

Added

  • Two attributes to Products API
  • percentSavings attribute - calculates savings between regularPrice and salePrice attribute
  • lowPriceGuarantee - finds SKUs that qualify for the Best Buy Low Price Guarantee
  • One attribute to Stores API
  • services.service - finds stores offering specific services

R13.2 - 2013-04-01

Added

  • shippingRestrictions attribute to Products API to indicate Marketplace products with restrictions
  • Three new Music attributes
    • mediaCount - Number of discs
    • monoStereo - Mono or stereo recording
    • studioLive - Studio or live performance
  • Six new Movies attributes
  • additionalFeatures - Bonus tracks, interviews, trailers, etc.
  • videoChapters - The movie's scenes
  • videoLanguage - Main audio language
  • screenFormat - Enhanced Widescreen for 16x9 TV, Full Screen, Widescreen, etc.
  • subtitleLanguage
  • fulfilledBy - Indicates if a title is fulfilled by Cinema Now

Changed

  • Expanded dollarSavings in Products API to include all products
  • Expanded shippingWeight in Products API to include all shippable products

R13.1 - 2013-03-01

Added

  • productTemplate attribute to Products API, making our product data-modeling template public
  • Subsets to allow more focused searches of our archives

Changed

  • Importing more digital products data to match Best Buy's expanded assortment

R12.5 - 2012-08-01

Added

  • priceRestriction attribute to Products API to accommodate "See price in cart" listings

Changed

  • Categories can now be made active or inactive

R12.4 - 2012-07-01

Added

  • New Reviews API attribute
  • planPrice attributes for Mobile Phones

Changed

  • Updated Stores API to avoid returning recently closed stores
  • Updated logic that sets values in Boolean attributes onlineAvailability and inStoreAvailability
  • Updated product data to refresh every 15 minutes

R12.3 - 2012-05-01

Added

  • Dedicated Archives job queue for more consistent time-keeping

Changed

  • Updated displayed-price rules

R12.2 - 2012-04-01

Changed

  • 19 unspecified operational updates

R12.1 - 2012-02-01

###Added

  • Four new Products API attributes:
  • onlinePlayfor Games and Software
  • numberOfPlayers for Games and Software
  • collection
  • bestSellingRank

###Changed

  • Reduced Product data latency
  • Updated albumLabel attribute for Music
  • Updated genre attribute for Music and Movies to allow a list of genres
  • Removed the following attributes
  • albumVersion
  • appleConnectivity
  • brand
  • cellPhoneBrand
  • copyright
  • napsterAlbumId
  • nationalFeatured
  • navigability
  • preferredRelatedBestBuySku
  • preferredRelatedNapsterSku
  • printOnly
  • related.active, related.sku, related.type, related.title
  • saleEndDate
  • savings
  • skuSourceIndicator
  • smartPhone
  • softwareMultiplayerInternet, softwareOnlinePlay, softwareNumberOfPlayers
  • softwareReleaseDate
  • tinyMobileUrl

R11.2 - 2011-06-01

Added

  • Four new Products API shipping costs attributes:
    • Ground
    • secondDay
    • nextDay
    • vendorDelivery

Changed

  • Floating-point search enhancement
  • Overall search improvement

R11.1 - 2011-05-01

Added

  • Three new Products API Products attributes:
    • tradeIn Value
    • Preowned
    • Digital Products