Stable integration policy

Adi Shipping API versioning and deprecation

Major versions are explicit in the URL and retire only with machine-readable notice.

Versioning

The current stable base is /api/v1/. Additive compatible fields can be introduced within v1. Breaking changes use a new major path such as /api/v2/.

Deprecation and sunset

Deprecated operations return the RFC 9745 Deprecation header, the RFC 8594 Sunset header when retirement is scheduled, and links to the successor and this policy.

The compatibility alias /api/tracking.php is deprecated from 10 October 2026, sunsets on 1 April 2027, and is replaced by /api/v1/tracking.php.

Notice period

Adi Shipping aims to give at least 90 days' notice before retiring a documented stable operation. Emergency security, privacy, carrier, or legal changes may require a shorter timeline with a documented migration path.