Product Search¶
Search for products matching a free-text query and optional filters.
Endpoint¶
POST
https://partners.waffarx.com/api/{partner}/search
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 |
|---|---|---|---|
SearchText, |
string |
|
The text to search for (min 3, max 150 characters) |
PageNumber |
integer |
|
Page number to retrieve (1-based index, must be ≥ 1) |
PageSize |
integer |
|
Number of items per page (1–50) |
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 |
|---|---|---|---|
Stores |
array of string |
|
List of store IDs to include |
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 |
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",
"PageNumber": 1,
"PageSize": 10,
"SortByPriceDsc":true, /* ← optional */
"Filter": { /* ← optional */
"Stores": ["9E102E81-2EDF-4C79-8EBA-25DD2B56334"], /* optional */
"Brand": "", /* optional */
"MinPrice": 1, /* optional */
"MaxPrice": 10000, /* optional */
"Discounted":true, /* optional */
"OfferId": "68094be714bc80efc32cefb6" /* optional */
}
}
cURL Example¶
curl --location 'https://partners.waffarx.com/api/{partner}/search' \
--header 'wxc-id: {YOUR_CLIENT_ID}' \
--header 'wxc-auth: 4f0a7c400fb0daf2d3c90f92c4efca0a2fdfafe98e2f0c29610c87b1eeee55' \
--header 'wxc-date: 2024-04-24T12:34:56Z' \
--header 'Accept-Language: en' \
--header 'Content-Type: application/json' \
--data '{
"SearchText": "iphone 16",
"PageNumber": 1,
"ItemCount": 10,
"SortByPriceDsc":true,
"Filter": {
"Stores": ["9E102E81-2EDF-4C79-8EBA-25DD2B56334"],
"Brand": "",
"MinPrice": 1,
"MaxPrice": 10000,
"Discounted":true,
"OfferId": "68094be714bc80efc32cefb6"
}
}'
Responses¶
Success (HTTP 200)¶
Success Response Example¶
{
"status": "Success",
"data": {
"products": [
{
"id": "6821b8301cc7307ecb6b9d66",
"name": "AntiShock Soft Touch Mobile Case for iPhone16, iPhone16 plus, Iphone16 Pro, iPhone16 Pro Max (White, iPhone16 Pro)",
"merchantName": "Amazon.eg",
"price": 245,
"priceText": "245.0 EGP",
"oldPrice": 245,
"oldPriceText": "245.0 EGP",
"discounted": false,
"discountedText": null,
"category": "Electronics > Mobile Phone Cases & Covers > Mobile Phone Basic Cases",
"brand": "PRO-TECT",
"currency": "EGP",
"primaryImg": "https://m.media-amazon.com/images/I/41x-SCmCGCL._SL500_.jpg",
"errorImg": "https://waffarxcdn-akcrhqbhbah9gpcc.z01.azurefd.net/waffarx-cdn/img/productsearcherror.png",
"shoppingUrl": "https://partners.waffarx.com/api/valu/shoppingtrip/productsearch/e279d45c-95ac-49c0-b940-c0536455be4a",
"shoppingUrlBase": "/api/valu/shoppingtrip/productsearch/e279d45c-95ac-49c0-b940-c0536455be4a/6821b8301cc7307ecb6b9d66",
"variantsImgs": [
"https://m.media-amazon.com/images/I/41RfR-8+c5L._SL500_.jpg",
"https://m.media-amazon.com/images/I/4100wYbe26L._SL500_.jpg",
"https://m.media-amazon.com/images/I/41yL-48MWyL._SL500_.jpg",
"https://m.media-amazon.com/images/I/41uMJU9EqYL._SL500_.jpg",
"https://m.media-amazon.com/images/I/31xKuLdAWGL._SL500_.jpg",
"https://m.media-amazon.com/images/I/31onGZa-1nL._SL500_.jpg"
],
"store": {
"shoppingUrl": "https://partners.waffarx.com/api/valu/shoppingtrip/advertiser/e279d45c-95ac-49c0-b940-c0536455be4a",
"shoppingUrlBase": "/api/valu/shoppingtrip/advertiser/e279d45c-95ac-49c0-b940-c0536455be4a",
"id": "e279d45c-95ac-49c0-b940-c0536455be4a",
"name": "Amazon.eg",
"logo": "https://waffarxcdn-akcrhqbhbah9gpcc.z01.azurefd.net/waffarx-cdn/siteimages/stores/advlogo202408150823202320.png",
"logoPng": "https://waffarxcdn-akcrhqbhbah9gpcc.z01.azurefd.net/waffarx-cdn/siteimages/stores/advpnglogo202408150837133713.png",
"backgroundColor": null
},
"offers": null,
"rateCard": {
"uptoText": "Up to 7%",
"storeValue": 7.00,
"rateCardOptions": [
{
"title": "Apparel",
"rateText": "7 %",
"rateValue": 7.00
},
{
"title": "Bags & Wallets\t",
"rateText": "7 %",
"rateValue": 7.00
},
{
"title": "Eyewear & Optics\t",
"rateText": "7 %",
"rateValue": 7.00
},
{
"title": "Jewelry & Accessories\t",
"rateText": "7 %",
"rateValue": 7.00
},
{
"title": "Footwear",
"rateText": "7 %",
"rateValue": 7.00
},
{
"title": "Classic Watches",
"rateText": "6 %",
"rateValue": 6.00
},
{
"title": "Books",
"rateText": "5 %",
"rateValue": 5.00
},
{
"title": "Sports & Fitness\t",
"rateText": "4 %",
"rateValue": 4.00
},
{
"title": "Beauty\t",
"rateText": "4 %",
"rateValue": 4.00
},
{
"title": "Perfumes\t",
"rateText": "4 %",
"rateValue": 4.00
},
{
"title": "Vehicle Parts Accessories\t",
"rateText": "4 %",
"rateValue": 4.00
},
{
"title": "Musical Instruments",
"rateText": "3.5 %",
"rateValue": 3.50
},
{
"title": "TVs\t",
"rateText": "2.5 %",
"rateValue": 2.50
},
{
"title": "Tools & Home Improvement",
"rateText": "2.5 %",
"rateValue": 2.50
},
{
"title": "Kitchen Appliances\t",
"rateText": "2.5 %",
"rateValue": 2.50
},
{
"title": "Home Decor & Furniture\t",
"rateText": "2.5 %",
"rateValue": 2.50
},
{
"title": "Health & Personal Care\t",
"rateText": "2.5 %",
"rateValue": 2.50
},
{
"title": "Office Products & Supplies\t",
"rateText": "2.5 %",
"rateValue": 2.50
},
{
"title": "Kitchen & Home Supplies\t",
"rateText": "2.5 %",
"rateValue": 2.50
},
{
"title": "Bathing & Body supplies\t",
"rateText": "2.5 %",
"rateValue": 2.50
},
{
"title": "Baby",
"rateText": "2.5 %",
"rateValue": 2.50
},
{
"title": "Toys",
"rateText": "2.5 %",
"rateValue": 2.50
},
{
"title": "Home Appliances\t",
"rateText": "2.5 %",
"rateValue": 2.50
},
{
"title": "Garden & Outdoor\t",
"rateText": "2.5 %",
"rateValue": 2.50
},
{
"title": "Electronics",
"rateText": "2.5 %",
"rateValue": 2.50
},
{
"title": "Laptops & Notebooks\t",
"rateText": "2 %",
"rateValue": 2.00
},
{
"title": "Computers & IT/Networking\t",
"rateText": "2 %",
"rateValue": 2.00
},
{
"title": "Video Games\t",
"rateText": "2 %",
"rateValue": 2.00
},
{
"title": "Supermarket",
"rateText": "2 %",
"rateValue": 2.00
},
{
"title": "Tablets & Accessories\t",
"rateText": "2 %",
"rateValue": 2.00
},
{
"title": "Pet Food & Supplies\t",
"rateText": "2 %",
"rateValue": 2.00
},
{
"title": "USB",
"rateText": "2 %",
"rateValue": 2.00
},
{
"title": "Cameras & Accessories\t",
"rateText": "1 %",
"rateValue": 1.00
},
{
"title": "Mobiles & Accessories\t",
"rateText": "1 %",
"rateValue": 1.00
}
]
}
}
],
"filters": {
"brands": [
"Nillkin",
"KRCIQMV",
"saifxy",
"FUPYWP",
"Generic",
"Devia",
"PlusAcc",
"SASOLINE",
"ESR",
"WGOGT",
"Next store",
"V Volt",
"ELMO3EZZ",
"Magic Mask",
"Anker",
"Noor Spark",
"UGREEN",
"YUN CHUANG",
"GQ",
"Patek",
"FOKKAH",
"generic",
"KufaerBeam",
"National Geographic",
"Armor",
"Niboow",
"KyraTech",
"Majentik",
"PRO-TECT",
"Tabletex",
"fashion mania"
],
"offers": [
{
"id": "6863ce303a0ce635a5d69717",
"name": "reward x product fixed ",
"description": "reward x product fixed ",
"isRewardOffer": true,
"typeName": "Rewards",
"isStoreLevel": false,
"isProductLevel": true
},
{
"id": "6865258f1167b8ab4018c9f0",
"name": "sh valu offer on merchant ",
"description": "sh valu offer on merchant ",
"isRewardOffer": false,
"typeName": "Valu Offer",
"isStoreLevel": true,
"isProductLevel": false
},
{
"id": "686525a11167b8ab4018c9f1",
"name": "sh1 reward on merchant",
"description": "sh reward on merchant",
"isRewardOffer": false,
"typeName": "Valu Offer",
"isStoreLevel": true,
"isProductLevel": false
},
{
"id": "686525c61167b8ab4018c9f2",
"name": "sh2 valu offer on merchant",
"description": "sh2 valu offer on merchant",
"isRewardOffer": false,
"typeName": "Valu Offer",
"isStoreLevel": true,
"isProductLevel": false
},
{
"id": "686526551167b8ab4018c9f3",
"name": "sh1 valu offer on merchant",
"description": "sh1 valu offer on merchant",
"isRewardOffer": false,
"typeName": "Valu Offer",
"isStoreLevel": true,
"isProductLevel": false
},
{
"id": "6865273e1167b8ab4018c9f4",
"name": "sh reward on merchant",
"description": "sh reward on merchant",
"isRewardOffer": true,
"typeName": "Rewards",
"isStoreLevel": true,
"isProductLevel": false
},
{
"id": "686a51911322c95a29d7f5e5",
"name": "product offer",
"description": "product offer",
"isRewardOffer": false,
"typeName": "Valu Offer",
"isStoreLevel": false,
"isProductLevel": true
},
{
"id": "686ae032e353ab31a85d5fc8",
"name": "50% Discount on iPhone",
"description": "Get the newest iPhone with 50% Discount",
"isRewardOffer": false,
"typeName": "Valu Offer",
"isStoreLevel": true,
"isProductLevel": false
},
{
"id": "686ae105e353ab31a85d5fc9",
"name": "product offer",
"description": "product offer",
"isRewardOffer": false,
"typeName": "Valu Offer",
"isStoreLevel": false,
"isProductLevel": true
},
{
"id": "686bc66e5715e1dc263bb63a",
"name": "Taroq",
"description": "T T ",
"isRewardOffer": true,
"typeName": "Rewards",
"isStoreLevel": false,
"isProductLevel": true
},
{
"id": "686bc6e05715e1dc263bb63b",
"name": "Teka ",
"description": "Waffar t ",
"isRewardOffer": false,
"typeName": "Valu Offer",
"isStoreLevel": false,
"isProductLevel": true
}
],
"stores": [
{
"shoppingUrl": null,
"shoppingUrlBase": null,
"id": "940007dd-ba3e-495b-a78a-6f0fa8b6837f",
"name": "Hatolna Shopping",
"logo": "https://waffarxcdn-akcrhqbhbah9gpcc.z01.azurefd.net/waffarx-cdn/siteimages/stores/advlogo202311200554145414.png",
"logoPng": "https://waffarxcdn-akcrhqbhbah9gpcc.z01.azurefd.net/waffarx-cdn/siteimages/stores/advpnglogo202311200554145414.png",
"backgroundColor": null
},
{
"shoppingUrl": null,
"shoppingUrlBase": null,
"id": "47afb8ec-b70e-4391-b271-847c0a1c5bcc",
"name": "More Shopping",
"logo": "https://waffarxcdn-akcrhqbhbah9gpcc.z01.azurefd.net/waffarx-cdn/siteimages/stores/advlogo20230917050619619.png",
"logoPng": "https://waffarxcdn-akcrhqbhbah9gpcc.z01.azurefd.net/waffarx-cdn/siteimages/stores/advpnglogo20230917050619619.png",
"backgroundColor": null
},
{
"shoppingUrl": null,
"shoppingUrlBase": null,
"id": "b694f32b-84c0-4dcc-8560-f28c2b8f2ad1",
"name": "2B Egypt",
"logo": "https://waffarxcdn-akcrhqbhbah9gpcc.z01.azurefd.net/waffarx-cdn/siteimages/stores/advlogo20231205033602362.png",
"logoPng": "https://waffarxcdn-akcrhqbhbah9gpcc.z01.azurefd.net/waffarx-cdn/siteimages/stores/advpnglogo202312050428452845.png",
"backgroundColor": "#f92424"
},
{
"shoppingUrl": null,
"shoppingUrlBase": null,
"id": "0795a91e-c78c-4861-a44f-51f5287ade51",
"name": "Kenzz",
"logo": "https://waffarxcdn-akcrhqbhbah9gpcc.z01.azurefd.net/waffarx-cdn/siteimages/stores/advlogo202502050725362536.png",
"logoPng": "https://waffarxcdn-akcrhqbhbah9gpcc.z01.azurefd.net/waffarx-cdn/siteimages/stores/advpnglogo20250206031605165.png",
"backgroundColor": "#000000"
},
{
"shoppingUrl": null,
"shoppingUrlBase": null,
"id": "98b31baf-bcb5-47c9-9bff-c0ac937441de",
"name": "B.TECH",
"logo": "https://waffarxcdn-akcrhqbhbah9gpcc.z01.azurefd.net/waffarx-cdn/siteimages/stores/advlogo202208150652345234.png",
"logoPng": "https://waffarxcdn-akcrhqbhbah9gpcc.z01.azurefd.net/waffarx-cdn/siteimages/stores/advpnglogo20220815070937937.png",
"backgroundColor": "#0c81ed"
},
{
"shoppingUrl": null,
"shoppingUrlBase": null,
"id": "e279d45c-95ac-49c0-b940-c0536455be4a",
"name": "Amazon.eg",
"logo": "https://waffarxcdn-akcrhqbhbah9gpcc.z01.azurefd.net/waffarx-cdn/siteimages/stores/advlogo202408150823202320.png",
"logoPng": "https://waffarxcdn-akcrhqbhbah9gpcc.z01.azurefd.net/waffarx-cdn/siteimages/stores/advpnglogo202408150837133713.png",
"backgroundColor": null
},
{
"shoppingUrl": null,
"shoppingUrlBase": null,
"id": "ac3bf270-fc1b-43b4-b27e-a2c4eb2b25dc",
"name": "Amazon.ae",
"logo": "https://waffarxcdn-akcrhqbhbah9gpcc.z01.azurefd.net/waffarx-cdn/siteimages/stores/advlogo20231228062603263.png",
"logoPng": "https://waffarxcdn-akcrhqbhbah9gpcc.z01.azurefd.net/waffarx-cdn/siteimages/stores/advpnglogo202408150919121912.png",
"backgroundColor": null
},
{
"shoppingUrl": null,
"shoppingUrlBase": null,
"id": "702cb9e2-51a2-4aeb-84ef-111847c502a1",
"name": "Amazon.sa",
"logo": "https://waffarxcdn-akcrhqbhbah9gpcc.z01.azurefd.net/waffarx-cdn/siteimages/stores/advlogo20231228062507257.png",
"logoPng": "https://waffarxcdn-akcrhqbhbah9gpcc.z01.azurefd.net/waffarx-cdn/siteimages/stores/advpnglogo202408150918381838.png",
"backgroundColor": null
}
],
"minPrice": 1,
"maxPrice": 100000,
"brand": null
}
},
"message": null,
"errors": null
}
Error (HTTP 4XX/5XX)¶
Error Response Example¶
{
"status": "Error",
"data": null,
"message": "",
"errors": ["SearchText is required"]
}