来自 Shopee 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 [CB Only] Significant OpenAPI Updates of First-Mile
Dear Developers
Please find below the OpenAPI updates released this time. These changes aim to enhance functionality, improve flexibility, and provide better integration support.
To improve cross-border logistics shipment efficiency, meet compliance requirements from logistics partners, and optimize system performance for historical data queries as well as seller operational experience, Shopee will upgrade the functionality of first mile shipment declaration related APIs.
This update mainly involves optimization of the shipment process under the "Drop Off" mode and adjustments to the historical order data query logic. The detailed updates are as follows:
- v2.first_mile.get_transit_warehouse_list added the following parameters:
● Request parameters: shipment_method
| Name | Type | Description |
|---|---|---|
| shipment_method | string | Use this field to specify the shipment method you want to ship parcel. Available value: pickup, dropoff, self_deliver, courier_delivery. Note: Only when shipment_method = dropoff, the API response will include warehouses where warehouse_type = 1 (vendor warehouse). |
● Response parameters: warehouse_type
| Name | Type | Description |
|---|---|---|
| warehouse_type | int32 | Warehouse type: 0 = normal warehouse 1 = vendor warehouse Note: Only when shipment_method = dropoff, the API response will include warehouses where warehouse_type = 1 (vendor warehouse). |
- v2.first_mile.bind_first_mile_tracking_number adds two new request parameters: warehouse_id, warehouse_type
| Name | Type | Description |
|---|---|---|
| warehouse_id | string | The identity of transit warehouse address. Retrieved from v2.first_mile.get_transit_warehouse_list. |
| warehouse_type | int32 | Warehouse type. Retrieved from v2.first_mile.get_transit_warehouse_list. 0 = normal warehouse 1 = vendor warehouse |
Note: When the first-mile delivery mode is "Drop Off", the warehouse_id and warehouse_type field are all expected to be required field. However, to avoid affecting your existing services, these two fields will be temporarily optional until April 30, 2026. Please complete the integration before then to avoid any impact on your services if it is changed to a required field later.
- To improve the first-mile order query experience, v2.first_mile.get_unbind_order_list will only return orders unbound to first-mile that were created within the past 6 months. Historical orders beyond this time range will no longer be returned, thereby reducing interference from outdated data and improving query efficiency and readability.
Related APIs:
v2.first_mile.get_transit_warehouse_list
v2.first_mile.bind_first_mile_tracking_number
v2.first_mile.get_unbind_order_list
Effective Date on Live：
2023.03.18
尊敬的开发者
请查收本次的 OpenAPI 功能更新。这些改动旨在提升功能灵活性、优化使用体验，并为集成提供更好的支持。
为提升跨境物流发货效率，满足物流合作伙伴的合规要求，同时优化系统历史数据查询性能及卖家操作体验，Shopee将对首公里发货预报相关接口进行功能升级。
本次更新主要涉及"快递自寄 (Drop Off)"模式的发货流程优化及历史订单数据查询逻辑调整。具体更新内容如下：
● 请求参数：shipment_method
| Name | Type | Description |
|---|---|---|
| shipment_method | string | 使用此字段指定您希望使用的包裹寄送方式。 可选值：pickup, dropoff, self_deliver, courier_delivery。 注意：仅当 shipping_method = dropoff 时，API 响应才会包含 warehouse_type = 1（供应商仓库）的仓库。 |
● 响应参数：warehouse_type
| Name | Type | Description |
|---|---|---|
| warehouse_type | int32 | 仓库类型： 0: 普通仓库 1: 供应商仓库 注意：仅当 shipping_method = dropoff 时，API 响应才会包含 warehouse_type = 1（供应商仓库）的仓库。 |
- v2.first_mile.bind_first_mile_tracking_number 新增请求参数：warehouse_id、warehouse_tpye
| Name | Type | Description |
|---|---|---|
| warehouse_id | string | 转运仓标识，通过 v2.first_mile.get_transit_warehouse_list 获取 |
| warehouse_type | int32 | 仓库类型，通过 v2.first_mile.get_transit_warehouse_list 获取 0: 普通仓库 1: 供应商仓库 |
注意：当首公里发货模式为"快递自寄 (Drop Off)"时，warehouse_id 和 warehouse_type 字段预期均为必填项。但是为避免对您的现有服务产生影响，上述字段在2026年4月30日前暂时为非必填，请您在此之前完成对接，避免后续修改为必填项后，对您的服务产生影响。
- 为提升首公里订单查询体验，v2.first_mile.get_unbind_order_list 仅返回过去 6 个月内创建的未绑定首公里的订单数据，超出该时间范围的历史订单将不再返回，从而减少历史订单干扰，提高查询效率和可读性。
影响接口：
v2.first_mile.get_transit_warehouse_list
v2.first_mile.bind_first_mile_tracking_number
v2.first_mile.get_unbind_order_list
上线时间：
2023.03.18