Store Search With Filter¶
Search for products in a specific store using optional filters including category and brands.
Endpoint¶
POST
https://partners.waffarx.com/api/{partner}/storesearchwithfilters
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 Body Parameters¶
Name |
Type |
Required |
Description |
|---|---|---|---|
PageNumber |
integer |
|
Page number to retrieve (1-based index, must be ≥ 1) |
PageSize |
integer |
|
Number of items per page (1–50) |
StoreId |
string |
|
Store Id |
SearchText |
string |
 |
The text to search for (min 3, max 150 characters) |
SortByPriceDsc |
boolean |
|
True | False (default is True) |
Filter |
object |
|
Optional filter object; you may omit it entirely or include any subset of its fields |
Filter Sub-Parameters¶
Name |
Type |
Required |
Description |
|---|---|---|---|
Category |
string |
|
Category name to filter by (e.g. Mobile Phones) |
Brand |
string |
|
Brand name to filter by (e.g. “Apple”) |
Discounted |
boolean |
|
True (if needed) |
MinPrice |
number |
|
Minimum price (inclusive) |
MaxPrice |
number |
|
Maximum price (inclusive) |
OfferId |
string |
|
Offer identifier to filter by |
OfferTypeId |
string |
|
Offer type identifier to filter by |
Note
The entire Filter object is optional. You may omit it, or include it with only the specific fields you need.
Request Body Example¶
Example Request Body¶
{
"SearchText": "iphone 16",
"StoreId":"DF913A-A1DB-4DA6-987E-839B8FFE17",
"PageNumber": 1,
"PageSize": 10,
"SortByPriceDsc":true, /* ← optional */
"Filter": { /* ← optional */
"Category": "", /* optional */
"Brand": "", /* optional */
"MinPrice": 1, /* optional */
"MaxPrice": 10000, /* optional */
"Discounted":true, /* optional */
"OfferId": "68094be714bc80efc32cefb6" /* optional */
"OfferTypeId": "68094ce714bc80efc231a23" /* optional */
}
}
CURL Example¶
curl --location 'https://partners.waffarx.com/api/{partner}/storesearchwithfilters' \
--header 'wxc-id: {YOUR_CLIENT_ID}' \
--header 'wxc-auth: 4f0a7c400fb0daf2d390f92c4efca0a2fdfafe98e2f0c29610c87b1eeee55' \
--header 'wxc-date: 2024-04-24T12:34:56Z' \
--header 'Accept-Language: en' \
--header 'Content-Type: application/json' \
--data '{
"SearchText":"iphone",
"StoreId":"DFBA913A-A1DB-4DA6-987E-839A3B8FFE17",
"PageNumber":1,
"PageSize":1,
"SortByPriceDsc":true,
"Filter":{
"Category":"",
"Brands":"",
"MinPrice":null,
"MaxPrice":null,
"Discounted":false,
"OfferId":"",
"OfferTypeId":""
}
}'
Responses¶
Success (HTTP 200)¶
Success Response Example¶
{
"status": "Success",
"data": {
"products": [
{
"id": "681a38130a3e41e2206ac5f2",
"name": "Belkin Magsafe Case l Iphone 15",
"merchantName": "DubaiPhone",
"price": 350,
"priceText": "350.0 ",
"oldPrice": 350,
"oldPriceText": "350.0 ",
"discounted": false,
"discountedText": null,
"category": "Cover & Screen",
"brand": null,
"currency": "",
"primaryImg": "https://assets-dubaiphone.dubaiphone.net/dp-prod/wp-content/uploads/2025/02/Belkin-Magsafe-Case-l-Iphone-15_Covers_22299_1.jpeg",
"errorImg": "https://waffarxcdn-akcrhqbhbah9gpcc.z01.azurefd.net/waffarx-cdn/img/productsearcherror.png",
"shoppingUrl": "https://partners.waffarx.com/api/valu/shoppingtrip/productsearch/dfba913a-a1db-4da6-987e-839a3b8ffe17/681a38130a3e41e2206ac5f2",
"shoppingUrlBase": "/api/valu/shoppingtrip/productsearch/dfba913a-a1db-4da6-987e-839a3b8ffe17/681a38130a3e41e2206ac5f2",
"variantsImgs": [],
"store": {
"shoppingUrl": "https://partners.waffarx.com/api/valu/shoppingtrip/advertiser/dfba913a-a1db-4da6-987e-839a3b8ffe17",
"shoppingUrlBase": "/api/valu/shoppingtrip/advertiser/dfba913a-a1db-4da6-987e-839a3b8ffe17",
"id": "dfba913a-a1db-4da6-987e-839a3b8ffe17",
"name": "Dubai Phone",
"logo": "https://waffarxcdn-akcrhqbhbah9gpcc.z01.azurefd.net/waffarx-cdn/siteimages/stores/advlogo202402110356485648.png",
"logoPng": "https://waffarxcdn-akcrhqbhbah9gpcc.z01.azurefd.net/waffarx-cdn/siteimages/stores/advpnglogo20240817045903593.png",
"backgroundColor": "#c32222"
},
"offers": [
{
"id": "686d2c83802a6c5da35515bf",
"name": "Valu Offer 0.0.0",
"description": "Get Offer",
"isRewardOffer": false,
"typeName": "Valu Offer",
"isStoreLevel": true,
"isProductLevel": false
}
],
"rateCard": null
}
],
"filters": {
"minPrice": 1,
"maxPrice": 100000,
"brands": [
"Amazfit",
"Anker",
"Apple",
"Baseus",
"Belkin",
"Buddy",
"Cavo",
"Celebrat",
"Choetech",
"Cmf",
"Energizer",
"G-Tide",
"Generic",
"Green",
"Green Lion",
"Havit",
"Hikvision",
"HMD",
"Hoco",
"Honor",
"Huawei",
"Infinix",
"Itel",
"JBL",
"Joyroom",
"Kieslect",
"Kospet",
"L'avvento",
"LDNIO",
"Lenovo",
"Logitech",
"Mibro",
"Momax",
"Monster",
"Mophie",
"Motorola",
"Oppo",
"Oraimo",
"Powerology",
"QCY",
"Realme",
"Recci",
"Redragon",
"Samsung",
"Sandisk",
"Smart Gate",
"Sony",
"SoundPeats",
"Unitronics",
"Usams",
"Viva",
"Vivo",
"Wiwu",
"Xiaomi",
"Xinsely"
],
"categories": [
"Accessories",
"Air Fryer",
"Airpods",
"AirTag",
"All",
"Anker Store",
"Apple",
"ASUS Laptop",
"Audio Accessories",
"Bags",
"Blenders & Mixers",
"Bussines",
"Cables",
"Cables & docks",
"Car Solution",
"CDs",
"Cover",
"Cover & Screen",
"Covers",
"Creator",
"Dock & Hub",
"Earphones",
"Economic-Range",
"Flash Sale",
"Games Accessories",
"Gaming Accessories",
"Gaming Mouse & Keyboard",
"Gifts",
"Headphones",
"Health equipment",
"HMD",
"Home",
"Home Appliances",
"Honor",
"Huawei",
"Huawei Tablet",
"Infinix",
"Infinix Tablet",
"IPad",
"Irons",
"Kettle & Coffee Maker",
"Keyboard",
"Keyboard & Mouse",
"Laptop Accessories",
"Last piece",
"Lenovo Laptop",
"Lenovo Monitors",
"Lenovo Tablet",
"LG TV",
"MacBook",
"Memories & Flashs",
"Microphone",
"Microwaves",
"Mid Range & High End",
"Monitors",
"More For Less",
"Motorola",
"Oppo",
"Other accessories",
"Others",
"Pantum Printers",
"Personal Care",
"Power & Batteries",
"Power Bank",
"Promo Codes",
"PS Consoles",
"Realme",
"Samsung",
"Samsung TV",
"Scooters",
"Screen Protector",
"Smart Band",
"Smart Watch",
"Speaker",
"Speakers",
"Stands",
"Touch Pen",
"TV Solutions",
"TWS",
"Vacuum",
"Vivo",
"Waffle & Sandwich Maker",
"Wearable Accessories",
"Xiaomi",
"الكل"
],
"offers": [
{
"id": "684ec2b11178c0ca4ac0b60d",
"name": "50% Discount on iPhone",
"description": "Get the newest iPhone with 50% Discount",
"isRewardOffer": false,
"typeName": "Valu Offer",
"isStoreLevel": false,
"isProductLevel": true
},
{
"id": "686d2c83802a6c5da35515bf",
"name": "Valu Offer 0.0.0",
"description": "Get Offer",
"isRewardOffer": false,
"typeName": "Valu Offer",
"isStoreLevel": true,
"isProductLevel": false
}
]
}
},
"message": null,
"errors": null
}
Error (HTTP 4XX/5XX)¶
Error Response Example¶
{
"status": "Error",
"data": null,
"message": "",
"errors": ["SearchText is required"]
}