v2.logistics.batch_update_tpf_warehouse_tracking_status
POST /api/v2/logistics/batch_update_tpf_warehouse_tracking_status
For CB orders that fulfilled by 3PF, support 3PF Warehouse Vendors to update the tpf_tracking_status when 3PF warehouse receive the order and complete the outbound of the package. CB orders that fulfilled by 3PF： v2.shop.get_shop_info - shop_fulfillment_flag in {Pure - 3PF Shop,PFF - 3PF Shop,LFF Hybrid Shop} And v2.order.get_order_detail - fulfillment_flag = fulfilled_by_local_seller
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/logistics/batch_update_tpf_warehouse_tracking_status
Common Request Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| partner_id | int | 1 | Partner ID is assigned upon registration is successful. Required for all requests. |
| timestamp | timestamp | 1610000000 | This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes. |
| access_token | string | c09222e3fc40ffb25fc947f738b1abf1 | The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours. |
| shop_id | int | 600000 | Shopee's unique identifier for a shop. Required param for most APIs. |
| sign | string | e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2 | Signature generated by partner_id, api path, timestamp, access_token, shop_id and partner_key via HMAC-SHA256 hashing algorithm. More details: https://open.shopee.com/documents?module=87&type=2&id=58&version=2 |
Request Parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| tpf_name | string | True | Shopee 3PF | The name of 3PF Warehouse Vendor. Prohibit pure numbers and excessive abbreviations. Standardize naming for easy business recognition. Input priority: warehouse English name > full pinyin of warehouse brand name > warehouse Chinese name > other officially recognized and prominent names. |
| tpf_tracking_status | string | True | 3pf_warehouse_outbound_done | The 3PF tracking status for the timestamp. All statuses are in lower case. List of status: - 3pf_warehouse_order_created - 3pf_warehouse_outbound_done |
| package_list | object[] | True | ||
| order_sn | string | True | 2003160SXK2A3T | Shopee's unique identifier for an order. |
| package_number | string | False | OFG38027870177402 | Shopee's unique identifier for the package under an order. |
| update_time | int64 | True | 1610000000 | This is to indicate timestamp of the 3PF tracking status. Timestamp should be within order create time and order pick up by 3PL time. |
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| error | string | Indicate error type if hit error. Empty if no error happened. | |
| message | string | Indicate error details if hit error. Empty if no error happened. | |
| request_id | string | e3e3e7f32b90e1a2b73dc8ca69586501 | The identifier for an API request for error tracking. |
| response | object | ||
| success_list | object[] | Update success order list. | |
| order_sn | string | 2003160SXK2A3T | Shopee's unique identifier for an order. |
| package_number | string | OFG38027870177402 | Shopee's unique identifier for the package under an order. |
| fail_list | object[] | Update fail order list. | |
| order_sn | string | 201214JASXYXY6 | Shopee's unique identifier for an order. |
| package_number | string | OFG134731496217591 | Shopee's unique identifier for the package under an order. |
| fail_error | string | common.error_server | Reason for failure. |
| fail_message | string | Something wrong. Please try later. | Reason for failure. |