Update Order Payment Status
Function
To update order's payment status
更新訂單付款狀態
URL
PATCH <<api_domain>>/v1/orders/:id/order_payment_status
Request Parameters
Parameter | Type | Description | Example |
---|---|---|---|
id *Required | String | Order's ID 訂單ID | ruby 59e97965e388095314000010 |
status *Required | String | Order Payment Status 訂單付款狀態 - Payment status allows pending 未付款failed 付款失敗expired 超過付款時間completed 已付款refunding 退款中refunded 已退款 | ruby "status": "completed" |
mail_notify | Boolean | Do you want to notify the customer via email with the change? 此更新是否要以email通知顧客? - Default: false | ruby "mail_notify": true |
Response Field
Field | Type | Description | Example |
---|---|---|---|
order_id | String | Order's ID 訂單ID | 59e97965e388095314000010 |
status | String | Order Payment Status 訂單付款狀態 | completed |
updated_at | DateTime | Order Last Updated Time 訂單最後更新時間 | 2017-10-20T12:19:50.196+08:00 |
Response Example
{
"order_id": "59e97965e388095314000010",
"status": "completed",
"updated_at": "2017-10-20T12:19:50.196+08:00"
}
Updated about 2 months ago