klevurecord

ƭ klevurecord object index signature ▪ \[key string ] any type declaration name type description brand string the brand of the product, eg 'nike' category string a double semicolon ;; separated list of the most specific categories, not including their full path for example if a record was in 'mens > shoes' and 'mens > tees', the value would be shoes;;tees currency string the currency code applicable to the price values being displayed deliveryinfo string discount string freeshipping string groupprices string this field is not always populated and is mostly used in older integrations it includes the prices of your record in format groupid \ price so you can use your own frontend logic to display prices in realtime if you are using the b2b group price search parameters described in this documentation, the price and saleprice are automatically calculated so there is no need to use this field in most cases hideaddtocart string hidegroupprices string id string the unique identifier of the record within klevu image string the fully qualified url to the main image of your record imagehover string the fully qualified url to the secondary image of your record imageurl string the fully qualified url to the main image of your record instock string whether or not your record is in stock, 'yes' or 'no' itemgroupid string the identifier used to group compound products together, eg the id of the parent in the case of a configurable product klevu bulk boosting number any manual score assigned by the manual boosting rules this value must be either explicitly requested in fields or using search preference enablescores klevu category string this is mostly for internal purposes, but includes the categorisation of the record within klevu for example klevu product;;shop all;;bath;;;groupid 1 @ku\@kucategory\@ku\@ klevu manual boosting number any manual score assigned by the merchant this value must be either explicitly requested in fields or using search preference enablescores klevu selflearning boosting number the machine learning score assigned by the klevu search engine this value must be either explicitly requested in fields or using search preference enablescores name string the name of your record, eg the product name or category title price string the original price of your product, before any discounts this can be used as 'was price' when used in conjunction with saleprice rating number the rating of your product, between 0 and 5 saleprice string the actual selling price of your product, or 'now' price when used in conjunction with price note that when using filters, the sale price is represented by klevu price score number the score the record has achieved, ie how relevant it is, which is used for sorting by relevance this value must be either explicitly requested in fields or using search preference enablescores shortdesc string the short description of your record sku string the stock keeping unit of the record startprice string the saleprice of the lowest variant within all those indexed with the same itemgroupid this can be used if you would like to show 'as low as' price storebasecurrency string swatches? { color string ; id string ; image string ; numberofadditionalvariants string ; swatchimage string }\[] if your indexed data includes variants with swatch information, this will be provided here as a nested object with the following elements swatchesinfo string tags string any tags or keywords klevu has saved for the record toprice string the saleprice of the highest variant within all those indexed with the same itemgroupid this can be used if you would like to show 'from x to y' price range totalvariants number how many additional variants are available for this product for example when searching for 'small tshirt', if a product has 3 colours available in small then the value here will be 2 if the search was 'tshirt' then the same record would return a value of 8 if there are 3 colours and 3 sizes of each available type string typeofrecord klevuanytypeofrecord docid\ ktm5wqto44nqfuwumtxje the type of record, e g klevu product, klevu cms, klevu category, etc url string the fully qualified url used to access the record in your store variantid? string the identifier used at the platform level; which could be different from the unique klevu id, eg the id of the variant in the case of a configurable product weight string defined in models/klevurecord ts 3 https //github com/klevultd/frontend sdk/blob/492d3760/packages/klevu core/src/models/klevurecord ts#l3