Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
WaffarX API Docs 1.0 documentation
Light Logo Dark Logo
  • Quick Start
  • WaffarX Signature
  • Products
    • Featured Products
    • Product Search
    • Product Details
  • Stores
    • Get Stores
    • Store Categories
    • Store With Products
    • Store Search
    • Store Search With Filter
    • Store Details
    • Store Brand Search
  • Offers
    • Offer Products
    • Offer Stores
  • Partner Orders
  • Shopping Trip
Back to top

Featured Products¶

Returns the list of products that have been marked as featured in the partner dashboard.

Endpoint¶

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

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. 2025-04-30T15:00:00Z

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

Required

The partner name

Request Parameters¶

Name

Type

Required

Description

StoreId

string

Required

The storeId whose featured products you want to retrieve.

PageNumber

integer

Required

Page number to retrieve (1-based index, must be ≥ 1)

PageSize

integer

Required

Number of items per page (1–50)

Request Body¶

Example Request Body¶
{
  "StoreId":"d413a-a1db-4da6-987e-83b8ffe17",
  "PageNumber": 1,
  "PageSize": 20
}

cURL Example¶

curl -X POST "https://partners.waffarx.com/api/{partner}/getfeaturedproducts" \
  -H "Content-Type: application/json" \
  -H "Accept-Language: en" \
  -H "wxc-id: {YOUR_CLIENT_ID}" \
  -H "wxc-date: 2025-05-04T21:58:34Z" \
  -H "wxc-auth: 712310e9379796869cf4915ef3e418f1f7fa45cf508aef44020cce" \
  -d '{"PageNumber": 1, "PageSize": 10}'

Responses¶

Success (HTTP 200)¶

Success Response Example¶
   {
 "totalCount": 19,
 "status": "Success",
 "data": [
     {
         "id": "6820d7f71cc7307ecbf0fbad",
         "name": "Turkey Gradient Mob",
         "merchantName": "Amazon.eg",
         "price": 899,
         "priceText": "EGP 899.00",
         "oldPrice": 899,
         "oldPriceText": "EGP 899.00",
         "discounted": false,
         "discountedText": null,
         "category": "Home & Kitchen > Household Cleaning Tools & Vacuums > Cleaning Buckets",
         "brand": "Generic",
         "currency": "EGP",
         "primaryImg": "https://m.media-amazon.com/images/I/41wXVrBokiL._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/6820d7f71cc7307ecbf0fbad",
         "variantsImgs": [
             "https://m.media-amazon.com/images/I/51hBnslLCYL._SL500_.jpg",
             "https://m.media-amazon.com/images/I/41Dv8UJVxoL._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
                 }
             ]
         }
     }
 ],
 "message": null,
 "errors": null

}

Error (HTTP 4XX/5XX)¶

Error Response Example¶
{
  "status": "Error",
  "data": null,
  "message": "",
  "errors": ["Failed to retrieve featured products"]
}
Next
Product Search
Previous
Products
Copyright © 2025, WaffarX
Made with Furo
On this page
  • Featured Products
    • Endpoint
    • Request Headers
    • Path Parameters
    • Request Parameters
    • Request Body
    • cURL Example
    • Responses
      • Success (HTTP 200)
      • Error (HTTP 4XX/5XX)