WIwithfaye
Quote

Generate a new quote (single product)

Changed on

Generates a price quote for a single product based on specified information.

post/v1/quote

Request

Headers

Authorizationstring

Bearer token

Request body

advisorIdstring

A unique identifier for the agent triggering this quote

departureDatestring date required

First day of trip

returnDatestring date required

Final day of trip

tripCostnumber

Value of non-refundable trip costs in $USD. Minimum $1000. Maximum is $150,000 or $50,000 per traveler (the lower between them)

productId'PR-STANDARD-01' | 'PR-SPORTS-01' | 'PR-CFAR-01' | 'PR-STANDARD-DO' | 'PR-SPORTS-DO' | 'PR-CFAR-DO' | 'PR-STR' | 'PR-GENERAL-STR' | 'RETAIL' | 'PR-FirstCountrywide' | 'PR-ForwardCountrywide' | 'PR-FlagshipCountrywide'

Product ID - relevant only for specific partners. Single product for single quote.

productIdsstring[]

Array of product IDs or group names for multi-quote. If provided, will create quotes for all products. Can contain ProductIdEnum values or group names.

productCodestring required

The product code to quote for, this field is no longer used

timezonestring

Timezone for the trip dates (IANA timezone identifier)

residencestring required

State of residence (USA) of all travelers. If some travelers are in different states, please quote for each state.

travelerDobsnumber[] required

List of dates of birth of the travelers. The price is age sensitive. If the full date of birth is missing, you can select Jan 1st of the relevant year. Either this field or travelerDetails must be provided

externalIdstring

The ID of the user on the partner system

noTravellersnumber

The number of travellers

Example request

{
  "advisorId": "123456",
  "departureDate": "2023-05-18",
  "returnDate": "2023-05-30",
  "destination": [
    {
      "country": "US",
      "googlePlaceId": "ChIJYYOWXuckZUcRZdTiJR5FQOc",
      "state": "CA"
    }
  ],
  "coverageOptions": {
    "cfarOption": {
      "initialDepositDate": "2023-05-18"
    },
    "cfwrOption": {
      "initialDepositDate": "2023-05-18"
    },
    "carRentalOption": {
      "carDatesDto": [
        {
          "startDate": "2023-05-18",
          "endDate": "2023-05-19",
          "noOfCars": 1
        }
      ],
      "noOfCars": 2
    }
  },
  "productId": "PR-STANDARD-01",
  "productIds": [
    "PR-STANDARD-01",
    "PR-SPORTS-01"
  ],
  "timezone": "America/New_York",
  "residence": "CA",
  "travelerDobs": [
    "1965-12-01",
    "1965-07-23"
  ],
  "travelerDetails": [
    {
      "firstName": "Jane",
      "lastName": "Doe",
      "email": "jane.doe@gmail.com",
      "dob": "1980-11-25"
    }
  ],
  "externalId": "Aa123",
  "noTravellers": 2,
  "utms": [
    {
      "key": "utm_source",
      "value": "google"
    }
  ]
}

Response

The quote has been successfully generated.

currentPricenumber required

The price for this quote is in $USD, including all selected add-ons.

policyExampleUrlstring required

URL to a PDF document of an example policy. Policy examples change based on the state of residency and whether the trip is domestic or international. By the regulation, it is mandatory to allow the traveler to review an example policy before purchasing.

quoteUrlstring required

URL to a printable version of the quote, which highlights the coverage options and price for that specific quote.

quotePageUrlstring required

URL to the web page for purchasing the quote

quoteHashstring required

Quote hash identifier for this quote

offerDescriptionobject required

Offer page V5 for this quote

Example response

{
  "currentPrice": 100.24,
  "coverageOptions": {
    "petOption": {
      "price": 100.24
    },
    "trcOption": {
      "price": 100.24
    },
    "cfarOption": {
      "price": 100.24
    },
    "cfwrOption": {
      "price": 100.24
    },
    "adventureOption": {
      "price": 100.24
    },
    "vacationRentalOption": {
      "price": 100.24
    },
    "carRentalOption": {
      "price": 100.24,
      "pricePerCarPerDay": 100.24
    },
    "medicalUpgrade": {
      "price": 100.24
    }
  },
  "quoteHash": "abc123def456"
}

Changes

  • e016afb8fdb3Revision changes
    • breaking

      added to the ///// request property allOf list

    • breaking

      the request property type changed from date to string, and format from no format to date

    • breaking

      the / request property type changed from array to string

    • breaking

      the request property type changed from date to string, and format from no format to date

    • breaking

      the // request property type changed from date to string, and format from no format to date

    • warning

      removed from the ///// request property allOf list

    • info

      api operation id generate removed and replaced with generateQuote

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the required property ///// to the response with the status

    • info

      added the required property ///// to the response with the status

    • info

      added the required property to the response with the status

  • e95f3723e41fRevision changes
    • breaking

      the request property type changed from string to date, and format from date to no format

    • breaking

      the / request property type changed from string to array

    • breaking

      the request property type changed from string to date, and format from date to no format

    • breaking

      the // request property type changed from string to date, and format from date to no format

    • info

      api operation id createQuote removed and replaced with generate

    • info

      added the new optional header request parameter Authorization