Changelog
This page contains the changelog of the current API version. For the past changelog, please refer to this page.
2024-10 (2024-10-10)
1. General
| CHANGE | BEFORE | AFTER |
|---|---|---|
| Base URL | https://api.aftership.com/commerce/2024-07 | https://api.aftership.com/commerce/2024-10 |
2. Order Resource Changes
2.1 New Fields
order.status_timestamps
The status_timestamps field enables you to record the exact timestamp when an order status occurs, such as when the order is canceled or placed.
When order.status is set to canceled, the timestamp recorded in order.status_timestamps.canceled_at will be displayed on the history route of the branded tracking page, indicating the time when the order was canceled.
For detailed information about the model, please refer to the full specifications.
order.custom_fields
The new custom_fields feature allows you to store limited metadata for orders using your preferred key-value pairs. This functionality provides greater control over the notification workflow, enabling you to use custom fields as triggers to determine specific branches of the notification flow.
2.2 Create an Order (POST /orders)
New Request Fields
- order.status_timestamps
- order.custom_fields
Response
See Order Resource changes.
2.3 Update an Order (PATCH /orders/{id})
New Request Fields
- order.status_timestamps
- order.custom_fields
Response
See Order Resource changes.
2.4 List Orders (GET /orders)
Response
See Order Resource changes.
2.5 Get an Order (GET /orders/{id})
Response
See Order Resource changes.