BuyWhere API Postman Collection

Importable Postman collection with all BuyWhere Catalog API endpoints, example requests, and environment variables.

Files

• buywhere.postman_collection.json - The Postman collection

Import Instructions

Option 1: Import via Postman App

1. Open Postman
2. Click the Import button (top left)
3. Select Upload Files
4. Choose buywhere.postman_collection.json
5. The collection "BuyWhere Catalog API" will appear in your collections

Option 2: Import via URL

1. Open Postman
2. Click Import
3. Select Link
4. Paste the raw GitHub URL to the JSON file
5. Click Continue

Option 3: Copy/Paste

1. Open the JSON file in a text editor
2. Copy the entire contents
3. In Postman, click Import
4. Select Raw text
5. Paste the JSON content

Environment Setup

1. In Postman, click the gear icon (top right) to manage environments
2. Create a new environment (e.g., "BuyWhere Dev")
3. Add the following variables:

1. Select your environment from the dropdown in the top right

Authentication

All endpoints (except /health and /api/v1/keys/bootstrap) require Bearer token authentication.

The collection is pre-configured to use the {{bw_api_key}} variable with Bearer auth.

To get an API key:

1. Sign up at https://dashboard.buywhere.ai
2. Go to Settings > API Keys
3. Create a new API key
4. Copy it to your Postman environment

Quick Start

1. Health Check: Start with System > Health Check to verify connectivity
2. Search Products: Try Products > Search Products with q=iphone
3. Compare Prices: Use Products > Compare Products to find best deals
4. Get Product: Try Products > Get Product by ID with a known product ID

Collection Structure

BuyWhere Catalog API
├── System
│   ├── API Root
│   ├── Health Check
│   └── Detailed Health
├── Products
│   ├── Search Products
│   ├── Get Product by ID
│   ├── Best Price (Cheapest)
│   ├── Compare Products (Search)
│   ├── Compare Products (Matrix)
│   ├── Compare Products (Diff)
│   ├── Trending Products
│   ├── Random Products
│   ├── Get Similar Products
│   ├── Get Product Matches
│   ├── Get Price History
│   ├── Get Price Stats
│   ├── Get Price Prediction
│   ├── Get Alternatives
│   ├── Get Bundle Suggestions
│   ├── Track Product Click
│   ├── Get Product Reviews
│   ├── Get Product Availability
│   ├── Get Product Stock
│   ├── Get Price Comparison
│   ├── Batch Product Lookup
│   ├── Bulk Lookup by IDs
│   ├── Bulk Lookup by SKU/UPC/URL
│   ├── Get Product by Barcode
│   ├── Export Products
│   ├── Bulk Import Products
│   ├── Bulk Check Availability
│   ├── Check Availability URLs
│   ├── Products Feed (NDJSON)
│   ├── Get Catalog Stats
│   ├── Get Duplicates
│   └── Compare by Product ID
├── Search
│   ├── Search Products
│   ├── Semantic Search
│   ├── Search Suggestions
│   ├── Benchmark Search
│   ├── Search by Image
│   └── Get Search Filters
├── Categories
│   ├── List Categories
│   ├── Get Category Tree
│   ├── Get Taxonomy
│   ├── Get Category by ID
│   └── Get Category Products
├── Deals
│   ├── Get Deals
│   ├── Get Price Drops
│   └── Get Best Deals
├── Trending
│   ├── Get Trending Searches
│   └── Get Trending Clicks
├── Feed
│   ├── Get New Products Feed
│   ├── Get Deals Feed
│   └── Get Changes Feed (SSE)
├── Catalog
│   ├── Catalog Health
│   ├── Catalog Stats
│   └── Incomplete Products
├── Ingestion
│   ├── Ingest Products (Batch)
│   ├── List Ingestion Runs
│   ├── Get Ingestion Run
│   ├── Create Ingestion Run
│   ├── Update Ingestion Run
│   ├── Complete Ingestion Run
│   └── Get Ingestion Stats
├── Status
│   ├── System Health
│   ├── Scraper Status
│   └── Platform Health
├── Brands
│   ├── List Brands
│   └── Get Brand Products
├── Merchants
│   ├── List Merchants
│   └── Get Merchant Analytics
├── Sources
│   └── List Sources
├── Metrics
│   ├── Get Metrics
│   ├── Get Quality Metrics
│   └── Get Platform Metrics
├── Keys
│   ├── Bootstrap First Key
│   ├── List API Keys
│   ├── Create API Key
│   ├── Revoke API Key
│   └── Rotate API Key
├── Developers
│   ├── Developer Signup
│   ├── Get Developer Profile
│   └── Get Developer Usage
├── Alerts
│   ├── List Alerts
│   ├── Create Alert
│   └── Delete Alert
├── Watchlist
│   ├── List Watchlist
│   ├── Add to Watchlist
│   ├── Remove from Watchlist
│   └── Get Watchlist Alerts
├── Saved Searches
│   ├── List Saved Searches
│   ├── Create Saved Search
│   ├── Get Saved Search
│   ├── Update Saved Search
│   ├── Delete Saved Search
│   └── Run Saved Search
├── Affiliate
│   ├── Create Affiliate Link
│   └── Get Affiliate Earnings
├── Billing
│   ├── Create Checkout Session
│   ├── Get Billing Status
│   ├── Upgrade Tier
│   └── List Billing Tiers
├── Webhooks
│   ├── List Webhooks
│   ├── Register Webhook
│   ├── Test Webhook
│   ├── Toggle Webhook
│   └── Delete Webhook
├── Analytics
│   ├── Get Click Analytics
│   └── Get Usage Analytics
├── Admin
│   ├── Get Admin Stats
│   ├── Query API Logs
│   ├── Get Agent Sessions
│   ├── Get Commissions
│   └── Get Revenue Dashboard
├── Enrichment
│   ├── Enrich Batch
│   ├── Preview Product Enrichment
│   ├── Apply Product Enrichment
│   └── Get Enrichment Stats
├── Deduplication
│   ├── Check Duplicates
│   └── Ingest Dedup Check
├── Images
│   ├── Get Image by Hash
│   ├── Get Product Image
│   ├── Register Image
│   └── Get Image Info
├── Changelog
│   └── Get API Changelog
├── Import
│   └── Import CSV
├── Preferences
│   ├── Get Preferences
│   ├── Set Preferences
│   ├── Update Preferences
│   └── Delete Preferences
└── Countries
    └── List Countries

Test Scripts

Some requests include test scripts that validate responses. Run the collection tests to verify API functionality:

1. Select the collection
2. Click Run button
3. Select your environment
4. Click Run BuyWhere Catalog API

Rate Limits

• Free tier: 100 requests/minute
• Pro tier: 1,000 requests/minute
• Enterprise: Custom limits

Check X-RateLimit-* response headers for current limits.

Support

• Documentation: https://docs.buywhere.ai
• Dashboard: https://dashboard.buywhere.ai
• Support: support@buywhere.ai