BuyWhere
← Back to documentation

changelog

Changelog

This page is the developer-facing release history for the BuyWhere API.

Use it to answer four questions quickly:

  • What changed?
  • Is anything breaking?
  • What is deprecated?
  • Do I need to migrate?

The public API is versioned independently from SDK releases. API versions are represented in the URL path, for example /v1/search.

Latest release

v1.0.0

  • Release date: 2026-04-04
  • Status: initial public v1 surface
  • Breaking changes: none, first public release

Added

Product discovery

  • GET /v1/search for full-text product search with filters and pagination
  • GET /v1/search/benchmark for representative query latency benchmarking
  • GET /v1/products for product search and filtered listing
  • GET /v1/products/trending for recently updated products by category
  • GET /v1/categories for category listing with counts

Product detail and comparison

  • GET /v1/products/{product_id} for single-product retrieval
  • GET /v1/products/best-price for cheapest listing discovery
  • GET /v1/products/compare for comparison against similar listings
  • POST /v1/products/compare for batch comparisons
  • POST /v1/products/compare/diff for structured product diffs
  • GET /v1/deals for discounted product discovery

Catalog quality and exports

  • GET /v1/products/export for CSV and JSON exports
  • GET /v1/catalog/health for catalog health metrics
  • GET /v1/catalog/incomplete for incomplete product detection
  • GET /v1/catalog/stats for aggregate catalog statistics

Ingestion and operations

  • POST /v1/ingest/products for batch product ingestion
  • ingestion run tracking endpoints under /v1/ingest/* and /v1/ingestion*
  • click tracking and analytics endpoints under /v1/products/{product_id}/click, /v1/track/*, and /v1/analytics/clicks
  • API key management under /v1/keys
  • admin and system status endpoints under /v1/admin/* and /v1/status*

Developer tooling

  • OpenAPI 3.1 spec in openapi.yaml
  • BuyWhere MCP server for agent integrations
  • Python SDK with LangChain and CrewAI integrations

Changed

  • Search ranking improved to websearch_to_tsquery with ts_rank_cd
  • product diff responses now include price_rank and price_spread_pct
  • ingestion runs now expose richer observability fields such as timestamps and error_message

Deprecations

  • None in v1.0.0

Migration guidance

  • None required for the initial public release

How BuyWhere uses this changelog

Every release entry should include:

  • version
  • release date
  • breaking changes
  • new features
  • deprecations
  • migration guidance when needed

If a release contains no breaking changes, say that explicitly.

Release categories

Breaking changes

Use this section when an integration must change behavior, request shape, response handling, auth flow, or endpoint usage to stay compatible.

Added

Use this section for new endpoints, fields, filters, SDK support, or docs surfaces.

Changed

Use this section for behavior improvements that are not strictly breaking but still matter operationally.

Deprecated

Use this section when a feature is still available now but has a known removal path.

Removed

Use this section only when a previously deprecated feature is actually removed.

Related docs