Update Order Delivery Status

❗️

Notice

Only allows orders without third-party delivery integration.
僅適用於非串接第三方物流之訂單

Function

To update order's delivery status
更新訂單運送狀態

📘

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

  • 訂單狀態已完成,不可更新運送狀態。

URL

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

Request Parameters

Parameter

Type

Description

Example

id *Required

String

Order's ID
訂單ID

ruby
59e97965e388095314000010

status
*Required

String

Order Delivery's status
訂單運送狀態

  • Delivery status allows
    • pending 備貨中
    • shipping 發貨中
    • shipped 已發貨
    • arrived 已到達
    • collected 已取貨
      returned 已退回 (2023/11/22 之前為已退貨)
      returning 退回中 (2023/11/22 之前為退貨中 )
ruby
"status": "arrived"

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 Delivery's status
訂單運送狀態

arrived

updated_at

DateTime

Order Last Updated Time
訂單最後更新時間

2018-05-17T11:38:56.473+08:00

Response Example

{
    "order_id": "59e97965e388095314000010",
    "status": "arrived",
    "updated_at": "2018-05-17T11:38:56.473+08:00"
}