---
title: Adi Shipping API versioning and deprecation policy
description: URL versioning, compatibility, Deprecation and Sunset headers, and migration timelines for the Adi Shipping API.
canonical: https://adi-shipping.com/developers/versioning/
last-updated: 2026-10-10
---

# Adi Shipping API versioning and deprecation policy

Adi Shipping versions public API operations in the URL. The current stable base is `/api/v1/`. Additive, backward-compatible fields may be introduced within v1; existing documented meanings are not silently changed.

## Breaking changes

A breaking contract change uses a new major URL such as `/api/v2/`. The existing major version remains available during a published migration period whenever operationally possible.

## Deprecation signals

Deprecated HTTP operations return:

- `Deprecation` using the structured date format defined by RFC 9745.
- `Sunset` using the HTTP-date format defined by RFC 8594 when a retirement date is scheduled.
- `Link` with `rel="successor-version"` for the replacement.
- `Link` with `rel="deprecation"` for this policy.

The compatibility alias `/api/tracking.php` is deprecated from 10 October 2026 and is scheduled to sunset on 1 April 2027. Its successor is `/api/v1/tracking.php`.

## Minimum notice

Adi Shipping aims to publish at least 90 days' notice before retiring a documented stable operation. Security, privacy, carrier, or legal requirements can require a shorter emergency change; if so, the developer guide will describe the reason and available migration path.

## Discovery

- [API discovery document](https://adi-shipping.com/api/)
- [OpenAPI 3.1 specification](https://adi-shipping.com/openapi.json)
- [Developer guide](https://adi-shipping.com/developers/)
- [Typed error model](https://adi-shipping.com/developers/errors/)