API changelog
每個 API 版本列出它帶進來的版本變更與遷移方式。新增端點、欄位、錯誤碼與 enum 值直接出現在所有版本,不列在這裡。各版本的形狀見 API 參考的版本選單。
CLI major ↔ API 版本
每個 CLI major 內建一個 API 版本,--json 的輸出就是那個版本的形狀。
| CLI major | API 版本 |
|---|---|
| 1 | 2026-11-03 |
下一個版本
尚未發布,下一次定名時生效
換梯確認與人工安置的回應不再帶 `backupOrderId`。
遷移:改讀 `orderId`。訂單原地換梯,`backupOrderId` 的值一直等於 `orderId`。
- POST /api/v1/orders/{id}/transfer-departure backupOrderId · removed
- POST /api/v1/orders/{id}/force-place backupOrderId · removed
對帳退款及撥款候選支援獨立保留款,訂單欄位可為 null。
遷移:以 retainedFundId 識別保留款;orderId 僅識別真實預訂。已發布版本僅回傳訂單列。
- GET /api/v1/reconciliation/refund-executions rows.orderId · became_optional
- GET /api/v1/reconciliation/transfers/gateway-payout-candidates orderId · became_optional
- GET /api/v1/reconciliation/transfers/gateway-payout-candidates orderNumber · became_optional
換梯快照的裝備租借單不再帶 `depositBalanceTwd`。裝備押金不再計入訂單應收。
遷移:押金是否還在手上,改讀 `/api/v1/equipment/rentals` 的 `depositCollectedAt` 與 `depositSettledAt`。舊版回應這個欄位一律是 0。
- GET /api/v1/orders/{id} departureChanges.snapshot.equipment.rentals.depositBalanceTwd · removed
- POST /api/v1/orders/{id}/transfer-departure preview.equipment.rentals.depositBalanceTwd · removed
2026-11-03
2026-11-03 定名
基準版本:導入 API 版本時的形狀。