跳至內容
ShopentlyLearn

訂單

讀取訂單摘要與詳情,再更新訂單或支付狀態。

操作

GET取得清單 · 狀態清單 — 訂單/api/v1/order-statuses

GET取得清單 — 訂單/api/v1/orders

GET取得 — 訂單/api/v1/orders/{order_id}

PATCH更新 · 付款狀態 — 訂單/api/v1/orders/{order_id}/payment-status

PATCH更新 · 狀態 — 訂單/api/v1/orders/{order_id}/status

工作原理

訂單列表和詳細資料均包含 delivery.dates。YYYY-MM-DD 格式的日期為計畫日期,不代表已出貨。目前日期優先;舊訂單使用已儲存的估計。已清除或未知的值為 null。詳細資料還包含所有訂單項目和商品圖片。

從 /api/v1/order-statuses 取得有效狀態識別碼。訂單狀態和支付狀態使用不同的 PATCH 端點及權限。修改記錄中的支付狀態不會從銀行卡扣款,也不會通過支付服務商發起退款。

delivery.dates: planned_dispatch_on, dispatch_timezone, estimated_delivery_from, estimated_delivery_to. 出貨及預計送達日期: YYYY-MM-DD; null. 出貨時區: IANA.

訂單 · 合計

金額和稅率取自已儲存的訂單,包括訂單項目的更正。缺少的歷史資料為 null,不會用目前商品目錄的稅率補齊。金額始終維持為十進位字串。

  • tax_country_code · 課稅國家 · 已儲存的訂單資料 · ISO 3166-1 alpha-2; null.
  • lines[].unit_* · 單件 · 折扣前; lines[].original_total_* · 折扣前; lines[].total_* · 折扣後.
  • lines[].discount_* · 折扣; manual_discount · 手動折扣; percentage "10" = 10%.
  • delivery.net / tax / gross · 折扣後; delivery.original_* · 折扣前; delivery.discount_* · 折扣.
  • tax_rate: "0.23" = 23%; "0" ≠ null. 未知:null;已知零值:0.
  • totals · 合計; tax_breakdown.groups · 稅務分組; 未分配稅額 = order.tax − Σ groups.tax; ±.

清單傳回摘要。針對每個結果取得 GET /api/v1/orders/{order_id},以匯出完整的金額明細。GET 重試次數有限,並遵循 Retry-After。依建立日期匯出不會同步之後的更正。

payment.amount 是訂單總額。付款狀態無法確定已付、已退款或待付金額。

指南

匯出訂單