get
https://api.shopalyst.com/v1/insights/daas/trendingProducts
This API provides top 100 best selling products, for the given hierarchy, merchant and date combination.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Sample Response
{
"success": true,
"message": "",
"errorCode": "",
"result": {
"data": [
{
"subCategory": "maternal",
"merchantDivision": "babies & toys",
"offerPrice": 19.9,
"productId": null,
"salePrice": 23.9,
"merchant": "shopee",
"productCodeTitle": null,
"trendingRank": 1,
"productImage": "",
"merchantProductId": "301166302",
"productCode": null,
"articleType": null,
"reviewCount": 52,
"ratingsCount": "50",
"category": "milk formula & baby food",
"brand": "anmum",
"title": "Anmum Materna Milk Powder Plain Milk Powder",
"avgRating": "4.84",
"skuInfo": [
{
"offerPrice": "19.90",
"salePrice": "23.90",
"skuId": "301166302_SGAMZ-527278139"
}
],
"selfBrand": true,
"previousRank": 7,
"rankChange": 2
}
],
"total": 1,
"type": "trendingProducts",
"date": "2021-05-02",
"comparedWithDate": "2021-04-26"
}
}Response Fields
| success | Indicates if API response is success or not. | bool |
| message | Response message. Typically populated in error scenarios. | string |
| errorCode | Error code. | string |
| merchant | Merchant name. | string |
| productCodeTitle | Title at EAN level. | string |
| title | Title as seen at merchant site. | string |
| offerPrice | Price after discount. | number |
| salePrice | M.R.P. | number |
| merchantDivision | Merchant division name. | string |
| category | Category name. | string |
| subCategory | Sub category name. | string |
| articleType | Article type name. | string |
| productId | Shopalyst productId of the product. | string |
| productCode | EAN. | string |
| trendingRank | Best seller rank. | number |
| productImage | Image link. | string |
| merchantProductId | Merchant productId of the product. | string |
| brand | Brand name. | string |
| skuInfo | Product sku level info. | list |
| selfBrand | Indicates whether its a given brand or competitor in the request. | bool |
| errorNodes | List of category nodes that had any error while fetching data from the merchant site. | list |
| previousRank | Best seller rank for the given hierarchy on the compared date. This field won’t be available if the product is not in top 100 list on the compared date. | number |
| rankChange | Absolute change between trendingRank and previousRank as on compared with date. This field won’t be available if previousRank is unavailable. | number |
| reviewCount | Total review count. For products with no review count the field may be missing. | number |
| ratingsCount | Total rating count. For products with no rating count the field may be missing. | number |
| avgRating | Average rating. For products with no ratings the field may be missing. | number |
| total | Number of products in the response. | number |
| date | Date. | string |
| comparedWithDate | Date, that used to compare(date - 6). | string |
Exceptions and Error Conditions
The Bestsellers trending products API will look for matching data based on the filters applied. However, there are a few scenarios where the API may not be able to return a valid response. For example.
- Data request for a future date.
- Data requested for invalid merchant/merchant division combination.
In all the above scenarios, the best sellers trending products API would return with an error response.
Example:
{
"success": false,
"message": "You can not request for future date",
"errorCode": "INVALID_DATE",
"result": ""
}