Significant OpenAPI Updates

Dear Developers,

Please find the below updates:

Due to system maintenance, the test-stable environment will be inaccessible from 01:00 pm May 22 to 07:00 am May 23. Really apologize for the impact to you.

Effective Date on Test-stable: 2021.05.22 13:00-2021.05.23 07:00

Related APIs: ALL

Update the former announcement about the split order process adjustment (https://open.shopee.com/announcement/116), the forder_id field will stop responding from 2021.06.07, please switch to package_number as soon as possible.

Effective Date on Test-stable: 2021.06.07

Related APIs:

Open API 1.0

shopee.orders.SplitOrder

shopee.orders.GetForderInfo

shopee.logistics.Init

shopee.logistics.GetOrderLogistics

shopee.logistics.GetForderWaybill

shopee.logistics.GetLogisticsMessage

To TW site, respond the thermal AWB with default when calling the shopee.logistics.GetAirwayBill API; also respond the thermal AWB when calling the v2.logistics.create_shipping_document without shipping_document_type field.

Effective Date on Live: 2021.03.01

Related APIs:

Open API 1.0

shopee.logistics.GetAirwayBill

Open API 2.0

v2.logistics.create_shipping_document

Added a new API shopee.orders.AddInvoiceData to support the BR local seller input invoice data before ship order in Total Express channel, the API will check if the invoice date is right or not, please make sure to input the right invoice data.

Added another new API shopee.orders.GetInvoiceOrder that responds to the order list by the invoice status.

The shopee.orders.GetOrderDetails added invoice_date object that responds to the invoice date which the seller added.

Effective Date on Live: Lived

Related APIs:

Open API 1.0

shopee.orders.AddInvoiceData

shopee.orders.GetInvoiceOrder

shopee.orders.GetOrderDetails

Open API respond the 302 transaction type, which include:

TW local order when paid by non CC channel/seller wallet
MY, ID, TW, VN sites when there is an SVS auto refund to Seller Wallet (original payment channel)
SPM cannot return to the original payment channel so they auto-refund to Seller Wallet

Effective Date on Live: Lived

Related APIs:

Open API 1.0

shopee.payment.GetTransactionList

Add a new toggle of whitelist and blacklist to control the drop off permission of the shop.

If the channel belongs to whitelist mode and the shop_id is in the whitelist, the shop will be able to use drop off .Otherwise the shop cannot drop off.

If the channel belongs to blacklist mode and the shop_id is in the blacklist, the shop won’t be able to use drop off.Otherwise the shop can drop off.

The toggle can be controlled by Shopee ops.If the shop is in blacklist, the drop off information in related api will not return and the init api will return "This order does not support ship with dropoff."

Effective Date on Live: 2021.05.27

Related APIs:

Open API 1.0

shopee.logistics.GetParameterForInit

shopee.logistics.GetLogisticInfo

shopee.logistics.Init

Open API 2.0

v2.logistics.get_shipping_parameter

v2.logistics.ship_order

v2.logistics.batch_ship_order

SG region’s normal shipping document type has changed to A5 awb+packlist and its thermal shipping document has changed to A6 awb.If you use openapi 1.0 the toggle will be controlled totally by the toggle in Seller center’s shipping setting.If you use openapi 2.0 the toggle can be controlled by your input parameter "shipping_document_type" to change to the Airwaybill type you want to print.

Effective Date on Live:lived

Related APIs:

Open API 1.0

shopee.logistics.GetAirwayBill

shopee.logistics.GetForderWaybill

Open API 2.0

v2.logistics.create_shipping_document

v2.logistics.download_shipping_document

尊敬的開發者，

請留意以下更新：

因係統維護，2021.05.22 13:00到2021.05.23 07:00 test-stable環境將不可訪問，給各位開發者帶來影響敬請諒解。

測試環境上線日期：2021.05.22 13:00-2021.05.23 07:00

影響接口：所有

關於拆單相關接口調整的公告更新（https://open.shopee.com/announcement/116）， forder_id 將會在2020年6月7日下線，還請盡快切換到package_number字段。

上線日期： 2021.06.07

影響接口：

Open API 1.0

shopee.orders.SplitOrder

shopee.orders.GetForderInfo

shopee.logistics.Init

shopee.logistics.GetOrderLogistics

shopee.logistics.GetForderWaybill

shopee.logistics.GetLogisticsMessage

TW 站點，OpenAPI 1.0中GetAirwayBill接口默認打印Thermal面單；v2.logistics.create_shipping_document 接口當shipping_document_type為空時，默認打印Thermal面單；

上線日期：已上線

影響接口：

Open API 1.0

shopee.logistics.GetAirwayBill

Open API 2.0

v2.logistics.create_shipping_document

為支持巴西Local渠道Total Express在發貨前上傳發票信息，新增shopee.orders.AddInvoiceData接口支持上傳發票，並增加發票準確性校驗，還請上傳正確的發票信息；新增shopee.orders .GetInvoiceOrder接口支持根據發票狀態查詢訂單列表，shopee.orders.GetOrderDetails接口新增返參invoice_data結構體用以查詢訂單發票信息。

上線日期：已上線

影響接口：

Open API 1.0

shopee.orders.AddInvoiceData

shopee.orders.GetInvoiceOrder

Open API支持查詢transaction type為302的交易記錄，其中場景包括：

台灣Local 訂單退款
非Credit card和Seller Wallet渠道支付的退款
MY、ID、TW、VN，SVS 訂單自動退款到Seller Wallet或SPM無法原返時

上線日期：已上線

影響接口：

Open API 1.0

shopee.payment.GetTransactionList

新增白名單和黑名單開關，控制店鋪的dropoff許可權。如果該渠道屬於白名單模式，並且店鋪id在白名單中，則店鋪可以使用dropoff，否則店鋪不能dropoff。如果該渠道屬於黑名單模式，且店鋪id在黑名單中，則該店鋪將不能使用dropoff，否則該店鋪可以dropoff。此開關可由Shopee運營控制，如果店鋪在黑名單中，則相關api中的下線資訊不會返回，init接口將返回"This order does not support ship with dropoff."

上線日期：2021.05.27

影響接口：

Open API 1.0

shopee.logistics.GetParameterForInit

shopee.logistics.GetLogisticInfo

shopee.logistics.Init

Open API 2.0

v2.logistics.get_shipping_parameter

v2.logistics.ship_order

v2.logistics.batch_ship_order

SG區域的正常裝運單據類型已更改為A5 awb+裝箱單，熱敏裝運單據已更改為A6 awb。如果使用openapi 1.0，則切換將完全由賣方中心裝運設定中的開關控制。如果使用openapi 2.0，則切換可由輸入參數“shipping_document_type”控制更改為要列印的Airwaybill類型。

上線日期：已上線

影響接口：

Open API 1.0

shopee.logistics.GetAirwayBill

shopee.logistics.GetForderWaybill

Open API 2.0

v2.logistics.create_shipping_document

v2.logistics.download_shipping_document

Significant OpenAPI Updates

资料正文

§1 Significant OpenAPI Updates