POST api/suppliers/search

Search Suppliers

Request Information

URI Parameters

None.

Body Parameters

Search Parameters

Name	Description	Type	Additional information
SearchString	Search string	string	None.
GeoLocation	Current geo Location	GeoLocation	None.
PageNumber	Page Number	integer	Default value is 0
PageSize	Page Size	integer	Default value is 10
SortDirection	Sort Direction	SortDirectionEnum	Default value is BestMatch
Facets	Facets Selection	FacetSelection	None.
CalculateFacets	Calculate Facets	boolean	Default value is False
OnContentSet	On Content Set Options	boolean	Default value is False

Request Formats

application/json, text/json

Sample:

{
  "searchString": "sample string 1",
  "geoLocation": {
    "longitude": 1.1,
    "latitude": 2.1
  },
  "pageNumber": 1,
  "pageSize": 1,
  "sortDirection": 0,
  "facets": {
    "brands": [
      "sample string 1",
      "sample string 2"
    ],
    "categories": [
      "sample string 1",
      "sample string 2"
    ],
    "dealTypes": [
      "sample string 1",
      "sample string 2"
    ],
    "departments": [
      "sample string 1",
      "sample string 2"
    ],
    "subCategories": [
      "sample string 1",
      "sample string 2"
    ],
    "themes": [
      "sample string 1",
      "sample string 2"
    ],
    "favorites": [
      "sample string 1",
      "sample string 2"
    ]
  },
  "calculateFacets": true,
  "onContentSet": true
}

Response Information

search result

Name	Description	Type	Additional information
SearchItems	Search Result Items	Collection of SearchResultItem	None.
Ads	Ad List	Collection of SearchResultItem	None.
TotalResults	Total Results count	integer	None.
Facets	Facets	FacetResult	None.

Response Formats

application/json, text/json

Sample:

{
  "searchItems": [
    {
      "supplierId": 1,
      "isFavorite": true,
      "name": "sample string 3",
      "about": "sample string 4",
      "teaser": "sample string 5",
      "imageUrl": "sample string 6",
      "supplierImage": "sample string 7",
      "specialOfferInfo": {
        "info": "sample string 1",
        "endDateTimeUTC": "2024-04-19T00:54:55.3726259+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"
      },
      "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
        }
      },
      "address": {
        "addressId": 1,
        "detail": "sample string 1",
        "latitude": 1.1,
        "longitude": 1.1
      },
      "numberOfAddresses": 8
    },
    {
      "supplierId": 1,
      "isFavorite": true,
      "name": "sample string 3",
      "about": "sample string 4",
      "teaser": "sample string 5",
      "imageUrl": "sample string 6",
      "supplierImage": "sample string 7",
      "specialOfferInfo": {
        "info": "sample string 1",
        "endDateTimeUTC": "2024-04-19T00:54:55.3726259+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"
      },
      "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
        }
      },
      "address": {
        "addressId": 1,
        "detail": "sample string 1",
        "latitude": 1.1,
        "longitude": 1.1
      },
      "numberOfAddresses": 8
    }
  ],
  "ads": [
    {
      "supplierId": 1,
      "isFavorite": true,
      "name": "sample string 3",
      "about": "sample string 4",
      "teaser": "sample string 5",
      "imageUrl": "sample string 6",
      "supplierImage": "sample string 7",
      "specialOfferInfo": {
        "info": "sample string 1",
        "endDateTimeUTC": "2024-04-19T00:54:55.3726259+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"
      },
      "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
        }
      },
      "address": {
        "addressId": 1,
        "detail": "sample string 1",
        "latitude": 1.1,
        "longitude": 1.1
      },
      "numberOfAddresses": 8
    },
    {
      "supplierId": 1,
      "isFavorite": true,
      "name": "sample string 3",
      "about": "sample string 4",
      "teaser": "sample string 5",
      "imageUrl": "sample string 6",
      "supplierImage": "sample string 7",
      "specialOfferInfo": {
        "info": "sample string 1",
        "endDateTimeUTC": "2024-04-19T00:54:55.3726259+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"
      },
      "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
        }
      },
      "address": {
        "addressId": 1,
        "detail": "sample string 1",
        "latitude": 1.1,
        "longitude": 1.1
      },
      "numberOfAddresses": 8
    }
  ],
  "totalResults": 1,
  "facets": {
    "brands": [
      {
        "count": 1,
        "name": "sample string 2",
        "selected": true
      },
      {
        "count": 1,
        "name": "sample string 2",
        "selected": true
      }
    ],
    "categories": [
      {
        "count": 1,
        "name": "sample string 2",
        "selected": true
      },
      {
        "count": 1,
        "name": "sample string 2",
        "selected": true
      }
    ],
    "dealTypes": [
      {
        "count": 1,
        "name": "sample string 2",
        "selected": true
      },
      {
        "count": 1,
        "name": "sample string 2",
        "selected": true
      }
    ],
    "departments": [
      {
        "count": 1,
        "name": "sample string 2",
        "selected": true
      },
      {
        "count": 1,
        "name": "sample string 2",
        "selected": true
      }
    ],
    "subCategories": [
      {
        "count": 1,
        "name": "sample string 2",
        "selected": true
      },
      {
        "count": 1,
        "name": "sample string 2",
        "selected": true
      }
    ],
    "themes": [
      {
        "count": 1,
        "name": "sample string 2",
        "selected": true
      },
      {
        "count": 1,
        "name": "sample string 2",
        "selected": true
      }
    ]
  }
}