Custom fields allow you add additional information to the listings in ILSA. You can add as many custom fields to ILSA as you want. Usually the values for those fields will be returned by one of your (webhook or TypeScript) enrichers, but it is also possible to push information (see below).
In the Backoffice you can create/edit/delete your custom fields. Custom fields exist for all your instances and you can’t have different field definitions between your prod and dev instance.
Custom fields can be used filtering, sorting, in fieldsets, as inputs for other enrichers etc.
The data types of fields are the same as described here on the fieldsets page.
WARNING
Once a custom field is created its type can’t be changed freely. Even deleting the field and creating it again (with the same name) is restricted to types which have a compatible storage format.
TIP
Contact us if you need any help with designing or configuring your custom fields.
Push fields are a type of custom fields that can be written to after the listing is created. Most fields are filled by DV or enrichers, but push fields are set by calls to the Hexon API.
One example usage of push fields is marking listings as top-ads. An advertiser on your site pays to promote a vehicle, and you set the field push.top_ad to true through the Hexon API. You can now use push.top_ad in your ordering.
PATCH https://api.hexon.nl/ilsa/api/v1/rest/objects/12345
Content-Type: application/json
Authorization: Basic ...
{
"push.top_ad": true
}
WARNING
Note that push fields will always start empty for new listings. In many cases a field filled by an enricher is more convenient for you to implement.
TIP
Changing a push field causes the vehicle to go through enrichment and indexing again. There will be a delay before your change is active on your site.
If you define fields under advertiser. they become visible in the Backoffice for each advertiser and can be viewed and modified. The data is stored with the advertiser and copied to each vehicle during enrichment.
INFO
Push and advertiser fields can’t be configured in the Backoffice yet. Contact us to get this set up.