Significant OpenAPI Updates

Dear Developer,

Please note the following changes:

For local shops, Shopee already provides Next Day Delivery channels to fulfill buyers’ fast delivery needs. To further fulfill buyers' fast delivery needs, Shopee provides 5 Day Guaranteed channels for CB Shops.

The logic of 5 Day Guaranteed channel is the same as Next Day Delivery channel, which doesn’t support pre-order products:

Call v2.logistics.get_channel_list to check whether the channel supports pre-order products via the support_pre_order response parameter, the support_pre_order will be “false” for Next Day Delivery and 5 Day Guaranteed channels.
When calling v2.product.add_item, v2.product.update_item, v2.product.update_model:

- If the item has enabled channels with support_pre_order = false, when you set the is_pre_order to true for the item or models under the item, the API will return error message: The channel doesn't allow pre order products. Channel: {channel_name}.

- If the is_pre_order has set to true for the item or models under the item, when you update the item's logistic_info and enable the channel with support_pre_order = false, the API will also return error message: The channel doesn't allow pre order products. Channel: {channel_name}.

Related APIs:

v2.logistic.get_channel_list

v2.product.add_item

v2.product.update_item

v2.product.update_model

Effective Date on Live:

2024.06.13

To improve the accuracy of the DTS (days_to_ship) for global items, Shopee will support sellers to set DTS for each global model.

The Open APIs are updated as follows:

Add new "pre_order >> days_to_ship" request parameters for the following Open APIs to support sellers to set DTS for each global model:

- v2.global_product.init_tier_variation

- v2.global_product.add_global_model

- v2.global_product.update_global_model

Add new "pre_order >> days_to_ship" response parameters for the following Open APIs to support sellers to get the DTS for each global model:

- v2.global_product.get_global_model_list

For the v2.global_product.update_global_item, updating the DTS of global item will overwrite the DTS of all global models under the global item.
For the v2.global_product.get_global_item_info, if the seller has set the DTS of global models under the global item, the API will still return the max DTS of all global models as the DTS of the global item during the switching period to ensure system compatibility.

Notes:

Currently, v2.product.init_tier_variation and v2.product.add_model don’t support setting the DTS of each model, sellers have to create the model first and then set the DTS of each model through v2.product.update_model.

To improve the efficiency of sellers setting the DTS of each model, we have add new "pre_order" request parameters to v2.product.init_tier_variation and v2.product.add_model to support sellers to set DTS of each model directly when they create model:

Related APIs:

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.product.init_tier_variation

v2.product.add_model

Effective Date on Live:

2024.06.24

3.Only for the whitelist shops which allow Partial Qty Return Refund.

Two new fields had been added to v2.returns.get_return_detail.

1）The new field item[*].refund_amount, which will return the refund amount at the item level (Non-bundle).

2）The new field activity[].items[].refund_amount for bundle level refund amount.

Please note these changes and make the necessary adjustments accordingly.

Related APIs:

v2.returns.get_return_detail

Effective Date on Live:

Lived

4.Only affect cross-border sellers using FirstMile-related APIs.

For thev2.first_mile.bind_first_mile_tracking_number API, add that when using self_deliver as the shipping method, the first_mile_tracking_number field should pass the value generated by v2.first_mile.generate_first_mile_tracking_number.

Related APIs:

v2.first_mile.bind_first_mile_tracking_number

v2.first_mile.generate_first_mile_tracking_number

Effective Date on Live:

Lived

尊敬的开发者，

请留意以下变动：

针对各个地区的Local Shop，Shopee已经提供了Next Day Delivery渠道，以满足买家的快速交货需求。为了进一步满足买家的快速交货需求，针对各个地区的CB Shop，Shopee将提供5 Day Guaranteed渠道。

5 Day Guaranteed渠道的逻辑与Next Day Delivery渠道一致，均不适用于预售商品：

1）调用v2.logistics.get_channel_list接口，通过support_pre_order字段获取“渠道是否支持预售商品”信息，针对Next Day Delivery与5 Day Guaranteed渠道，support_pre_order字段均会返回“false”。

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

- 若item开启了不支持预售商品的渠道，设置item或item下的model的is_pre_order为true时，接口将会报错：The channel doesn't allow pre order products. Channel: {channel_name}.

- 若item或item下的model设置了is_pre_order为true，设置item的logistic_info以开启不支持预售商品的渠道时，接口同样也会报错：The channel doesn't allow pre order products. Channel: {channel_name}.

影响接口：

v2.logistic.get_channel_list

v2.product.add_item

v2.product.update_item

v2.product.update_model

上线时间：

2024.06.13

为了提升全球商品的DTS (days_to_ship) 准确性，Shopee将支持卖家为单个global model设置DTS。

接口更新如下：

1）针对下列接口新增“pre_order >> days_to_ship”请求参数，以支持卖家为单个global model设置DTS。

- v2.global_product.init_tier_variation

- v2.global_product.add_global_model

- v2.global_product.update_global_model

针对下列接口新增“pre_order >> days_to_ship”响应参数，以支持卖家获取每个global model的DTS。

- v2.global_product.get_global_model_list

针对v2.global_product.update_global_item接口，更新global item维度的DTS，将会覆盖该global item下所有global model的DTS。
针对v2.global_product.get_global_item_info接口，如果卖家设置了global model维度的DTS，在切换期间，为了确保系统的兼容性，接口仍然会返回该global item下所有global model对应的DTS的最大值作为global item维度的DTS。

注意：

目前，v2.product.init_tier_variation和v2.product.add_model接口，不支持卖家在创建变体时直接设置每个model的 DTS，卖家必须先创建model，再通过v2.product.update_model接口设置每个model的DTS。

为了提升卖家设置model DTS的效率，针对v2.product.init_tier_variation和v2.product.add_model接口，同样新增了“pre_order”请求参数：

影响接口：

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.product.init_tier_variation

v2.product.add_model

上线时间：

2024.06.24

3.以下更新仅适用于允许部分数量退货退款的白名单商店。

在v2.returns.get_return_detail添加了两个新的响应字段： 1) item[].refund_amount将返回项目级别（非捆绑）的退款金额。 2)activity[].items[*].refund_amount 返回捆绑销售的退款金额。

请注意这些更改，并做出相应的必要调整。影响接口： v2.returns.get_return_detail

上线时间：

已上线

4.以下更新仅影响使用FirstMile相关接口的跨境卖家。

对于 v2.first_mile.bind_first_mile_tracking_numberAPI，当使用 self_deliver 作为发货方式时，first_mile_tracking_number 字段应传递由 v2.first_mile.generate_first_mile_tracking_number 生成的值。

影响接口：

v2.first_mile.bind_first_mile_tracking_number

v2.first_mile.generate_first_mile_tracking_number

上线时间：

已上线

Significant OpenAPI Updates

资料正文

§1 Significant OpenAPI Updates