B7RDevelopers
PoliciesVersioning and changelog
Policies / Versioning and changelog

Versioning and changelog

View .md

The version is in the path

Every path starts with /v1. A version keeps working the same way for as long as it is offered.

Changes without notice

These are additions, made to v1 at any time. Write your client so they cannot break it:

  • New endpoints, and new optional fields in a request.
  • New fields in an answer: ignore the ones you do not know.
  • New values in a field that lists values (a new delivery_method, a new area): handle an unknown value without failing.
  • New error codes and new codes inside errors: fall back on status and retryable.
  • A different order of fields in JSON.

Breaking changes

Removing or renaming a field, changing its type or meaning, or refusing what was accepted only happens in a new version, /v2. The old version then answers with Deprecation and Sunset headers that give the date it stops: at least six months after its first Deprecation answer, and every account with an active key gets an email when that starts. After that date it answers 410 Gone.

Changelog

DateChange
2026-11-22v1 opens: GET /v1/status, GET /v1/me, GET /v1/catalog/products, GET /v1/catalog/products/{id}, GET /v1/carriers and POST /v1/quote.

Titles and headings of every page. llms-full.txt holds the full text.