v2.logistics.update_tracking_status
POST /api/v2/logistics/update_tracking_status
Only available for Brazil sellers. This API is only available for orders/parcels which are fulfilled by BR Seller Logistics channel (logistics_channel_id: 90021), Samsung (logistics_channel_id: 90025) and BR Instant Delivery channel (logistics_channel_id: 90026). The logistics_status will become LOGISTICS_REQUEST_CREATED after arrange shipment, and can call this API to update to: LOGISTICS_PICKUP_DONE, LOGISTICS_DELIVERY_DONE, LOGISTICS_DELIVERY_FAILED.
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/logistics/update_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 |
|---|---|---|---|---|
| order_sn | string | True | 201212DCXHJUIKJ | Shopee's unique identifier for an order. |
| tracking_number | string | False | 1234567890 | Order tracking number, might help seller to identify his order on the tracking_URL. Can only be sent when updating logistics_status to "logistic_pickup_done". |
| tracking_url | string | False | https://tracking\_url\_order\_201212DCXHJUIKJ | Website's URL for order tracking with maximum length of 2048 characters. Can only be sent when updating logistics_status to "logistic_pickup_done". |
| logistics_status | string | True | logistics_pickup_done | Order status update support: - logistics_pickup_done - logistics_delivery_done - logistics_delivery_failed |
| failed_reason | string | False | buyer_unreachable | Only required when updating logistics_status to "logistics_delivery_failed". Only required for BR Instant Delivery channel (logistics_channel_id: 90026). Only accept the following values. - buyer_unreachable - buyer_unresponsive - no_delivery_location_consensus |
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| request_id | string | e9b086380a7dcdc408cb5ebe2cf38041 | API request identifier |
| error | string | Error code | |
| message | string | Error message | |
| warning | string | ||
| response | object | Response body | |
| update_result | string | succeed | Update results: - succeed - failed |