来自 Shopee 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Significant OpenAPI Updates of Order and Logistics
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. [BR] Order and Package Detail APIs Add Invoice Status Information
1. [BR] Order and Package Detail APIs Add Invoice Status Information
To help sellers in Brazil more accurately identify the invoice status of orders and packages, Shopee Open API will add invoice status information to the Order and Package Detail APIs.
After this update, sellers can use Open API to obtain the invoice status and the reason when an invoice fails validation. This allows them to pause the relevant automated shipment process and promptly provide or correct invoice information.
The details are as follows:
The v2.order.get_order_detail API will add the following response field:
| Field Name | Type | Description |
|---|---|---|
| invoice_data | object | Invoice data for the order. |
| >>status | string | Invoice status. Possible values are pending and valid. |
| >>pending_reason | string | The reason when the invoice status is pending. |
The v2.order.get_package_detail API will add the following response field:
| Field Name | Type | Description |
|---|---|---|
| invoice_pending | object | Invoice status information for the order or package. |
| >>status | string | Invoice status. Possible values are pending and valid. |
| >>pending_reason | string | The reason when the invoice status is pending. |
Status Definitions
| Value | Description |
|---|---|
| valid | The invoice has passed validation, or the order does not require an invoice. |
| pending | The system is waiting to receive or validate the invoice. Shipment cannot be arranged at this time. |
Shipment API Validation Update
The v2.logistics.ship_order and v2.logistics.batch_ship_order APIs will validate the real-time invoice status.
If a seller attempts to ship an order or package whose invoice_pending status is pending, the API will block the shipment request and return the corresponding error.
| Error | Message |
|---|---|
| error_pending_invoice | Pending shipment: Please upload the invoice or verify the details of the document already submitted, which is currently flagged as invalid by SEFAZ. Correction is required to release the shipment. |
Notes:
- pending_reason is returned only when the order or package is in a shipment-ready status and the invoice status is pending.
- When the invoice status is not pending, the invoice rejection reason will be ignored by the API, and the related field may be empty.
- pending_reason contains the raw error reason returned by the system.
- Sellers can pause the automated shipment process based on the invoice status and resume shipment after the status is updated to valid.
Affected APIS
Effective Date
July 29, 2026
§3 尊敬的开发者
请查收本次的 OpenAPI 功能更新。这些改动旨在提升功能灵活性、优化使用体验,并为集成提供更好的支持。
§4 1. [BR] 订单与包裹详情 API 新增发票状态信息
1. [BR] 订单与包裹详情 API 新增发票状态信息
为帮助巴西站点卖家更准确地识别订单及包裹的发票状态,Shopee Open API 将在订单与包裹详情接口中新增发票状态信息。
更新后,卖家可通过 Open API 获取发票状态及发票未通过校验时的原因,并据此暂停相关自动发货流程,及时补充或修正发票信息。
具体更新如下:
v2.order.get_order_detail 接口将新增以下 Response 字段:
| Field Name | Type | Description |
|---|---|---|
| invoice_data | object | 订单的发票数据。 |
| >>status | string | 发票状态。可能返回 pending 或 valid. |
| >>pending_reason | string | 发票状态为 pending 时的具体原因。 |
v2.order.get_package_detail 接口将新增以下 Response 字段:
| Field Name | Type | Description |
|---|---|---|
| invoice_pending | object | 订单或包裹的发票状态信息。 |
| >>status | string | 发票状态。可能返回 pending 或 valid. |
| >>pending_reason | string | 发票状态为 pending 时的具体原因。 |
状态说明:
| Value | Description |
|---|---|
| valid | 发票已通过校验,或该订单不需要发票。 |
| pending | 系统正在等待接收或校验发票,暂不可安排发货。 |
发货接口校验更新:
v2.logistics.ship_order 和 v2.logistics.batch_ship_order 将基于实时发票状态进行校验。若卖家尝试对 invoice_pending 状态为 pending 的订单或包裹发起发货请求,接口将阻止该请求并返回对应错误。
当发票状态为 pending 时,接口将返回:
| Error | Message |
|---|---|
| error_pending_invoice | 待发货:请上传发票或核实已提交文件的详细信息,该文件目前被SEFAZ标记为无效。需要更正信息才能放行发货。 |
注意事项:
- pending_reason 仅在订单或包裹处于可安排发货相关状态,且发票状态为 pending 时返回。
- 当发票状态不是 pending 时,接口将忽略发票未通过原因,相关字段可能为空。
- pending_reason 为系统返回的原始错误原因文本。
- 卖家可根据发票状态暂停相关包裹的自动发货流程,并在发票状态更新为 valid 后继续发货。
影响 API :
上线时间:
2026年7月29日