Significant OpenAPI Updates of Account Health

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. [Only for TW] Add "% HD Listings" and "% HD Free Shipping Enabled" Metrics

To help sellers better understand the enablement status of Home Delivery related logistics channels across their products, Shopee has added corresponding metrics to the v2.account_health.get_shop_performance and v2.account_health.get_metric_source_detail APIs. Details are as follows:

1. For v2.account_health.get_shop_performance, the metric_id response parameter adds two options: 2030: % HD Listings and 2031: % HD Free Shipping Enabled, allowing sellers to retrieve the performance data for these metrics.

2. For v2.account_health.get_metric_source_detail, the metric_id request parameter adds two options: 2030: % HD Listings and 2031: % HD Free Shipping Enabled. Additionally, add the hd_listing_list response parameter for these two metrics to retrieve the corresponding product details data.

Related APIs:

v2.account_health.get_shop_performance

v2.account_health.get_metric_source_detail

Effective Date on Live:

2025.12.29

開發者您好，

以下說明本次 OpenAPI 的功能更新，此改動旨在提升泛用性、優化使用體驗，並提供更完整的整合功能

為了讓賣家更了解賣場宅配(HD)相關物流選項在各商品的啟用狀況，Shopee 在 v2.account_health.get_shop_performance 和 v2.account_health.get_metric_source_detail API 新增返回對應指標。具體內容如下：

1）v2.account_health.get_shop_performance 的返回參數 metric_id 新增 2030: % HD Listings 與 2031: % HD Free Shipping Enabled 選項，支援獲得對應指標的表現情況。

2）v2.account_health.get_metric_source_detail 的請求參數 metric_id 新增 2030: % HD Listings 與 2031: % HD Free Shipping Enabled 選項，同時，針對上述兩個指標，新增 hd_listing_list 返回參數，用於取得對應商品的細節資訊。

影響API：

v2.account_health.get_shop_performance

v2.account_health.get_metric_source_detail

上線時間：

2025.12.29