Order Deliveries

Update Order Delivery

Changed on

To update a specific order delivery with its ID<br>使用訂單ID配送更新特定一筆訂單配送的資料

put/order_deliveries/{id}

Request

  • Base URL
    https://open.shopline.io/v1
  • URL
    https://open.shopline.io/v1/order_deliveries/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

Order Delivery ID<br>訂單配送ID

Request body

remarkstring

Delivery remark<br>出貨備註 Up to 255 words.<br>最多只能填寫255個字。

statusstring

Order delivery status<br>訂單送貨狀態 Order delivery Status only allows<br>訂單送貨狀態只可以填入 pending 備貨中<br> shipping 發貨中<br> shipped 已發貨<br> arrived 已到達<br> collected 已取貨<br> returned 已退貨<br> returning 退貨中

Example request

{
  "remark": "Please check the package before receiving it.",
  "status": "pending"
}

Response

OK

idstring

Order Delivery ID<br>訂單配送ID

delivery_option_idstring

Delivery Option ID<br>送貨方式ID

platformstring

Delivery platform<br>送貨方式類別

status'pending' | 'shipping' | 'shipped' | 'arrived' | 'collected' | 'returned' | 'returning'

Delivery Status<br>送貨狀態<br><br> Status allows:<br> pending 備貨中<br> shipping 發貨中<br> shipped 已發貨<br> arrived 已到達<br> collected 已取貨<br> returned 已退貨<br> * returning 退貨中

delivery_status'arrived' | 'collected' | 'expired' | 'failed' | 'pending' | 'request_accepted' | 'request_authorized' | 'request_submitted' | 'returned' | 'returning' | 'returning_store_closed' | 'shipped' | 'store_closed'

Logistic Service Order Status<br>配送狀態<br><br> Status allows:<br> arrived 已到達<br> collected 已取貨<br> expired 已過出貨期限<br> failed 失敗<br> pending 未執行<br> request_accepted 可供出貨<br> request_authorized 待處理<br> request_submitted 處理中<br> returned 已退貨<br> returning 退貨中<br> returning_store_closed 退貨門市關轉<br> shipped 已出貨<br> * store_closed 門市關閉

shipped_atstring

Shipped Time<br>已送貨時間<br>(UTC +0)

arrived_atstring

Arrived Time<br>已到達時間<br>(UTC +0)

collected_atstring

Collected Time<br>已取貨時間<br>(UTC +0)

returned_atstring

Returned Time<br>已退貨時間<br>(UTC +0)

updated_atstring

Updated Time<br>更新時間<br>(UTC +0)

remarkstring

Order remark<br>訂單出貨備註

request_accepted_atstring

Logistic accepted shipment time<br>物流商收到出貨時間

request_authorized_atstring

Logistic authorized shipment time<br>物流商接受出貨時間

request_submitted_atstring

Logistic proceeded shipment time<br>物流商處理出貨時間

requested_fmt_atstring

Shipment execution time (Family Mart)<br>執行出貨時間 (全家)

return_order_idstring

Return order ID<br>退貨訂單編號

store_closed_atstring

Pick up store closed time<br>訂單取貨門市關轉時間

require_expired_uploadboolean

Check if delivery needs reupload and schedule aggregation upload

require_storeclosed_uploadboolean

whether scheduled upload to 7-11 B2C FTP, SUP

storeclosed_upload_atstring

prevent duplicated update storeclosed (EIN.36) for 7-11 B2C

exp_typestring

exp type

requires_customer_addressboolean

Whether the customer address is required<br>是否需要顧客提供地址

Example response

{
  "id": "610b567643cee45b793faf53",
  "delivery_option_id": "5de88e17aa84ce6c4ad4e255",
  "platform": "custom",
  "name_translations": {
    "zh-hant": "面交取貨"
  },
  "total": {
    "cents": 0,
    "currency_symbol": "NT$",
    "currency_iso": "TWD",
    "label": "",
    "dollars": 0
  },
  "shipped_at": "2019-04-23T04:36:25.230+00:00",
  "arrived_at": "2019-04-23T04:36:33.524+00:00",
  "collected_at": "2019-04-23T04:36:41.623+00:00",
  "returned_at": "2019-04-23T04:36:50.505+00:00",
  "updated_at": "2019-04-23T04:36:50.505+00:00",
  "remark": "pack it carefully",
  "request_accepted_at": "2019-09-26T09:56:16.803+00:00",
  "request_authorized_at": "2019-09-26T09:56:16.803+00:00",
  "request_submitted_at": "2019-09-26T09:56:16.803+00:00",
  "requested_fmt_at": "2019-09-26T09:56:16.803+00:00",
  "return_order_id": "5cc17da1e388091b6fd299ed",
  "store_closed_at": "2019-09-26T09:56:16.803+00:00",
  "exp_type": "Janio_ND",
  "requires_customer_address": true
}

Changes