Skip to main content

POST List Opportunity

List Opportunity Shop Required scope: seller.product.basic Search and retrieve a paginated list of opportunity leads available to the authorized seller, with optional filters by type, status, category, etc and ordered by the algorithm ranking model. Version 202604

POST/product/202604/opportunities/query

Request

Header

PropertiesTypeDescription
content-type RequiredstringAllowed type: application/json
x-tts-access-token RequiredstringThe seller access_token value from Get Access Token, when user_type = 0. Follow this guide to get seller access_token.

Query

PropertiesTypeDescription
app_key RequiredstringEvery single app will have a unique key. Please use the specific key assigned to your app.
sign RequiredstringSignature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders.
timestamp RequiredintUnix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time.
page_size RequiredintNumber of results per page. Max: 100. Default: 20.
page_tokenstringPagination token from previous response. Omit for first page.
localestringExpressed using {language_code}-{COUNTRY_CODE}, in accordance with the BCP-47 standard.
shop_cipher RequiredstringUse 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

PropertiesTypeDescription
opportunity_type RequiredstringType of opportunity: PRODUCT(品线索)/ KEYWORD(词线索)/ CATEGORY(类目线索)
category_ids[]stringFilter by category IDs. Leave empty to return all leads that available to the seller.
create_time_geintFilter opportunities created after this time. timestamp in seconds
create_time_ltintFilter opportunities created before this time. timestamp in seconds

Example

CurlGoNode.jsJavaEnable word wrap

Response Parameters

PropertiesTypeDescription
codeintThe success or failure status code returned in API response.
messagestringThe success or failure messages returned in API response. Reasons of failure will be described in the message.
request_idstringRequest log
dataobjectSpecific return information

Example

JSONEnable word wrap

Error Code

View common error codes

| Code | Message | | --- | --- | | Empty. No business logic error codes. |

Is this content helpful?Helpful

Not Helpful

PreviousNext