OpenAPI Specification

Interactive API documentation powered by Swagger UI.

BuyWhere Catalog API v1

openapi: ../openapi.yaml

Overview

The BuyWhere API follows the OpenAPI 3.1.0 specification. Use the interactive documentation above to:

• Explore all available endpoints
• View request/response schemas
• Test API calls directly from the browser
• Generate code snippets in your preferred language

Authentication

All endpoints (except /health and /v1) require Bearer token authentication:

Authorization: Bearer bw_live_xxxxx

Enter your API key in the Authorize dialog to test authenticated requests.

Try It Out

1. Click on any endpoint in the specification above
2. Click Try it out
3. Enter required parameters
4. Click Execute
5. View the response below

Rate Limits

Remember that rate limits apply:

• Search/Products: 1,000 requests/minute (Premium)
• Ingestion: 100 requests/minute

Check the X-RateLimit-* headers in responses to monitor your usage.