Significant OpenAPI Updates

Dear Developer,

Please note the following changes:

1. To support sellers selling auto parts to select specific cars compatible with their products so that buyers can know whether the products are suitable for their cars, Shopee will support sellers to get the vehicle list and set product compatibility information via Open API.

The Open APIs are updated as follows:

1. Add new v2.product.get_all_vehicle_list to get the information about all vehicles.

2. Add new v2.product.get_vehicle_list_by_compatibility_detail to get the information by brand, model, year, and version.

3. Add new "compatibility_info" request parameter for v2.product.add_item and v2.product.update_item to set product compatibility information.

4. Add new "compatibility_info" response parameter for v2.product.get_item_base_info to get product compatibility information.

The following categories (category_id) are supported for setting compatibility_info:

101452,101448, 101454, 101446, 101449, 101416, 101455, 101482, 101497, 101431, 101415, 101440, 100754, 101457, 101451, 101456, 101496, 101483, 101494, 101435, 101453, 101426, 101490, 101444, 101476, 100753, 101495, 101488, 101422, 101423, 101486, 101491, 101434, 101487, 101450, 101442, 101430, 101437, 101428, 101484, 101478, 101433, 101447, 100755, 101493, 101477, 101489, 101438, 100758, 101485, 101443, 101439, 101436, 101474, 101492, 101479, 101480, 101417, 101429, 101432, 101445, 101420, 101475, 101441, 100759, 101473, 100746

Related APIs:

v2.product.get_all_vehicle_list

v2.product.get_vehicle_list_by_compatibility_detail

v2.product.add_item

v2.product.update_item

v2.product.get_item_base_info

Effective Date on Live:

2024.06.20

2. To improve the usability of API and minimize changes to the API structure due to adding metric or modifying metric level, Shopee provides a new v2.account_health.get_shop_performance, please refer to the API Reference for more details.

Besides, Shopee adds the Fast Handover Rate, On-time Pickup Failure Rate, Non Fulfillment Rate (NDD), and Late Shipment Rate (NDD) metrics to the new v2.account_health.get_shop_performance.

Note: The existing v2.account_health.shop_performance will be sunset on 2024.09.30, please switch to using the new v2.account_health.get_shop_performance as soon as possible.

Related APIs:

v2.account_health.get_shop_performance

v2.account_health.shop_performance

Effective Date on Live:

2024.06.27

3. To help you know the price update of the item in time to update the price stored in your system, Shopee provides a new item_price_update_push push mechanism, when the original_price of the item changes, Shopee will send a push notification with the following content:

Related Push：

item_price_update_push

Effective Date on Live:

2024.06.27

4. To support getting weight, dimension, and days to ship limitation of different categories, Shopee adds the "category_id" request parameter and the "weight_limit", "dimension_limit", "dts_limit" response parameters to the existing v2.product.get_item_limit and v2.global_product.get_item_limit.

1. For v2.product.get_item_limit, updated as follows:

Request Parameters:

Response Parameters:

2. For v2.global_product.get_global_item_limit, updated as follows:

Request Parameters:

Response Parameters:

Notes: The existing v2.product.get_dts_limit and v2.global_product.get_dts_limit will be sunset on 2024.09.30, please switch to using the v2.product.get_item_limit and v2.global_product.get_item_limit to get the days to ship limitation as soon as possible.

Related APIs：

v2.product.get_item_limit

v2.global_product.get_global_item_limit

v2.product.get_dts_limit

v2.global_product.get_dts_limit

Effective Date on Live:

2024.06.27

5. To help sellers modify the tier variation structure more flexibly, Shopee supports updating the product with variation structure to the product without variation structure via v2.product.init_tier_variation and v2.global_product.init_tier_variation, can pass the tier_variation, standardise_tier_variation as [], pass the model >> tier_index as [], meanwhile pass the original_price, seller_stock, etc., to set the price and stock for the modified product without variant structure.

Related APIs：

v2.product.init_tier_variation

v2.global_product.init_tier_variation

Effective Date on Live:

2024.06.27

6. We will block frozen users from sending messages or sending messages to frozen users through Chat OpenAPI v2.sellerchat.send_message and v2.sellerchat.send_autoreply_message. The error message for the block will be: "You can not send messages as you are frozen." and "You can not send messages as opposite user is frozen"

Related APIs：

v2.sellerchat.send_message

v2.sellerchat.send_autoreply_message

Effective Date on Live:

2024.06.28

7. The existing banned_item_push will be sunset on 2024.09.30, please switch to using violation_item_push as soon as possible.

尊敬的开发者，

请留意以下变动：

1. 为了支持销售汽车配件的卖家选择其商品兼容的特定车型，以便买家了解商品是否适配自己的车辆，Shopee将支持卖家通过Open API获取车型列表以及设置商品的兼容车型信息。

接口更新如下：

1）新增v2.product.get_all_vehicle_list接口，获取所有的车辆信息。

2）新增v2.product.get_vehicle_list_by_compatibility_detail接口，按照brand, model, year, version获取车辆信息。

3）已有的v2.product.add_item与v2.product.update_item接口新增“compatibility_info”请求参数，以设置商品的兼容车型信息。

4）已有的v2.product.get_item_base_info接口新增“compatibility_info”响应参数，以获取商品的兼容车型信息。

支持设置兼容车型信息的类目 (category_id) 如下：

101452,101448, 101454, 101446, 101449, 101416, 101455, 101482, 101497, 101431, 101415, 101440, 100754, 101457, 101451, 101456, 101496, 101483, 101494, 101435, 101453, 101426, 101490, 101444, 101476, 100753, 101495, 101488, 101422, 101423, 101486, 101491, 101434, 101487, 101450, 101442, 101430, 101437, 101428, 101484, 101478, 101433, 101447, 100755, 101493, 101477, 101489, 101438, 100758, 101485, 101443, 101439, 101436, 101474, 101492, 101479, 101480, 101417, 101429, 101432, 101445, 101420, 101475, 101441, 100759, 101473, 100746

影响接口：

v2.product.get_all_vehicle_list

v2.product.get_vehicle_list_by_compatibility_detail

v2.product.add_item

v2.product.update_item

v2.product.get_item_base_info

上线时间：

2024.06.20

2. 为了提升接口的可用性，减少由于新增指标或者调整指标层级导致的接口结构变更，Shopee提供了一个新的v2.account_health.get_shop_performance接口，详细信息请参考接口文档。

此外，针对新的v2.account_health.get_shop_performance接口，新增了Fast Handover Rate, On-time Pickup Failure Rate, Non Fulfillment Rate (NDD), and Late Shipment Rate (NDD)等指标。

注意：已有的v2.account_health.shop_performance接口，将于2024年9月30日正式下线，请尽快切换对接新的v2.account_health.get_shop_performance接口。

影响接口：

v2.account_health.get_shop_performance

v2.account_health.shop_performance

上线时间：

2024.06.27

3. 为了帮助您及时地感知商品的价格更新，从而更新您系统中存储的价格，Shopee提供了一个item_price_update_push，当商品的original_price发生变更时，Shopee将会推送一条Push消息，包含以下内容：

影响Push：

item_price_update_push

上线时间：

2024.06.27

4. 为了支持获取不同Category对应的Weight、Dimension、Days to ship限制条件，针对已有的 v2.product.get_item_limit、v2.global_product.get_item_limit接口，增加了“category_id”请求参数以及“weight_limit”、“dimension_limit”、“dts_limit”响应参数。

1）针对v2.product.get_item_limit，更新如下：

Request Parameters:

Response Parameters:

2）针对v2.global_product.get_global_item_limit，更新如下：

Request Parameters:

Response Parameters:

注意：已有的v2.product.get_dts_limit、v2.global_product.get_dts_limit接口，将于2024年9月30日正式下线，请尽快切换对接v2.product.get_item_limit、v2.global_product.get_global_item_limit接口，获取不同Category的Days to ship限制条件。

影响接口：

v2.product.get_item_limit

v2.global_product.get_global_item_limit

v2.product.get_dts_limit

v2.global_product.get_dts_limit

上线时间：

2024.06.27

5. 为了帮助卖家更灵活地调整变体结构，Shopee支持通过v2.product.init_tier_variation、v2.global_product.init_tier_variation将有变体结构的商品修改为没有变体结构的商品，即：传tier_variation、standardise_tier_variation均为[]，model >> tier_index为[]，同时传original_price、seller_stock等参数，为修改后的没有变体结构的商品设置价格与库存。

影响接口：

v2.product.init_tier_variation

v2.global_product.init_tier_variation

上线时间：

2024.06.27

6. 我们将阻止冻结用户通过 Chat OpenAPI v2.sellerchat.send_message 和 v2.sellerchat.send_autoreply_message 发送消息或者向冻结用户发送消息。错误码为 "You can not send messages as you are frozen." 和 "You can not send messages as opposite user is frozen"

影响接口：

v2.sellerchat.send_message

v2.sellerchat.send_autoreply_message

上线时间：

2024.06.28

7. 已有的banned_item_push将于2024年9月30日正式下线，请尽快切换对接新的 violation_item_push。