📖
/ THE PRODUCT LLM /
HomePlayground
  • 👋Welcome
  • Getting Started
    • 🏃‍♂️Quickstart
  • Endpoints
    • 🔎/search-products
    • 🧠/match-products
    • 🔎/search-and-match
  • Topics
    • 📖Guidelines for Input Data
    • 📦Product Field
    • ‼️ Error Types
  • 🚨 Alerts
Powered by GitBook
On this page
  • /search-and-match
  • Request
  1. Endpoints

/search-and-match

Available at https://api.theproductllm.com/search-and-match-products

Last updated 18 days ago

Please note: this endpoint is coming soon

Our search-and-match/ endpoint searches, fetches, and evaluates the final matches for a given product.

Responses are a list of validated matches, along with e-commerce page data

Available sites: All major global amazon sites (.com, .co.uk, .de, .fr, .co.jp, .ca, .it, .es, .in, .com.mx, .com.br). Please reach out to add additional sites.

Rate Limiting: Please reach out to increase your rate limit. Starts at 7 requests per minute, but you can have upwards of 10k requests per minute.

/search-and-match

Required Parameters:

  • product: dict. Provide a JSON object of your product with key value pairs such as {'title':'value'}. You must define the product title under the 'title' key. You can specify familiar or unfamiliar keys. Familiar keys such as 'code', 'brand', 'description', and 'price' will be added under their own key value pair. All other key value pairs will be added to the 'description' key value pair. See .

  • site: string. Limit search to a specific domain, such as amazon.com, amazon.ca, amazon.mx, walmart.com, ebay.com, etc.

Optional Parameters:

  • search_sequence: list of strings. Provide the sequence of searches you would like to run, with each item specifying the search depth. Defaults to ['standard', 'standard']. While there is currently only one search depth option, 'standard', you have the option to control how many of searches to run. To use one search, use ['standard']. However, we strongly recommend 2 standard searches for a good outcome, i.e., ['standard', 'standard']. Each search in the sequence is a separate charge.

Request

See playground for code in other formats.

import requests
response = requests.post(
    "https://api.theproductllm.com/search-products",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    json={
        "product": {
            "title":"This is a product title", 
            "description": "this is a product description" #optional
        }
        "site": "amazon.com",
        "search_sequence":["standard","standard"]
    }
)
print(response.json())

Response:

Coming soon.

🔎
guidelines for input data