Store Search¶
Search for products in a specific store using optional filters.
Endpoint¶
POST
https://partners.waffarx.com/api/{partner}/StoreSearch
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 |
RRequest 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}/storesearch' \
--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": "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": null
},
"message": null,
"errors": null
}
Error (HTTP 4XX/5XX)¶
Error Response Example¶
{
"status": "Error",
"data": null,
"message": "",
"errors": ["SearchText is required"]
}