Quote & Save V2

Generate multiple quotes (V2)

Generates price quotes for multiple products using the V2 API endpoint.

post/v2/quote/multi

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)

timezonestring

Timezone for the trip dates (IANA timezone identifier)

residencestring

Residence information (backward compatibility - accepts string). If provided, it will be used as areaLevel1 in residency. Either residence (string) or residency must be provided.

noTravellersnumber

The number of travellers

Example request

{
  "advisorId": "123456",
  "departureDate": "2023-05-18",
  "returnDate": "2023-05-30",
  "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
    }
  },
  "timezone": "America/New_York",
  "destination": [
    {
      "country": "FR",
      "areaLevel1": "CA",
      "locality": "Paris",
      "label": "Paris, France"
    }
  ],
  "residence": "CA",
  "residency": {
    "country": "FR",
    "areaLevel1": "CA",
    "locality": "Paris",
    "label": "Paris, France",
    "streetAndNumber": "123 Main St",
    "city": "San Francisco",
    "apartment": "Apt 4B",
    "zipCode": "94102"
  },
  "travellers": [
    {
      "dateOfBirth": "1985-05-15",
      "firstName": "John",
      "email": "john.doe@example.com",
      "lastName": "Doe",
      "mainTraveller": true
    }
  ],
  "utms": [
    {
      "key": "utm_source",
      "value": "google"
    }
  ],
  "noTravellers": 2
}

Response

The quotes have been successfully generated.

groupHashstring

The group_hash linking all quotes

isCompletedboolean

Whether the group was purchased

Example response

{
  "quotes": [
    {
      "quote": {
        "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

Changed in 2 of the 3 revisions of this API.121519

  • e016afb8fdb371518See the full diff
    • added InitialDepositBaseCoverageOptionRequestDto to the coverageOptions/allOf[AddonsRequestDto]/cfarOption request property allOf list

      request-property-all-of-added

    • the request property departureDate became required

      request-property-became-required

    • the request property destination became required

      request-property-became-required

    • the request property returnDate became required

      request-property-became-required

    • the destination/items/country request property's minLength was increased from 0 to 2

      request-property-min-length-increased

    • the departureDate request property type/format changed from date/ to string/date

      request-property-type-changed

    • the returnDate request property type/format changed from date/ to string/date

      request-property-type-changed

    • removed CfarCoverageOptionRequestDto from the coverageOptions/allOf[AddonsRequestDto]/cfarOption request property allOf list

      request-property-all-of-removed

    • the destination/items/country request property's maxLength was set to 2

      request-property-max-length-set

    • removed the request property destination/items/googlePlaceId

      request-property-removed

    • removed the request property destination/items/state

      request-property-removed

    • removed the request property destinations

      request-property-removed

    • removed the request property policyCodeHash

      request-property-removed

    • removed the request property product

      request-property-removed

    • removed the request property productCode

      request-property-removed

    • removed the request property productId

      request-property-removed

    • removed the request property productIds

      request-property-removed

    • removed the request property products

      request-property-removed

    • removed the request property travelerDetails

      request-property-removed

    • removed the request property tripEndDate

      request-property-removed

    • removed the request property tripStartDate

      request-property-removed

    • removed the optional property quotes/items/status from the response with the 201 status

      response-optional-property-removed

    • api tag Quote removed

      api-tag-removed

    • added the new optional request property coverageOptions/allOf[AddonsRequestDto]/cfwrOption

      new-optional-request-property

    • added the new optional request property coverageOptions/allOf[AddonsRequestDto]/medicalUpgrade

      new-optional-request-property

    • added the new optional request property destination/items/areaLevel1

      new-optional-request-property

    • added the new optional request property destination/items/fullCountryName

      new-optional-request-property

    • added the new optional request property destination/items/googleId

      new-optional-request-property

    • added the new optional request property destination/items/label

      new-optional-request-property

    • added the new optional request property destination/items/locality

      new-optional-request-property

    • added the new optional request property residency/allOf[ResidencyDtoV2]/city

      new-optional-request-property

    • the request property destination/items/country became nullable

      request-property-became-nullable

    • the request property travellers/items/firstName became optional

      request-property-became-optional

    • the request property travellers/items/isDriver became optional

      request-property-became-optional

    • the request property travellers/items/lastName became optional

      request-property-became-optional

    • the request property travellers/items/mainTraveller became optional

      request-property-became-optional

    • added the required property quotes/items/productName to the response with the 201 status

      response-required-property-added

    • added the required property quotes/items/quote/allOf[CreateQuoteResponseDto]/coverageOptions/allOf[AddonsDto]/cfwrOption to the response with the 201 status

      response-required-property-added

    • added the required property quotes/items/quote/allOf[CreateQuoteResponseDto]/coverageOptions/allOf[AddonsDto]/medicalUpgrade to the response with the 201 status

      response-required-property-added

    • added the required property quotes/items/quote/allOf[CreateQuoteResponseDto]/offerDescription to the response with the 201 status

      response-required-property-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • the departureDate request property type/format changed from string/date to date/

      request-property-type-changed

    • the productIds/items/ request property type/format changed from string/ to array/

      request-property-type-changed

    • the products/items/ request property type/format changed from string/ to array/

      request-property-type-changed

    • the returnDate request property type/format changed from string/date to date/

      request-property-type-changed

    • the travelerDetails/items/dob request property type/format changed from string/date to date/

      request-property-type-changed

    • added the new optional header request parameter Authorization

      new-optional-request-parameter