快工助手跨境电商知识与商机助手

Significant OpenAPI Updates

Shopee 官方资料 · Shopee Open Platform 变更通知(Announcements) · 适合开发者

stable本次发布有变化全部展示

来自 Shopee 官方资料快照 ·

打开官方原文 ↗
  1. 当前资料结构化阅读页
  2. 固定快照已留存,可追溯
  3. 官方原文可核对
查看技术与溯源信息
平台 / profile
Shopee / profile.shopee.announcements
语言
en
发布版本
cn-20260909-2
标签
zhuge/sourceplatform/shopeeaudience/developercategory/announcementtopic/apitopic/api-discounttopic/api-paymenttopic/api-producttopic/changelogtopic/developertopic/openapi-updates

资料正文

§1 Significant OpenAPI Updates

Dear Developer,

Please note the following changes:

  1. Shopee will support local SIP sellers to get and set discounts for Affiliate shops via Open API, these discounts will be applied to all products in the Affiliate shops. The API updates are as follows:
  1. Add v2.discount.get_sip_discounts API to get discounts set for Affiliate shops. Sellers can request using Primary shop's Shop ID, the API will return the list of Affiliate shops under this Primary shop that have set discounts, along with the discount details.

  2. Add v2.discount.set_sip_discount API to set and update discounts for Affiliate shops. Sellers can request using Primary shop's Shop ID, and provide the region and discount rate of the Affiliate shop to be set or update, the API will set or update the discount rate for that region's Affiliate shop.

  3. Add v2.discount.delete_sip_discount API to delete discounts from Affiliate shops. Sellers can request using Primary shop's Shop ID, and provide the region of the Affiliate shop to be deleted, the API will delete the discount from that region's Affiliate shop.

Related APIs:

v2.discount.get_sip_discounts

v2.discount.set_sip_discount

v2.discount.delete_sip_discount

Effective Date on Live:

2025.10.16

2.Shopee has updated the APIs v2.product.get_model_list and v2.product.get_item_base_info to include a new response field "has_promotion", indicating whether an item has an ongoing promotion:

true — the item has an active promotion

false — the item has no active promotion

Note: The “promotion_id” field will be deprecated. The exact deprecation date will be announced separately. To retrieve details of the item’s participating promotions, please use v2.product.get_item_promotion.

Related APIs:

v2.product.get_model_list

v2.product.get_item_base_info

v2.product.get_item_promotion

Effective Date on Live:

2025.10.27

3.Shopee now supports sellers to retrieve and consolidate income reports via Open API. The updates include:

  1. v2.payment.generate_income_report

Cross-Border (CB) shops are now supported.

Generates a unique report ID for the specified time range. For CB shops, income data is aggregated based on payout cycles.Use v2.payment.get_income_report to retrieve detailed income data.

  1. v2.payment.get_income_overview (New)

Provides a consolidated snapshot of the seller’s income by income status.

Consistent with Seller Center’s “Income Overview” tab. Supports dynamic data based on shop type (Local/CB) and selected income status.

  1. v2.payment.get_income_detail (New)

Provides order-level detailed income for a specified time period.

Data display is consistent with Seller Center’s “Income Details” tab. Income is segmented by status and payout stage. Data fields dynamically adjust based on shop type (Local or Cross-Border) and selected income status (e.g., Pending, To Release, Released).

Related APIs:

v2.payment.generate_income_report

v2.payment.get_income_overview

v2.payment.get_income_detail

Effective Date on Live:

2025.11.07

尊敬的开发者,

请留意以下变更:

  1. Shopee将支持本土 SIP 卖家通过 Open API 获取以及设置 Affiliate 店铺的商品折扣,该折扣将应用于 Affiliate 店铺下的所有商品,接口更新如下:

1)新增 v2.discount.get_sip_discounts 接口,用于获取卖家为 Affiliate 店铺设置的商品折扣 (即:使用 Primary 店铺的 Shop ID 请求接口,接口返回该 Primary 店铺下所有已设置商品折扣的 Affiliate 店铺列表及其商品折扣信息);

  1. 新增v2.discount.set_sip_discount 接口,用于为 Affiliate 店铺设置以及更新商品折扣 (即:使用 Primary 店铺的 Shop ID 请求接口,传入需要设置或更新的 Affiliate 店铺的地区与折扣比例,接口将会更新该地区的 Affiliate 店铺的商品折扣比例);

3)新增 v2.discount.delete_sip_discount 接口,用于删除 Affiliate 店铺的商品折扣 (即:使用 Primary 店铺的 Shop ID 请求接口,传入需要删除的 Affiliate 店铺的地区,接口将会删除该地区的 Affiliate 店铺的商品折扣)。

影响接口:

v2.discount.get_sip_discounts

v2.discount.set_sip_discount

v2.discount.delete_sip_discount

上线时间:

2025.10.16

2.接口 v2.product.get_model_listv2.product.get_item_base_info 已新增响应字段 “has_promotion”,用于标识商品是否有正在进行的促销活动:

true:商品当前有促销

false:商品暂无促销

Note: ”promotion_id” 字段将逐步下线,具体下线时间将另行通知。若需获取商品参与的促销活动详情,请使用接口 v2.product.get_item_promotion

影响接口:

v2.product.get_model_list

v2.product.get_item_base_info

v2.product.get_item_promotion

上线时间:

2025.10.27

3.Shopee 支持卖家通过 Open API 获取收入报告和收入明细,接口更新如下:

1)v2.payment.generate_income_report 接口, 新增支持跨境(CB)店铺调用,将根据支付周期聚合收入数据生成报告 ID,请调用v2.payment.get_income_report 接口获取详细收入数据。

2)新增v2.payment.get_income_overview 接口,用于获取卖家收入概览,按收入状态汇总收入金额。数据展示与卖家中心“收入概览”一致,可用于外部系统实时展示当前店铺收入情况。

数据动态根据店铺类型(本地或跨境)及收入状态生成。

3)新增v2.payment.get_income_detail接口,用于获取指定时间段内各收入状态的订单级别明细收入信息。数据展示与卖家中心“收入明细”一致,并按收入状态及支付阶段进行划分。数据字段会根据卖家店铺类型(本地或跨境)以及选择的收入状态(如待支付、待释放、已释放)动态调整。

影响接口:

v2.payment.generate_income_report

v2.payment.get_income_overview

v2.payment.get_income_detail

上线时间:

2025.11.7

#