来自 Shopee 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Significant OpenAPI Updates of Order and AMS
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. New Affiliate Refundable Sample Order Identifier Field
1. New Affiliate Refundable Sample Order Identifier Field
To support the identification of Affiliate Refundable Sample Orders, Shopee Open API will add a new response field, affiliate_sample_type, to v2.order.get_order_detail.
A Refundable Sample Order refers to an order where a KOL first purchases a sample through the standard Marketplace order flow and receives a refund after meeting the refund criteria set by the seller. This type of order will follow the same fulfillment and logistics process as a normal Marketplace order.
The detailed update is as follows:
| Field Name | Type | Description |
|---|---|---|
| affiliate_sample_type | int | Affiliate sample order type identifier. 1 indicates that the order is a Refundable Sample Order; null indicates that the order is not a Refundable Sample Order. |
Affected API:
v2.order.get_order_detail
Effective Date:
June 18, 2026
§3 2. [BR] AMS APIs Add Seller Service Fee Fields
2. [BR] AMS APIs Add Seller Service Fee Fields
Background
To improve fee transparency and reconciliation accuracy in AMS reports, AMS OpenAPI will add item-level Seller Service Fee relevant information to the conversion report and validation report, helping identify the service fee rate and service fee amount for each item.
Applicable Scope
BR
Update Details
v2.ams.get_conversion_report / v2.ams.get_validation_report will add the following response fields to display Seller Service Fee relevant information at the item level.
| Field | Type | Description |
|---|---|---|
| list > items > seller_service_fee_rate | New Response Field | Seller Service Fee rate applied to the item. |
| list > items > seller_service_fee | New Response Field | Seller Service Fee amount charged for the item. Formula: seller_service_fee = item_brand_commission * seller_service_fee_rate. |
Note:
The new fields will be added for all markets. Currently, Seller Service Fee is only applicable to BR Affiliate operations. For other markets, the new fields will return 0 for now.
Please adjust your AMS report parsing and financial reconciliation logic based on the new fields to correctly identify the intermediary service fee charged by Shopee under BR Affiliate operations.
Related APIs
v2.ams.get_conversion_report
v2.ams.get_validation_report
Effective Date
Live
尊敬的开发者
请查收本次的 OpenAPI 功能更新。这些改动旨在提升功能灵活性、优化使用体验,并为集成提供更好的支持。
§4 1. 新增 Affiliate Refundable Sample Order 标识字段
1. 新增 Affiliate Refundable Sample Order 标识字段
为支持 Affiliate Refundable Sample Order 相关订单识别,Shopee Open API 将在 v2.order.get_order_detail 接口中新增返回字段 affiliate_sample_type。
Refundable Sample Order 是指 KOL 先通过标准 Marketplace 下单流程购买样品,并在达成卖家设定的返款条件后获得退款的订单。该类订单将使用普通 Marketplace 订单的履约及物流流程处理。
具体更新如下:
v2.order.get_order_detail 接口将新增以下 Response 字段:
| Field Name | Type | Description |
|---|---|---|
| affiliate_sample_type | int | Affiliate sample order 类型标识。1表示该订单为 Refundable Sample Order; null 表示该订单不是 Refundable Sample Order。 |
影响 API:
v2.order.get_order_detail
上线时间:
2026 年 6 月 18 日
§5 2. [BR] AMS 接口新增 Seller Service Fee 相关字段
2. [BR] AMS 接口新增 Seller Service Fee 相关字段
背景
为提升巴西 AMS 报表中的费用透明度与对账准确性, AMS OpenAPI 将在转化报表和校验报表中新增商品维度的 Seller Service Fee 相关信息,以便开发者通过新增字段识别每个商品对应的服务费率及服务费金额。
适用范围
BR
更新内容
v2.ams.get_conversion_report / v2.ams.get_validation_report 将新增以下 response 字段,用于展示商品维度的 Seller Service Fee 相关信息。
| Field | Type | Description |
|---|---|---|
| list > items > seller_service_fee_rate | New Response Field | 商品适用的 Seller Service Fee 费率。 |
| list > items > seller_service_fee | New Response Field | 商品对应的 Seller Service Fee 金额。计算公式: seller_service_fee = item_brand_commission * seller_service_fee_rate。 |
Note:
本次新增字段将对所有市场生效。目前 Seller Service Fee 仅适用于 BR Affiliate 业务,其他市场的新增字段当前将返回 0。
请开发者根据新增字段调整 AMS 报表解析及财务对账逻辑,以正确识别 BR Affiliate 业务下 Shopee 收取的中介服务费。
相关接口
v2.ams.get_conversion_report
v2.ams.get_validation_report
生效日期
Lived