New Shopee's Openapi Announcement (ID: 1443)
Dear Developers
Please find below the OpenAPI updates released this time. These changes aim to enhance functionality, improve flexibility, and provide better integration support.
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_performancev2.account_health.get_metric_source_detail
**Effective Date:**2026.06.26
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
@junie-agent Please review the API changes described above. Focus ONLY on major updates such as adding new endpoints or removing/taking legacy APIs offline. You can safely ignore any other changes regarding request/response parameters or fields. Update the PHP code and create a new PR for review.
New Shopee's Openapi Announcement (ID: 1443)
Dear Developers
Please find below the OpenAPI updates released this time. These changes aim to enhance functionality, improve flexibility, and provide better integration support.
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:
The new metrics will be returned in metric_list. Field descriptions are as follows:
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:
When metric_id = 2035, the API will return:
Order detail fields are as follows:
**Affected APIs:**v2.account_health.get_shop_performancev2.account_health.get_metric_source_detail
**Effective Date:**2026.06.26
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.
**Affected API:**v2.order.get_estimate_cancel_value
**Effective Date:**Lived
@junie-agent Please review the API changes described above. Focus ONLY on major updates such as adding new endpoints or removing/taking legacy APIs offline. You can safely ignore any other changes regarding request/response parameters or fields. Update the PHP code and create a new PR for review.