PriceSuggesterServer

PriceSuggesterServer

Facilitates interaction with the price suggester server.

Constructor

new PriceSuggesterServer(sdk, serverUrl, opts)

Create a new price suggester server instance.

Source:
Parameters:
Name Type Description
sdk ShelfNetwork

Parent SDK instance.

serverUrl string

price suggester URL.

opts Object
Name Type Attributes Description
allowHttp boolean <optional>

Allow connecting to http servers, default: false. This must be set to false in production deployments!

proxy Object <optional>

Proxy configuration. Look axios docs for more info

httpBasicAuth Object <optional>

HTTP basic auth credentials. Look axios docs for more info.

customHeaders Object <optional>

Custom headers for request.

Classes

PriceSuggesterServer

Methods

getGoodConditionSuggestions(query) → {Promise.<JsonApiResponse>}

Get average of suggestions in good condition.

Source:
Parameters:
Name Type Description
query Object

Request query

Name Type Description
filter Object

Request query filter

Name Type Description
maker string

Maker enum value.

model string

Model enum value.

year number

Vehicle production year.

Returns:
Type:
Promise.<JsonApiResponse>

Suggestions response.

getSuggestions(vin, queryopt) → {Promise.<JsonApiResponse>}

Get average market price and closest available prices.

Source:
Parameters:
Name Type Attributes Description
vin string

Vehicle identification number.

query Object <optional>

Request query.

Name Type Attributes Description
primaryDamage string <optional>

Vehicle primary damage.

limit number <optional>

Maximum market prices to display.

Returns:
Type:
Promise.<JsonApiResponse>

Leasing requests page.