Significant Open Platform and OpenAPI Updates

Dear Developers,

Please note the following changes:

1.Please note the following update on Open Platform Console function.

To optimize your push line, we have introduced the Push Service Deployment Area feature, which ensures that your line and your server's deployment address are the same, and the feature is now live.

[For your action]

Please check whether "The Deployment Service Area of your Call Back URL" is the same as the server area, if not, please adjust to the location where your server is deployed.

2.The updates below are only applicable to Shopee selected sellers in the markets of SG TH TW MY, regardless of local or CB.

For better experience of v2.order.split_order, we had removed some of the limitations on split orders.

Details as follow:

Summarized as follow:

1. The split order permission for unit level is now only for whitelisted sellers, if you encounter "Cannot split order with items in one bundle-deal or add-on deal into different packages" or "Unknown error, detail: error_key:FULFILLMENT_ORDER_SPLIT_WRONG_ITEM_QUANTITY.", you need to contact Shopee business manager to apply for whitelisting privileges.

2. Items under the same bundle deal and add on deal promotion can be split into different packages.

The order_item_id of the items in the v2.order.get_order_detail API is the same, indicating that they are in the same Bundle deal, and the add_on_deal_id is the same, indicating that they are in the same add on deal.

3. If a buyer purchases multiple items with the same specifications, split is also supported.

eg: If buyer purchases cell phone A (blue)*2 and cell phone A (red)*4, it can be freely combined and split into multiple parcels, such as: parcel 1: cell phone A (blue)*1, parcel 2: cell phone A (red)*3, parcel 3: cell phone A (blue)*1, parcel 4: cell phone A (red)*1.

To implement the new order splitting capability described above, the open API is updated as follows:

v2.order.split_order API adds a new optional request field "model_quantity", which is only applicable to whitelisted sellers.

Tips:

If a shop is not whitelisted but passes the "model_quantity" field when splitting order, it responds with the error "Unknown error, detail: error_key:FULFILLMENT_ORDER_SPLIT_WRONG_ITEM_QUANTITY.".

Related API:

v2.order.split_order

Effective Date on Live:

December 28, 2023

3. To further improve the developer experience, we have updated the Open API Return&Refund dispute flow to consistent with Shopee Seller Center.

Detailed as follow:

1. Add a new Open API v2.return.get_return_dispute_reason to get the available dispute reasons for specific return refund cases.

2. Add a new request field "dispute_reason_id" to the v2.return.dispute API for filing a dispute.

3.Support for sellers to raise a dispute to request seller compensation via the v2.return.dispute API.

New flow:

1. Call the new v2.returns.get_return_dispute_reason API to get the reason for the dispute.

2.Use the appropriate "disput_reason_id" request to call v2.returns.dispute to raise the dispute.

Deprecation plan for the old request field "disput_reason" in v2.returns.dispute:

Related APIs:

v2.returns.get_return_dispute_reason

v2.returns.dispute

Effective Date on Live:

December 28, 2023

尊敬的开发者,

请留意以下变动:

1.请留意开放平台 Console 功能的变动：

为了您的push线路可以达到最优，我们上线了Push 选择服务部署地区的功能，保证您的线路和您服务器的部署地址是一致的，目前该功能已经上线。

[需要采取的行动］

检查"The Deployment Service Area of your Call Back URL"是否和服务器所在区域一致，若不一致可以自行调整至您的服务器部署的位置。

2. 以下更新仅适用于SG TH TW MY市场的Shopee 白名单卖家。

为顺应业务发展，进一步提升用户体验，我们移除了一些关于拆分订单的限制。

详情如下：

总结:

1.最细粒度的拆单权限现在只针对白名单卖家，如果您在调用v2.order.split_order api时遇到"Cannot split order with items in one bundle-deal or add-on deal into different packages" 或者 "Unknown error, detail: error_key:FULFILLMENT_ORDER_SPLIT_WRONG_ITEM_QUANTITY."的错误，需要卖家联系Shopee业务经理申请白名单权限。

2.在同一个Bundle deal及add on deal活动下的商品也支持拆分到不同的包裹。v2.order.get_order_detail API中item的order_item_id 相同，表示在同一个Bundle deal，add_on_deal_id相同，表示在同一个add on deal。

3.如果买家购买多个相同规格的商品，也支持拆分。

eg: 买家购买了手机 A（蓝）*2 和手机 A（红）*4，则可自由组合拆分成多个包裹，如：包裹 1：手机 A（蓝）*1，包裹 2：手机 A（红）*3，包裹 3：手机 A（蓝）*1，包裹 4：手机 A（红）*1。

为实现上述新的拆单能力，接口更新如下：

v2.order.split_order API 添加一个新的可选请求字段"model_quantity"，该字段仅适用于白名单卖家。

Tips:

如果店铺不在白名单中，但在拆分订单时传递了 "model_quantity "字段，则会响应错误："Unknown error, detail: error_key:FULFILLMENT_ORDER_SPLIT_WRONG_ITEM_QUANTITY." 。

影响接口：

v2.order.split_order

生效日期:

2023年12月28日

3.为进一步优化开发者体验，我们更新了Open API 侧关于退货和退款发起争议流程，使发起争议流程与Shopee卖家中心一致。

具体更新：

1.新增一个新的Open API v2.return.get_return_dispute_reason，以获取特定退货退款案例可用争议原因。

2.为v2.return.dispute接口增加新的请求字段 "dispute_reason_id"，以提出争议。

3.新增支持卖家通过 v2.return.dispute API 发起dispute来申请卖家赔偿。

新的发起争议流程：

1.调用新接口 v2.returns.get_return_dispute_reason 获取争议原因。

2.使用相应的 "disput_reason_id "请求调用 v2.returns.dispute 发起争议。

v2.returns.dispute 中旧请求字段 "disput_reason "的弃用计划:

影响接口：

v2.returns.get_return_dispute_reason

v2.returns.dispute

生效日期：

2023年12月28日