Significant OpenAPI Updates

Dear Developers,

Please note the following changes:

1.[MY] Important Update for Open Platform Shopee Logistics API (Instant Delivery by ShopeeFood)

Please find the following updates below are effective for Shopee MY local whitelisted sellers in Klang Valley only.

Please note that starting from 18 September 2023, Shopee will rollout a new shipping carrier called "Instant Delivery by ShopeeFood” (Channel ID: 22000). This channel only supports Klang Valley orders with delivery distance not more than 30km.

Kindly note the changes for the response data in the response body regarding Shipping Carrier Related APIs.

Scenario

When developers call v2.order.get_order_detail, or v2.logistics.get_shipping_document_info, the response body will be as follows:

Sample of Response body:

v2.order.get_order_detail

v2.logistics.get_shipping_document_data_info

Action to take from developers

When calling this API “v2.logistics.get_shipping_document_data_info”,

If the Response body field "shipping_carrier" returns the "shipping_carrier" named "Instant Delivery by ShopeeFood", the developer should hardcode the wording "Instant Delivery" under Order Details (Courier) at the top right of the AWB.

For this channel, sellers are able to pre-print AWB before arranging shipment.

The API calling method is the same as normal.

AWB Sample:

Note

Seller pickup address is compulsory to have geolocation and distance between pickup and delivery address must be within 30km in order to successfully generate tracking numbers for an order.

Related APIs

v2.logistics.get_channel_list

v2.logistics.update_channel

v2.product.add_item

v2.product.update_item

v2.product.get_item_base_info

v2.logistics.get_shipping_parameter

v2.logistics.get_tracking_number

v2.logistics.get_shipping_document_parameter

v2.order.get_order_detail

v2.logistics.get_shipping_document_data_info

Effective Date on Live: 2023.09.18

2.Please find the following update below are effective for Shopee local whitelisted sellers.

Add new fields "order_adjustment","total_adjustment_amount"and "escrow_amount_after_adjustment" for v2.payment.get_escrow_detail API to get the adjustment value.

Note: If the order without adjustment, no returned of the field "order_adjustment".

Related API:

v2.payment.get_escrow_detail

Effective Date on Live: 2023.09.20

2.以下更新仅适用于local白名单店铺：

v2.payment.get_escrow_detail接口新增字段 "order_adjustment" ,"total_adjustment_amount"以及 "escrow_amount_after_adjustment" 用于获取订单的调整金额。

Note: 如订单不包含adjustment，则字段"order_adjustment"将不返回。

Related APIs

v2.payment.get_escrow_detail

Effective Date on Live: 2023.09.20