v2.first_mile.get_unbind_order_list
GET /api/v2/first_mile/get_unbind_order_list
Use this api to get unbind order list. It will only return orders unbound to first-mile that were created within the past 6 months.
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/first_mile/get_unbind_order_list
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 |
|---|---|---|---|---|
| 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 | int32 | 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, 100] |
| response_optional_fields | string | False | logistics_status,package_number | Indicate response fields you want to get. Please select from the below response parameters. If you input an object field, all the params under it will be included automatically in the response. If there are multiple response fields you want to get, you need to use English comma to connect them. Available values: logistics_status,package_number. |
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| request_id | string | YsmmEesFTPEUfSVeqvVmwOrplMpgulHB | 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 | success | Indicate error details if hit error. Empty if no error happened. |
| response | object | Detail informations you are querying. | |
| 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 result list of order you querying. | |
| order_sn | string | 201224EM1FMFG1 | Shopee's unique identifier for an order. |
| package_number | string | 91238191238123 | Shopee's unique identifier for the package under an order. |
| logistics_status | string | LOGISTICS_PICKUP_DONE | The Shopee logistics status for the order. Applicable values: See Data Definition- LogisticsStatus. |
| next_cursor | string | "10" | 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. |