POST Search Package
Search Package Shop Required scope: seller.fulfillment.basic Retrieve package IDs based on specified conditions. Package creation time and information update time are the common querying conditions. Version 202309
POST/fulfillment/202309/packages/search
Request
Header
| Properties | Type | Description |
|---|---|---|
| content-type Required | string | Allowed type: application/json |
| x-tts-access-token Required | string | The seller access_token value from Get Access Token, when user_type = 0. Follow this guide to get seller access_token. |
Query
| Properties | Type | Description |
|---|---|---|
| app_key Required | string | Every single app will have a unique key. Please use the specific key assigned to your app. |
| sign Required | string | Signature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders. |
| timestamp Required | int | Unix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time. |
| page_size Required | int | The number of results to be returned per page. Valid range: [1-50]. |
| sort_field | string | The returned results will be sorted by the specified field. Default: create_timePossible values:- create_time- update_time- order_pay_timeSpecify the order for sorting the returned results by using the sort_order parameter. |
| sort_order | string | The sort order for the sort_field parameter. Default: DESCPossible values:- ASC: Ascending order- DESC: Descending order |
| page_token | string | An opaque token used to retrieve the next page of a paginated result set. Retrieve this value from the result of the next_page_token from a previous response. It is not needed for the first page. |
| shop_cipher | string | Use this property to pass shop information in requesting the API. Failure in passing the correct value when requesting the API for cross-border shops will return incorrect response. Get by API Get Authorization Shop |
Body
| Properties | Type | Description |
|---|---|---|
| create_time_ge | int | Filter the packages to show only those that are created after (or at) the specified date and time. Unix timestamp. |
| create_time_lt | int | Filter the packages to show only those that are created before the specified date and time. Unix timestamp. |
| update_time_ge | int | Filter the packages to show only those that are updated after (or at) the specified date and time. Unix timestamp. |
| update_time_lt | int | Filter the packages to show only those that are updated before the specified date and time. Unix timestamp. |
| package_status | string | Possible values:- PROCESSING: Package has been arranged by seller. Waiting for carrier to collect the parcel.- FULFILLING: Package has been collected by carrier and in transit.- COMPLETED: Package has been delivered.- CANCELLED: Package has been canceled. Normally, the package is canceled due to the package being lost or damaged. |
Example
CurlGoNode.jsJavaEnable word wrap
Response Parameters
| Properties | Type | Description |
|---|---|---|
| code | int | The success or failure status code returned in API response. |
| message | string | The success or failure messages returned in API response. Reasons of failure will be described in the message. |
| request_id | string | Request log |
| data | object | Specific return information |
Example
JSONEnable word wrap
Error Code
View common error codes
| Code | Message | | --- | --- | | 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |
Is this content helpful?Helpful
Not Helpful
PreviousNext