Skip to main content

Retrieve products' Terms & Conditions

When you sell a Koala product, the travellers should always have access to the details of the product they are buying inside your purchase funnel. So here's how to retrieve the Terms & Conditions (T&C) of your product! 👀

Why do I need to integrate this?​

Being able to retrieve products' T&C will be very useful for 3 reasons:

  • We may back your product by more than one insurance partner to offer you the best price possible (and each insurance company has its own T&C)
  • We are continuously improving the content inside the T&C to offer the clearest and most accessible documentation (and each improvement requires a new upload)
  • We will improve the protection offered by your products throughout our partnership (and each change requires a new upload)

In short, by implementing this logic, you will no longer care about changes in T&C in the future. 🚀

How does it work?​

When you will quote a trip using our API, you will receive in the body of the Quotes response the list of all the T&C related to the products you quoted.

Inside the response, you will find one T&C link per language per type of product. Even if your product is backed by more than 1 insurance partner, we will always show you only one T&C per productType as we will pre-select the most advantageous insurance provider.


Your job will be to retrieve the right T&C to display based on 3 fields:

  • language (ISO 639-1 standard) by matching it with your customers' language
  • productType by matching it with the product you are selling
  • bundles by matching it with the bundle(s) that you select

Once you manage to identify the right T&C, you will need to take the url associated and display this url inside your purchase funnel.

Example​

Because an example often makes more sense than an explanation, here is an example of quote response for a partner selling 2 bundles: Silver (containing only Flex) and Gold(containing both Flex and FDC):

{
  "data": [
    {
      "documents": [
        {
          "bundles": ["Gold", "Silver"],
          "type": "TERMS_AND_CONDITIONS",
          "productType": "WITHDRAWAL",
          "language": "en",
          "url": "https://hikoala.co/company-flex-tcs-en.pdf"
        },
        {
          "bundles": ["Gold", "Silver"],
          "type": "TERMS_AND_CONDITIONS",
          "productType": "WITHDRAWAL",
          "language": "fr",
          "url": "https://hikoala.co/company-flex-tcs-fr.pdf"
        },
        {
          "bundles": ["Gold"],
          "type": "TERMS_AND_CONDITIONS",
          "productType": "FLIGHT_DISRUPTION",
          "language": "en",
          "url": "https://hikoala.co/company-fdc-tcs-en.pdf"
        },
        {
          "bundles": ["Gold"],
          "type": "TERMS_AND_CONDITIONS",
          "productType": "FLIGHT_DISRUPTION",
          "language": "fr",
          "url": "https://hikoala.co/company-fdc-tcs-fr.pdf"
        }
      ],
      "id": "641ec6b7-c150-4a56-a40e-6f9a14c82075",
      "quotes": []
    }
  ]
}

If a customer is making a trip simulation on your French website and chooses the products Flex and FDC (aka the Gold Bundle), you should select https://hikoala.co/company-flex-tcs-fr.pdf and https://hikoala.co/company-fdc-tcs-fr.pdf as both products are offered to the traveller and they are using "FR" as a language on your website. However, if only the Flex product is available for this French customer (aka the Silver Bundle), you should select https://hikoala.co/company-flex-tcs-fr.pdf.

note

We will always provide a T&C in English.