v2.first_mile.get_detail

GET /api/v2/first_mile/get_detail

Use this api to get first mile detail.

Endpoint URL

URL: https://partner.shopeemobile.com/api/v2/first_mile/get_detail

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
first_mile_tracking_number	string	True	CNF731738838434210105	The first mile tracking number.
cursor	string	False	""	Specifies the starting entry of data to return in the current call. Default is "". If data is more than one page, the offset can be some entry to start next call.

Response Parameters

Name	Type	Sample	Description
request_id	string		The identifier for an API request for error tracking.
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.
response	object		Detail informations you are querying.
logistics_channel_id	int	813	The identity of logistic channel.
first_mile_tracking_number	string	CNF731738838434210105	The first-mile tracking number.
shipment_method	string	pickup	The shipment method for bound orders, should be pickup or dropoff.
status	string	PICKED_UP	The logistics status for first-mile tracking number. Status could be: NOT_AVAILABLE,ORDER_CREATED,PICKED_UP,DELIVERED,ORDER_RECEIVED,CANCELING,CANCELED. NOT_AVAILABLE status means that either of the two scenarios has happened: 1. First Mile Tracking Number in the request does not exist. (e.g., wrong format) 2. First Mile Tracking Number is not yet bound with any order.
declare_date	string	2020-05-19	The specified delivery date.
more	boolean	false	This is to indicate whether the item list is more than one page. If this value is true, you may want to continue to check next page to retrieve the rest of items.
order_list	object[]		The list of order.
order_sn	string	20012328KKGVR0	Shopee's unique identifier for an order.
package_number	string	25333320394471234567	Shopee's unique identifier for the package under an order.
sls_tracking_number	string	TW211342705212345	The tracking number of SLS for orders/forders.
pick_up_done	boolean	false	Use this filed to indicate whether the order has been picked up by carrier.
arrived_transit_warehouse	boolean	false	Use this filed to indicate whether the order has arrived at transit warehouse.
next_cursor	string	"100"	If more is true, you should pass the next_cursor in the next request as cursor. The value of next_cursor will be empty string when more is false.