Significant OpenAPI Updates of Payment and 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.

1. [CBVN] Payment APIs Add VN Corporate Seller Withholding CIT Field

Background

Starting from July 1, 2026, Shopee CB is required to withhold Corporate Income Tax (CIT) for VN Corporate Sellers. Previously, Corporate Sellers were exempted from this withholding tax. After this adjustment, all sellers will be subject to the corresponding withholding tax based on seller type.

Corporate Sellers will be subject to withholding_cit_tax, while Business Households and Individuals will continue to be subject to withholding_pit_tax.

Applicable Scope

VN CB Corporate Sellers

Update Details

v2.payment.get_escrow_detail / v2.payment.get_escrow_detail_batch will add the following response field to display the Withholding CIT amount for Corporate Seller orders.

Note:

• For Corporate Sellers, the APIs will return withholding_cit_tax.
• For other business types, the APIs will continue to return withholding_pit_tax.

Please adjust your Payment API parsing, order income calculation, and financial reconciliation logic based on the new field to correctly identify the Withholding CIT amount for VN CB Corporate Sellers.

Related APIs

v2.payment.get_escrow_detail

v2.payment.get_escrow_detail_batch

Effective Date

Lived

2. [BR] Open API Buyer Information Display Rule Update for FBS Orders

To help sellers in Brazil better handle FBS order fulfillment and return/refund scenarios, Shopee Open API will update the buyer information display rules for BR FBS orders.

After this update, for BR FBS orders in READY_TO_SHIP status or under return/refund processing, Open API will return buyer information according to the same rules as BR non-FBS orders, including the buyer's name, CPF, and full recipient address information.

Notes:

• This update only applies to BR FBS orders in READY_TO_SHIP status or under return/refund processing.
• The display rules for BR non-FBS orders remain unchanged.
• The display rules for non-BR orders remain unchanged.
• The display rules for other order statuses, such as shipping, completed, and cancelled, remain unchanged.
• This update will still comply with the platform's global buyer information masking rules and related permission controls.

Affected APIs:

v2.order.get_order_detail

v2.order.get_package_detail

Effective Date:

Lived

3. Partial Fulfillment / Partial Cancellation Capability Rollout Update

To help sellers continue fulfilling orders when some items are out of stock, Shopee Open API now supports the partial cancellation capability. Eligible sellers can cancel only the out-of-stock items in an order through Open API and continue shipping the remaining items.

This feature will be gradually rolled out by site, seller scope, and logistics channel. The current rollout progress is as follows:

尊敬的开发者

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

1. [CBVN] Payment 接口新增 VN Corporate Seller Withholding CIT 字段

背景

自2026年7月1日起, Shopee CB 需针对 VN 企业型卖家代扣企业所得税(Corporate Income Tax, CIT)。此前,企业型卖家无需缴纳该预扣税;本次调整后,所有卖家均需根据卖家类型缴纳对应的预扣税。

其中,Corporate Sellers 将适用 withholding_cit_tax; Business Households 和 Individuals 将继续适用 withholding_pit_tax。

适用范围

VN CB Corporate Sellers

更新内容

v2.payment.get_escrow_detail / v2.payment.get_escrow_detail_batch 将新增以下 response 字段,用于展示企业型卖家订单对应的 Withholding CIT 金额。

Note:

• 对于 Corporate Sellers, 接口将返回 withholding_cit_tax。
• 对于其他 business type, 接口将继续返回 withholding_pit_tax。

请开发者根据新增字段调整 Payment 接口解析、订单收入计算及财务对账逻辑,以正确识别 VN CB 企业型卖家的预扣企业所得税金额。

相关接口

v2.payment.get_escrow_detail

v2.payment.get_escrow_detail_batch

生效日期

Lived

2. [BR] FBS 订单 Open API 买家信息展示规则更新

为帮助巴西站点卖家更好地处理 FBS 订单履约及退货退款场景, Shopee Open API 将更新 BR FBS 订单的买家信息展示规则。

更新后,对于处于 READY_TO_SHIP 或退货退款处理中的 BR FBS 订单, Open API 将按照与 BR 非 FBS 订单一致的规则返回买家信息,包括买家姓名、CPF 及完整收件地址信息。

注意事项:

• 本次更新仅适用于 BR FBS 订单在 READY_TO_SHIP 或退货退款处理中的场景。
• BR 非 FBS 订单展示规则保持不变。
• 非 BR 订单展示规则保持不变。
• 其他订单状态,例如运输中、已完成、已取消等,展示规则保持不变。
• 该更新仍会遵循平台全局买家信息脱敏规则及相关权限控制。

影响 API:

v2.order.get_order_detail

v2.order.get_package_detail

上线时间:

已上线

为帮助卖家在部分商品缺货时继续履约订单, Shopee Open API 已支持部分取消能力。符合条件的卖家可通过 Open API 仅取消订单中的缺货商品,并继续发货其余商品。

本功能将按站点、卖家范围及物流渠道逐步开放。当前开放进度如下: