HomeGuidesAPI ReferenceChangelogDiscussions
HomeLog In
Guides

Update Order Status

Function

To update order status
更新訂單狀態

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:
temp 暫存狀態
pending 處理中
removed 已刪除
confirmed 已確認
completed 已完成
cancelled 已取消
ruby "status": "shipping"
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