v2.first_mile.get_courier_delivery_detail
GET /api/v2/first_mile/get_courier_delivery_detail
Use this api to get first mile detail for courier delivery method.
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/first_mile/get_courier_delivery_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 |
|---|---|---|---|---|
| binding_id | string | True | DCN249237197572VU | Binding ID |
| 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. |
| page_size | int64 | False | 10 | Each result set is returned as a page of entries. Use the "page_size" filters to control the maximum number of entries to retrieve per page (i.e., per call). This integer value is used to specify the maximum number of entries to return in a single "page" of data. limit [1, 50]. |
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 | The identifier for an API request for error tracking. | |
| response | object | ||
| binding_id | string | DCN249237197572VU | Binding ID |
| first_mile_tracking_number | string | ZJS1729224232 | The first mile tracking number. |
| status | string | ORDER_RECEIVED | The logistics status for first-mile tracking number. Status could be: CANCELED CANCELING DELIVERED NOT_AVAILABLE ORDER_CREATED ORDER_RECEIVED PICKED_UP |
| declare_date | string | 2024-10-18 | 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. |
| next_cursor | string | "" | 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. |
| order_list | object[] | ||
| order_sn | string | 2410106R6X5Q85 | Shopee's unique identifier for an order. |
| package_number | string | OFG182232162204802 | Shopee's unique identifier for the package under an order. |
| sls_tracking_number | string | SG246207786489JU | 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. |