Versioning

Versioning helps the API users to smoothen the API upgrade process by providing a predictable new release and version deprecation schedule.

API users can manage their own system upgrade roadmap that fits their needs and no longer need to be bounded by the API version upgrade timeframe.

The API version is specified in the API endpoint URL. For AfterShip Commerce API, the URL would be:

preparing...

The version number follows a date-based format like YYYY-MM. For example, for the order resource in April 2024, the complete URL would be:

preparing...

To discover the exact API version serving your request, check the API response header field named as-api-version.

HEADER NAMEDESCRIPTIONFORMAT
as-api-versionThe actual API version that serves the request.YYYY-MM

2024-04 2024-07  and so on.

Expect a new version of the AfterShip Commerce API every quarter, released on the 2nd Thursday of the 1st month of that quarter. The table below provides the release dates for the next 6 versions:

VERSIONRELEASE DATESUPPORTED UNTIL
2024-042024-04-112025-10-08
2024-072024-07-112026-01-07
2024-102024-10-102026-04-08
2025-012025-01-092026-07-08
2025-042025-04-102026-10-08
2025-072025-07-102027-01-07

Every API version enjoys support for a minimum of approximately 18 months, ensuring that the first version remains supported until the day before the release of the seventh version. This provides developers with a substantial overlap of at least 15 months between two consecutive stable versions, allowing them ample time to complete their API upgrading process.

We strongly recommend updating your integration to the latest API version every quarter in order to use our latest features. If a request is made to an unsupported API version, it will automatically redirect to the oldest supported API version.

For example, if you make a request to the API version 2024-04 after 2025-10-09, the request will be served by the API version 2024-07 (the oldest supported version).

version_schedule.png