Options

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 Code Description
POLEXCESS Policy excess
CAREXCESS Rental car excess
SPECITEMS Specified item excess
ADVENTUREACTIVITY Adventure activity (World Nomads only)
SNOWSPORTS Snow sports
TRIPCANX Trip cancellation value
POLEXCESSPERCENT Excess buy out option
TRIPCANXPERCENT Trip 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:

Copy
Copied
basicOptions : [
  {SNOWSPORTS, isOptedIn : true
  },
  {POLICYEXCESSPERCENT, OptedInValue : 0
  },
  {CAREXCESS, OptedInValue : 5000
  }
]

Specified item option requests

Attribute Description
name Name of specified item (E.g. 'iphone 14')
itemValue Requested value to cover the specified item option
itemTypeCode The following types are available:
  • Electronic
  • Sport
  • Other|
Copy
Copied
specifiedItemOption : {
"SPECITEMS",
specfifiedItems : [
 {
   name : "iPhone 14", 
   itemValue : "1000",
   itemTypeCode : "Electronic" 
 }
]
}

Cancellation option requests

The following request provides ability to adjust cancellation cover limits:

Copy
Copied
cancellationOption : {
"TRIPCANX",
cancellationCoverLimit: 0
}

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.

Copy
Copied
 "prices": [
      {
          "planId": 79,
          "totalPrice": 700.24,
          "totalTax": 0,
          "iptTax": 0,
          "standardExcess": 150,
          "standardCancellationCoverageLimit": 5000,
      ...
      }
  ]

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:

Activity AdventureActivityId Level
Acrobatics 14739 Level 1
Aerial safari 14740 Level 2
Abseiling 14695 Level 3

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

Copy
Copied
        "adventureActivitiesOption": {
            "optionType": "ADVENTUREACTIVITY",
            "adventureActivityIds": [
                14695,
                15016
            ]
        },
Copyright © nib Travel 2022. All right reserved.