POST api/suppliers/homepage
Get Home Page
Request Information
URI Parameters
None.
Body Parameters
Search Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| GeoLocation |
Geo Location |
GeoLocation |
None. |
| OnContentSet |
On Content Set Options |
boolean |
Default value is False |
| ManageDataSets |
Manage Data Display or Not |
ManageDataSets |
None. |
Request Formats
application/json, text/json
Sample:
{
"geoLocation": {
"longitude": 1.1,
"latitude": 2.1
},
"onContentSet": true,
"manageDataSets": {
"isNotEmptySpecialOffersList": true,
"isNotEmptyFeaturedList": true,
"isNotEmptyNearestList": true,
"isNotEmptyTopBannerList": true,
"isNotEmptyTopBannerSpecialList": true,
"isNotEmptyThemeList": true
}
}
Response Information
Featured suppliers
| Name | Description | Type | Additional information |
|---|---|---|---|
| NearestItems |
Nearest items |
Collection of HomePageItem |
None. |
| SpecialOffersItems |
Special Offers items |
Collection of OverviewItem |
None. |
| FeaturedItems |
Featured items |
Collection of OverviewItem |
None. |
| TopBannerItems |
Top Banner Items |
Collection of TopBannerItem |
None. |
| TopBannerSpecialItems |
Top Banner Special Items |
Collection of TopBannerItem |
None. |
| ThemeItems |
Theme Items |
Collection of ThemeListItem |
None. |
| CustomerLogoUrl |
Current customer Logo URL |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"nearestItems": [
{
"supplierId": 1,
"name": "sample string 2",
"info": "sample string 3",
"teaser": "sample string 4",
"about": "sample string 5",
"imageUrl": "sample string 6",
"supplierImage": "sample string 7",
"address": {
"addressId": 1,
"detail": "sample string 1",
"latitude": 1.1,
"longitude": 1.1
},
"discountInfo": {
"info": "sample string 1",
"minPercent": 1.1,
"maxPercent": 1.1,
"minAmount": 1.1,
"maxAmount": 1.1,
"text": "sample string 2",
"currency": {
"currencySymbol": "sample string 1",
"isPrefix": true
}
},
"specialOfferInfo": {
"info": "sample string 1",
"endDateTimeUTC": "2024-04-20T11:09:00.1756771+02:00",
"timeLeft": "sample string 2",
"campaignImageUrl": "sample string 3",
"discountInfo": {
"info": "sample string 1",
"minPercent": 1.1,
"maxPercent": 1.1,
"minAmount": 1.1,
"maxAmount": 1.1,
"text": "sample string 2",
"currency": {
"currencySymbol": "sample string 1",
"isPrefix": true
}
},
"dealTitle": "sample string 4"
},
"numberOfAddresses": 8,
"primaryCategory": "sample string 9"
},
{
"supplierId": 1,
"name": "sample string 2",
"info": "sample string 3",
"teaser": "sample string 4",
"about": "sample string 5",
"imageUrl": "sample string 6",
"supplierImage": "sample string 7",
"address": {
"addressId": 1,
"detail": "sample string 1",
"latitude": 1.1,
"longitude": 1.1
},
"discountInfo": {
"info": "sample string 1",
"minPercent": 1.1,
"maxPercent": 1.1,
"minAmount": 1.1,
"maxAmount": 1.1,
"text": "sample string 2",
"currency": {
"currencySymbol": "sample string 1",
"isPrefix": true
}
},
"specialOfferInfo": {
"info": "sample string 1",
"endDateTimeUTC": "2024-04-20T11:09:00.1756771+02:00",
"timeLeft": "sample string 2",
"campaignImageUrl": "sample string 3",
"discountInfo": {
"info": "sample string 1",
"minPercent": 1.1,
"maxPercent": 1.1,
"minAmount": 1.1,
"maxAmount": 1.1,
"text": "sample string 2",
"currency": {
"currencySymbol": "sample string 1",
"isPrefix": true
}
},
"dealTitle": "sample string 4"
},
"numberOfAddresses": 8,
"primaryCategory": "sample string 9"
}
],
"specialOffersItems": [
{
"supplierId": 1,
"name": "sample string 2",
"info": "sample string 3",
"teaser": "sample string 4",
"about": "sample string 5",
"imageUrl": "sample string 6",
"supplierImage": "sample string 7",
"address": {
"addressId": 1,
"detail": "sample string 1",
"latitude": 1.1,
"longitude": 1.1
},
"discountInfo": {
"info": "sample string 1",
"minPercent": 1.1,
"maxPercent": 1.1,
"minAmount": 1.1,
"maxAmount": 1.1,
"text": "sample string 2",
"currency": {
"currencySymbol": "sample string 1",
"isPrefix": true
}
},
"specialOfferInfo": {
"info": "sample string 1",
"endDateTimeUTC": "2024-04-20T11:09:00.1756771+02:00",
"timeLeft": "sample string 2",
"campaignImageUrl": "sample string 3",
"discountInfo": {
"info": "sample string 1",
"minPercent": 1.1,
"maxPercent": 1.1,
"minAmount": 1.1,
"maxAmount": 1.1,
"text": "sample string 2",
"currency": {
"currencySymbol": "sample string 1",
"isPrefix": true
}
},
"dealTitle": "sample string 4"
},
"numberOfAddresses": 8
},
{
"supplierId": 1,
"name": "sample string 2",
"info": "sample string 3",
"teaser": "sample string 4",
"about": "sample string 5",
"imageUrl": "sample string 6",
"supplierImage": "sample string 7",
"address": {
"addressId": 1,
"detail": "sample string 1",
"latitude": 1.1,
"longitude": 1.1
},
"discountInfo": {
"info": "sample string 1",
"minPercent": 1.1,
"maxPercent": 1.1,
"minAmount": 1.1,
"maxAmount": 1.1,
"text": "sample string 2",
"currency": {
"currencySymbol": "sample string 1",
"isPrefix": true
}
},
"specialOfferInfo": {
"info": "sample string 1",
"endDateTimeUTC": "2024-04-20T11:09:00.1756771+02:00",
"timeLeft": "sample string 2",
"campaignImageUrl": "sample string 3",
"discountInfo": {
"info": "sample string 1",
"minPercent": 1.1,
"maxPercent": 1.1,
"minAmount": 1.1,
"maxAmount": 1.1,
"text": "sample string 2",
"currency": {
"currencySymbol": "sample string 1",
"isPrefix": true
}
},
"dealTitle": "sample string 4"
},
"numberOfAddresses": 8
}
],
"featuredItems": [
{
"supplierId": 1,
"name": "sample string 2",
"info": "sample string 3",
"teaser": "sample string 4",
"about": "sample string 5",
"imageUrl": "sample string 6",
"supplierImage": "sample string 7",
"address": {
"addressId": 1,
"detail": "sample string 1",
"latitude": 1.1,
"longitude": 1.1
},
"discountInfo": {
"info": "sample string 1",
"minPercent": 1.1,
"maxPercent": 1.1,
"minAmount": 1.1,
"maxAmount": 1.1,
"text": "sample string 2",
"currency": {
"currencySymbol": "sample string 1",
"isPrefix": true
}
},
"specialOfferInfo": {
"info": "sample string 1",
"endDateTimeUTC": "2024-04-20T11:09:00.1756771+02:00",
"timeLeft": "sample string 2",
"campaignImageUrl": "sample string 3",
"discountInfo": {
"info": "sample string 1",
"minPercent": 1.1,
"maxPercent": 1.1,
"minAmount": 1.1,
"maxAmount": 1.1,
"text": "sample string 2",
"currency": {
"currencySymbol": "sample string 1",
"isPrefix": true
}
},
"dealTitle": "sample string 4"
},
"numberOfAddresses": 8
},
{
"supplierId": 1,
"name": "sample string 2",
"info": "sample string 3",
"teaser": "sample string 4",
"about": "sample string 5",
"imageUrl": "sample string 6",
"supplierImage": "sample string 7",
"address": {
"addressId": 1,
"detail": "sample string 1",
"latitude": 1.1,
"longitude": 1.1
},
"discountInfo": {
"info": "sample string 1",
"minPercent": 1.1,
"maxPercent": 1.1,
"minAmount": 1.1,
"maxAmount": 1.1,
"text": "sample string 2",
"currency": {
"currencySymbol": "sample string 1",
"isPrefix": true
}
},
"specialOfferInfo": {
"info": "sample string 1",
"endDateTimeUTC": "2024-04-20T11:09:00.1756771+02:00",
"timeLeft": "sample string 2",
"campaignImageUrl": "sample string 3",
"discountInfo": {
"info": "sample string 1",
"minPercent": 1.1,
"maxPercent": 1.1,
"minAmount": 1.1,
"maxAmount": 1.1,
"text": "sample string 2",
"currency": {
"currencySymbol": "sample string 1",
"isPrefix": true
}
},
"dealTitle": "sample string 4"
},
"numberOfAddresses": 8
}
],
"topBannerItems": [
{
"id": 1,
"headline": "sample string 2",
"subheadline": "sample string 3",
"tag": "sample string 4",
"type": "sample string 5",
"data": "sample string 6",
"visibleStartDate": "2024-04-20T11:09:00.1756771+02:00",
"visibleEndDate": "2024-04-20T11:09:00.1756771+02:00",
"bannerImage": "sample string 8",
"sortOrder": 9
},
{
"id": 1,
"headline": "sample string 2",
"subheadline": "sample string 3",
"tag": "sample string 4",
"type": "sample string 5",
"data": "sample string 6",
"visibleStartDate": "2024-04-20T11:09:00.1756771+02:00",
"visibleEndDate": "2024-04-20T11:09:00.1756771+02:00",
"bannerImage": "sample string 8",
"sortOrder": 9
}
],
"topBannerSpecialItems": [
{
"id": 1,
"headline": "sample string 2",
"subheadline": "sample string 3",
"tag": "sample string 4",
"type": "sample string 5",
"data": "sample string 6",
"visibleStartDate": "2024-04-20T11:09:00.1756771+02:00",
"visibleEndDate": "2024-04-20T11:09:00.1756771+02:00",
"bannerImage": "sample string 8",
"sortOrder": 9
},
{
"id": 1,
"headline": "sample string 2",
"subheadline": "sample string 3",
"tag": "sample string 4",
"type": "sample string 5",
"data": "sample string 6",
"visibleStartDate": "2024-04-20T11:09:00.1756771+02:00",
"visibleEndDate": "2024-04-20T11:09:00.1756771+02:00",
"bannerImage": "sample string 8",
"sortOrder": 9
}
],
"themeItems": [
{
"id": 1,
"name": "sample string 2",
"startDate": "2024-04-20T11:09:00.1766755+02:00",
"endDate": "2024-04-20T11:09:00.1766755+02:00",
"sortOrder": 4,
"suppliers": [
{
"sortOrder": 1,
"supplierId": 2,
"name": "sample string 3",
"info": "sample string 4",
"teaser": "sample string 5",
"about": "sample string 6",
"imageUrl": "sample string 7",
"supplierImage": "sample string 8",
"address": {
"addressId": 1,
"detail": "sample string 1",
"latitude": 1.1,
"longitude": 1.1
},
"discountInfo": {
"info": "sample string 1",
"minPercent": 1.1,
"maxPercent": 1.1,
"minAmount": 1.1,
"maxAmount": 1.1,
"text": "sample string 2",
"currency": {
"currencySymbol": "sample string 1",
"isPrefix": true
}
},
"specialOfferInfo": {
"info": "sample string 1",
"endDateTimeUTC": "2024-04-20T11:09:00.1756771+02:00",
"timeLeft": "sample string 2",
"campaignImageUrl": "sample string 3",
"discountInfo": {
"info": "sample string 1",
"minPercent": 1.1,
"maxPercent": 1.1,
"minAmount": 1.1,
"maxAmount": 1.1,
"text": "sample string 2",
"currency": {
"currencySymbol": "sample string 1",
"isPrefix": true
}
},
"dealTitle": "sample string 4"
},
"numberOfAddresses": 9,
"primaryCategory": "sample string 10"
},
{
"sortOrder": 1,
"supplierId": 2,
"name": "sample string 3",
"info": "sample string 4",
"teaser": "sample string 5",
"about": "sample string 6",
"imageUrl": "sample string 7",
"supplierImage": "sample string 8",
"address": {
"addressId": 1,
"detail": "sample string 1",
"latitude": 1.1,
"longitude": 1.1
},
"discountInfo": {
"info": "sample string 1",
"minPercent": 1.1,
"maxPercent": 1.1,
"minAmount": 1.1,
"maxAmount": 1.1,
"text": "sample string 2",
"currency": {
"currencySymbol": "sample string 1",
"isPrefix": true
}
},
"specialOfferInfo": {
"info": "sample string 1",
"endDateTimeUTC": "2024-04-20T11:09:00.1756771+02:00",
"timeLeft": "sample string 2",
"campaignImageUrl": "sample string 3",
"discountInfo": {
"info": "sample string 1",
"minPercent": 1.1,
"maxPercent": 1.1,
"minAmount": 1.1,
"maxAmount": 1.1,
"text": "sample string 2",
"currency": {
"currencySymbol": "sample string 1",
"isPrefix": true
}
},
"dealTitle": "sample string 4"
},
"numberOfAddresses": 9,
"primaryCategory": "sample string 10"
}
]
},
{
"id": 1,
"name": "sample string 2",
"startDate": "2024-04-20T11:09:00.1766755+02:00",
"endDate": "2024-04-20T11:09:00.1766755+02:00",
"sortOrder": 4,
"suppliers": [
{
"sortOrder": 1,
"supplierId": 2,
"name": "sample string 3",
"info": "sample string 4",
"teaser": "sample string 5",
"about": "sample string 6",
"imageUrl": "sample string 7",
"supplierImage": "sample string 8",
"address": {
"addressId": 1,
"detail": "sample string 1",
"latitude": 1.1,
"longitude": 1.1
},
"discountInfo": {
"info": "sample string 1",
"minPercent": 1.1,
"maxPercent": 1.1,
"minAmount": 1.1,
"maxAmount": 1.1,
"text": "sample string 2",
"currency": {
"currencySymbol": "sample string 1",
"isPrefix": true
}
},
"specialOfferInfo": {
"info": "sample string 1",
"endDateTimeUTC": "2024-04-20T11:09:00.1756771+02:00",
"timeLeft": "sample string 2",
"campaignImageUrl": "sample string 3",
"discountInfo": {
"info": "sample string 1",
"minPercent": 1.1,
"maxPercent": 1.1,
"minAmount": 1.1,
"maxAmount": 1.1,
"text": "sample string 2",
"currency": {
"currencySymbol": "sample string 1",
"isPrefix": true
}
},
"dealTitle": "sample string 4"
},
"numberOfAddresses": 9,
"primaryCategory": "sample string 10"
},
{
"sortOrder": 1,
"supplierId": 2,
"name": "sample string 3",
"info": "sample string 4",
"teaser": "sample string 5",
"about": "sample string 6",
"imageUrl": "sample string 7",
"supplierImage": "sample string 8",
"address": {
"addressId": 1,
"detail": "sample string 1",
"latitude": 1.1,
"longitude": 1.1
},
"discountInfo": {
"info": "sample string 1",
"minPercent": 1.1,
"maxPercent": 1.1,
"minAmount": 1.1,
"maxAmount": 1.1,
"text": "sample string 2",
"currency": {
"currencySymbol": "sample string 1",
"isPrefix": true
}
},
"specialOfferInfo": {
"info": "sample string 1",
"endDateTimeUTC": "2024-04-20T11:09:00.1756771+02:00",
"timeLeft": "sample string 2",
"campaignImageUrl": "sample string 3",
"discountInfo": {
"info": "sample string 1",
"minPercent": 1.1,
"maxPercent": 1.1,
"minAmount": 1.1,
"maxAmount": 1.1,
"text": "sample string 2",
"currency": {
"currencySymbol": "sample string 1",
"isPrefix": true
}
},
"dealTitle": "sample string 4"
},
"numberOfAddresses": 9,
"primaryCategory": "sample string 10"
}
]
}
],
"customerLogoUrl": "sample string 1"
}