Migration from 2025-04 API & Webhook to 2025-07
Important Update: Changes to Our API Versioning Schedule
Starting from version 2025-07, we’re adjusting our API version release cadence to enhance stability and quality. New major versions of our API will now be released once every six months (twice yearly), replacing our previous quarterly schedule
The following guide will help you migrate the API and webhook from version 2025-04 to version 2025-07.
1. General API Changes
1.1 Endpoint Change
What's the difference?
| Change | Before | After |
|---|---|---|
| Base URL | https://api.aftership.com/tracking/2025-04 | https://api.aftership.com/tracking/2025-07 |
as-api-version response header value | 2025-04 | 2025-07 |
as-webhook-version request header value | 2025-04 | 2025-07 |
What do I need to do?
Make the following updates to your application's code:
- Replace the base URL from https://api.aftership.com/tracking/2025-04 to https://api.aftership.com/tracking/2025-07.
- When editing existing URLs or adding new ones, select the Webhook version. Please review your webhook settings for verification.
- Parse the header to distinguish between different versions. Otherwise, no action is required.
2. New SDK Added
3. Webhook Changes
3.1 Fields updated in tracking
3.1.1 the default value of custom_fields changed
custom_fields changedWhat's the difference?
| Change | Before | After |
|---|---|---|
|
The default value of |
|
|
What do I need to do?
Parse the null value of custom_fields in the webhook if you are using this field. Otherwise, no action is required.
4. What if I don’t migrate?
After April 13, 2028, any requests made to the 2025-04 version will be automatically redirected to version 2025-07. While this redirection aims to minimize disruptions, it may not fully support all functionalities available in the newer versions. We encourage you to complete the migration at your earliest convenience.