Nothing is currently deprecated.
When an endpoint or tool enters deprecation, it will be listed on this page with a sunset date and a migration guide.
Deprecation timeline
When FreightUtils deprecates an endpoint, tool, or response field, you get a minimum of three months between the deprecation notice and the sunset date. That window covers a typical release cycle for most integrators.
For endpoints with high integration count (measured by unique API keys hitting them in the last 90 days), the window extends to six months.
Deprecation signals
A deprecated endpoint emits four signals you can watch for:
- Response headers on every call —
Deprecation: true(per RFC 8594) andSunset: <IMF-fixdate>with the removal date. If you're hitting the endpoint programmatically, log these headers and alert on them. - Changelog entry tagged
API Changeon /changelog (also in the RSS feed at /changelog.xml). - This page lists the endpoint with its deprecation date, sunset date, recommended replacement, and a migration guide link.
- Email notice to holders of any API key that has called the affected endpoint in the last 90 days. Sent once on deprecation announcement, once 30 days before sunset, once 7 days before sunset.
Migration guides
Every deprecated endpoint ships with a migration guide linked from this page before the deprecation date. The guide covers:
- What's replacing it (recommended target endpoint or pattern)
- Before/after request + response examples
- Field-level mapping (old name → new name, type changes)
- Any behavioural differences that aren't apparent from the schema
- Known edge cases surfaced during migration
Currently deprecated endpoints
Out-of-policy changes
Two situations justify a shorter window than 3 months:
- Security fix — a vulnerability or data-integrity issue that cannot be patched without changing behaviour. Fix ships as soon as ready; changelog tagged
Security, affected key holders notified within 24 hours. - Upstream retraction — a regulatory body (UNECE, WCO, HMRC, etc.) withdraws or corrects source data. Affected endpoints continue to serve but return corrected data; a changelog entry notes the change.
Related policies
- Versioning policy — what counts as breaking, how the MCP package is semver'd, tool stability tiers.
- Changelog — every released change, including deprecations.
- Roadmap — what's coming (and by implication, what current things it may replace).
Questions about a planned deprecation or migration? Email contact@freightutils.com.