| Name | Description | Type | Additional information |
|---|---|---|---|
| Zip |
5 Character US zip code or a 7 Character Canadian Postal code. Required for all US/CA searches. (international not supported). |
string |
None. |
| Country |
2 Character country code. Required. |
string |
None. |
| BrandFilter |
Comma-delimited list of brand codes to include in the search. Required. (Fireplaces BU: HNG,HTL,MAJ,MON,SFE,STL Stoves BU: QDF,HAR,VMT,FFE ) |
string |
None. |
| DealerType |
Consumer or Professional. Required. Aligns with ADP/IDP Eligibility. Required. |
string |
None. |
| RuleSet |
Rules engine to use for search: locator, lead or custom. Required. |
string |
None. |
| FiresideOnly |
Restrict search to owned Fireside locations only. |
boolean |
None. |
| PrimarySort |
How to present dealer results: award, distance. Optional. Defaults to 'award'. Not applicable to lead searches. |
string |
None. |
| Exclusions |
Delimited list of dealer ID's to exclude from search results. Optional. (used for lead reassignment) |
string |
None. |
| CustomRadiantType |
radius or nearest (search radius or number of dealers). Will only be evaluated for RuleSet:Custom searches. Internal use for custom searches. |
string |
None. |
| CustomRadiantValue |
Enter number for either radius miles or number of dealers depending on selected CustomRadiantType. Will only be evaluated for RuleSet:Custom searches.Internal use for custom searches. |
integer |
None. |