Hero Products¶
Returns a list of hero products in a specified date range.
Endpoint¶
POST
https://partners.waffarx.com/api/{partner}/getheroproducts
Request Headers¶
Header |
Description |
|---|---|
wxc-id |
Your WaffarX Client Id |
wxc-auth |
Signature auth header for the request |
wxc-date |
UTC timestamp of the request, e.g. |
Accept-Language |
Response language preference (e.g. |
Content-Type |
Must be |
Note
wxc-id: The WaffarX client ID specified in your integration data.
Path Parameters¶
Name |
Type |
Required |
Description |
|---|---|---|---|
partner |
string |
 |
The partner name |
Request Parameters¶
Name |
Type |
Required |
Description |
|---|---|---|---|
StartDate |
string |
|
Start date for retrieving hero products |
EndDate |
string |
|
End date for retrieving hero products |
Request Body¶
Example Request Body¶
{
"StartDate": "2025-09-28",
"EndDate": "2025-10-31"
}
Responses¶
Success (HTTP 200)¶
Success Response Example¶
{
"status": "Success",
"data": [
{
"date": "2025-09-29T00:00:00",
"category": "Mobile & Phones",
"product": {
"id": "68cfec712c112fb2b5000a9a",
"name": "Iphone 14 Pro Max",
"merchantName": "WaffarX Test",
"price": 285,
"priceText": "285 EGP",
"oldPrice": 650,
"oldPriceText": "650 EGP",
"discounted": true,
"discountedText": "56.15 %",
"category": "Mobile & Phones",
"brand": "waffar",
"currency": "EGP",
"primaryImg": "https://cdn.shopify.com/s/files/1/0550/1734/1113/files/iphone-17-lineup-STORY-BANNER-850x500.png?v=1757969431",
"errorImg": "https://waffarxcdn-akcrhqbhbah9gpcc.z01.azurefd.net/waffarx-cdn/img/productsearcherror.png",
"shoppingUrl": "https://partners-test.waffarx.com/api/valu/shoppingtrip/productsearch/61a535ad-bf20-4d71-8846-413ebe8bb8ff/68cfec712c112fb2b5000a9a",
"shoppingUrlBase": "/api/valu/shoppingtrip/productsearch/61a535ad-bf20-4d71-8846-413ebe8bb8ff/68cfec712c112fb2b5000a9a",
"variantsImgs": [],
"store": {
"shoppingUrl": "https://partners-test.waffarx.com/api/valu/shoppingtrip/advertiser/61a535ad-bf20-4d71-8846-413ebe8bb8ff",
"shoppingUrlBase": "/api/valu/shoppingtrip/advertiser/61a535ad-bf20-4d71-8846-413ebe8bb8ff",
"id": "61a535ad-bf20-4d71-8846-413ebe8bb8ff",
"name": "Test Valu",
"logo": "https://waffarxcdn-akcrhqbhbah9gpcc.z01.azurefd.net/waffarx-cdn/siteimages/stores/advlogo202509101016121612.jpeg",
"logoPng": "https://waffarxcdn-akcrhqbhbah9gpcc.z01.azurefd.net/waffarx-cdn/siteimages/stores/advlogo202509101016121612.jpeg",
"backgroundColor": "#ffffff"
},
"offers": [
{
"id": "68bd642bb56fd4d9e26db563",
"name": "Valu Offer Test 0 Interest",
"typeName": "Pay with Valu",
"description": "Valu Offer Test 0 Interest",
"isRewardOffer": false,
"isFixed": false,
"rewardAmount": 0,
"partnerOfferTypeId": 1,
"partnerOfferTypeName": "0% Interest",
"isStoreLevel": true,
"isProductLevel": false,
"expirationDate": "2025-12-31T23:59:59.999"
},
{
"id": "68dac782dd1bf2770e0a5713",
"name": "Test Product Offer",
"typeName": "Pay with Valu",
"description": "Test Product Offer",
"isRewardOffer": false,
"isFixed": false,
"rewardAmount": 0,
"partnerOfferTypeId": 2,
"partnerOfferTypeName": "CashBack",
"isStoreLevel": false,
"isProductLevel": true,
"expirationDate": "2025-10-01T23:59:59.999"
}
],
"rateCard": null,
"isDeleted": false,
"quantity": 33,
"isPartnerProduct": true,
"heroProduct": false,
"partnerDiscounted": true
}
},
{
"date": "2025-09-30T00:00:00",
"category": "Mobile & Smart Phones",
"product": {
"id": "68cfec712c112fb2b5000a99",
"name": "Iphone 15 Pro Max",
"merchantName": "WaffarX Test",
"price": 475,
"priceText": "475 EGP",
"oldPrice": 650,
"oldPriceText": "650 EGP",
"discounted": true,
"discountedText": "26.92 %",
"category": "Mobile & Smart Phones",
"brand": "Apple",
"currency": "EGP",
"primaryImg": "https://cdn.shopify.com/s/files/1/0550/1734/1113/files/iphone-17-lineup-STORY-BANNER-850x500.png?v=1757969431",
"errorImg": "https://waffarxcdn-akcrhqbhbah9gpcc.z01.azurefd.net/waffarx-cdn/img/productsearcherror.png",
"shoppingUrl": "https://partners-test.waffarx.com/api/valu/shoppingtrip/productsearch/61a535ad-bf20-4d71-8846-413ebe8bb8ff/68cfec712c112fb2b5000a99",
"shoppingUrlBase": "/api/valu/shoppingtrip/productsearch/61a535ad-bf20-4d71-8846-413ebe8bb8ff/68cfec712c112fb2b5000a99",
"variantsImgs": [],
"store": {
"shoppingUrl": "https://partners-test.waffarx.com/api/valu/shoppingtrip/advertiser/61a535ad-bf20-4d71-8846-413ebe8bb8ff",
"shoppingUrlBase": "/api/valu/shoppingtrip/advertiser/61a535ad-bf20-4d71-8846-413ebe8bb8ff",
"id": "61a535ad-bf20-4d71-8846-413ebe8bb8ff",
"name": "Test Valu",
"logo": "https://waffarxcdn-akcrhqbhbah9gpcc.z01.azurefd.net/waffarx-cdn/siteimages/stores/advlogo202509101016121612.jpeg",
"logoPng": "https://waffarxcdn-akcrhqbhbah9gpcc.z01.azurefd.net/waffarx-cdn/siteimages/stores/advlogo202509101016121612.jpeg",
"backgroundColor": "#ffffff"
},
"offers": [
{
"id": "68bd642bb56fd4d9e26db563",
"name": "Valu Offer Test 0 Interest",
"typeName": "Pay with Valu",
"description": "Valu Offer Test 0 Interest",
"isRewardOffer": false,
"isFixed": false,
"rewardAmount": 0,
"partnerOfferTypeId": 1,
"partnerOfferTypeName": "0% Interest",
"isStoreLevel": true,
"isProductLevel": false,
"expirationDate": "2025-12-31T23:59:59.999"
}
],
"rateCard": null,
"isDeleted": false,
"quantity": 33,
"isPartnerProduct": true,
"heroProduct": false,
"partnerDiscounted": true
}
}
],
"message": null,
"errors": null
}
Error (HTTP 4XX/5XX)¶
Error Response Example¶
{
"status": "Error",
"data": 0,
"message": null,
"errors": []
}