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

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-accounthealthtopic/api-producttopic/changelogtopic/developertopic/openapi-updates

资料正文

§1 Significant OpenAPI Updates

Dear Developer,

Please note the following changes:

  1. Currently, for P Item under SIP Primary Shop, the API only returns the reserved stock set by P Item itself, and does not return the reserved stock set by A Items in the SIP Affiliate Shop, which makes it difficult for sellers to know the real available stock.

To solve this problem, the updates are as follows:

  1. For P Item, the total_reserved_stock field in v2.product.get_item_base_info and v2.product.get_model_list will return the total reserved stock for P Item and all A Items under the P Item;

  2. Add v2.product.get_aitem_by_pitem_id API to get all A Items under the P Item.

Note: To maintain the performance of v2.product.get_item_base_info and v2.product.get_model_list, we don't directly return the reserved stock of each A Item in these two APIs, if you want to know the details of the total reserved stock, you can first call the v2.product.get_aitem_by_pitem_id to get all A Items under the P Item, and then call the v2.product.get_item_base_info or v2.product.get_model_list to individually get the reserved stock of each A Item.

Related APIs:

v2.product.get_aitem_by_pitem_id

v2.product.get_item_base_info

v2.product.get_model_list

Effective Date on Live:

2024.11.01

  1. To help sellers get more comprehensive information about shop performance and more timely notifications about shop penalty updates, the updates are as follows:
  1. Add v2.account_health.get_metric_source_detail API to get the Affected Orders and Relevant Listings details of metrics;

  2. Add v2.account_health.get_penalty_point_history API to get the penalty point records generated in the current quarter;

  3. Add v2.account_health.get_punishment_history API to get the punishment records generated in the current quarter;

  4. Add v2.account_health.get_listings_with_issues API to get the Problematic Listings to improve the listings to avoid incurring penalty points;

  5. Add v2.account_health.get_late_orders API to get the Late Orders to take action to avoid order cancellation and penalty points.

  6. Add shop_penalty_update_push to get notified when the shop’s penalty point or punishment is updated.

Related APIs:

v2.account_health.get_metric_source_detail

v2.account_health.get_penalty_point_history

v2.account_health.get_punishment_history

v2.account_health.get_listings_with_issues

v2.account_health.get_late_orders

Related Push:

shop_penalty_update_push

Effective Date on Live:

2024.11.01

尊敬的开发者,

请留意以下变更:

  1. 目前,对于 SIP P Shop (主店铺) 下的 P Item,接口仅返回 P Item 自身设置的活动预留库存,而不返回对应的 SIP A Shop (附属店铺) 下的 A Item 设置的活动预留库存,导致卖家难以了解实际的可用库存。

为了解决这一问题,更新如下:

  1. 对于 P Item,v2.product.get_item_base_infov2.product.get_model_list 接口中的 total_reserved_stock 字段将返回 P Item 及其所有 A Item 的活动预留库存总和;

  2. 增加 v2.product.get_aitem_by_pitem_id 接口,用来获取 P Item 下的所有 A Item。

注意:为了避免影响 v2.product.get_item_base_info 和 v2.product.get_model_list 接口的性能,我们没有在这两个接口中直接返回 P Item 下每个 A Item 的活动预留库存。如果您想了解活动预留库存的明细,可以先调用 v2.product.get_aitem_by_pitem_id 接口,获取 P Item 下的所有 A Item,然后调用 v2.product.get_item_base_info 或 v2.product.get_model_list 接口,逐个获取每个 A Item 的活动预留库存。

影响接口:

v2.product.get_aitem_by_pitem_id

v2.product.get_item_base_info

v2.product.get_model_list

上线时间:

2024.11.01

  1. 为了帮助卖家更全面地了解店铺表现以及更及时地获得店铺处罚更新的通知,更新如下:

1)新增 v2.account_health.get_metric_source_detail 接口,获取影响指标的订单和商品详情;

2)新增 v2.account_health.get_penalty_point_history 接口,获取当前季度产生的罚分记录;

3)新增 v2.account_health.get_punishment_history 接口,获取当前季度产生的处罚记录;

4)新增 v2.account_health.get_listings_with_issues 接口,获取待改进的商品列表,从而改进商品以避免产生罚分;

5)新增 v2.account_health.get_late_orders 接口,获取延迟发货的订单列表,从而采取行动以避免订单取消和产生罚分;

6)新增 shop_penalty_update_push,以便在店铺罚分或处罚更新时获得通知。

影响接口:

v2.account_health.get_metric_source_detail

v2.account_health.get_penalty_point_history

v2.account_health.get_punishment_history

v2.account_health.get_listings_with_issues

v2.account_health.get_late_orders

影响Push:

shop_penalty_update_push

上线时间:

2024.11.01

#