Significant OpenAPI Updates

Dear Developers,

Please note the following updates:

1. To improve the accuracy of the weight and dimension of the items, Shopee will support sellers to set weight and dimension for each model.

The Open APIs are updated as follows:

1. Add new "weight" and "dimension > package_height / package_length / package_width" request parameters for the following Open APIs to support sellers to set weight and dimension for each model:

• v2.product.init_tier_variation
• v2.product.add_model
• v2.product.update_model
• v2.global_product.init_tier_variation
• v2.global_product.add_global_model
• v2.global_product.update_global_model

2. Add new "weight" and "dimension > package_height / package_length / package_width" response parameters for the following Open APIs to support sellers to get the weight and dimension for each model:

• v2.product.get_model_list
• v2.global_product.get_global_model_list

3. For the v2.product.update_item and v2.global_product.update_global_item, updating the weight and dimension of item will overwrite the weight and dimension of all models under the item.

4. For the v2.product.get_item_base_info and v2.global_product.get_global_item_info, if the seller has set the weight and dimension of models under the item, the APIs will still return the weight and dimension of the item during the switching period to ensure system compatibility with the following logic:

• If set the weight of models under the item, the APIs will return the max weight of all models
• If set the dimension of models under the item, the APIs will return the dimension with largest volume calculated by heightlengthwidth

Notes:

After the switching period, if the seller has set the weight and dimension of models under the item, the APIs will no longer return the weight and dimension of the item, please switch to call the v2.product.get_model_list and v2.global_product.get_global_model_list to get the weight and dimension for each model as soon as possible.

Related Open APIs:

v2.product.init_tier_variation

v2.product.add_model

v2.product.update_model

v2.product.get_model_list

v2.product.update_item

v2.product.get_item_base_info

v2.global_product.init_tier_variation

v2.global_product.add_global_model

v2.global_product.update_global_model

v2.global_product.get_global_model_list

v2.global_product.update_global_item

v2.global_product.get_global_item_info

Effective Date on Live:

Lived on 2024-05-27 (Currently only open to sellers in TH, will progressively expand availability to sellers in other regions throughout June)

2. For local shops in BR region, Shopee provides "Shopee Entrega Direta" channel (channel ID: 90022) to fulfill buyer’s fast delivery needs.

The Open APIs are updated as follows:

1. The "Shopee Entrega Direta" channel (channel ID: 90022) doesn't support pre-order products.

When calling v2.product.add_item, v2.product.update_item, v2.product.update_model:

- If the item has enabled the "Shopee Entrega Direta" channel, when you set the is_pre_order to true for the item or the model under the item, the API will return error message: The channel doesn't allow pre order products. Channel: Shopee Entrega Direta.

- If the is_pre_order has set to true for the item or the model under the item, when you update the item's logistic_info and enable the "Shopee Entrega Direta" channel, the API will also return error message: The channel doesn't allow pre order products. Channel: Shopee Entrega Direta.

2. The "Shopee Entrega Direta" channel (channel ID: 90022) can't be the only enabled shipping channel.

When calling v2.product.add_item, v2.product.update_item:

- If the item has only enabled the "Shopee Entrega Direta" channel, the API will return error message: Product can't be saved with only one shipping option, when Direct Delivery is enabled.

Related Open APIs:

v2.product.add_item

v2.product.update_item

v2.product.update_model

Effective Date on Live:

Will be lived on 2024-06-09

3. To avoid the impact on your service after the platform adjusts the character length of access_token and refresh_token, please do not set the character length limit of access_token and refresh_token in your system.

尊敬的开发者，

请留意以下变动：

1. 为了提升商品重量和尺寸的准确性，Shopee将支持卖家为单个model设置weight和dimension。 接口更新如下：

1. 针对下列接口新增"weight"和"dimension > package_height / package_length / package_width"请求参数，以支持卖家为单个model设置weight和dimension。

• v2.product.init_tier_variation
• v2.product.add_model
• v2.product.update_model
• v2.global_product.init_tier_variation
• v2.global_product.add_global_model
• v2.global_product.update_global_model

2. 针对下列接口新增“weight”和“dimension > package_height / package_length / package_width”响应参数，以支持卖家获取每个model的weight和dimension。

• v2.product.get_model_list
• v2.global_product.get_global_model_list

3. 针对v2.product.update_item和v2.global_product.update_global_item接口，更新item维度的weight和dimension，将会覆盖该item下所有model的weight和dimension。

4. 针对v2.product.get_item_base_info和v2.global_product.get_global_item_info接口，如果卖家设置了model维度的weight和dimension，在切换期间，为了确保系统的兼容性，接口仍然会返回item维度的weight和dimension，逻辑如下：

• 如果设置了model维度的weight，那么item维度的weight将会返回该item下所有model对应的weight的最大值
• 如果设置了model维度的dimension，那么item维度的dimension将会返回该item下所有model对应的heightlengthwidth得到体积最大的dimension

注意：后续如果卖家设置了model维度的weight和dimension，接口将不再返回item维度的weight和dimension，因此请尽快切换到调用 v2.product.get_model_list和v2.global_product.get_global_model_list接口以获取每个model的weight和dimension。

影响接口：

v2.product.init_tier_variation

v2.product.add_model

v2.product.update_model

v2.product.get_model_list

v2.product.update_item

v2.product.get_item_base_info

v2.global_product.init_tier_variation

v2.global_product.add_global_model

v2.global_product.update_global_model

v2.global_product.get_global_model_list

v2.global_product.update_global_item

v2.global_product.get_global_item_info

上线时间：

2024-05-27 已上线 (目前仅开放给TH地区的卖家，将于6月逐渐开放给其他地区的卖家使用)

2. 针对BR地区的Local Shop，Shopee推出了“Shopee Entrega Direta”渠道 (channel ID: 90022)，以满足买家的快速交货需求。

接口更新如下：

1. “Shopee Entrega Direta”渠道不支持预售商品。

调用v2.product.add_item、v2.product.update_item、v2.product.update_model接口时：

- 若item开启了“Shopee Entrega Direta”渠道，设置item或item下的model的is_pre_order为true时，接口将会报错：The channel doesn't allow pre order products. Channel: Shopee Entrega Direta.

- 若item或item下的model设置了is_pre_order为true，设置item的logistic_info以开启“Shopee Entrega Direta”渠道时，接口同样也会报错：The channel doesn't allow pre order products. Channel: Shopee Entrega Direta.

2. “Shopee Entrega Direta”渠道不能作为商品的唯一启用渠道。

调用v2.product.add_item、v2.product.update_item接口时：

- 若item只开启了“Shopee Entrega Direta”渠道，接口将会报错：Product can't be saved with only one shipping option, when Direct Delivery is enabled.

影响接口：

v2.product.add_item

v2.product.update_item

v2.product.update_model

上线时间：

将于2024-06-09上线

3. 为了避免后续平台调整access_token和refresh_token的字符长度对您的服务产生影响，请不要在您的系统中设置access_token和refresh_token的字符长度限制。