FeesServer

FeesServer

Facilitates interaction with the Fees server.

Constructor

new FeesServer(sdk, serverUrl, opts) → {Promise.<JsonApiResponse>}

Create a new Fees server instance.

Source:
Parameters:
Name Type Description
sdk ShelfNetwork

Parent SDK instance.

serverUrl string

Fees 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.

Returns:
Type:
Promise.<JsonApiResponse>

Classes

FeesServer

Methods

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

Get Georgia lot fees.

Source:
Parameters:
Name Type Description
query object

Request query.

Name Type Attributes Description
filter object

Query filter.

Name Type Attributes Description
currency string <optional>

Currency of lot price.

responseCurrency string <optional>

Currency of fee to be returned.

lotType number

Lot type.

platformId string

Lot platform ID.

lotPrice number

Lot price.

departureZipCode string <optional>

Lot transportation ZIP code.

productionYear number

Vehicle production year.

registrationYear number <optional>

A year when a car is expected to be registered.

engineVolumeCm number

Engine volume of the vehicle (in cubic centimeters)

fuelType string

Fuel type of vehicle.

wheelPosition string

Wheel position of vehicle.

departureCountry string

Lot departure country.

isNew boolean

Is vehicle new.

isRegistered boolean

Is lot registered.

include string | Array.<string> <optional>

Included relationships. Available: customs_fee_details, registration_fee_details

Returns:
Type:
Promise.<JsonApiResponse>

Fees response

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

Get Ukraine lot fees.

Source:
Parameters:
Name Type Description
query object

Request query.

Name Type Attributes Description
filter object

Query filter.

Name Type Attributes Description
currency string <optional>

Currency of lot price.

responseCurrency string <optional>

Currency of fee to be returned.

lotType number

Lot type.

platformId string

Lot platform ID.

lotPrice number

Lot price.

departureZipCode string <optional>

Lot transportation ZIP code.

productionYear number

Vehicle production year.

registrationYear number <optional>

A year when a car is expected to be registered.

engineVolumeCm number

Engine volume of the vehicle (in cubic centimeters)

fuelType string

Fuel type of vehicle.

departureCountry string

Lot departure country.

isNew boolean

Is vehicle new.

wheelPosition string

Wheel position of vehicle.

isRegistered boolean

Is lot registered.

include string | Array.<string> <optional>

Included relationships. Available: customs_fee_details, registration_fee_details

Returns:
Type:
Promise.<JsonApiResponse>

Fees response