Store Brand Search¶

Search for brands within a store using a text query.

Endpoint¶

POST https://partners.waffarx.com/api/{partner}/storebrandsearch

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
StoreId	string		The storeId whose featured products you want to retrieve.
SearchText,	string		The text to search for (min 2, max 150 characters)

Request Body Example¶

Example Request Body¶

{
  "SearchText":"de",
  "StoreId":"B694F32B-84C0-4DCC-8560-F28C2B8F2AD1"
}

cURL Example¶

curl --location 'https://partners.waffarx.com/api/{partner}/storebrandsearch' \
  --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 '{
    "PageNumber": 1,
    "PageSize": 10,
}'

Responses¶

Success (HTTP 200)¶

Success Response Example¶

 {
     "status": "Success",
     "data": [
         "De'Longhi Dedica",
         "Devia",
         "Dell"
     ],
     "message": null,
     "errors": null
 }

Error (HTTP 4XX/5XX)¶

Error Response Example¶

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