For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
HomeGuidesAPI ReferenceChangelog
HomeGuidesAPI ReferenceChangelog
  • Getting Started
    • Introduction
    • Authorization
  • Quote and Booking flows
    • Quote Purchase Flows
    • Country list
    • Displaying Prices
    • Options
    • Discounts
    • Taking payments
    • E-mail a quote
    • Medical screening
    • External membership numbers
  • Mid-office travel agent integration
    • Mid-office travel agent integration
  • Travel alerts
    • Travel alerts
LogoLogo
On this page
  • Available options
  • Basic option requests
  • Specified item option requests
  • Cancellation option requests
  • Fetching standard cancellation coverage limit for a quote
  • Adventure activity option requests
Quote and Booking flows

Options

Was this page helpful?
Previous

Discounts

Next
Built with

Options are optional extras that can be added to the product after a plan is selected.

These can be added using the Quotes API method, as part of the input request parameter.

Available options

The following are the available options available. Note that each product offered will not support all options provided below and available options will be product dependent:

Option CodeDescription
POLEXCESSPolicy excess
CAREXCESSRental car excess
SPECITEMSSpecified item excess
ADVENTUREACTIVITYAdventure activity (World Nomads only)
SNOWSPORTSSnow sports
TRIPCANXTrip cancellation value
POLEXCESSPERCENTExcess buy out option
TRIPCANXPERCENTTrip cancellation percentage

Basic option requests

Basic options are used to configure the following option types:

  • Snow sports coverage
  • Excess by out
  • Rental vechicle excess

The following show sample values for these options:

1basicOptions : [
2 {
3 “SNOWSPORTS”, isOptedIn : true
4 },
5 {
6 “POLICYEXCESSPERCENT”, OptedInValue : 0
7 },
8 {
9 “CAREXCESS”, OptedInValue : 5000
10 }
11]

Specified item option requests

AttributeDescription
nameName of specified item (E.g. ‘iphone 14’)
itemValueRequested value to cover the specified item option
itemTypeCodeThe following types are available:
  • Electronic
  • Sport
  • Other|
1specifiedItemOption : {
2"SPECITEMS",
3specfifiedItems : [
4 {
5 name : "iPhone 14",
6 itemValue : "1000",
7 itemTypeCode : "Electronic"
8 }
9]
10}

Cancellation option requests

The following request provides ability to adjust cancellation cover limits:

1cancellationOption : {
2"TRIPCANX",
3cancellationCoverLimit: 0
4}

Fetching standard cancellation coverage limit for a quote

In order to fetch the standard cancellation coverage limit for a quote (based on the # of the travellers) use prices[].standardCancellationCoverageLimit which is exposed via the Quote API.

1 "prices": [
2 {
3 "planId": 79,
4 "totalPrice": 700.24,
5 "totalTax": 0,
6 "iptTax": 0,
7 "standardExcess": 150,
8 "standardCancellationCoverageLimit": 5000,
9 ...
10 }
11 ]

Adventure activity option requests

Adventure activities is a World Nomads product option that provides the ability to have 3 levels of specified cover - Level 1, Level 2 and Level 3.

You can identify the list of adventure activities and whether a specified adventure activities is covered by the Options API Example adventure activities include:

ActivityAdventureActivityIdLevel
Acrobatics14739Level 1
Aerial safari14740Level 2
Abseiling14695Level 3

An example request to configure adventure activities is given in the following request:

1 "adventureActivitiesOption": {
2 "optionType": "ADVENTUREACTIVITY",
3 "adventureActivityIds": [
4 14695,
5 15016
6 ]
7 },