Migrate from 2026-01 to 2026-07
The following guide will help you migrate the API and webhook from version 2026-01 to version 2026-07.
1. General API Changes
1.1 Endpoint Change
What's the difference?
| Change | Before | After |
|---|---|---|
| Base URL | https://api.aftership.com/returns/2026-01 | https://api.aftership.com/returns/2026-07 |
| as-api-version response header value | 2026-01 | 2026-07 |
| as-webhook-version request header value | 2026-01 | 2026-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/returns/2026-01 to https://api.aftership.com/returns/2026-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. Return Model New Fields Added
| new fields | description |
|---|---|
| return_items[*].green_return | The green_return field is a boolean value indicating whether this return item is marked as a green return item. When true, no physical return is required for this item. |
| shipments[*].invoice_url | The invoice_url field is a nullable string containing the URL for the invoice associated with the shipment. |
What do I need to do?
Simply parse the new fields in the API response and the webhook body to fetch the data. Otherwise, no action is required.
3. Returns Endpoints Common Changes
3.1 New fields added in return
Please refer to the Return Model New Fields Added section of the guide.
4. Webhook Changes
4.1 New fields added in return
Please refer to the Return Model New Fields Added section of the guide.