来自 Shopee 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Significant OpenAPI Updates of Return, Logistics, Payment
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. [TW Only] Support Seller Collection PIN Code Retrieval for Return and RTS parcel
1. [TW Only] Support Seller Collection PIN Code Retrieval for Return and RTS parcel
To optimize the parcel collection experience for sellers in the TW market, we are introducing an update to provide Collection PIN Codes via OpenAPI. This enhancement allows sellers to retrieve PIN codes required for picking up C2C Return and RTS parcels at SPX service points.
- For Return Parcel Scenarios
A new field will be added to the Return API to support collection PIN codes for return parcels.
Affected API: v2.returns.get_reverse_tracking_info
| Field Name | Type | Description |
|---|---|---|
| collection_pin_code | String | The unique 6-digit PIN code for sellers to collect return parcels at service points. This field is returned when a PIN code is available. |
(Applies only when the return parcel uses reverse logistics channels associated with SPX.)
- For RTS parcel Scenarios
For parcels that fail delivery and are returned to the service point (Return to Seller), the collection PIN code will now be available via the Logistics API to ensure sellers can retrieve their items promptly.
Affected API: v2.logistics.get_tracking_info
| Field Name | Type | Description |
|---|---|---|
| collection_pin_code | String | The unique 6-digit PIN code for sellers to collect RTS parcels at service points. This field is returned when a PIN code is available. |
(Applies only when the return parcel uses logistics channels associated with SPX.)
Effective Date on Live:
May 25, 2026
§3 2. [BR Only] Pickup Address SRN Validation Update
2. [BR Only] Pickup Address SRN Validation Update
To help BR CNPJ sellers ensure that their Pickup Address is consistent with valid State Registration Number (SRN) information, Shopee will enhance the SRN validation logic for Pickup Address-related scenarios. This update adds new SRN validation error messages to help reduce fulfillment and electronic transport document processing issues caused by missing, invalid, or mismatched tax information.
When BR CNPJ sellers call v2.logistics.update_address or v2.logistics.set_address_config to set or update a Pickup Address, the following error message will be returned if the address state does not have a valid SRN record, if the matched SRN status is invalid, or if the Pickup Address state does not match the seller’s KYC / SRN information.
| Error Message | Description |
|---|---|
| BR pickup address SRN record not found. | The selected Pickup Address state does not have a valid SRN record. |
| BR pickup address SRN is invalid. | The matched SRN record exists, but its current status is invalid. |
| BR pickup address state does not match SRN | The Pickup Address state does not match the seller’s KYC / SRN information. |
Note: This update only adds new error messages for API validation. There are no changes to the request parameters, response parameters, or field structure of v2.logistics.update_address and v2.logistics.set_address_config.
Developers are advised to optimize their error handling logic based on the error messages above and guide sellers to check whether their Pickup Address and SRN information are consistent.
Related APIs：
v2.logistics.update_address v2.logistics.set_address_config
Effective Date on Live：
May 28, 2026
§4 3. [ID Local Only] Support for Transaction Title Information
3. [ID Local Only] Support for Transaction Title Information
To enhance the display of wallet transaction information, the txn_title field has been added to the get_wallet_transaction_list API to return transaction title information.
Applicable Scope
ID local sellers only
Update Details
A new response field, txn_title, has been added to v2.payment.get_wallet_transaction_list to return transaction title information.
Affected API：
v2.payment.get_wallet_transaction_list
Effective Date：
Lived
尊敬的开发者
请查收本次的 OpenAPI 功能更新。这些改动旨在提升功能灵活性、优化使用体验，并为集成提供更好的支持。
§5 1. [TW] 支援透過 OpenAPI 取得退貨包裹及運送失敗包裹的取件驗證碼
1. [TW] 支援透過 OpenAPI 取得退貨包裹及運送失敗包裹的取件驗證碼
為了優化台灣市場賣家在蝦皮店到店門市的取件體驗，OpenAPI 將提供 ”取件驗證碼” 的資訊。此功能將允許賣家透過 OpenAPI 取得在蝦皮店到店領取 門市交寄的 “退貨包裹” 及 ”運送失敗包裹” 時所需的取件驗證碼。
- 退貨包裹情境
Return API 將新增一個 Response 欄位，以支援取得退貨包裹的取件驗證碼。
影響 API: v2.returns.get_reverse_tracking_info
| Field Name | Type | Description |
|---|---|---|
| collection_pin_code | String | The unique 6-digit PIN code for sellers to collect return parcels at service points. This field is returned when a PIN code is available. |
（僅適用於使用蝦皮店到店相關的逆物流選項的退貨包裹。）
- 運送失敗包裹情境
Logistics API 將新增一個 Response 欄位，以支援取得運送失敗並退回門市包裹的取件驗證碼。
影響 API: v2.logistics.get_tracking_info
| Field Name | Type | Description |
|---|---|---|
| collection_pin_code | String | The unique 6-digit PIN code for sellers to collect RTS parcels at service points. This field is returned when a PIN code is available. |
（僅適用於使用蝦皮店到店相關的物流選項的運送失敗包裹。）
上線時間 ：
May 25, 2026
§6 2. [BR Ony]取件地址 SRN 校验更新
2. [BR Ony]取件地址 SRN 校验更新
为帮助 BR CNPJ 卖家确保取件地址与有效的州注册号（SRN：State Registration Number）信息保持一致，Shopee 将加强取件地址相关的 SRN 校验逻辑，并在取件地址相关校验中新增 SRN 校验错误信息，以降低因缺失、无效或不匹配的税务信息导致的履约与电子运输文件处理问题。
当 BR CNPJ 卖家调用 v2.logistics.update_address和 v2.logistics.set_address_config设置或更新取件地址时，若该地址所在州未配置有效 SRN、匹配到的 SRN 状态无效，或取件地址所在州与卖家 KYC / SRN 信息不一致，将返回以下 error message。
| Error Message | 说明 |
|---|---|
| BR pickup address SRN record not found. | 所选取件地址的州没有有效的 SRN 记录 |
| BR pickup address SRN is invalid. | 已匹配到 SRN 记录，但该 SRN 当前状态无效。 |
| BR pickup address state does not match SRN | 取件地址所在州与卖家 KYC / SRN 信息不匹配。 |
注意：本次更新仅新增API调用校验的报错信息，不涉及 v2.logistics.update_address 和 v2.logistics.set_address_config 的入参、出参或字段结构变更。
建议开发者根据上述错误信息优化异常处理逻辑，并引导卖家检查取件地址与 SRN 信息是否一致。
影响接口：
v2.logistics.update_address v2.logistics.set_address_config
上线时间：
2026 年 5 月 28 日
§7 3. [ID local Only]支持返回交易标题信息
3. [ID local Only]支持返回交易标题信息
为支持钱包交易信息展示优化，平台已在get_wallet_transaction_list接口中新增 txn_title 字段，用于返回交易标题信息。
适用范围
仅限 ID 本地卖家
更新内容
v2.payment.get_wallet_transaction_list新增返回 txn_title 字段，用于返回交易标题信息。
影响接口：
v2.payment.get_wallet_transaction_list
上线时间：
Lived