Offer types aim to set a certain template on offer to specify their content according to a specific domain (Only available on V3 services).
An offer response is a mix between common offer fields and specific offer type fields:
We distinguish 12 offer types:
Theses offer types are set with the type attribute under the Offer tag in xml results of our web services; for example:
<ProductSearch> <Products totalResultsAvailable="4776" firstResultPosition="1" totalResultsReturned="20" searchOperator="and"> <Product> <Offer id="5b6892714bc16a6dd1c7b2608ca26bd9" type="VEHICLE">
Following are common fields for all offers:
| Name | Summary |
|---|---|
| Title | The offer name, with no control characters or embedded HTML. Max: 80 char |
| Description | The offer description, with no control characters or embedded HTML. (max : 300 char) |
| EstimatedCPC | Estimated revenue per click on this offer (desktop traffic) |
| EstimatedMobileCPC | Estimated revenue per click on this offer (mobile traffic) |
| Images | Different images of the offer with following informations:
|
| Url | The URL that links to the offer on the merchant website. The URL includes http://. |
| MobileUrl | The URL that links to the offer on the merchant website. The URL is dedicated to mobile OS. |
| MobileFriendly | Indicates if offer is mobile compliant or not. |
| CompareUrl | The URL to compare prices for that product on kelkoo site. |
| Merchant | Contains all merchant data:
|
| CatalogID | Contains couple [Catalog Id – Product id] if the offer has been matched to a product in our database. The Catalog Id can be used to reviews, specs or listings for the Catalog. |
| Catalog | Contains definition of product related to offer:
|
| Ean | The fully qualified, 13-digit European Article Numbering code for the product. This information is present for few products. |
| Category | Contains the name of the Category. Has the attribute:
|
| Price | Price informations with potential following items:
|
| MerchantCategory | Contains the name of the category according to merchant |
| Brand | Contains the name of the brand related to offer |
| BrandId | Contains the kelkoo id of the brand related to offer |
| Mpn | Contains the MPN |
| Sku | Contains the SKU |
| FashionSize | Contains the fashion size |
| OtherImages | Contains a list of other images :
|
| Weight | offer weight |
| LastModified | offer last modified date |
| EfficiencyClass | Indicates the efficiency class for a given product (i.e: A+ for a fridge) |
| GreenProduct | Indicates if a product is green or not |
| MadeIn | Indicates where the product has been made (i.e: France) |
| NbReviews | Indicates the number of reviews for the product on the merchant side. |
| UserRating | Indicates the average ratings for the product on the merchant side. |
| DeliveryProgram | A “PREMIUM” value indicates the presence of a top tier delivery program, usually available to users on a subscription model, eg Amazon Prime. |
Following are specific offer fields by offer type:
| Name | Summary |
|---|---|
| ProductClass | The classification of the product is one of the following numerical values:
|
| Warranty | Free text that indicates the warranty by the merchant |
| TypeSource | The origin of the car (professional…). Free Text, with no control characters or embedded HTML. |
| Year | The year of the car (can be the current year if it’s a new one). Free Text, with no control characters or embedded HTML. |
| Mileage | The km of the car (can be 0 if it’s a new one). It is a positive integer, with no unit |
| PostCode | The post code where the car is currently available. Free Text, with no control characters or embedded HTML. |
| Region | The region where the car is currently available. Free Text, with no control characters or embedded HTML. |
| Department | The department where the car is currently available. Free Text, with no control characters or embedded HTML. |
| CoordX | Geolocalisation. X coordinate where the car is available. Integer. |
| CoordY | Geolocalisation. X coordinate where the car is available. Integer. |
| NearDepartment | A list of close departments (identified by department numbers) from the department where the car is available, separated by “;“ |
| Energy | The energy of the product (oil, gasoil, ..). Free Text, with no control characters or embedded HTML. |
| Transmission | The transmission of the car (manual or automatic). Free Text, with no control characters or embedded HTML. |
| VehicleFuelType | |
| VehicleAllFuelTypes | |
| VehicleConsumptionHighway | |
| VehicleConsumptionCity | |
| VehicleConsumptionMix | |
| VehicleElectricConsumptionHighway | |
| VehicleElectricConsumptionCity | |
| VehicleElectricConsumptionMix | |
| VehicleCo2Emission | |
| TyreWetGrip | |
| TyreNoiseClass | |
| Color |
XML sample:
| Name | Summary |
|---|---|
| DepartDate | Pick-up date of the car, following the dd/mm/yyyy pattern |
| ReturnDate | Drop-off date of the car, following the dd/mm/yyyy pattern |
| PickupAddress | Pick-up address. Free text, with no control characters or embedded HTML. |
| PickupAirport | Pick-up airport code, following the international standards (see http://www.world-airport-codes.com/ for reference) |
| PickupTime | Pick-up time, following the hh:mm pattern |
| PickupCountry | Pick-up country, with no control characters or embedded HTML. |
| PickupTown | Pick-up location of the car, usually the city. Free text, with no control characters or embedded HTML. |
| DropoffAddress | Drop-off address. Free text, with no control characters or embedded HTML. |
| DropoffAirport | Drop-off airport code, following the international standards (see http://www.world-airport-codes.com/ for reference) |
| DropoffTime | Drop-off time, following the hh:mm pattern |
| DropoffCountry | Pick-up country, with no control characters or embedded HTML. |
| DropoffTown | Drop-off town. Free text, with no control characters or embedded HTML. |
| Transmission | Transmission of the car. Free text, with no control characters or embedded HTML. |
| AirCond | Indicates if air conditioning is available:
|
| Characteristics | List of the car features / options. Free text, with no control characters or embedded HTML ; each feature / option is separated by the “;” character. |
| CategoryType | Type of the car to hire. Free text, with no control characters or embedded HTML. |
| Model | Model of the car to hire. Free text, with no control characters or embedded HTML. |
| Containing | The number of passengers. It is a positive integer. |
XML sample:
| Name | Summary |
|---|---|
| TypicalApr | The typical APR, as a percentage.The typical_apr field is a positive float with a “.” separator ; it does not contain any symbol (currency, %, +/- …). |
| MinMonthlyRepaymentPercentage | The minimum monthly repayment percentage, as a percentage.The min_monthlyrepaymentpercentage field is a positive float with a “.” separator ; it does not contain any symbol (currency, %, +/- …). |
| IntroApr | The intro APR on purchases, as a percentage.The intro_apr field is a positive float with a “.” separator ; it does not contain any symbol (currency, %, +/- …). |
| IntroAprLength | Time period of intro APR on purchases. Free Text, with no control characters or embedded HTML (HTML entities are supported). |
| BalanceTransferFee | The balance transfer fee, as a percentage.The balance_transfer_fee field is a positive float with a “.” separator ; it does not contain any symbol (currency, %, +/- …). |
| IntroBalanceTransferLength | The Intro Balance transfer period – can be number of months or an actual date. Free text, with no control characters or embedded HTML (HTML entities are supported). |
| CashAdvanceRate | The cash advance annual rate, as a percentage.The cash_advance_rate field is a positive float with a “.” separator ; it does not contain any symbol (currency, %, +/- …). |
| CashWithDrawalFee | The cash withdrawal fee, as a percentage.The cash_withdrawal_fee field is a positive float with a “.” separator ; it does not contain any symbol (currency, %, +/- …). |
| MaxCashWithDrawal | The maximum cash withdrawal amount. Free text, with no control characters or embedded HTML (HTML entities are supported). |
| AnnualFee | Annual fee. It is a positive float with a max 2 decimals and a “.” separator ; it does not contain any currency symbol or spaces or +/- symbols.If annual_fee > 0 then the field annual_fee_details can be displayed to give more details. |
| AnnualFeeDetails | Annual fee details. Free text, with no control characters or embedded HTML (HTML entities are supported). |
| InternetFraudProtectionAvailable | Indicates if internet fraud protection is available:
|
| TravelInsurance | Indicates if travel insurance is available:
If travel_insurance = y then the field travel_insurance_details can be displayed to give more details. |
| TravelInsuranceDetails | Travel insurance details. Free Text, with no control characters or embedded HTML (HTML entities are supported). |
| CashbackAvailable | Indicates if there is a cashback option available:
If cashback_available = y then the field cashback_terms can be displayed to give more details. |
| CashbackTerms | Cashbacks details. Free Text, with no control characters or embedded HTML (HTML entities are supported). |
| CharityDonation | Indicates if charity donation is available:
If charity_donation = y then the field charity_donation_details can be displayed to give more details. |
| CharityDonationDetails | Charity donation details. Free Text, with no control characters or embedded HTML (HTML entities are supported). |
| PurchaseProtectionAvailable | Indicates if purchase protection is available:
If purchase_protection_available = y then the field purchase_protection_details can be displayed to give more details. |
| PurchaseProtectionDetails | Purchase protection details. Free Text, with no control characters or embedded HTML (HTML entities are supported). |
| LoyaltySchemeAvailable | Indicates if loyalty scheme is available:
If loyalty_scheme_available = y then the field loyalty_scheme_details can be displayed to give more details. |
| LoyaltySchemeDetails | Loyalty scheme details. Free Text, with no control characters or embedded HTML (HTML entities are supported). |
| LatePaymentFees | Late payment fees. It is a positive float with a max 2 decimals and a “.” separator ; it does not contain any currency symbol or spaces or +/- symbols. |
| OverCreditLimitFees | Over credit limit fee. It is a positive float with a max 2 decimals and a “.” separator ; it does not contain any currency symbol or spaces or +/- symbols. |
| CardLimit | The card limit (the amount of money you can spend on the card). It is a positive float with a max 2 decimals and a “.” separator ; it does not contain any currency symbol or spaces or +/- symbols. |
| IntroBalanceTransfer |
XML sample:
[sourcecode language=”xml”]
…
Virgin Money Virgin Credit Card
Typical APR: 16.6% – Intro APR: 0.0% / 3 monthsIntro Balance Transfer: 0.0% / 16 months
http://img.kelkoo.com/uk/medium/189/618/51801159212894516214470420993740618189.jpg
90
90
http://uk.shoppingapis.kelkoo.com/ctl/go/sitesearchGo?.ts=1253203923560…
Virgin Credit Cards
Credit Cards
16.6
1.0
0.0
3 months
2.98
16 months
0.0
0.0
no limit
0.0
There is no annual fee.
false
false
If the cardholder pays for their travel tickets with their Virgin Money Credit Card, they will be automatically covered for up to ?250,000 if they have an accident while travelling to or from their destination.
false
na
false
This is not a Charity Affiliation account.
false
Free purchase protection cover is available.
false
12.0
12.0
-1.0
…
[/sourcecode]
| Name | Summary | |||||
|---|---|---|---|---|---|---|
| Flight | flight content:
|
|||||
| TicketClass | Ticket class. It matches the display rules in terms of uppercases / lowercases. It does not contain the word “class” in it. I.e: economy instead of economy class | |||||
| NbAdults | Nr. of adults allowed on the flight. It is a positive number. | |||||
| NbChildren | Nr. of children allowed on the flight. It is a positive number. | |||||
| NbBabies | Nr. of babies allowed on the flight. It is a positive number. | |||||
| DestCountry | Full name for country destination |
XML sample:
| Name | Summary |
|---|---|
| Duration | Duration of the stay. It is a positive integer |
| DepartureDate | A multi-valued field that contains the available departure dates – following the yyyy-mm-dd format, and separated by the || separator. |
| Location | Town or Country name, with no control characters or embedded HTML. |
| Rating | Rating of the hotel. Numeric values to indicate the number of stars. It is contain an integer value. |
| Accommodation | Type of accommodation, with no control characters or embedded HTML. |
| ReturnDate | A field that contains the return date following the yyyy-mm-dd format |
| BoardBasis | Board basis. Free text, with no control characters or embedded HTML. |
| DepartureTown | Departure town. Free text, with no control characters or embedded HTML. |
| Equipments | List of equipments available. Free text, with no control characters or embedded HTML. |
| Extra | A list of extra features coming with the holiday. Free text, with no control characters or embedded HTML. |
| Transport | Transport options (Bus, Train…). Free text, with no control characters or embedded HTML. |
XML sample:
[sourcecode language=”xml”]
…
Balearics : Ibiza
The individual rooms offer a relaxing ambiance and a tastefully decorated. Almost all the rooms include a balcony or a terrace. All the rooms include a large bathroom, …
http://img.kelkoo.com/uk/medium/608/073/149196276455076753701740561320690073608.jpg
90
90
http://uk.shoppingapis.kelkoo.com/ctl/go/sitesearchGo?.ts=1253204020447&amp;amp;amp;…
On The Beach
Holidays
192.44
Price per person in double room.
-3
192.44
Ibiza
3
…
[/sourcecode]
| Name | Summary |
|---|---|
| ArrivalDate | Check-in date, following the dd/mm/yyyy pattern |
| Location | The town where the hotel is located. Free text. |
| DepartureDate | Check-out date, following the dd/mm/yyyy pattern |
| Rating | Rating of the hotel. It is a positive float with a “.” separator ; it does not contain any symbol (currency, %, +/- …) |
| RoomType | The room type, with no control characters or embedded HTML. |
| Duration | Duration of the stay. It is a positive integer |
| NbAdults | Nr. of adults allowed on the flight. It is a positive number. |
| NbChildren | Nr. of children allowed on the flight. It is a positive number. |
| NbBabies | Nr. of babies allowed on the flight. It is a positive number. |
| Address | The address of the hotel, with no control characters or embedded HTML. |
| Area | The area where the hotel is located, with no control characters or embedded HTML. |
| Country | The country where the hotel is located, with no control characters or embedded HTML. |
| Equipments | List of available services in the hotel, with no control characters or embedded HTML. |
| HotelChain | Hotel chain the hotel belongs to, with no control characters or embedded HTML. |
| BoardBasis | Board basis – simple, double…, with no control characters or embedded HTML. |
| HotelID | ID of the corresponding hotel in an Hotel database. |
| HotelDetailURL | URL that links on a page with more details about the hotel. |
| GeoLoc | Coordinates of the hotel. |
| Town | The town where the hotel is located. Free text. |
XML sample:
| Name | Summary |
|---|---|
| TypicalApr | Typical APR. The apr field is a positive float with a “.” separator |
| Currency | The currency, following the ISO-4217 international standard. See http://en.wikipedia.org/wiki/ISO_4217 for reference |
| PsCalculateAverageMonthlyCost | Monthly Cost |
| AmountMin | Amount to be borrowed. Minimum value of the range. |
| AmountMax | Amount to be borrowed. Maximum value of the range. |
| BadCredit | Your Credit Rating: used to eliminate/select bad credit loans. |
| Manufacturer | Loan Provider: List of card providers. |
| LoanTerm | Loan Length: How long the loan is for. |
| MinAge | Your Age: Minimum age of applicant. |
| MinIncome | Your Annual Salary: Salary of applicant. |
| ExpressDelivery | Express Delivery.
|
| DeferredStart | Deferred Start
|
| FlexibleRepayment | Flexible Repayment
|
| OnlineDescision | Online Decision
|
| EarlyRedemptionCost | Early redemption charge
|
| RateType | The rate type. Free Text, with no control characters or embedded HTML (HTML entities are supported). |
| PaymentProtectionAvailable | Payment Protection
|
| DirectDebitAvailable | Payment by Direct Debit
|
| PsAverageApplicantLoanAmount | Integer. The PS average loan amount and average loan period are generated via the config.xml and relate to the average of the two values (based on that tuples data). As we are unable to accept user inputted values in the L1 search this is the closest we can get to give the user a rough idea of what the repayment costs will be for an average loan. The ps_average_applicant_loan_amount is calculated by adding the min_amount and max_amount values and dividing by two. The ps_average_applicant_loan_period is calculated by adding the term_min and term_max values and dividing by two. At L2, these values are used until the filter is selected that replaces this value. |
| PsAverageApplicantLoanPeriod | Integer. See description for ps_average_applicant_loan_amount |
| annualFee | |
| totalCreditCharged |
XML sample:
[sourcecode language=”xml”]
…
−
Nationwide Personal Loan …
APR: 9.4% when borrowing for a period of 12 to 60 months.#br/#(* Monthly repayment shown is for a loan of …
http://img.kelkoo.com/uk/medium/063/542/00153738798701540733772343234687549542063.jpg
90
90
http://uk.shoppingapis.kelkoo.com/ctl/go/sitesearchGo?.ts=1253204104496&amp;amp;amp;…
NatWest Loans.
Personal Loans
gbp
639.72
15000.0
25000.0
Nationwide Building Society
18
8400.0
false
false
false
false
false
fixed
false
false
20000
36
…
[/sourcecode]
| Name | Summary |
|---|---|
| Network | The network the mobile phone will work on. Max: 30 chars |
| ContractType | The type of contract. Free Text, with no control characters or embedded HTML (HTML entities are supported). |
| ContractDuration | The duration of the contact, expressed as a number of months. The contract_duration field is a positive float with a “.” separator ; it does not contain any symbol (currency, %, +/- …). |
| LineRental | The monthly line rental. It is a positive float with a “.” separator ; it does not contain any symbol (currency, %, +/- …). |
XML sample:
[sourcecode language=”xml”]
…
Nokia E75 (Vodafone)
Contract Duration: 24 Months. Black Nokia E75 Contract Mobile Phone on Vodafone ??40 1200mins??? txt 24m with anytime any network minutes and anytime texts. Handset …
http://img.kelkoo.com/uk/medium/106/519/004420024729119398457848882306538519106.jpg
90
90
http://uk.shoppingapis.kelkoo.com/ctl/go/sitesearchGo?.ts=1253204150866&amp;amp;amp;…
Carphone Warehouse
Contract Mobile Phones
40.0
-3
40.0
0
Next Day For Mobiles else 2-3 days
false
Vodafone
Black Nokia E75 Contract Mobile Phone on Vodafone ??40 1200mins??? txt 24m with …
24.0
40.0
…
[/sourcecode]
| Name | Summary |
|---|---|
| Currency | The currency, following the ISO-4217 international standard. See http://en.wikipedia.org/wiki/ISO_4217 for reference |
| Tenure | The tenure of the property (the right to hold property; part of an ancient hierarchical system of holding lands). Free Text, with no control characters or embedded HTML. |
| Typesource | The origin of the good (professional…). Free Text, with no control characters or embedded HTML. |
| CategoryType | The type of the good (flat, house…). Free Text, with no control characters or embedded HTML. |
| Surface | The surface, as square meters. It is a positive float. |
| Garage | Indicates if the property has a garage or not. Free Text, with no control characters or embedded HTML. |
| Bathrooms | Indicates the number of bathrooms. It is a positive integer. |
| Rooms | Indicates the number of rooms. It is a positive integer. |
| Parking | Indicates if the property has a parking or not. Free Text, with no control characters or embedded HTML. |
| PostCode | The post code where the appartment/house is available. Free Text, with no control characters or embedded HTML. |
| City | The city where the appartment/house is available. Free Text, with no control characters or embedded HTML. |
| Since | date the offer has been published on the merchant site. It is a positive integer. |
XML sample:
[sourcecode language=”xml”]
…
Achat – Appartement CLERMONT FERRAND CENTRE VILLE (63000)
CLERMONT FERRAND Centre Ville Appartement de caractère 5 chambres au dernier étage avec ascenseur. 170m en très bon état. Terrasse, cuisine équipée, proche tous …
http://img.kelkoo.com/fr/medium/042/060/136619003967793734726494676560491060042.jpg
90
90
http://fr.shoppingapis.kelkoo.com:10080//ctl/go/sitesearchGo?.ts=1249290320434&amp;amp;amp;…
annoncesjaunes.fr
Petites annonces Achat
Appartement
eur
170
Non
11
CLERMONT FERRAND CENTRE VILLE
…
[/sourcecode]
| Name | Summary |
|---|---|
| Currency | The currency, following the ISO-4217 international standard. See http://en.wikipedia.org/wiki/ISO_4217 for reference |
| Aer | The standard AER, as a percentage. It is a positive float with a max 2 decimals and a “.” separator ; it does not contain any currency symbol or spaces or +/- symbols. |
| IntroRate | The intro rate, as a percentage. It is a positive float with a max 2 decimals and a “.” separator ; it does not contain any currency symbol or spaces or +/- symbols. |
| AccountType | The account type. Free Text, with no control characters or embedded HTML (HTML entities are supported). |
| RateType | The interest rate type. Free Text, with no control characters or embedded HTML (HTML entities are supported). |
| MinInvest | The Min Balance to open (Investment). It is a positive float with a max 2 decimals and a “.” separator ; it does not contain any currency symbol or spaces or +/- symbols. |
| MaxInvest | The Max Investment. It is a positive float with a max 2 decimals and a “.” separator ; it does not contain any currency symbol or spaces or +/- symbols. |
| MinAge | The age requirement. It is an integer ; it does not contain any currency symbol or spaces or +/- symbols. |
| Phone | Indicates if telephone banking is available or not:
|
| Post | Indicates if post banking is available or not:
|
| Internet | Indicates if internet banking is available or not:
|
| Branch | Indicates if branch banking is available or not:
|
| WithdrawNotice | The notice period to funds, as a number of days. It is a positive integer. Could be 0. “99999999” value is used to indicate data is not known. |
| IncentivesAvailable | Indicates if incentives are available: not clear %ENDCOLOR
If incentives = yes then the field incentives can be displayed to give more details. |
| Incentives | Incentives details. Free Text, with no control characters or embedded HTML (HTML entities are supported). |
XML sample:
[sourcecode language=”xml”]
…
Alliance &amp;amp;amp;amp;amp;amp; Leicester Premier Current Account
Account features: ATM (cash) card and cheque book with &amp;amp;amp;amp;amp;amp; guarantee.
http://img.kelkoo.com/uk/medium/487/226/00142857552644999655180921488827424226487.jpg
90
90
http://uk.shoppingapis.kelkoo.com/ctl/go/sitesearchGo?.ts=1253204930021&amp;amp;amp;…
A Premier Current Account
Current, ISA &amp;amp;amp;amp;amp;amp; Savings Accounts
gbp
0.5
Current Account
false
false
false
false
false
…
[/sourcecode]
| Name | Summary |
|---|---|
| Availability | Is it in stock, on command, how much time do we have to wait ? The following number will be translated to specific definitions:
|
| DeliveryTime | Free text that indicates the expected delivery time by the merchant |
| EventFlag | The merchant may used this fields to flag your offers for special event (ex : Mother’s Day, Bargains …) |
| FinancingOption | Partner informations:
|
| OffensiveContent | Indicates if the offer shows offensive content ; if yes, this can trigger special behavior at the front-end level (hide photo at L1…)
|
| ProductClass | The classification of the product. It is one of the following numerical values:
|
| Promo | Promotion informations:
|
| ShopInfo | You may use this field to relay any specific mentions that the merchant really want to strengthen. Up to 150 characters of text, with no control characters or embedded HTML (HTML entities are supported). |
| Warranty | Free text that indicates the warranty by the merchant |
| IsBundle | Indicates if the offer is a bundle of several products. single or bundle |
| Isbn | For Books only. The International Standard Book Number for the product. |
XML sample:
| Name | Summary |
|---|---|
| Currency | The currency, following the ISO-4217 international standard. See http://en.wikipedia.org/wiki/ISO_4217 for reference |
| Promo | Promotion informations:
|
| RelatedCategory | Contains the name of the Category. Has the attribute:
|
| Date | The voucher date |
XML sample: