https://api.nexscope.ai/eh/etsy/productQueryEjecutar esta API
Envía una solicitud JSON para ejecutar esta API y recibir los datos de respuesta documentados.
Endpoint
| Método | POST |
| Ruta | https://api.nexscope.ai/eh/etsy/productQuery |
| Autenticación | Bearer API key |
| Content-Type | application/json |
Parámetros de la solicitud
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
beginFavorites | integer | opcional | The number of favorites (starting), together with the ending value, form the upstream favorites |
beginFavoritesWeekly | integer | opcional | Number of new favorites per week (start), which together with the end value form the upstream favorites_weekly |
beginPrice | number | opcional | Price (start), together with the end price, form the upstream price (such as 20~100); when filling in only one side, the upstream is start~ or ~end |
beginReviews | integer | opcional | The number of reviews (starting), which together with the end value form the upstream reviews |
beginReviewsWeekly | integer | opcional | Number of new comments per week (start), which together with the end value form the upstream reviews_weekly |
beginSales | integer | opcional | Total sales (starting), which together with the ending value form the upstream sales |
beginSalesWeekly | integer | opcional | Weekly sales volume (start), together with the end value, form the upstream sales_weekly (such as 1~100) |
category | string | opcional | Product classification ID (single product category), please see the product classification interface for details |
country | string | opcional | Shipping country |
currencyCode | string | opcional | Currency code, default `USD` |
endFavorites | integer | opcional | Number of collections (end) |
endFavoritesWeekly | integer | opcional | Number of new favorites per week (end) |
endPrice | number | opcional | Price (end), which together with the starting price forms the upstream price |
endReviews | integer | opcional | Number of comments (end) |
endReviewsWeekly | integer | opcional | Number of new comments per week (end) |
endSales | integer | opcional | Total sales (end) |
endSalesWeekly | integer | opcional | Weekly sales (end) |
isBestsell | integer | opcional | Is it a best-selling product? |
isPick | integer | opcional | Whether to Pick the product |
isRaving | integer | opcional | Whether Raving product |
listedTime | string | opcional | The shelf time is no earlier than this date (YYYY-MM-DD) |
page | integer | opcional | Page number (starting from 1) |
pageSize | integer | opcional | Number of entries per page, maximum 100, recommended not to exceed 50 |
productType | string | opcional | Product type, multiple commas separated: 1=Handmade 2=Vintage 3=Digital 4=Customized 9=Other |
searchKey | string | opcional | Search keywords or Etsy product URLs |
sortBy | integer | opcional | Sorting field (corresponding to upstream sort_by, value 1~6) |
sortDesc | integer | opcional | Sorting direction (corresponds to upstream `desc`). Schema example: Descending `1`, Ascending `2` |
status | integer | opcional | Product status (example: 1 on the shelves, 0 off the shelves) |
Respuesta de ejemplo
Estructura de respuesta de la plataforma. code 0 indica éxito o aceptación; data contiene el resultado de negocio.
No hay un ejemplo de respuesta publicado para esta API. Consulta los campos de respuesta siguientes.
Campos de respuesta
Referencia de campos de respuesta (27 campos)
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
total | integer | opcional | Number of records (this page returns the number of records to facilitate alignment with the length of the list) |
sourceType | string | opcional | Source type: etsy |
columns | array | opcional | Rendered columns |
costToken | integer | opcional | Token consumption (estimated based on the number of items returned on this page) |
productNum | integer | opcional | Total number of eligible products (upstream product_num) |
title | string | opcional | Title |
type | string | opcional | Rendering style |
products | array | opcional | Etsy product listings |
category | string | opcional | Category name |
favorites | integer | opcional | Number of collections |
favoritesWeekly | integer | opcional | Number of new favorites per week |
imageUrl | string | opcional | Main image URL |
isBestsell | integer | opcional | Best seller or not: 1=yes |
isPick | integer | opcional | Whether to Pick: 1=Yes |
isRaving | integer | opcional | Whether Raving: 1=Yes |
price | number | opcional | price |
productUrl | string | opcional | Product link |
releaseTime | string | opcional | Shelf/release time |
reviews | integer | opcional | Number of comments |
reviewsWeekly | integer | opcional | New comments per week |
salesTotal | integer | opcional | total sales |
salesWeekly | integer | opcional | Weekly sales |
shipsFrom | string | opcional | Shipping country |
status | integer | opcional | Product status: 1=on the shelves, 0=off the shelves |
storeName | string | opcional | Store name |
tags | string | opcional | tag |
title | string | opcional | Título del producto |
Respuestas
| Código | Descripción |
|---|---|
| 200 | Respuesta HTTP predeterminada tanto para el éxito como para muchos errores de negocio. Solo el código JSON externo 0 indica éxito o aceptación asíncrona; consulta data para obtener el resultado. |
| 429 | Límite de admisión de ejecuciones; respeta Retry-After cuando esté presente. |
| 503 | La admisión de ejecuciones no está disponible temporalmente; respeta Retry-After cuando esté presente. |
| Opcional | X-Nexscope-Http-Status: semantic asigna estados HTTP a los errores de negocio gestionados por el controlador en las rutas de ejecución y tareas. Los fallos previos a la autenticación, como una clave API ausente o no válida (code 11209, incluida una copia incompleta o dañada) o una sesión web caducada (code 12001), pueden seguir devolviendo HTTP 200 antes de esta asignación. Comprueba siempre el código JSON externo; las solicitudes malformadas y los fallos de infraestructura también pueden devolver respuestas HTTP distintas de 200. |
Fuente de datos, vigencia y limitaciones
La fuente, la vigencia, la cobertura, los límites de frecuencia y las notas de estimación no se especifican en esta definición de API salvo que aparezcan en la documentación de campos de solicitud o respuesta anterior. No supongas datos oficiales del mercado ni actualización en tiempo real cuando no estén documentados explícitamente.