ShopSavvy for OpenAI Functions

Python

JSON schema files for OpenAI function calling, plus complete Python and TypeScript examples. Drop these schemas into any OpenAI API integration to add product search and pricing.

Set up ShopSavvy for OpenAI Functions

  1. 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. 2

    Install

    Get the integration from its repository and follow the README's install section: https://github.com/shopsavvy/openai-shopsavvy-function

    git clone https://github.com/shopsavvy/openai-shopsavvy-function.git
  3. 3

    Add your API key

    Set the SHOPSAVVY_API_KEY environment variable to your key (shell, .env file or OpenAI Functions's secrets settings), or pass it to the client as the README shows.

  4. 4

    Make your first call

    From the shopsavvy/openai-shopsavvy-function README (Python Example):

    import json
    import os
    from openai import OpenAI
    from shopsavvy import ShopSavvyDataAPI, ShopSavvyConfig
    
    client = OpenAI()
    api = ShopSavvyDataAPI(ShopSavvyConfig(api_key=os.environ["SHOPSAVVY_API_KEY"]))
    
    # Load function schemas
    with open("schemas/search_products.json") as f:
        search_schema = json.load(f)
    
    response = client.chat.completions.create(
        model="gpt-4o",
        messages=[{"role": "user", "content": "Find the best price for AirPods Pro"}],
        tools=[{"type": "function", "function": search_schema}],
    )

    Copied from the repository README.

  5. 5

    TypeScript Example

    From the shopsavvy/openai-shopsavvy-function README (TypeScript Example):

    import OpenAI from 'openai'
    import { ShopSavvyDataAPI } from '@shopsavvy/sdk'
    import searchSchema from './schemas/search_products.json'
    
    const openai = new OpenAI()
    const api = new ShopSavvyDataAPI({ apiKey: process.env.SHOPSAVVY_API_KEY! })
    
    const response = await openai.chat.completions.create({
      model: 'gpt-4o',
      messages: [{ role: 'user', content: 'Find the best price for AirPods Pro' }],
      tools: [{ type: 'function', function: searchSchema }],
    })

    Copied from the repository README.

Keys come with a Data API plan. See plans.

Features

JSON schemas: search, offers, history, deals
Python example with full tool call loop
TypeScript example with full tool call loop
Works with GPT-4, GPT-3.5, and newer models

Use Cases

1.Add shopping tools to GPT-powered apps
2.Build price comparison chatbots
3.Create product research assistants

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 OpenAI Functions. 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 OpenAI Functions 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?

The README has you supply it through the SHOPSAVVY_API_KEY environment variable or your own configuration, so it stays out of 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.

Is it open source?

Yes. The source is on GitHub at https://github.com/shopsavvy/openai-shopsavvy-function under the MIT 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.