来自 Shopee 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Significant OpenAPI Updates of Account Health, Order
Dear Developers
Please find below the OpenAPI updates released this time. These changes aim to enhance functionality, improve flexibility, and provide better integration support.
§2 1. [BR] Account Health API Adds On-time Delivery Rate (OTDR) Metrics
1. [BR] Account Health API Adds On-time Delivery Rate (OTDR) Metrics
To help sellers in Brazil better understand the delivery performance of their seller-fulfilled logistics channels, Shopee Open Platform will add On-time Delivery Rate (OTDR) metric information to Account Health APIs.
After this update, sellers can query OTDR performance for Seller Logistic and Direct Delivery channels, as well as related affected order details, through Open ΑΡΙ.
The detailed updates are as follows:
v2.account_health.get_shop_performance will add the following fulfillment performance metrics:
| Metric ID | Metric Name | Description |
|---|---|---|
| 2034 | on_time_delivery_rate_seller_logistic | On-time delivery rate for the Seller Logistic channel. |
| 2035 | on_time_delivery_rate_direct_delivery | On-time delivery rate for the Direct Delivery channel. |
The new metrics will be returned in metric_list. Field descriptions are as follows:
| Field | Type | Description |
|---|---|---|
| metric_type | int32 | Metric type. OTDR metrics return 1, indicating Fulfillment Performance. |
| metric id | int64 | Metric ID. Seller Logistic returns 2034, and Direct Delivery returns 2035. |
| unit | int32 | Metric unit. OTDR metrics return 2, indicating Percentage. |
| >>target>>comparator | string | Metric target comparator. OTDR metrics return >=. |
v2.account health.get metric_source_ detail will support returning affected order details related to OTDR metrics.
When metric_id = 2034, the API will return:
| Field | Type | Description |
|---|---|---|
| otdr_sl_order_list | object[] | List of affected orders related to OTDR for the Seller Logistic channel. |
When metric_id = 2035, the API will return:
| Field | Type | Description |
|---|---|---|
| otdr_dd_order_list | object[] | List of affected orders related to OTDR for the Direct Delivery channel. |
Order detail fields are as follows:
| Field | Type | Description |
|---|---|---|
| order_sn | string | Shopee order number. |
| item_id | int64 | Item ID. |
| paid_time | timestamp | Order payment time. |
| estimated_delivery_date | timestamp | Estimated delivery date. |
| actual_pick_up_time | timestamp | Actual pickup time. |
| real_delivery_time | timestamp | Actual delivery time. |
| difference_between_edd_rdt | float | Difference in days between the estimated delivery date and the actual delivery date. |
Affected APIs:
v2.account_health.get_shop_performance
v2.account_health.get_metric_source_detail
Effective Date:
2026.06.26
§3 2. Partial Cancellation Estimated Amount Field Format Update
2. Partial Cancellation Estimated Amount Field Format Update
To improve the usability of amount fields in partial order cancellation scenarios, Shopee Open API will update the return format of the estimated cancellation amount in the v2.order.get_estimate_cancel_value ΑΡΙ.
After this update, the API will return the estimated cancellation amount after currency conversion, allowing sellers to confirm the estimated amount before submitting a partial cancellation request.
The detailed update is as follows:
The cancel_value_price field in v2.order.get_estimate_cancel_value will return the converted amount value.
| Field Name | Type | Description |
|---|---|---|
| cancel_value_price | string | The estimated cancellation amount of the selected partially cancelled items. The amount will be returned in the converted format. |
Affected API:
v2.order.get_estimate_cancel_value
Effective Date:
Lived
尊敬的开发者
请查收本次的 OpenAPI 功能更新。这些改动旨在提升功能灵活性、优化使用体验,并为集成提供更好的支持。
§4 1. [BR] Account Health API 新增准时配送率(OTDR)指标
1. [BR] Account Health API 新增准时配送率(OTDR)指标
为帮助巴西站点卖家更好地了解自履约物流渠道的配送表现,Shopee Open Platform 将在 Account Health 相关 API 中新增准时配送率(On-time Delivery Rate, OTDR)指标信息。
更新后,卖家可通过 Open API 查询 Seller Logistic 和 Direct Delivery 渠道的 OTDR 表现,以及相关受影响订单明细。
具体更新如下:
- v2.account_health.get_shop_performance 将新增以下履约表现指标:
| Metric ID | Metric Name | Description |
|---|---|---|
| 2034 | on_time_delivery_rate_seller_logistic | Seller Logistic 渠道的准时配送率。 |
| 2035 | on_time_delivery_rate_direct_delivery | Direct Delivery 渠道的准时配送率。 |
新增指标将返回在 metric_list 中,字段说明如下:
| Field | Type | Description |
|---|---|---|
| metric_type | int32 | 指标类型。OTDR 指标返回 1, 表示 Fulfillment Performance。 |
| metric id | int64 | 指标 ID。Seller Logistic 返回 2034, Direct Delivery 返回 2035。 |
| unit | int32 | 指标单位。OTDR 指标返回 2, 表示 Percentage。 |
| >>target>>comparator | string | 指标目标比较符。OTDR 指标返回 >=。 |
- v2.account_health.get_metric_source_detail 将支持返回 OTDR 指标相关的受影响订单明细。
当 metric_id = 2034 时,接口将返回:
| Field | Type | Description |
|---|---|---|
| otdr_sl_order_list | object[] | Seller Logistic 渠道 OTDR 相关受影响订单列表。 |
当 metric_id = 2035 时,接口将返回:
| Field | Type | Description |
|---|---|---|
| otdr_dd_order_list | object[] | Direct Delivery 渠道 OTDR 相关受影响订单列表。 |
订单明细字段如下:
| Field | Type | Description |
|---|---|---|
| order_sn | string | Shopee 订单编号。 |
| item_id | int64 | 商品 ID。 |
| paid_time | timestamp | 订单支付时间。 |
| estimated_delivery_date | timestamp | 预计送达日期。 |
| actual_pick_up_time | timestamp | 实际揽收时间。 |
| real_delivery_time | timestamp | 实际送达时间。 |
| difference_between_edd_rdt | float | 预计送达日期与实际送达日期之间的天数差异。 |
影响 API :
v2.account_health.get_shop_performance
v2.account_health.get_metric_source_detail
上线时间:
2026.06.26
§5 2. 部分取消预估金额字段格式更新
2. 部分取消预估金额字段格式更新
为提升部分取消订单场景下金额字段的易用性, Shopee Open API 将更新 v2/order/get_estimate_cancel_value 接口中预估取消金额的返回格式。
更新后,接口将返回已完成币种换算后的预估取消金额,方便卖家在提交部分取消请求前确认预计取消金额。
具体更新如下:
v2.order.get_estimate_cancel_value接口中的 cancel_value_price 字段将返回转换后的金额值。
| Field Name | Type | Description |
|---|---|---|
| cancel_value_price | string | 所选部分取消商品的预估取消金额。该金额将以转换后的格式返回。 |
影响 API :
v2.order.get_estimate_cancel_value
上线时间:
已上线