New API Updates for Managing Shop Flash Sales and Product API

We are excited to announce the available APIs for managing your in-shop flash sales!

Here is the API list:

- v2.shop_flash_sale.get_time_slot_id: Retrieve available time slots for flash sales.

- v2.shop_flash_sale.get_item_criteria: Get the criteria for selecting eligible items for the sale.

- v2.shop_flash_sale.create_shop_flash_sale: Initiate a new flash sale for your shop.

- v2.shop_flash_sale.add_shop_flash_sale_items: Add items to a flash sale.

- v2.shop_flash_sale.get_shop_flash_sale_list: List all active flash sales in your shop.

- v2.shop_flash_sale.get_shop_flash_sale: Get details of a specific flash sale.

- v2.shop_flash_sale.get_shop_flash_sale_items: Retrieve items included in a particular flash sale.

- v2.shop_flash_sale.update_shop_flash_sale: Modify an existing flash sale's details.

- v2.shop_flash_sale.update_shop_flash_sale_items: Update items associated with a flash sale.

- v2.shop_flash_sale.delete_shop_flash_sale_items: Remove specific items from a flash sale.

- v2.shop_flash_sale.delete_shop_flash_sale: Remove a flash sale from your shop.

Effective Date on Live:

2024.09.27

To improve sellers’ chat response time, Shopee add the Average Response Time metric (metric_id: 29) in v2.account_health.get_shop_performance to get the shop’s chat average response time performance.

Related APIs:

v2.account_health.get_shop_performance

Effective Date on Live:

2024.09.13

To improve sellers’ on-time pickup success, Shopee add a sub-metric under On-time Pickup Failure Rate as the penalty point indicator for the upcoming penalty plan, the updates are as follows:

For v2.account_health.get_shop_performance, add the On-time Pickup Failure Rate Violation Value metric (metric_id: 28) to get the shop’s on-time pickup performance;
For v2.account_health.shop_penalty, add the opfr_violations response parameter to get the penalty points caused by orders that failed to be picked up during the scheduled pickup day.

Related APIs:

v2.account_health.get_shop_performance

v2.account_health.shop_penalty

Effective Date on Live:

2024.09.23

To enable sellers to set product publish time, Shopee add the scheduled_publish_time parameter, the updates are as follows:

For v2.product.add_item, v2.product.update_item, add scheduled_publish_time request parameter to enable the seller to set item publish time;
Forv2.product.get_item_base_info, add scheduled_publish_time response parameter to get the publish time set by the seller;
Add item_scheduled_publish_failed_push push mechanism to notify the seller when the item fails to publish at the scheduled publish time.

Related APIs/Pushs:

v2.product.add_item

v2.product.update_item

item_scheduled_publish_failed_push

Effective Date on Live:

2024.09.13

To better manage product quality, Shopee block product updates when product is under Shopee Review, the updates are as follows:

For v2.product.update_item, block sellers updating the item name, description, image, and video for items in “REVIEWING” status;
For v2.product.init_tier_variation, block sellers creating the tier variation for items in “REVIEWING” status;
For v2.product.update_tier_variation, block sellers updating the variation name, option name, and option image for items in “REVIEWING” status.

Related APIs:

v2.product.update_item

v2.product.init_tier_variation

v2.product.update_tier_variation

Effective Date on Live:

2024.09.27

To help sellers better manage comments, Shopee optimize v2.product.get_comment, the updates are as follows:

Add the following response parameters:

model_id_list: Return the model_id_list of the buyer’s purchase corresponding to the comment;

media > image_url_list: Return the image_url_list uploaded by the buyer in the comment;

media > video_url_list: Return the video_url_list uploaded by the buyer in the comment;

comment_reply > create_time: Return the time the seller replied to the comment.

Increase the maximum number of comments from 600 to 1000;
Only comments with normal status will be returned, no more deleted comments will be returned.

Related APIs:

v2.product.get_comment

Effective Date on Live:

2024.09.27

To increase buyers’ trust in sellers’ products, Shopee use the Brand as an Official Shop, and support the Umbrella Brand where multiple sellers associated with a single brand are presented as a single Official Shop, the updates are as follows:

Add v2.shop.get_authorised_reseller_brand API to get the brand_id and brand_name of the authorized brands supported by the shop. Only support BR, SG, and MY regions;
For v2.product.add_item, v2.product.update_item, add authorised_brand_id request parameter to enable the seller to set the authorized brand for item;
For v2.product.get_item_base_info, add authorised_brand_id response parameter to return the authorized brand set for item by the seller.

Related APIs:

v2.shop.get_authorised_reseller_brand

v2.product.add_item

v2.product.update_item

v2.product.get_item_base_info

Effective Date on Live:

2024.09.27

我们很高兴地宣布管理店内秒杀活动的 API 已经上线

API 列表如下：

- v2.shop_flash_sale.get_time_slot_id：获取秒杀活动的可用时间段。

- v2.shop_flash_sale.get_item_criteria：获取选择符合条件商品的标准。

- v2.shop_flash_sale.create_shop_flash_sale：为您的商店发起新的秒杀活动。

- v2.shop_flash_sale.add_shop_flash_sale_items：将商品添加到秒杀活动中。

- v2.shop_flash_sale.get_shop_flash_sale_list：列出您商店中所有的秒杀活动。

- v2.shop_flash_sale.get_shop_flash_sale：获取特定秒杀活动的详细信息。

- v2.shop_flash_sale.get_shop_flash_sale_items：检索特定秒杀活动中包含的商品。

- v2.shop_flash_sale.update_shop_flash_sale：修改现有秒杀活动的详情。

- v2.shop_flash_sale.update_shop_flash_sale_items：更新与秒杀活动相关的商品。

- v2.shop_flash_sale.delete_shop_flash_sale_items：从秒杀活动中移除特定商品。

- v2.shop_flash_sale.delete_shop_flash_sale：从您的商店中删除该秒杀活动。

生效日期：2024年9月27日

为了提高卖家的聊天响应时间，Shopee 在 v2.account_health.get_shop_performance 中新增了 Average Response Time metric 平均响应时间指标（metric_id: 29），以获取商店的聊天平均响应时间表现。

相关 API：

v2.account_health.get_shop_performance

生效日期：2024年9月13日

为了提高卖家的按时取件成功率，Shopee 在按时取件失败率下增加了一个子指标作为即将实施的处罚计划的惩罚点指标，更新内容如下：

1）在 v2.account_health.get_shop_performance 中，新增 On-time Pickup Failure Rate Violation Value metric (按时取件失败率违规值指标)（metric_id: 28），以获取商店的按时取件表现；

2）在 v2.account_health.shop_penalty 中，新增 opfr_violations 响应参数，以获取因未按计划取件而导致的罚分。

相关 API：

v2.account_health.get_shop_performance

v2.account_health.shop_penalty

生效日期：2024年9月23日

4.为了使卖家能够设置商品发布时机，Shopee 新增了 scheduled_publish_time 参数，更新内容如下：

1）在 v2.product.add_item、v2.product.update_item 中，新增 scheduled_publish_time 请求参数，使卖家能够设置商品的发布时机；

2）在 v2.product.get_item_base_info 中，新增 scheduled_publish_time 响应参数，以获取卖家设置的发布时机；

3）新增 item_scheduled_publish_failed_push 推送机制，当商品未能在计划发布时发布时通知卖家。

相关 API：

v2.product.update_item

v2.product.init_tier_variation

v2.product.update_tier_variation

生效日期：2024年9月27日

为了帮助卖家更好地管理评论，Shopee 优化了 v2.product.get_comment，更新内容如下：

1）新增以下响应参数：

model_id_list：返回与评论对应的买家购买的 model_id_list；

media > image_url_list：返回买家在评论中上传的 image_url_list；

media > video_url_list：返回买家在评论中上传的 video_url_list；

comment_reply > create_time：返回卖家回复评论的时间。

2）将评论的最大返回数量从 600 增加到 1000；

3）仅返回正常状态的评论，不再返回已删除的评论。

相关 API：

v2.product.get_comment

生效日期：2024年9月27日

7.为了增加买家对卖家商品的信任，Shopee 使用品牌作为官方店铺，并支持多个卖家与单一品牌关联的伞品牌，更新内容如下：

1）新增 v2.shop.get_authorised_reseller_brand API，以获取商店支持的授权品牌的 brand_id 和 brand_name。仅支持 BR、SG 和 MY 地区；

2）在 v2.product.add_item、v2.product.update_item 中，新增 authorised_brand_id 请求参数，使卖家能够为商品设置授权品牌；

3）在 v2.product.get_item_base_info 中，新增 authorised_brand_id 响应参数，以返回卖家为商品设置的授权品牌。

相关 API：

v2.shop.get_authorised_reseller_brand

v2.product.add_item

v2.product.update_item

v2.product.get_item_base_info

生效日期：2024年9月27日

New API Updates for Managing Shop Flash Sales and Product API

资料正文

§1 New API Updates for Managing Shop Flash Sales and Product API