Partner Store Search

Search for products in partner store using optional filters.

Endpoint

POST https://partners-test.waffarx.com/api/{partner}/partnerstoresearch

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. 2024-04-24T12:34:56Z)
Accept-Language	Response language preference (e.g. en | ar)
Content-Type	Must be application/json

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
Stores	array of string		Store identifiers 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 */
    "Stores": [] /* optional */
  }
}

CURL Example

curl --location 'https://partners.waffarx.com/api/{partner}/partnerstoresearch' \
  --header 'wxc-id: {YOUR_CLIENT_ID}' \
  --header 'wxc-auth: 2187894575dae3325a2974ffc424684acbb707f5a282a83ccdd837a9cdbe6dd5' \
  --header 'wxc-date: 2025-09-22T20:17:01Z' \
  --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":"",
        "Stores":[]
        }
    }'

Responses

Success (HTTP 200)

Success Response Example

  {
    "status": "Success",
    "data": {
        "products": [
            {
                "id": "68cfec712c112fb2b5000a9a",
                "name": "Iphone 14 Pro Max",
                "merchantName": "WaffarX Test",
                "price": 630,
                "priceText": "630 EGP",
                "oldPrice": 650,
                "oldPriceText": "650 EGP",
                "discounted": true,
                "discountedText": "3.08 %",
                "category": "Mobile & Smart Phones",
                "brand": "WAFFARX Test",
                "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"
                    }
                ],
                "rateCard": null,
                "isDeleted": false,
                "quantity": 33,
                "isPartnerProduct": true,
                "heroProduct": false,
                "partnerDiscounted": true
            },
        ],
        "filters": {
            "minPrice": 0,
            "maxPrice": 0,
            "brands": null,
            "categories": null,
            "offers": null,
            "stores": null
        }
    },
    "message": null,
    "errors": null
  }

Error (HTTP 4XX/5XX)

Error Response Example

  {
    "status": "Error",
    "data": null,
    "message": "",
    "errors": ["SearchText is required"]
  }