Significant OpenAPI Updates

Dear Developers,

Please note the following changes:

1.[Only Apply for VN/ID shops please add this field below to your customized airwaybill]

Add one new field "mutual_check" for customized airwaybill API indicates whether the parcel is eligible for Return-on-the-Spot (RoS) co-check.

RoS (co-check) is a service where buyers are allowed to open and inspect their goods when the driver delivers their parcels.

If mutual_check=1, then the parcel is RoS eligible, where drivers and buyers can co-check the parcel. Buyer can then choose to accept or reject the parcel on the spot.

If mutual_check=0, then the parcel is ineligible for RoS.

Related APIs:

v2.logistics.get_shipping_document_data_info

Effective Date on Live: 2023.05.18

2.[Only Apply for BR local shop]

In order to enhance the experience of our users, we will stop using NF-e access key (access_key) to upload invoice information, i.e. offline v2.order.add_invoice_data API, the specific sunset time of this API is July 10, 2023 Brazilian time.

For BR local shops, we will start using invoices with XML files only.

Please upload invoices with XML files via v2.order.upload_invoice_doc API and download invoice files via v2.order.download_invoice_doc API.

Here's the sample of request v2.order.upload_invoice_doc API:

{

"order_sn": "201218V2Y6E59M",

"file_type": "4",

"file": "path/to/file"

}

Note:

1)"file_type"used for XML is "4";

For invoice download, it will only apply to orders that have previously completed uploading the invoice data.

Related APIs:

v2.order.upload_invoice_doc

v2.order.download_invoice_doc

v2.order.add_invoice_data

Effective Date on Live: Lived

3.By the end of March 2023, all the existing authorized sellers have been switched from Open API v1.0 to Open API v2.0, so v2.public.get_refresh_token_by_upgrade_code is also planned to be taken offline on 2023.07.10, meanwhile, before the API is taken offline, if there are still Original type of APP is not finished upgrading, it will also be retired.

Related APIs:

v2.public.get_refresh_token_by_upgrade_code

Effective Date on Live: 2023.07.10

1)Name changed of the field "country"to"region"of v2.shop.get_warehouse_detail API.

Related APIs:

v2.shop.get_warehouse_detail

Effective Date on Live: 2023.05.22

Name changed of the field "brand_country"to"brand_region"of v2.product.register_brand API.

Related APIs:

v2.product.register_brand

Effective Date on Live: 2023.05.25

Please complete the adjustment of the above two APIs before the corresponding effective date.

尊敬的开发者：

请留意以下变动:

1.(仅适用于越南和印尼卖家，自画面单需包含以下新字段)

自画面单接口新增字段"mutual_check", 表示包裹是否有资格进行Return-on-the-Spot（RoS）联合检查。

RoS(联合检查)是在司机交付包裹时，允许买家打开并检查他们的货物的服务。

如果mutual_check=1，那么该包裹符合RoS（联合检查）条件，司机和买家可以共同检查该包裹。然后买方可以选择当场接受或拒绝该包裹。

如果mutual_check=0，那么该包裹不符合RoS（联合检查）资格。

影响接口：v2.logistics.get_shipping_document_data_info

上线时间：2023.05.18

2.（仅适用于BR local卖家）

为了提升我们用户的体验，我们将停止使用 NF-e 访问密钥 (access_key)来上传发票信息，即下线v2.order.add_invoice_data API，该接口下线时间是巴西时间2023.07.10。

对于BR本土店铺，我们将开始仅使用带有XML文件的发票。请通过 v2.order.upload_invoice_doc API 上传带有 XML 文件的发票，通过 v2.order.download_invoice_doc API 下载发票文件。

以下是 v2.order.upload_invoice_doc API 请求的示例：

{

"order_sn": "201218V2Y6E59M",

"file_type": "4",

"file": "path/to/file"

}

注意：

1）用于 XML 的"file_type"为"4";

2）完成上传发票后，才可以调用v2.order.download_invoice_doc 下载发票;

影响接口：

v2.order.upload_invoice_doc

v2.order.download_invoice_doc

v2.order.add_invoice_data

上线时间：

已上线

3.截止2023年3月底，所有存量的授权卖家已完成从Open API v1.0切换至Open API v2.0，因此v2.public.get_refresh_token_by_upgrade_code也计划于2023.07.10下线，与此同时，在接口下线前，如仍有Original类型的APP未完成升级，也将被清退。

影响接口：

v2.public.get_refresh_token_by_upgrade_code

上线时间：2023.07.10

1)v2.shop.get_warehouse_detail接口的"country"字段命名修改为"region"。

影响接口:v2.shop.get_warehouse_detail

上线时间：2023.05.22

2)v2.product.register_brand接口的"brand_country"字段命名修改为brand_region。

影响接口:v2.product.register_brand

上线时间：2023.05.25

请在对应的生效时间之前完成上述两个接口的调整。

Significant OpenAPI Updates

资料正文

§1 Significant OpenAPI Updates