Migrate from 2025-04 to 2025-07
This migration guide outlines the essential changes required to maintain the same functionality when transitioning from the previous API version. It does not cover any new resources or endpoints, and does not cover any relaxed conditional changes that do not involve breaking changes (such as a required field becoming optional).
For comprehensive details on new features, please refer to the Changelog for a complete overview of all API updates.
1. All Endpoints
The Base URL for the API has been updated. You must update the version in the URL path for all your API requests.
- Before: https://api.aftership.com/commerce/2025-04
- After: https://api.aftership.com/commerce/2025-07
2. Fulfillment Endpoints
Affected Endpoints (Request and Response Body)
- POST /fulfillments
- PATCH /fulfillments/{id}
Affected Endpoints (Response Body only)
- GET /fulfillments
- GET /fulfillments/{id}
- POST /fulfillments/{id}/update-status
- POST /fulfillments/{id}/ship
How to migrate
- When creating or update a fulfillment, you need to remove the
ship_to_locationfield from the request body of thePOST /fulfillmentsendpoint. The API will no longer accept this field. - For all listed endpoints, you must update your code to stop reading or expecting the ship_to_location field in the fulfillment response object.
Migrate from legacy API to Versioned API
For all legacy API user (with the API URL https://api.aftership.com/commerce/v1), please visit 2024-04 migration guide for the detail instruction.