Significant OpenAPI Updates

Dear Developer,

Please note the following changes:

1.Support CNSC and KRSC sellers to partial publish model for Shop products.

The following are API changes:

1. The v2.global_product.create_publish_task API supports CNSC and KRSC sellers to set model_status when publishing shop products. When model_status=NORMAL, the model can be sold on the buyer's side; when model_status=UNAVAILABLE, the model cannot be sold. All models should have at least one model with model_status=NORMAL.

2. The v2.product.get_model_list API adds the model_status field to return, regardless of local or cross-border sellers.

3. The v2.product.update_model API only supports CNSC and KRSC sellers to update model_status. All models should have at least one model with model_status=NORMAL. If all models are set to model_status=UNAVAILABLE, API will report an error.

4. If the seller deletes the model of the global product by calling v2.global_product.delete_global_model API and it causes the all models of shop product are UNAVAILABLE, the API will report an error.

Related API:

v2.global_product.create_publish_task

v2.product.get_model_list

v2.product.update_model

v2.global_product.delete_global_model

Effective Date on Live: Lived

2.In order to support the sellers in TW region who sell tax-free products to set products to be taxable or tax-free so that sellers could issue corresponding taxable invoice and tax-free invoice in Shopee，OpenAPI support to add or update tax type by calling v2.product.add_item and v2.product.update_item, and call v2.product.get_item_base_info to get one product's tax type. The type of the tax is indicated by the parameter tax_type：

tax_type=1: taxable

tax_type=2: tax free

tax_type=0: not in the whitelist

The whitelist of this feature is configured at the level of shop id+category id.For the categories in this tax free whitelist, the current uploading methods of tax types are mainly divided into two groups:

1.Book group：category in this group need to follow the rule of book group to pass the value of attribute——ISBN to get this ISBN's tax type automatically. For example, input ISBN with 9787306075697, the result of getting tax type by ISBN is tax_type=2 which means tax free.

Request

{ "category_id": 400136, "attribute_list": [ { "attribute_id": 100574, "attribute_value_list": [ { "original_value_name": "9787306075697", "value_id": 0, "value_unit": "" } ], "is_mandatory": false, "original_attribute_name": "ISBN 國際標準書號" } ], "tax_info": {}}

Response

{ "item_id": 800396049, "tax_info": { "tax_type": 2 }}

2.Fresh food group: category in this group need to follow the rule of this group to pass tax_type in tax_info to upload tax type

Request

{ "category_id": 400148, "tax_info": { "tax_type": 1 }}

Response

{"item_id": 800395979, "tax_info": { "tax_type": 1 }}

In addition, the Shopee operation team is able to add new category_id to the fresh food group or book group, and there may also be new groups. The specific configuration will be updated to sellers by the operation team. Moreover, the requirement of request parameters、error case and error message can refer to this FAQ

Related API:

v2.product.add_item

v2.product.update_item

v2.product.get_item_base_info

Effective Date on Live: 2023/1/12

3.According to Singapore GST regulations, goods and Service Tax for product price and shipping fee is required for imported goods (overseas orders).

We add two new fields final_escrow_product_gst and final_escrow_shipping_gst of API v2.payment.get_escrow_detail for sellers to calculate escrow amount. (Only applicable for cb normal and cb sip primary shop in SG)

Related API:

v2.payment.get_escrow_detail

Effective Date on Live: 2023/1/1

尊敬的开发者，请留意以下变动：

1.支持CNSC和KRSC卖家针对店铺商品部分发布model。

下列是API改动：

1）v2.global_product.create_publish_task API 支持CNSC和KRSC卖家发布店铺商品时设置model_status。当model_status=NORMAL, 则model可售卖，当model_status=UNAVAILABLE, 则model不可售卖。所有model至少要有一个model的model_status=NORMAL；

2）v2.product.get_model_list API添加model_status 字段返回，无论本土还是跨境卖家均返回；

3）v2.product.update_model API仅支持CNSC和KRSC卖家更新model_status。所有model至少要有一个model的model_status=NORMAL，如果所有model设置为model_status=UNAVAILABLE，API 将会报错；

4）如果卖家用v2.global_product.delete_global_model API删除全球商品的model导致店铺商品全部model的model_status=UNAVAILABLE，API将会报错。

影响接口:

v2.global_product.create_publish_task

v2.product.get_model_list

v2.product.update_model

v2.global_product.delete_global_model

上线时间：已上线

2.为了支持台湾销售免税商品的卖家对商品设置税种类别为应税或免税，从而使得卖家可以在shopee开具相应的应税发票与免税发票，现在openapi支持通过v2.product.add_item接口和v2.product.update_item接口通过tax info中的tax type来添加或更新它的税种类型，同时也支持调用v2.product.get_item_base_info接口查询商品的税种类型。目前税种类型用tax_type的值来表示，其中：

tax_type=1:税种类型为应税

tax_type=2:税种类型为免税

tax_type=0:此商品不在此需求的白名单内

此需求白名单配置在shop id与category id维度，对于在tax白名单的商品category来说，目前税种类型的上传方式主要分为2个类别：

1.书籍类：配置到书籍类的category只能遵循书籍的tax上传规则，即通过所传的attribute——ISBN的值来自动读取其tax type的结果，例如入参为ISBN值为9787306075697，自动读取ISBN配置结果为tax_type=2，为免税。

Request

{ "category_id": 400136, "attribute_list": [ { "attribute_id": 100574, "attribute_value_list": [ { "original_value_name": "9787306075697", "value_id": 0, "value_unit": "" } ], "is_mandatory": false, "original_attribute_name": "ISBN 國際標準書號" } ], "tax_info": {}}

Response

{ "item_id": 800396049, "tax_info": { "tax_type": 2 }}

2.生鲜类：配置到生鲜类的category需要遵循此类别的tax上传规则。即通过所传的tax_info中tax_type的值来传入tax类型

Request

{ "category_id": 400148, "tax_info": { "tax_type": 1 }}

Response

{"item_id": 800395979, "tax_info": { "tax_type": 1 }}

此外，Shopee运营会将符合条件的新的category_id加入到生鲜类或书籍类中，后续也可能会增加新的类别，具体的配置情况运营团队会同步给卖家，有关传参要求、异常场景与报错可以参考此FAQ

影响接口:

v2.product.add_item

v2.product.update_item

v2.product.get_item_base_info

上线时间：2023/1/12

3.根据新加坡消费税的规定，进口商品（海外订单）需要缴纳产品价格和运费的商品和服务税。

我们在API v2.payment.get_escrow_detail中增加了两个新字段final_escrow_product_gst和final_escrow_shipping_gst，以便卖家计算escrow_amount。(适用于所有新加坡的跨境店铺)

影响接口:

v2.payment.get_escrow_detail

上线时间：2023/1/1