Significant OpenAPI Up[date

Dear Developers,

1. Currently, CBSC shop can only use Image Size Charts. This update will allow CBSC stores to use Template Size Charts. In the future, CBSC shops will be able to choose between Template Size Charts or Image Size Charts when creating global products. The API updates are as follows:

1. To add a Template Size Chart, sellers must first create the chart in Seller Center. Use the v2.global_product.get_size_chart_list API to fetch the list of size charts under a category, and the v2.global_product.get_size_chart_detail API to retrieve the details of a size chart within the category.

2. The v2.global_product.get_global_item_limit API now includes the following new response parameters under size_chart_limit:

support_image_size_chart

support_template_size_chart

size_chart_mandatory These parameters indicate whether the category supports size charts and whether a size chart is mandatory for the category.

Attention:

The existing v2.global_product.support_size_chart API will be deprecated in January 2025 (the exact deprecation date will be announced later). Please migrate to using the v2.global_product.get_global_item_limit API for size chart restrictions as soon as possible.

3. In the v2.global_product.add_global_item and v2.global_product.update_global_item APIs, new request parameters size_chart_info > size_chart and size_chart_id have been added for setting and updating product size charts. The logic is as follows:

Attention:

The existing v2.product.update_size_chart API will be deprecated in January 2025. Please migrate to using the v2.global_product.add_global_item and v2.global_product.update_global_item APIs to set and update product size charts.

2. For v2.global_product.update_stock and v2.product.update_stock, in scenarios involving batch updates of multipes model stock, it allows partial success where some models update successfully while others fail. The API will return the reason for the update failure for each failed model_id.

3. Regarding the previously released [MY] Important Update for MY-SG SIP and Direct Programme AWB API announcement, all the updates mentioned in the announcement have been released:

1. Add logistics_channel_id response parameter in v2.order.get_order_detail to return the Logistics Channel ID of the fulfillment channel for the package;

2. Add allow_self_design_awb response parameter in v2.order.get_order_detail to indicate whether the package allows for self-designed AWB, if allow_self_design_awb returns false, it means that the package does not allow for self-designed AWB and only the system-AWB can be used;

3. For packages that do not allow self-designed AWB, when calling the v2.logistics.get_shipping_document_data_info to retrieve AWB data, the API will return the error: “Not allowed to self design AWB”, please call the v2.logistics.download_shipping_document to download the system-AWB;

4. For the following 5 affected channels, the format of the system-AWB will be updated, for specific updates, please refer to the previous announcement: [MY] Important Update for MY-SG SIP and Direct Programme AWB API.

[MY-SG Shopee International Platform Orders] Affected channel ID: - 18061 5-Day Delivery - 18092 Shopee Collection Point (Overseas) - 18054 Doorstep Delivery (Overseas)

[MY-SG Direct Programme Orders] Affected channel ID: - 18079 Shopee Collection Point (Overseas) - 18080 5-Day Delivery (SPX)

Related APIs: v2.order.get_order_detail v2.logistics.get_shipping_document_data_info v2.logistics.download_shipping_document

Effective Date on Live: 2024.11.20

尊敬的开发者

以下是关于商品上架的两条更新：

1. 目前，CBSC 店铺只能使用图片尺寸表(Image Size Chart)，本期Shopee将支持Local店铺使用表格模板尺寸表(Template Size Chart) ，后续CBSC 店铺在创建商品时可以自由选择使用表格尺寸表或者图片尺寸表，接口更新如下：

1）如需要添加模板尺寸表，则需在卖家中心提前添加模板尺寸表，通过 v2.global_product.get_size_chart_list 获取类目下尺寸表的列表。并通过 v2.global_product.get_size_chart_detail 获取类目下尺寸表的详情

2）在 v2.global_product.get_global_item_limit 接口中新增 size_chart_limit > support_image_size_chart、support_template_size_chart、size_chart_mandatory 响应参数，以获取 Category 是否支持尺寸表以及 Category 下尺寸表是否必填

注意：

现有的 v2.global_product.support_size_chart 接口未来即将在 2025年1月下线（确定下线时间后会再次公告），请尽快切换使用 v2.global_product.get_global_item_limit 接口获取尺寸表限制。

3. 在 v2.global_product.add_global_item 和 v2.global_product.update_global_item 接口中新增 size_chart_info > size_chart、size_chart_id 请求参数，用于设置和更新商品的尺寸表，逻辑如下：

注意：现有的 v2.product.update_size_chart 接口会在 2025年1月 会线，请尽快切换使用 v2.global_product.add_global_item 和 v2.global_product.update_global_item 设置和更新商品的尺寸表。

2. v2.global_product.update_stock, v2.product.update_stock 对于批量更新变体库存的场景，允许 model 部分更新成功，剩余更新失败的model 会返回每一个model_id更新错误的原因

3. 针对平台此前发布的 [MY] Important Update for MY-SG SIP and Direct Programme AWB API 公告，公告中提到的更新均已上线，改动如下：

1）v2.order.get_order_detail 接口新增 logistic_channel_id 响应参数，来说明该订单的履约渠道的Channel ID

2）v2.order.get_order_detail 接口新增 allow_self_design_awb 响应参数，来说明该包裹是否允许自画面单，若 allow_self_design_awb 返回false，意味着该包裹不允许自画面单，只能使用系统面单；

3）对于不允许自画面单的包裹，调用 v2.logistics.get_shipping_document_data_info 接口获取面单数据时，接口将会返回报错：Not allowed to self design AWB，请调用 v2.logistics.download_shipping_document 接口下载系统面单；

4）针对下述五个受影响渠道，系统面单格式将会更新，具体更新内容请参考之前的公告：[MY] Important Update for MY-SG SIP and Direct Programme AWB API。

[MY-SG Shopee International Platform 订单] 受影响渠道的Channel ID：

- 18061 5-Day Delivery

- 18092 Shopee Collection Point (Overseas)

- 18054 Doorstep Delivery (Overseas)

[MY-SG Direct Programme 订单] 受影响渠道的Channel ID：

- 18079 Shopee Collection Point (Overseas)

- 18080 5-Day Delivery (SPX)

影响接口：

v2.order.get_order_detail

v2.logistics.get_shipping_document_data_info

v2.logistics.download_shipping_document

上线时间：

2024.11.20