ShopSavvy for Haystack
PythonBetaHaystack components that add product search and price comparison to your NLP pipelines. Search products by keyword and compare prices across retailers.
Set up ShopSavvy for Haystack
- 1
Get a ShopSavvy Data API key
Create a key at shopsavvy.com/data. Keys look like ss_live_ followed by 32 characters. Keep it out of source control.
- 2
Install from GitHub
The package in the install command (pip install shopsavvy-haystack) is not on its public registry yet, so install from the source repository and follow its README:
git clone https://github.com/shopsavvy/haystack-core-integrations/tree/feat/shopsavvy-integration/integrations/shopsavvy.git - 3
Add your API key
Enter your key where Haystack asks for ShopSavvy credentials, as the README describes. Store it as a secret, not in code.
- 4
Make your first call
Look up a product by barcode, ASIN or URL and read its current offers. The shopsavvy/haystack-core-integrations README has the full example: https://github.com/shopsavvy/haystack-core-integrations/tree/feat/shopsavvy-integration/integrations/shopsavvy#readme
Keys come with a Data API plan. See plans.
Features
Use Cases
What data, how often, which direction
- Data
- Product records, current offers from tens of thousands of retailers and price history back to 2011, dense from 2019, from the ShopSavvy Data API. Prices are in US dollars.
- How often
- Every offer carries the time it was last checked. With the Data API you can schedule refreshes hourly, daily or weekly for retailers we can re-check through an official retailer API; other retailers update as ShopSavvy sees them.
- Direction
- ShopSavvy data flows into Haystack. Requests carry only what you ask about (identifiers, search terms or schedules) and your API key.
FAQ
Do I need an API key?
Yes. The Haystack integration calls the ShopSavvy Data API, which needs a Data API key. Create one at shopsavvy.com/data, then add it as the setup steps above show.
What data does it return?
ShopSavvy product records (title, brand, model, barcode, ASIN), current offers from tens of thousands of retailers with price, availability and condition, and price history back to 2011, dense from 2019. Products can be looked up by barcode, ASIN, URL or model number. Prices are in US dollars.
How fresh are the prices?
Every offer carries the time ShopSavvy last checked it, so you can see how current each price is. Through the Data API you can schedule refreshes hourly, daily or weekly for retailers we can re-check through an official retailer API; other retailers update as ShopSavvy sees them.
Is my API key stored securely?
Store it as a secret in your own configuration, not in source code. The key is sent to the ShopSavvy API (api.shopsavvy.com) over HTTPS in the Authorization header. You can revoke a key and create a new one at shopsavvy.com/data/api-keys.
Can I install it from a package registry?
Not yet. The package named in its install command has not been published to its public registry, so install it from the GitHub repository (https://github.com/shopsavvy/haystack-core-integrations/tree/feat/shopsavvy-integration/integrations/shopsavvy) for now.
Is it open source?
Yes. The source is on GitHub at https://github.com/shopsavvy/haystack-core-integrations/tree/feat/shopsavvy-integration/integrations/shopsavvy under the Apache-2.0 license.
Powered by the ShopSavvy Data API
This integration connects to the ShopSavvy Data API: product data and current prices from tens of thousands of retailers, across 30M+ products, with price history back to 2011, dense from 2019. Look up products by barcode, ASIN, URL or keyword, compare prices, read history and schedule refreshes.