Significant OpenAPI Updates of Order

资料正文

§1 Significant OpenAPI Updates of Order

Dear Developers

Please find below the OpenAPI updates released this time. These changes aim to enhance functionality, improve flexibility, and provide better integration support.

§2 1. Order/Package PENDING Status Field Update

To alleviate logistics pressure caused by high order volume during peak periods, the platform will temporarily defer shipment processing for certain orders/packages.

To help sellers identify affected orders and avoid accidental shipment triggers, Shopee is adding a new pending_terms option and corresponding descriptive field in the v2.order.get_package_detail and v2.order.get_order_detail APIs.

The API changes are as follows:

The existing pending_terms response parameter now includes a new enum value: ARRANGE_SHIPMENT_PENDING, indicating that shipment has been deferred due to platform logistics scheduling.
A new pending_description response parameter has been added to provide readable explanations corresponding to each pending_terms value.

Updated response fields of v2.order.get_package_detail:

Name	Type	Description
package_list	object[]	/
>>pending_terms	string[]	The list of pending terms. Applicable values: - SYSTEM_PENDING: Under Shopee internal processing. - KYC_PENDING: Under KYC checking (TW CB order only). - ARRANGE_SHIPMENT_PENDING: Temporarily held due to 3PL capacity constraints.
>>pending_description	string[]	The value of this field is the description of pending reason corresponding with pending terms. Applicable values: - For SYSTEM_PENDING: Order is being processed by Shopee. - For KYC_PENDING: Order is pending buyer TW KYC pre-authorization. - For ARRANGE_SHIPMENT_PENDING: Allocating delivery resources due to high order volume. Label print will be available within 4 days after buyer paid.

Updated response fields of v2.order.get_order_detail:

Name	Type	Description
order_list	object[]	/
>>pending_terms	string[]	The list of pending terms. Applicable values: - SYSTEM_PENDING: Under Shopee internal processing. - KYC_PENDING: Under KYC checking (TW CB order only). - ARRANGE_SHIPMENT_PENDING: Temporarily held due to 3PL capacity constraints.
>>pending_description	string[]	The value of this field is the description of pending reason corresponding with pending terms. Applicable values: - For SYSTEM_PENDING: Order is being processed by Shopee. - For KYC_PENDING: Order is pending buyer TW KYC pre-authorization. - For ARRANGE_SHIPMENT_PENDING: Allocating delivery resources due to high order volume. Label print will be available within 4 days after buyer paid.

Related APIs:

v2.order.get_package_detail

v2.order.get_order_detail

Effective Date on Live:

2025.12.12

尊敬的开发者

请查收本次的 OpenAPI 功能更新。这些改动旨在提升功能灵活性、优化使用体验，并为集成提供更好的支持。

§3 1. 订单/包裹 PENDING 状态字段更新

为缓解高峰期订单集中带来的物流压力，平台将对部分订单/包裹进行暂缓发货处理。

为帮助卖家识别因物流调度而暂缓发货的订单/包裹，并避免误触发发货操作，Shopee 在 v2.order.get_package_detail 和 v2.order.get_order_detail 接口中新增状态标识与说明文案。

接口变更如下：

已有的 pending_terms 响应参数新增 ARRANGE_SHIPMENT_PENDING 枚举值，表示因平台物流调度而暂缓发货；
新增 pending_description 响应参数，返回 pending_terms 对应的说明文案。

v2.order.get_package_detail 接口更新后的响应参数如下：

Name	Type	Description
package_list	object[]	/
>>pending_terms	string[]	The list of pending terms. Applicable values: - SYSTEM_PENDING: Under Shopee internal processing. - KYC_PENDING: Under KYC checking (TW CB order only). - ARRANGE_SHIPMENT_PENDING: Temporarily held due to 3PL capacity constraints.
>>pending_description	string[]	The value of this field is the description of pending reason corresponding with pending terms. Applicable values: - For SYSTEM_PENDING: Order is being processed by Shopee. - For KYC_PENDING: Order is pending buyer TW KYC pre-authorization. - For ARRANGE_SHIPMENT_PENDING: Allocating delivery resources due to high order volume. Label print will be available within 4 days after buyer paid.

v2.order.get_order_detail 接口更新后的响应参数如下：

Name	Type	Description
order_list	object[]	/
>>pending_terms	string[]	The list of pending terms. Applicable values: - SYSTEM_PENDING: Under Shopee internal processing. - KYC_PENDING: Under KYC checking (TW CB order only). - ARRANGE_SHIPMENT_PENDING: Temporarily held due to 3PL capacity constraints.
>>pending_description	string[]	The value of this field is the description of pending reason corresponding with pending terms. Applicable values: - For SYSTEM_PENDING: Order is being processed by Shopee. - For KYC_PENDING: Order is pending buyer TW KYC pre-authorization. - For ARRANGE_SHIPMENT_PENDING: Allocating delivery resources due to high order volume. Label print will be available within 4 days after buyer paid.

影响接口：

v2.order.get_package_detail

v2.order.get_order_detail

上线时间：

2025.12.12