Migrate from 2024-10 to 2025-01
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. Order Endpoints
Affected Endpoints (Request and Response Body)
- POST /orders (request_body.items.*.id)
Affected Endpoints (Response Body)
- GET /orders
- GET /orders/{id}
- PATCH /orders/{id}
How to migrate
-
For POST /orders endpoint, rename
items.*.source_idtoitems.*.idin the request body, no action required if this field is not utilized. -
Rename
order.items.*.source_idtoorder.items.*.idfor all response body of order resource endpoints, no action required if this field is not utilized. -
Remove the usage of
order.items.*.fulfillable_quantity, no action required if this field is not utilized. -
Make sure to include
order.items.*.product_titlewhen creating the order.
2. Fulfillment Endpoints
Affected Endpoints (Request and Response Body)
- POST /fulfillments (request_body.line_items.*.id)
Affected Endpoints (Response Body)
- GET /fulfillments
- GET /fulfillments/{id}
- PATCH /fulfillments/{id}
- POST /fulfillments/{id}/update-status
- POST /fulfillments/{id}/ship
How to migrate
-
For POST /fulfillments endpoint, rename
line_items.*.source_idtoline_items.*.idin the request body, no action required if this field is not utilized. -
Rename
fulfillment.line_items.*.source_idtofulfillment.line_items.*.idfor all response body of fulfillment resource endpoints, no action required if this field is not utilized.
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.