v2.logistics.get_booking_tracking_info
GET /api/v2/logistics/get_booking_tracking_info
Use this api to get the logistics tracking information of a booking.
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/logistics/get_booking_tracking_info
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 |
|---|---|---|---|---|
| booking_sn | string | True | 201201E81SYYKE | Shopee's unique identifier for a booking. |
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| request_id | string | 862fc4d77de74edf9bf045c7650f1988 | The identifier for an API request for error tracking. |
| error | string | error_auth | Indicate error type if hit error. Empty if no error happened. |
| message | string | Invalid access_token. | Indicate error details if hit error. Empty if no error happened. |
| response | object | Detail informations you are querying. | |
| booking_sn | string | 201214JASXYXY6 | Shopee's unique identifier for a booking. |
| logistics_status | string | LOGISTICS_REQUEST_CREATED | The Shopee logistics status for the booking. Applicable values. LOGISTICS_REQUEST_CREATED:booking arranged shipment LOGISTICS_PICKUP_DONE:booking handed over to 3PL LOGISTICS_PICKUP_FAILED:booking cancelled by 3PL due to failed pickup or picked up but not able to proceed with delivery LOGISTICS_DELIVERY_DONE:successfully delivered LOGISTICS_REQUEST_CANCELED:cancelled when booking at LOGISTICS_REQUEST_CREATED LOGISTICS_READY:booking ready for fulfilment LOGISTICS_INVALID:cancelled when booking at LOGISTICS_READY LOGISTICS_LOST:booking cancelled due to 3PL lost the parcel |
| tracking_info | object[] | The tracking info of the booking. | |
| update_time | timestamp | 1587375600 | The time when logistics info has been updated. |
| description | string | Your parcel is ready to ship from the seller | The description of booking logistics tracking info.logistics_status |
| logistics_status | string | PICKED_UP | The Shopee logistics status for the booking. TrackingLogisticsStatus: INITIAL ORDER_INIT ORDER_SUBMITTED ORDER_CREATED PICKUP_REQUESTED PICKUP_PENDING PICKED_UP DELIVERY_PENDING DELIVERED LOST UPDATE UPDATE_SUBMITTED UPDATE_CREATED RETURN_STARTED RETURN_PENDING CANCEL CANCEL_CREATED CANCELED FAILED_ORDER_SUBMITTED FAILED_ORDER_CREATED FAILED_PICKUP_REQUESTED FAILED_PICKED_UP FAILED_DELIVERED FAILED_UPDATE_SUBMITTED FAILED_UPDATE_CREATED FAILED_RETURNED FAILED_CANCEL_CREATED FAILED_CANCELED RETURNED RETURN_INTIATED |