v2.order.search_package_list
POST /api/v2/order/search_package_list
Use this API to search the list of packages that have not been SHIPPED to proceed arranging shipment, and it supports various filters and sort fields.
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/order/search_package_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 |
|---|---|---|---|---|
| filter | object | False | ||
| package_status | int32 | False | 2 | Use this field to filter the packages of specific status. Applicable values: 0: All 1: Pending 2: ToProcess 3: Processed Default value = 2 (ToProcess) |
| product_location_ids | string[] | False | ["VN0005EIZ"] | List of product_location_id. Use this field to filter the packages under specific warehouses. |
| logistics_channel_ids | int32[] | False | [50021] | List of logistics_channel_id. Use this field to filter the packages under specific logistics channels. |
| fulfillment_type | int32 | False | 2 | Use this field to filter the packages fulfilled by shopee or seller. Applicable values: 0: None (not apply filter) 1: Shopee 2: Seller Default value = 2 (Seller) |
| invoice_pending | boolean | False | false | Use this field to filter the packages under invoice_pending. Default value = false |
| sorting_group | int32 | False | 1 | [Only for TW 30029 channel] Use this field to filter the sorting group of parcel. This field is only available for package with package_status = 3 and logistics_channel_id = 30029. Applicable values: 0: All 1: North 2: South |
| order_type | int32 | False | 0 | Use this field to filter packages by order type. Applicable values: 0: All 1: Regular Order 2: Instant Order Default value = 0 (All) Note: For VN shops, using 2: Instant Order will return both Instant Delivery and Same-day Delivery packages. |
| is_pre_order | int32 | False | 0 | Use this field to filter packages by pre-order status. Applicable values: 0: All 1: Pre-Order 2: Non Pre-Order Default value = 0 (All) |
| shipping_priority | int32 | False | 0 | Use this field to filter packages by shipping priority. Applicable values: - For MY/PH/TW/TH shops, and VN Preferred/Preferred Plus/Shopee Mall shops: 0: All 1: Overdue 2: Ship by Today 3: Ship by Tomorrow - For other shops： 0: All 1: Overdue 2: Within 24h 3: Beyond 24h Default value = 0 (All) |
| pagination | object | True | ||
| page_size | int32 | True | 5 | 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.The limit of page_size if between 1 and 100. |
| 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. |
| sort | object | False | ||
| sort_type | int32 | False | 1 | Use this field to specify which field to use to sort the returned package list. Available values: 1: ShipByDate 2: CreateDate 3: ConfirmedDate Default value = 1 (ShipByDate) |
| ascending | boolean | False | false | Use this field to specify whether the returned package list is sorted in ascending or descending sort_type. Default value = true |
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| error | string | error_auth | Indicate error type if hit error. Empty if no error happened. |
| mesage | string | Invalid access_token | Indicate error details if hit error. Empty if no error happened. |
| response | object | ||
| packages_list | object[] | ||
| order_sn | string | "250211UJM7EVM7" | Shopee's unique identifier for an order. |
| package_number | string | "OFG192947720204989" | Shopee's unique identifier for the package under an order |
| logistics_channel_id | int32 | 50021 | The identity of logistic channel. |
| product_location_id | string | "VN0005EIZ" | Just use this field to pass the next step of Mass ArrangeShipment |
| sorting_group | string | "North" | [Only for TW 30029 channel] This field indicate the sorting group value of the package. This field is only available for logistics_channel_id = 30029 and after the package has been arranged for shipment. |
| is_shipment_arranged | boolean | false | Only effective when the package's logistics_status/fulfillment_status is LOGISTICS_READY. This parameter further distinguishes between two scenarios: - true: Package shipment has been arranged (Seller has processed shipment, system is generating tracking number, not yet updated to LOGISTICS_REQUEST_CREATED, no duplicate action needed) - false: Package awaiting shipment arrangement (Seller hasn't processed shipment yet, shipping arrangement required) |
| pagination | object | ||
| total_count | int64 | 320 | Total orders can be returned with your query |
| next_cursor | string | "1730437200,184066343203459" | if packages is not empty or length of packages <= page_size. You should pass the next_cursor in the next request as page_sentinel. |
| more | boolean | true | To indicate, it's a the last page or not |
| sort | object | As same as request param | |
| sort_type | int32 | 1 | As same as request param |
| is_asc | boolean | false | As same as request param |
| request_id | string | 69ee3f61ec6f4e3f85836391e5b78dbc | The identifier for an API request for error tracking. |