Policy
The policies below apply from the General Availability release onward.
Backward Compatibility
As the API continues to evolve, some specifications for the same API may change.
A typical case might be the addition of an enumeration value. The impact of these changes will be different for different users, and in some cases, you may want to reproduce bugs as well as common behavior.
As a result, Delivery Tracker provides API Version Request Headers to ensure backward compatibility and reduce the impact of API changes on users.
If not otherwise defined, the latest-stable is assumed to be the version.
trackql-api-version: latest-stable
TrackQL is the codename for the Delivery Tracker Cloud system.
Backward Compatibility coverage depends on the Service Plan you are on, and only the latest-stable is available during preview periods prior to the General Availability release.
[TBA - please contact contact@tracker.delivery for more information].
There may be specifications that are defined in existing API specifications that are not being used. This may be used in the future, so keep this in mind when implementing. (e.g., TrackStatusCode.UNKNOWN is rarely used, but backwards compatibility difficulties exist if the implementation is missing)
Deprecated APIs
For APIs that are scheduled to be deprecated, the general rule of thumb is to remove them one year after the announcement. This timing may change with advance notice based on service reliability, usage, etc.
Experimental API
Experimental APIs may be modified/added/deleted at any time without notice, independent of the above policy.