来自 Shopee 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Significant OpenAPI Updates of Product, Order, 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.
§3 2.API Offline Notice
2.API Offline Notice
Affected APIs:
v2.product.get_ssp_list, v2.product.get_ssp_info, v2.product.add_ssp_item, v2.product.link_ssp, v2.product.unlink_ssp
These API were built based on BR's old SSP system, but their functions were never enabled after launch with zero production data and traffic. Listing has launched a new SSP system to replace the legacy one.
We will fully take these APIs offline today. There is no impact on all developers as no business logic relies on them.
Effective Date
2026.06.18
§4 3.Payment APIs Add Ads Smart Voucher Field
3.Payment APIs Add Ads Smart Voucher Field
Background
To support the Ads Smart Voucher business, Shopee will introduce advertiser-funded vouchers as buyer incentives to help improve item conversion.
To help developers identify and calculate this voucher amount, a new field ads_voucher_discount will be added to indicate the discount amount covered by Ads Smart Voucher in an order.
Applicable Scope
SG, ID, TH, TW, MY, PH, VN, BR
Update Details
v2.payment.get_escrow_detail / v2.payment.get_escrow_detail_batch will add the response field ads_voucher_discount, which is used to display the discount amount corresponding to Ads Smart Voucher.
| Field Path | Description |
|---|---|
| buyer_payment_info.ads_voucher_discount | Discount amount corresponding to Ads Smart Voucher |
Related APIs
v2.payment.get_escrow_detail_batch
Effective Date
Lived
§5 4.Order APIs Add Prescription Item Identification Fields
4.Order APIs Add Prescription Item Identification Fields
Background
As Shopee gradually supports online medicine sales and pharmacist service scenarios, new prescription item identification fields will be added to meet prescription drug management requirements. These fields help developers identify prescription items and obtain related prescription review status information.
Applicable Scope
TH, PH, ID
Update Details
- v2.order.get_order_detail will add the response field error_in_fetching_is_prescription_item, which indicates whether an error occurred when verifying if the item is a prescription item.
| Name | Type | Description |
|---|---|---|
| item_list > error_in_fetching_is_prescription_item | boolean | To indicate if there was an error when validating whether this item is a prescription. Default false. If is_prescription_item=false and this field is true, the item's prescription status is uncertain (label service call failed). Only for TH, PH, ID local shop. |
- v2.order.get_package_detail will add the response fields is_prescription_item and error_in_fetching_is_prescription_item. In addition, prescription_check_status and prescription_reject_reason will be added for PH and ID sites.
| Name | Type | Description |
|---|---|---|
| package_list > item_list > is_prescription_item | boolean | To indicate if this item is a prescription item. Default false. Only for PH, TH, ID whitelist shops. |
| package_list > item_list > error_in_fetching_is_prescription_item | boolean | To indicate if there was an error when validating whether this item is prescription. Default false. If is_prescription_item=false and this field is true, the item's prescription status is uncertain (label service call failed). Only for PH, TH, ID whitelist shops. |
| package_list > prescription_check_status | int | Prescription check status. For ID, PH whitelisted sellers, the applicable values: 0: NONE 1: PASSED 2: FAILED For TH whitelisted sellers, the applicable values: 0: NONE 1: PASSED |
| package_list > prescription_reject_reason | string | Return the reason why a prescription is rejected. If no rejection reason, return empty. Only for ID and PH whitelist sellers. |
Related APIs
Effective Date
Lived
尊敬的开发者
请查收本次的 OpenAPI 功能更新。这些改动旨在提升功能灵活性、优化使用体验,并为集成提供更好的支持。
§6 1. Product 接口新增批量更新相关 API
1. Product 接口新增批量更新相关 API
背景
目前 Shopee OpenAPI 仅支持单个商品维度的价格及库存更新,卖家需要逐个商品进行更新。对于管理大量商品及多个 outlet 的卖家,该方式难以扩展,并会带来较高的运营成本。
为提升 OpenAPI 在大规模商品管理场景下的可用性, Shopee 将新增批量更新相关 API,支持通过异步任务方式进行批量处理。
更新内容
Product OpenAPI 将新增以下批量处理接口,用于创建异步任务或查询批量任务结果。
- 新增接口v2.product.batch_add_item,创建异步任务以批量新增商品。
- 新增接口v2.product.batch_update_outlet_price,创建异步任务以批量更新 outlet 商品价格。
- 新增接口v2.product.batch_update_outlet_stock,创建异步任务以批量更新 outlet 商品库存
- 新增接口v2.product.batch_publish_item_to_outlet_shop,创建异步任务以批量发布 outlet商品。
- 新增接口v2.product.get_batch_task_result,用于查询批量异步任务的处理结果。
Note:
本次新增的批量处理接口将以异步任务方式执行。开发者需先调用对应批量接口创建任务,再调用 v2.product.get_batch_task_result查询任务处理结果。
请开发者根据批量任务处理方式调整商品价格、库存、新增商品及 outlet 商品发布相关系统逻辑,避免继续通过大量单商品接口调用完成批量操作。
相关接口
v2.product.batch_update_outlet_price
v2.product.batch_update_outlet_stock
v2.product.batch_publish_item_to_outlet_shop
v2.product.get_batch_task_result
生效日期
Lived
§7 2.接口下线通知
2.接口下线通知
涉及接口:
v2.product.get_ssp_list、v2.product.get_ssp_info、v2.product.add_ssp_item、v2.product.link_ssp、v2.product.unlink_ssp
以上接口基于 BR 旧版 SSP 体系开发,上线后功能从未启用,无任何业务数据与调用流量;目前 Listing 已上线全新 SSP 系统替代旧方案。
我们将于今天正式下线这组接口。因暂无开发者基于该接口开发业务逻辑,本次下线不会造成任何业务影响。
生效日期
2026.06.18
§8 3. Payment 接口新增 Ads Smart Voucher 字段
3. Payment 接口新增 Ads Smart Voucher 字段
背景
为支持智能广告优惠券（Smart Ads Voucher）业务,平台新增广告主出资的优惠券作为买家激励手段，帮助提升商品转化率。
为便于开发者识别和统计该部分优惠金额，本次新增字段 ads_voucher_discount，用于表示订单中由智能广告优惠券承担的折扣金额。
适用范围
SG、ID、TH、TW、MY、PH、VN、BR
更新内容
v2.payment.get_escrow_detail/v2.payment.get_escrow_detail_batch将新增返回字ads_voucher_discount，用于展示Ads Smart Voucher 对应的优惠金额。
| 字段路径 | 字段说明 |
|---|---|
| buyer_payment_info.ads_voucher_discount | Ads Smart Voucher 对应的优惠金额 |
相关接口
v2.payment.get_escrow_detail_batch
生效日期
Lived
§9 4.Order 接口新增处方药识别相关字段
4.Order 接口新增处方药识别相关字段
背景
随着平台逐步支持在线药品销售及药师服务场景,为满足处方药管理要求,平台新增处方药订单识别相关字段,帮助开发者识别处方药商品并获取相关审核状态信息。
适用范围
TH、PH、ID
更新内容
- v2.order.get_order_detail 将新增返回字段error_in_fetching_is_prescription_item 用于表明该商品是否为处方药。
| Name | Type | Description |
|---|---|---|
| item_list > error_in_fetching_is_prescription_item | boolean | 用于指示验证此商品是否为处方时是否出错。默认值为 false。 如果 is_prescription_item=false 且此字段为 true,则表示该商品的处方状态不确定（标签服务调用失败）。 仅适用于TH、PH和ID的本地商店。 |
- v2.order.get_package_detail 将新增返回字段 is_prescription_item 和 error_in_fetching_is_prescription_item。
同时，PH、ID 站点将新增返回 prescription_check_status 和 prescription_reject_reason。
| Name | Type | Description |
|---|---|---|
| package_list > item_list > is_prescription_item | boolean | 用于指示此商品是否为处方药。默认值为false。 仅适用于PH、TH和ID的白名单商店。 |
| package_list > item_list > error_in_fetching_is_prescription_item | boolean | 用于指示验证此商品是否为处方时是否出错。默认值为false。 如果 is_prescription_item=false 且此字段为 true,则表示该商品的处方状态不确定（标签服务调用失败）。 仅适用于PH、TH和ID的白名单商店。 |
| package_list > prescription_check_status | int | 处方核查状态。 对于ID/PH白名单卖家,适用值如下: 0: NONE 1: PASSED 2: FAILED 对于TH白名单卖家,适用值如下: 0: NONE 1: PASSED |
| package_list > prescription_reject_reason | string | 返回处方被拒的原因。如果没有拒收原因，则返回空结果。 仅适用于 ID 和 PH 白名单卖家。 |
相关接口
生效日期
Lived