POST api/Syndication/SearchListProducts

Search all the products for a category with products that have brands the dealer is authorized to sell. Authorization required

Request Information

URI Parameters

None.

Body Parameters

RequestProductListSearch

Name	Type	Additional information
CategoryId	string	None.
SubcategoryId	string	None.
BrandCodes	Collection of string	None.
FuelType	string	None.
ProductIds	Collection of string	None.
SiteKey	string	None.

Request Formats

application/json, text/json

Sample:

{
  "CategoryId": "sample string 1",
  "SubcategoryId": "sample string 2",
  "BrandCodes": [
    "sample string 1",
    "sample string 2"
  ],
  "FuelType": "sample string 3",
  "ProductIds": [
    "sample string 1",
    "sample string 2"
  ],
  "SiteKey": "sample string 4"
}

application/xml, text/xml

Sample:

<RequestProductListSearch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/data.hearthnhome.Models.Syndication.Request">
  <SiteKey>sample string 4</SiteKey>
  <BrandCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </BrandCodes>
  <CategoryId>sample string 1</CategoryId>
  <FuelType>sample string 3</FuelType>
  <ProductIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ProductIds>
  <SubcategoryId>sample string 2</SubcategoryId>
</RequestProductListSearch>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'RequestProductListSearch'.

Response Information

Resource Description

ResponseProductListSearch

Name	Type	Additional information
ListProducts	Collection of jListProduct	None.
Success	boolean	None.
Message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ListProducts": [
    {
      "ProductID": "sample string 1",
      "ProductName": "sample string 2",
      "ImageUrl": "sample string 3",
      "ListImageUrl": "sample string 4",
      "Brand": "sample string 5",
      "BrandCode": "sample string 6",
      "MSRP": "sample string 7",
      "ClassSignature": "sample string 8",
      "FuelType": "sample string 9",
      "CategorySource": "sample string 10"
    },
    {
      "ProductID": "sample string 1",
      "ProductName": "sample string 2",
      "ImageUrl": "sample string 3",
      "ListImageUrl": "sample string 4",
      "Brand": "sample string 5",
      "BrandCode": "sample string 6",
      "MSRP": "sample string 7",
      "ClassSignature": "sample string 8",
      "FuelType": "sample string 9",
      "CategorySource": "sample string 10"
    }
  ],
  "Success": true,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:

<ResponseProductListSearch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/data.hearthnhome.Models.Syndication.Response">
  <Message>sample string 2</Message>
  <Success>true</Success>
  <ListProducts xmlns:d2p1="http://schemas.datacontract.org/2004/07/data.hearthnhome.Models.Syndication.Catalog">
    <d2p1:jListProduct>
      <d2p1:Brand>sample string 5</d2p1:Brand>
      <d2p1:BrandCode>sample string 6</d2p1:BrandCode>
      <d2p1:CategorySource>sample string 10</d2p1:CategorySource>
      <d2p1:ClassSignature>sample string 8</d2p1:ClassSignature>
      <d2p1:FuelType>sample string 9</d2p1:FuelType>
      <d2p1:ImageUrl>sample string 3</d2p1:ImageUrl>
      <d2p1:ListImageUrl>sample string 4</d2p1:ListImageUrl>
      <d2p1:MSRP>sample string 7</d2p1:MSRP>
      <d2p1:ProductID>sample string 1</d2p1:ProductID>
      <d2p1:ProductName>sample string 2</d2p1:ProductName>
    </d2p1:jListProduct>
    <d2p1:jListProduct>
      <d2p1:Brand>sample string 5</d2p1:Brand>
      <d2p1:BrandCode>sample string 6</d2p1:BrandCode>
      <d2p1:CategorySource>sample string 10</d2p1:CategorySource>
      <d2p1:ClassSignature>sample string 8</d2p1:ClassSignature>
      <d2p1:FuelType>sample string 9</d2p1:FuelType>
      <d2p1:ImageUrl>sample string 3</d2p1:ImageUrl>
      <d2p1:ListImageUrl>sample string 4</d2p1:ListImageUrl>
      <d2p1:MSRP>sample string 7</d2p1:MSRP>
      <d2p1:ProductID>sample string 1</d2p1:ProductID>
      <d2p1:ProductName>sample string 2</d2p1:ProductName>
    </d2p1:jListProduct>
  </ListProducts>
</ResponseProductListSearch>