HomeGuidesAPI ReferenceChangelogDiscussions
HomeLog In
Guides

Update Order Status

Function

To update order status
更新訂單狀態

📘

After return_order_revamp feature key on/啟用「return_order_revamp」功能後

  • 送貨狀態為已發貨/已到達/已取貨,不可更新訂單狀態為已取消。
  • 此訂單下任一筆新退貨單狀態為非取消,不可更新訂單狀態為已取消。
  • 訂單狀態為已完成,不可修改訂單狀態。

URL

PATCH <<api_domain>>/v1/orders/:id/status

Request Parameters

ParameterTypeDescriptionExample
id
*Required
StringOrder's ID
訂單ID
ruby 5d8c8b3be388095d25acbc89
status
*Required
StringOrder's Status
訂單狀態
-
Status allows:
pending 處理中
confirmed 已確認
completed 已完成
cancelled 已取消 (Note: 如果希望取消訂單同時自動回補點數或購物金,請使用 Cancel Order)
ruby "status": "completed"
mail_notifyBooleanDo you want to notify the customer via email with the change?
此更新是否要以email通知顧客?
(Default: false)
ruby "mail_notify":true

Response Field

The same as Get Order

Response Example

The same as Get Order