Offer Stores¶
Retrieve all store-level offers, with each offer including the list of stores assigned to it.
Endpoint¶
POST
https://partners.waffarx.com/api/{partner}/getofferstores
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 |
---|---|---|---|
PageNumber |
integer |
![]() |
Page number to retrieve (1-based index, must be ≥ 1) |
PageSize |
integer |
![]() |
Number of items per page (1–50) |
Request Body Example¶
Example Request Body¶
{
"PageNumber": 1,
"PageSize": 10
}
cURL Example¶
curl --location 'https://partners.waffarx.com/api/{partner}/getofferstores' \
--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¶
{
"totalCount": 6,
"status": "Success",
"data": [
{
"stores": [
{
"shoppingUrl": "https://partners.waffarx.com/api/valu/shoppingtrip/advertiser/b694f32b-84c0-4dcc-8560-f28c2b8f2ad1",
"shoppingUrlBase": "/api/valu/shoppingtrip/advertiser/b694f32b-84c0-4dcc-8560-f28c2b8f2ad1",
"rateCard": 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": "https://partners.waffarx.com/api/valu/shoppingtrip/advertiser/0795a91e-c78c-4861-a44f-51f5287ade51",
"shoppingUrlBase": "/api/valu/shoppingtrip/advertiser/0795a91e-c78c-4861-a44f-51f5287ade51",
"rateCard": 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": "https://partners.waffarx.com/api/valu/shoppingtrip/advertiser/e279d45c-95ac-49c0-b940-c0536455be4a",
"shoppingUrlBase": "/api/valu/shoppingtrip/advertiser/e279d45c-95ac-49c0-b940-c0536455be4a",
"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
}
]
},
"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
}
],
"id": "686ae032e353ab31a85d5fc8",
"name": "50% Discount on iPhone",
"description": "Get the newest iPhone with 50% Discount",
"isRewardOffer": false,
"typeName": "Valu Offer",
"isStoreLevel": true,
"isProductLevel": false
}
],
"message": null,
"errors": null
}
Error (HTTP 4XX/5XX)¶
Error Response Example¶
{
"status": "Error",
"data": null,
"message": "",
"errors": [
"Page number must be greater than or equal to 1.",
"Please choose a page size between 1 and 50."
]
}