TL;DR?
The most important field is the asking price: sales_conditions.pricing.asking.formatted. You must show it together with sales_conditions.pricing.asking.suffix.
For searching use sales_conditions.pricing.asking.amount.
Pricing can be surprisingly complicated, especially in regions with additional tax schemes such as the Netherlands (BPM). There are quite a few things to consider when displaying a price: VAT, currency, discounts, delivery costs, other taxes, advertiser preferences, prices on request, legislation, localization, et cetera.
To make things as easy as possible, ILSA will always return the correct price to show based on your target audience and region.
When displaying the asking price, use these two fields:
sales_conditions.pricing.asking.formatted. This contains the asking price, correctly formatted for the locale. For example “€ 15.000”.sales_conditions.pricing.asking.suffix. This contains additional important information to show next to the price. For example “plus VAT” or “Margin vehicle”.
These fields will take into consideration all variables, including the audience and region.
If you prefer to format the price yourself, you can use the .amount and .currency fields. Note that unless you specify the _currency parameter you might get prices in different currencies. See the currencies section below.
In some cases an alternative price is available which could be of use to your visitor, for example the price excluding VAT. The corresponding fields are sales_conditions.pricing.asking.alt_formatted and sales_conditions.pricing.asking.alt_suffix. It is of course up to you if and how you want to display this second price.
In case the vehicle has been discounted by the advertiser, the original price is available in sales_conditions.pricing.asking.before_discount.formatted, allowing you to show a before and after price.
If your instance serves multiple regions (countries), prices can differ from region to region. For example, an advertiser might have raised the asking price for a far-away region to compensate for the additional administration costs.
ILSA automatically picks the correct price based on the _region parameter, or your instance configuration.
ILSA also has extensive support for currencies. Advertisers can supply prices in multiple currencies. ILSA can complement these using automated currency conversion. ILSA tries to pick the best available currency for displaying.
When returning a price in a fieldset, ILSA follows these rules to choose the currency:
- If the request includes the
_currencyparameter, prices are in that currency. (If that currency is not supplied, the price would be left empty.) - If the price is available in the preferred currency of the region (see above), we choose that currency.
- Otherwise we choose the currency preferred by the advertiser.
Note that different price fields might return different currencies, if the dealer supplied them in different currencies. Always use the corresponding .currency field. By using the .formatted field you don’t need to worry about this.
ILSA has a module for automatic currency conversions based on the daily conversion rate. We’ll update all prices every night. Contact us to get this enabled.
On all requests to ILSA you can include the _currency parameter, for example /dropdowncontents?_currency=EUR&_fields=sales_conditions.pricing.asking.amount. The dropdowncontents and filtering will be done in the given currency. (If no _currency was given, we use the preferred currency of the visitors region.)
For calls returning a fieldset the prices in the fieldset will all be in the given currency.
If you need specific prices, for example to calculate a monthly price even more fields are available. For example sales_conditions.pricing.asking.business.in_eur.excl_vat.amount.
Below are schematic versions of the available price fields. Note that not all combinations are valid.
sales_conditions.delivery_costs info
delivery_packages[].price_absolute info
delivery_packages[].price_relative info
.be
.de
.fr
.nl
...
.consumer
.general
.business
.in_eur
.in_gpb
.in_usd
.in_czk
...
.incl_vat
.excl_vat
.before_discount
.currency info
.formatted info
.is_discounted info
.suffix info
.amount_has_vat info
.amount_has_dutch_bpm info
.alt_formatted
.alt_suffix
.alt_amount_has_vat
.alt_amount_has_dutch_bpm
Lease prices
If the vehicle is currently leased, lease_contract contains information about that contract. lease_proposals[] contains offers for which you can lease the vehicle.lease_proposals[]
.monthly_installment
.original_monthly_installment info
.over_distance_penalty
.under_distance_refund
.remaining_balance
.security_deposit
.total_price
.in_eur
.in_gpb
.in_usd
.in_czk
...
.formatted
Damage repair costs
.in_eur
.in_gpb
.in_usd
.in_czk
...
.excl_vat
.formatted
Equipment surcharges
.in_eur
.in_gpb
.in_usd
.in_czk
...
.excl_vat
.formatted
Price when new
.in_eur
.in_gpb
.in_usd
.in_czk
...
.net.amount
.net.formatted
.gross.amount
.gross.formatted
Fiscal value
.in_eur
.in_gpb
.in_usd
.in_czk
...
.gross.amount
.gross.formatted