Skip to content

Document availability by SKU attributes #97

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 4, 2020
Merged

Document availability by SKU attributes #97

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 21 additions & 7 deletions source/includes/stores/_index.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -296,15 +296,16 @@ curl "https://api.bestbuy.com/v1/products/4807511/stores.json?postalCode=55423&a
"ispuEligible": true,
"stores": [
{
"storeID": "281",
"name": "RICHFIELD MN",
"address": "1000 WEST 78TH ST",
"city": "RICHFIELD",
"storeID": "10",
"name": "Maplewood",
"address": "1795 County Rd D E",
"city": "Maplewood",
"state": "MN",
"postalCode": "55423",
"postalCode": "55109",
"storeType": "Big_Box_Store",
"minPickupHours": 1,
"lowStock": false
"minPickupHours": null,
"lowStock": false,
"distance": 16.594
},
]
}
Expand All @@ -317,3 +318,16 @@ The Stores API, in conjunction with the Products API, allows you to search store
You can look up near real time store availability for single SKUs. You may search either on `postalCode` or based on `storeId`. Results for `postalCode` queries will include all stores within a 250 mile radius, sorted by proximity.

_HINT: The Products API attribute `inStoreAvailability` will tell you if a product is sold in stores but not if it's available at a particular store. Using the In-Store availability queries is equivalent to checking product availability in store._

Attribute | Description
--------- | -----------
**stores.storeID** | The unique ID of the store
**stores.name** | The store name
**stores.address** | The street address of the store
**stores.city** | The city in which the store is located
**stores.postalCode** | The postal code in which the store is located
**stores.storeType** | The type of store
**stores.minPickupHours** | The minimum number of hours that must pass after placing a store pick up order before the item will be available for pick up.
**stores.lowStock** | Whether or not the product availability at this store is low and may soon shift to out of stock.
**stores.distance** | The store's distance (in miles) from the given postalCode