跳至内容
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 是订单总额。付款状态不能确定已付、已退款或待付金额。

指南

导出订单