Significant OpenAPI Updates of Account Health, Payment

Dear Developers

Please find below the OpenAPI updates released this time. These changes aim to enhance functionality, improve flexibility, and provide better integration support.

To alleviate logistical pressure caused by Monday's peak pickup period, shorten buyer waiting times, and improve seller fulfillment efficiency and buyer shopping experience, Shopee encourages Preferred Sellers to offer Saturday shipping services and has added a new "Saturday Shipment" metric as an important evaluation item for Preferred Seller onboarding/exit.

Meanwhile, the BR marketplace has added a "Preparation Time PS" metric for Preferred Sellers to showcase their inventory preparation time performance; other marketplaces continue to use the existing "Preparation Time" metric.

To support open platform sellers in obtaining performance data and order details for the above metrics, the v2.account_health.get_shop_performance and v2.account_health.get_metric_source_detail interfaces have been updated as follows:

1. The response parameter metric_id forv2.account_health.get_shop_performance has been updated to include 2032: Saturday Shipment and 2033: Preparation Time PS, allowing users to retrieve the performance information for the corresponding metrics.

2. The request parameter for v2.account_health.get_metric_source_detail has been added metric_id: 2032: Saturday Shipment and 2033: Preparation Time PS. And for 2032: Saturday Shipment, add a new response parameter: saturday_shipment_list to retrieve order details for shipments made on Saturdays. For 2033: Preparation Time PS metric will retain the original response parameter: apt_order_list.

Related APIs：

v2.account_health.get_shop_performance

v2.account_health.get_metric_source_detail

Effective Date on Live：

2026.02.06

To further optimize sellers’ ad fund management experience and ensure the continuity of ad campaigns, Shopee will upgrade the Ads Balance Auto Top-up mechanism.

Under the upgraded mechanism, once an order is completed and settled, the system will automatically top up the seller’s Ads Balance based on the settled amount. This helps sellers maintain more stable ad campaigns and reduces interruptions caused by insufficient ad balance.

Based on this mechanism, starting from February 2, 2026 (BJT), Shopee will collect a fee in certain regions (SG, MY, TH, VN, PH, ID). This fee is a standard platform fee, automatically calculated upon order completion, and, where applicable, any related taxes will be added. The total amount will be deducted from the seller’s sales proceeds.

To ensure consistency in fee display, a new field ads_escrow_top_up_fee_or_technical_support_fee will be added to v2.payment.get_escrow_detail and v2.payment.get_escrow_detail_batch APIs. This field will synchronize the information displayed in the Seller Center under “Ads Escrow Top Up Fee” “technical_support_fee” or “Traffic Growth Fee”.

Applicable Regions

SG, MY, TH, VN, PH, ID

Affected API:

• v2.payment.get_escrow_detail
• v2.payment.get_escrow_detail_batch

New Field in Response: ads_escrow_top_up_fee_or_technical_support_fee（Includes Ads Escrow Top-Up Fee/Technical Support Fee/Traffic Growth Fee.）

*Note:

When a buyer cancels an order, requests a refund, or returns an item, the calculation rules for the corresponding fees are as follows:

• Before order completion: If cancellation/refund/return occurs, the platform will charge fees proportionally based on the actual completed product amount in the order; if there are no completed products in the order, no fees will be charged.
• After order completion: If cancellation/refund/return occurs, the platform will charge the standard fees, and fees will not be refunded.

Effective Date

2026/02/02

3.[Only for BR]Payment API Update：New "discount_pix" field

PIX is Brazil’s instant payment system launched by the Central Bank of Brazil in 2020. It allows individuals and businesses to transfer money instantly, 24/7, without the need for credit cards or bank slips.

To enhance competitiveness and provide a consistent shopping experience, Shopee now supports displaying PIX discounts throughout the User Journey. A new field discount_pix has been added to payment-related APIs.

Applicable Market: BR

APIs Affected:

v2.payment.get_escrow_detail

v2.payment.get_escrow_detail_batch

Effective Date

2026/02/06

尊敬的开发者

请查收本次的 OpenAPI 功能更新。这些改动旨在提升功能灵活性、优化使用体验，并为集成提供更好的支持。

1. [针对BR, TH, PH] 新增 “Saturday Shipment” & “Preparation Time PS” 指标

为缓解周一揽件高峰带来的物流压力，缩短买家等待时间，提升卖家履约效率与买家购物体验，Shopee 鼓励优选卖家 (Preferred Seller) 提供周六发货服务，并新增 “Saturday Shipment” 指标，作为优选卖家准入 / 退出的重要评估项。

同时，BR 市场为优选卖家新增 “Preparation Time PS” 指标，用于展示优选卖家的备货时长表现；其他市场仍沿用现有的 “Preparation Time” 指标。

为支持开放平台卖家获取上述指标的表现数据与订单详情，v2.account_health.get_shop_performance 与 v2.account_health.get_metric_source_detail 接口更新如下：

1. v2.account_health.get_shop_performance 的响应参数 metric_id 增加 2032：Saturday Shipment 和 2033：Preparation Time PS 选项，支持获取对应指标的表现数据。

2. v2.account_health.get_metric_source_detail 的请求参数 metric_id 增加 2032：Saturday Shipment 和 2033：Preparation Time PS 选项。同时，针对 2032：Saturday Shipment 指标，新增 saturday_shipment_list 响应参数，用于获取该指标对应的订单明细。针对 2033：Preparation Time PS 指标，将沿用现有的 apt_order_list 响应参数。

影响接口：

v2.account_health.get_shop_performance

v2.account_health.get_metric_source_detail

上线时间：

2026.02.06

为进一步优化卖家广告资金管理体验，并保障广告投放的连续性，Shopee 将升级广告余额自动充值机制。

在升级后的机制下，系统将在订单完成并结算后，根据结算金额为卖家的广告余额进行自动充值，帮助卖家更稳定地进行广告投放，减少因余额不足带来的投放中断。

基于上述机制，自 北京时间 2026 年 2 月 2 日起，Shopee 将在部分地区（SG、MY、TH、VN、PH、ID）收取服务费。该费用属于平台标准费用，系统将在订单完成后自动计算，并在适用情况下加收相应税费（如有），统一从卖家的销售额中扣除。

为确保费用信息展示的一致性，在v2.payment.get_escrow_detail 和 v2.payment.get_escrow_detail_batch 将新增响应字段 ads_escrow_top_up_fee_or_technical_support_fee，用于同步卖家中心中展示的 “Ads Escrow Top Up Fee” /“technical_support_fee”/“Traffic Growth Fee”。

适用范围：

SG、MY、TH、VN、PH、ID

影响接口：

• v2.payment.get_escrow_detail
• v2.payment.get_escrow_detail_batch

新增响应字段：ads_escrow_top_up_fee_or_technical_support_fee（包含广告保证金充值费/技术支持费。）

Note*：

当买家发生订单取消、退款或退货时，该字段对应的费用计算规则如下：

• 订单完成前 发生取消 / 退款 / 退货：平台将根据订单实际完成的商品金额按比例收取费用；若订单未产生任何完成商品，则不收取费用。
• 订单完成后 发生取消 / 退款 / 退货：平台将正常收取费用，且费用不予退回。

生效日期

2026/02/02

PIX 是巴西中央银行于 2020 年推出的即时支付系统，可让个人和企业 全天候 24/7 即时转账，无需信用卡或银行汇票。

为了提升竞争力并提供一致的购物体验，Shopee 支持在User Journey显示 PIX 折扣,Payment 相关接口新增 discount_pix字段。

适用范围：BR

影响接口：

v2.payment.get_escrow_detail

v2.payment.get_escrow_detail_batch

生效日期

2026/02/05