POST Get Order List
Get Order List Shop Required scope: seller.order.info Returns a list of orders created or updated during the timeframe indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned, such as order status, delivery option type, and buyer user ID. Version 202309
POST/order/202309/orders/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. Default: 20. Valid range: [1-100]. |
| 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. |
| sort_field | string | The returned results will be sorted by the specified field. Default: create_timePossible values:- create_time- update_timeSpecify the order for sorting the returned results by using the sort_order parameter. |
| shop_cipher Required | 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 |
|---|---|---|
| order_status | string | Specific order status.Available values:- UNPAID: The order has been placed, but payment has not been completed.- ON_HOLD: The order has been accepted and is awaiting fulfillment. The buyer may still cancel without the seller’s approval. If order_type=PRE_ORDER, the product is still awaiting release so payment will only be authorized 1 day before the release, but the seller should start preparing for the release.- AWAITING_SHIPMENT: The order is ready to be shipped, but no items have been shipped yet.- PARTIALLY_SHIPPING: Some items in the order have been shipped, but not all.- AWAITING_COLLECTION: Shipping has been arranged, but the package is waiting to be collected by the carrier.- IN_TRANSIT: The package has been collected by the carrier and delivery is in progress.- DELIVERED: The package has been delivered to the buyer.- COMPLETED: The order has been completed, and no further returns or refunds are allowed.- CANCELLED: The order has been cancelled. |
| create_time_ge | int | Filter orders to show only those that are created on or after the specified date and time. Unix timestamp.Note:create_time_ge and create_time_lt together constitute the creation time filter condition.- If create_time_ge is filled but create_time_lt is empty, create_time_lt will default to the current time.- If create_time_lt is filled but create_time_ge is empty, create_time_ge will default to the earliest shop time. |
| create_time_lt | int | Filter orders to show only those that are created before the specified date and time. Unix timestamp.Refer to notes in create_time_ge for more usage information. |
| update_time_ge | int | Filter orders to show only those that are updated on or after the specified date and time. Unix timestamp.Note:update_time_ge and update_time_lt together define the update time filter condition.- If update_time_ge is filled but update_time_lt is empty, update_time_lt will default to the current time.- If update_time_lt is filled but update_time_ge is empty, update_time_ge will default to the earliest shop time.Update times may exceed the selected search range due to ongoing data refreshes during the search process. |
| update_time_lt | int | Filter orders to show only those that are updated before the specified date and time. Unix timestamp.Refer to notes in update_time_ge for more usage information.Update times may exceed the selected search range due to ongoing data refreshes during the search process. |
| shipping_type | string | The delivery method.- TIKTOK: Shipping service provided by TikTok. The seller should obtain a shipping label from TikTok.- SELLER: Seller provides shipping, including through 3rd party fulfillment providers on behalf of the seller. - TIKTOK_DIGITAL: Tiktok delivers virtual goods directly to buyers. There is no action needed. |
| buyer_user_id | string | Buyer user ID. |
| is_buyer_request_cancel | bool | Whether the buyer has initiated an order cancellation request. |
| warehouse_ids | []string | Filter orders by pickup/sales warehouse IDs.Applicable only if the multi-warehouse feature is enabled.Max count: 100 |
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