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

[Important] Supports more granular item_status and deboost information

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

资料正文

§1 [Important] Supports more granular item_status and deboost information

Dear developers,

Please note the following updates:

  1. Currently, Open API only supports NORMAL, BANNED, UNLIST, and DELETED four item_status, which makes it impossible for sellers to distinguish between items deleted by sellers themselves and items deleted by Shopee due to non-compliance, and also between items waiting for seller's modification and items under Shopee's review.

Furthermore, Open API does not support returning whether the item's search ranking has been lowered or not, which leads to sellers not being able to perceive the violation and make timely adjustments.

To address these issues, Open API has updated the item_status enumeration values and supports returning whether the item's search ranking has been lowered. The updates are as follows:

APIUpdates
v2.product.get_item_base_info1) Update the enumeration values of the existing "item_status" response parameters to NORMAL, BANNED, UNLIST, REVIEWING, SELLER_DELETE, SHOPEE_DELETE. 2) Add a new response parameter named "deboost", boolean type, if "deboost" is true, it means the item's search ranking has been lowered, if "deboost" is false, it means the item's search ranking has not been lowered.
v2.product.get_item_listUpdate the enumeration values of the existing "item_status" request and response parameters to NORMAL, BANNED, UNLIST, REVIEWING, SELLER_DELETE, SHOPEE_DELETE.
v2.product.search_itemAdd item_status and deboost_only request parameters: - item_status: The enumeration values are NORMAL, BANNED, UNLIST, REVIEWING, SELLER_DELETE, SHOPEE_DELETE, supports filtering of items with specific status; - deboost_only: If deboost_only is true, then API will return items whose deboost is true, if deboost_only is empty or false, then API will return items whose deboost is true and false simultaneously.

Note: To avoid any disruption to your services caused by the above updates, please make the necessary adjustments before January 18, 2024. Thank you for your cooperation!

Related APIs:

v2.product.get_item_base_info

v2.product.get_item_list

v2.product.search_item

Effective Date on Live:

January 18, 2024

  1. After the above updates, Open API will support returning items with item_status of BANNED, SHOPEE_DELETE and lowered search rankings (deboost set to true), but still does not support returning the violation type, violation reason, suggestion, and fix deadline for such items. which leads to sellers not knowing how to adjust their items to meet platform requirements.

Furthermore, Open Platform only support sending push notifications when the item_status changes to BANNED, but does not support sending push notifications when the item_status changes to SHOPEE_DELETE and when the search ranking is lowered (deboost becomes true), which leads to sellers not being able to perceive the violation and make timely adjustments.

To address these issues, we will add the following new API and Push:

  1. Add v2.product.get_item_violation_info API, which supports to get the violation type, violation reason, suggestion, and fix deadline according to item_id_list;

  2. Add violation_item_push, which supports sending push notifications when item_status changes to BANNED or SHOPEE_DELETE and deboost becomes true, informing sellers about the violation type, violation reason, suggestion, and fix deadline.

For further details of the new API and push, please refer to the upcoming announcement and API Reference/Push Document.

Note: The banned_item_push will be deprecated in the future, please migrate to use the new push as soon as possible after the new push is released. Thank you for your cooperation!

Related APIs/pushs:

v2.product.get_item_violation_info

violation_item_push

Effective Date on Live:

January 18, 2024

尊敬的开发者,

请留意以下变动:

  1. 目前,Open API仅支持 NORMAL, BANNED, UNLIST, DELETED 四种item_status,导致卖家无法区分卖家自行删除的商品与Shopee判定不合格而删除的商品,也无法区分Shopee判定不合格后等待卖家修改的商品与卖家完成修改后等待Shopee审核的商品。

此外,Open API不支持返回搜索排名被降低的商品,导致卖家无法感知商品的搜索排名被降低并及时对其进行调整。

为了解决上述问题,Open API调整了item_status枚举值,并且支持返回商品的搜索排名是否被降低,改动点如下:

APIUpdates
v2.product.get_item_base_info1)响应参数中已有的item_status字段,枚举值调整为 NORMAL, BANNED, UNLIST, REVIEWING, SELLER_DELETE, SHOPEE_DELETE 2)响应参数新增deboost字段,格式为boolean,若deboost为true,表示该商品的搜索排名被降低,若deboost为false,表示该商品的搜索排名未被降低
v2.product.get_item_list请求参数与响应参数中已有的item_status字段,枚举值调整为 NORMAL, BANNED, UNLIST, REVIEWING, SELLER_DELETE, SHOPEE_DELETE
v2.product.search_item请求参数新增item_status与deboost_only字段,逻辑如下: - item_status:枚举值为 NORMAL, BANNED, UNLIST, REVIEWING, SELLER_DELETE, SHOPEE_DELETE,支持筛选特定状态的商品 - deboost_only:若deboost_only传true,则接口返回deboost为true的商品,若不传deboost_only或deboost_only传false,则接口同时返回deboost为true与false的商品

注意:为了避免上述改动上线后影响您服务的正常使用,请您在2024年1月18日之前完成调整,感谢您的配合!

影响接口:

v2.product.get_item_base_info

v2.product.get_item_list

v2.product.search_item

上线时间:

2024.01.18

  1. 上述改动上线后,Open API将支持返回 item_status为BANNED, SHOPEE_DELETE 以及 搜索排名被降低 (deboost为true) 的商品,但是仍然不支持返回返回此类商品对应的违规类型、违规原因、整改建议与时间期限,导致卖家不知道应该如何调整以满足平台要求。

此外,Open Platform仅支持当 item_status变为BANNED 时发送Push通知,不支持当 item_status变为SHOPEE_DELETE 以及 搜索排名被降低 (deboost变为true) 时发送Push通知,导致卖家无法及时感知到商品被惩罚,从而无法及时做出调整。

为了解决上述问题,平台将新增以下接口与Push:

1)新增v2.product.get_item_violation_info接口,支持根据item_id_list获取对应的违规类型、违规原因、整改建议与时间期限;

2)新增violation_item_push,支持当 item_status变为BANNED或SHOPEE_DELETE 以及 deboost变为true 时,主动发送Push通知,告知对应的违规类型、违规原因、整改建议与时间期限。

新增接口与Push的具体设计,请参见后续的上线公告与接口/Push文档。

注意:后续banned_item_push将会下线,请您在新Push上线后,尽快完成对接,感谢您的配合!

影响接口/Push:

v2.product.get_item_violation_info

violation_item_push

banned_item_push

上线时间:

2024.01.18

#