Quote request data dictionary | Allianz Partner Services

Element	Type	Definition
`Location`	object
`city`	string	The city in the travel itinerary.
`code`	string	The airport code or other identifier for the location.
`country`	string	The 2 letter abbreviation or code country for the location.
`region`	string	The abbreviation or code for state province or region.
`Address`	object
`address1`	string	First line of address. Do not persist for customer.
`address2`	string	Second line of address. Do not persist for customer.
`city`	string	Address city. Do not persist for customer.
`country`	string	The country for this address.
`postalCode`	string	The postal code for this address. Do not persist for customer.
`region`	string	The abbreviation or code for state province or region. Referenced in Origin elements in for travel.
`Membership`	object
`level`	string	Status or level of membership.
`name`	string	The name of the membership.
`number`	string	The membership number assigned to the member.
`type`	string	The type of membership.
`Customer`	object
`age`	integer	Age of the customer.
`assistanceType`	string	These are values provided by the partner which provide information into what type of assistance is needed by the customer during their travel.
`birthDate`	string	Birthdate of the customer. Do not persist.
`canPersist`	boolean	Indicates whether the customer information may be persisted to the AWP database.
`customerId`	string	Unique identifier generated by Partner to identify customer.
`customerType`	string	Descriptive category for the traveler. Values may be vertical-specific. (Adult Child Infant Senior …)
`demographicInfo`	object
`occupation`	string	Occupation of the customer. Do not persist.
`emailAddress`	string	Email address of policyholder. Do not persist.
`firstName`	string	First name of customer. Not Persisted.
`gender`	string	Gender of the customer.
`includeForPricing`	boolean	Indicates should be included in AWP internal traveler group pricing.
`includeInGroupDetermination`	boolean	Indicates should be included in AWP internal traveler group pricing.
`lastName`	string	Last name of customer. Not Persisted.
`memberships`	array
`middleInitial`	string	Middle initial of traveler. Do not persist.
`nationality`	string
`okToContact`	boolean	Indicates whether marketing representatives may contact the customer.
`options`	array
`phones`	array
`items`	object
`areaCode`	string	represents the area code of customer’s phone number
`countryCode`	string	represents the country code of customer’s phone number
`isPrimary`	boolean	Indicates if this phone number can be treated as the primary phone number for the customer
`number`	string	Represents the customer’s phone number. Not persisted.
`type`	string	Type of customer’s phone - Home Work Mobile etc.
`relationshipToPrimary`	string	Relationship of the person in the sequence to the primary customer.
`salutation`	string	The nickname or greeting the customer prefers to be called. Do not persist
`sequence`	integer	The sequential order of the primary driver in the list. In most cases this would be the first position in the list.
`suffix`	string	A name suffix if used. Do not persist
`title`	string	A personal title if used. Do not persist
`totalCost`	number	Travel cost per traveler. Iindividual cost relating to the transaction item (Motor or Travel or Event etc..)
`Vehicle`	object
`age`	integer	Age of the vehicle.
`annualDistance`	integer	Estimated annual miles driven with the vehicle.
`antiTheftDevice`	string	Whether or not vehicle has an anit theft device.
`associatedTrailerSequence`	integer	Sequence number of the associated trailer.
`bodyStyle`	string	The body style of the vehicle.
`color`	string	The painted color of the vehicle.
`edition`	string	The edition of the vehicle.
`engineSize`	integer	The size of the vehicle engine in millileters. (4200 = 4.2)
`firstRegistrationDate`	string	The date on which the vehicle was first registered.
`fuelType`	string	The type of fuel used in the vehicle.
`horsePower`	integer	Horse power or power (kw) as a number.
`imageURL`	string	Image of the vehicle
`isForBusinessUse`	boolean	Is the vehicle used for business.
`isHighMileage`	boolean	Is the vehicle considered in the high-mileage range by the partner.
`isOriginalOwner`	boolean	Is the current owner the original owner
`lastRegistrationDate`	string	The most recent registration date of the vehicle.
`manufactureDate`	string	The year the vehicle was manufactured.
`manufacturer`	string	Name of the vehicle manufacturer.
`model`	string	The model of the Vehicle.
`options`	array
`parkedAtNightLocation`	string	Where the vehicle is parked at night.
`plateNumber`	string	The plate or tag number issued when the vehicle was registered.
`primaryDriverSequence`	integer	The sequential order of the primary driver in the list. In most cases this would be the first position in the list.
`primaryUse`	string	Primary use of the vehicle.
`regionWhereRegistered`	string	State province or region where vehicle is registered.
`riskCategory`	string	Partner-defined risk.
`sequence`	integer	The sequence number of the vehicle in the request.
`situationOfRisk`	string	Partner-defined
`value`	number	The current value of the vehicle in the currency type of the partner.
`vehicleIdentification`	string	A unique identifier assigned to this vehcle by the governing authority such as the VIN assigned in the US).
`vehicleType`	string	The type of vehicle to be insured.
`weight`	integer	Weight of the vehicle
`yearsOwned`	integer	# years the vehicle in under ownership
`MotorRelated`	object
`distanceToWork`	integer	The distance the driver travels to work.
`driverCategory`	string	Indicates a category of the driver.
`hasCommuterTicket`	boolean	Indicates whether the driver is the holder of a commuter railway ticket.
`hasMileageAllowance`	boolean	Indicates whether the driver has a job-related mileage allowance.
`isDrivingOtherCars`	boolean	Indicates whether the driver has use of other cars.
`isFulltimeCarUse`	boolean	Indicates the car will be in fulltime use by the drivers.
`licenceStatus`	string	The status of the license held by the driver.
`licenceType`	string	The type of license held by the driver.
`noClaimsBonusCode`	string	The code used to identify the bonus offered to the customer.
`noClaimsStepCode`	string	If applicable a step code for the no-claim bonus code.
`noClaimsYears`	integer	Years of no claim for the driver.
`noClaimsYearsNamedDriver`	integer	The no-claim years for a driver other than the primary driver.
`noClaimsYearsOwnName`	integer	The no-claim years for the primary driver.
`penaltyPoints`	integer	The Total penalty points against the driver.
`yearFirstLicenceHeld`	integer	The year the driver first obtained a licence.
`TravelLeg`	object
`arrivalDate`	string	Arrival Date for this leg.
`brandedFare`	string	TBD - Partner defined branded fare for travel leg.
`classOfService`	string	The class of service for this segment
`departureDate`	string	Departure Date for this leg.
`distanceTraveled`	integer	The distance in miles for this segment
`equipmentType`	string	The description of the equipment used for this segment
`fareClass`	string	Fare class code of this flight segment
`isDomestic`	boolean	Indicates if trip is considered domestic by Partner.
`layoverDuration`	integer
`options`	array
`routeGroup`	string	A route is defined by the origin and destination of a unit of travel. Routes can be combined into a group.
`routeNumber`	string	The flight number as assigned by the airline for this route.
`seatAvailability`	integer	Total number of available seats on the equipment type
`seatCapacity`	integer	Total number of seats the equipment type can support
`sequence`	integer	The sequence of the traveling segment in the trip
`travelDuration`	integer	The length or duration of the trip in minutes
`TravelSegment`	object
`arrivalDate`	string	Arrival Date for this segment.
`brandedFare`	string	TBD - Partner defined branded fare for travel segment.
`classOfService`	string
`departureDate`	string	Departure Date for this segment.
`distanceTraveled`	integer
`fareClass`	string
`includesConnection`	boolean	Does this segment have more than 1 leg?
`isDomestic`	boolean	Indicates if trip is considered domestic by Partner.
`layoverDuration`	integer
`options`	array
`routeGroup`	string
`sequence`	integer	The sequence of the traveling segment in the trip
`travelLegs`	array
`Travel`	object
`autoTrain`	boolean	Indicates that an autotrain is being booked.
`brandedFare`	string	TBD - Partner defined branded fare for trip
`classOfService`	string	The class of service in the booking e.g. business.
`connection`	string	? check which one is right (DB or Dictionary)
`departureDate`	string	The scheduled date of departure for the trip.
`includesConnection`	boolean	Does this trip have more than 1 segment or leg?
`isDomestic`	boolean	Indicates if trip is considered domestic by Partner.
`options`	array
`refundable`	string	Indicates that the booking is refundable
`returnDate`	string	The scheduled date or return for the booking.
`routeGroup`	string	A route is defined by the origin and destination of a unit of travel. Routes can be combined into a group.
`ticketSalesType`	string	The type of tickets sold. (Pre-Sales VIP Members Only Fan club sales …)
`totalCost`	number	Total cost including taxes surcharges and fees. In Air Wrapper a value > 0 is enforced
`travelAgent`	string	The agent or agent site that is booking the travel.
`travelLegs`	array	Collection of travel legs. Populate this when segments are not used.
`travelPurpose`	string	The traveler’s purpose of travel.
`travelSegments`	array	Collection of segments
`tripDuration`	integer	The length or duration of the trip in days.
`tripIndicator`	string	The type of trip booked. Should be either Round-trip; One-way; or Multicity.
`SearchPreference`	object
`flexibleDates`	boolean	Indicates whether flexible dates are used in the search criteria.
`includeNearbyAirports`	boolean	Indicates if nearby airports are included in the search criteria.
`includeWeekends`	boolean	Indicates if weekends were included in the search criteria.
`maxPrice`	number	Top of the price range a customer is searching
`minPrice`	number	Bottom of the price range a customer is searching
`searchByPrice`	boolean	Indicates if price was used in the search criteria.
`searchBySchedule`	boolean	Indicates if flight or event schedule was used in the search criteria.
`AdditionalItem`	object
`cost`	number	The cost of the additional item.
`currencyType`	string	The type of currency being used in the form of the three character ISO format currency code.
`description`	string	The description of the product.
`externalIdentifier`	string	The identifier used by the partner.
`name`	string	The name of the associated product.
`options`	array
`quantity`	integer	The number of the products in the request.
`sequence`	integer	The sequence of the associated product.
`totalCost`	number	Quantity x Cost
`Provider`	object
`isPrimary`	boolean	Indicates the primary product provider.
`options`	array
`providerCode`	string	The code used by the product provider.
`providerName`	string	The name of the product provider.
`providerType`	string	The type of product provider.
`RequestDetail`	object
`businessUnit`	string	Country where products are eligible to be sold.
`clientVersion`	string	Version of the JS
`costIncludes`	array	array of items included in cost
`items`	string
`currency`	string	The type of currency being used in the form of the three character ISO format currency code.
`cxid`	string	Customer Experience ID. This value is returned by AWP in the first quote response so only applies in customer scenarios where the partner is making multiple quote requests within the customer’s browsing session.
`dataSource`	string	Line of Business Source for the data sent to AWP
`exchangeRate`	number	The exchange rate that should be used to convert prices from their default currency into the requested currency
`experimentVariant`	string	Indicates which experiment (marketing test) was origingally rendered so that it may be given again under the same circumstances or session
`itemDeliveryMethod`	string	The method for receipt of the ticket(s).
`language`	string	Two character ISO format language code.
`locations`	array	List of codes where we are allowed to optimize for the request.
`items`	string	AWP location code
`offerVersionId`	integer	ID that allows tracking of offer when Partner is transitioning between different AWP platform versions. Also allows AWP to align offers to different versions of the partner’s path.
`options`	array
`redemptionPoints`	number	The number of program points being redeemed by the customer in the booking.
`requestCategories`	array	Contains a delimited list of booking categories.
`items`	string
`requestChannel`	string	The partner’s site that sent this request.
`requestedDate`	string	Populates current server date by default - exposed for internal purposes
`requestOrigin`	string	The location or logical entity within the partner’s site where the request originated (e.g. booking or managed reservations).
`requestOriginPage`	string	The specific page that sent this request.
`requestingHost`	string	Host issuing request - Host URL (origin from WidgetRequest)
`salesOriginType`	string	The location from which the booking was made.
`sessionId`	string	Session Id that AWP receives in the quote request. Allows AWP to track duplicate requests within same visitor session. Supports identification of duplicates in analytical activities.
`trafficSource`	string	Describes source of traffic which brought the consumer to partner site prior to insurance purchase.
`transactionId`	string	Available for Partner to send a unique ID with their quote request which will flow through the entire transaction. AWP will return it in their response and the partner can send it back with the purchase request.
`usePromotionCode`	boolean	Indicates that a promotion code was used for the booking.
`vertical`	string	Request line of business such as AIRFARE EVENT or MOTOR.
`visitorId`	string	Used to help track a customer and the offers that they receive when the customer retursn to the site.
`widgetKey`	string	Unique identifier generated by AWP for each client widget. Will be populated by the partner when interacting with the Widget/JS.
`RequestProductSequence`	object
`sequence`	integer	The number of the sequence.
`sequenceType`	string	The name of the sequence. Ex: Leg or Segment
`RequestProductOption`	object
`name`	string	The name of the product option. Ex: SeatGroup
`value`	string	The value of the product option. Ex: ExtraLegRoom Upfront
`RequestProductPrice`	object
`isAvailable`	boolean	Indicates if this product/option is not available for purchase.
`isIncluded`	boolean	Indicates if the product/option is included with another product or package.
`price`	number	The price for the product
`productOptions`	array
`productSequences`	array
`stepName`	string	Indicates step that price is for.
`RequestProduct`	object
`isAvailable`	boolean	Indicates the product is available to the current customer.
`isDefault`	boolean	Indicates if partner has defaulted this selection.
`isEditable`	boolean	Can user select and unselect this product?
`isSelected`	boolean	Indicates if the product was selected for purchase.
`price`	number	The price for the product if not priced differently per leg option or other factor.
`pricePoints`	array
`productCode`	string	Code that uniquely defines the product.
`supplierCode`	string	The supplier code assigned by AWP.
`Partner`	object
`distributorCode`	string	The partner code assigned by AWP.
`externalCode`	string	This is a code that the partner is assigned by other external systems. This may be needed for reporting and fulfilment purposes and can be different from the partner code that is assigned by AWP.
`externalSubCode`	string	Placeholder if additional code is needed.
`Incident`	object
`customerSequence`	integer	The sequencial order in the list of the specific customer to which the incident applies.
`description`	string	A more detailed description of the incident.
`incidentType`	string	A short code that describes the type of vehicle-related incident (e.g. SPEEDING DUI PARKING). Thse codes will be defined by the partner and/or provider.
`penaltyPoints`	integer	The penalty points for the specific incident.
`vehicleSequence`	integer	The sequencial order in the list of the specific vehicle to which the incident applies.
`Lodging`	object
`accomodationType`	string	Accomodation type being booked: Timeshare Hotel Vacation Rental Shared Accomodation etc.
`agencyRating`	number	The travel agency rating given by the preferred agency.
`availability`	string	Airbnb groupings for properties (Limited Popular Rare etc)
`cancelationPolicyType`	string	Whether the cancellation policy on the Airbnb property is flexible or strict
`carbonMonoxideDetector`	boolean	Whether Airbnb property has a carbon monoxide detector
`chain`	string	The name of the hotel chain in the itinerary.
`checkInDate`	string	The hotel checkin date on the itinerary.
`checkOutDate`	string	The hotel checkout date on the itinerary.
`crib`	boolean	Indicates a crib is needed for the booking.
`eventName`	string	The name of the specific event in the itinerary.
`fireExtinguisher`	boolean	Property has fire extinguisher
`hostName`	string	First name of the host / DO NOT PERSIST
`hostStatus`	string	Status of Airbnb Property Host
`hotTub`	boolean	Property has hot tub
`indoorFirePlace`	boolean	Property has indoor fireplace
`instantBooking`	boolean	Whether the Airbnb booking is an instant booking
`levelOfService`	string	Level of service: World Class Service Mid-Range Service Budget/Limited Service etc.
`locationCategory`	string	The category of the hotel location as information of the area.
`locationType`	string	The location of the accomodation as specified by the vendor.
`name`	string	The name of the specific hotel in the itinerary.
`numberOfBedRooms`	integer	Number of bedrooms in unit
`numberOfBookingUnits`	integer	Number of units in the property that are being booked for this request
`options`	array
`petsAllowed`	boolean	Are pets allowed
`propertyType`	string	House appartment loft etc.
`rateType`	string	The type of rate given for the booking.
`refundable`	string	Indicates that the booking is refundable
`rollaway`	boolean	Indicates a rollaway bed is needed for the booking.
`roomType`	string	Whether the property’s room is an entire home private room or shared room
`smokeDetector`	boolean	Property has smoke detectors
`smokingAllowed`	boolean	Property allows smoking
`starRating`	number	This is the star rating given by travel industry.
`thumbRating`	number	This is the rating given by the end user (average of reviews). Varies by distributor.
`totalCost`	number	The total cost including taxes fees and surcharges.
`zone`	string	Whether a partner country of residence (BU) is the same as the accomodation’s country of residence is ‘domestic’ or ‘international’.
`Gadget`	object
`browserType`	string	Indicates the type of browser used to access the website. For example: Internet Explorer
`browserVersion`	string	Indicates the version of the browser used to access the website. For example: IE7
`deviceCategory`	string	Indicates the category of device being used to access the partner website
`deviceType`	string	Describes the brand of device used to access the partner website. For example: BlackBerry
`ipAddress`	string	IP address of the computer or device which is being used when accessing the partner site
`operatingSystem`	string	Indicates the operating system that the traveler is using when accessing the partner site
`operatingSystemVersion`	string	Indicates the version of the operating system the traveler is using when accessing the partner site
`requestingPlatform`	string	The platform from which the request was initiated
`requestingPlatformVersion`	string	Version of the platform from which the request was initiated
`userAgent`	string	User Agent string that provides information about user’s device.
`OfferType`	object
`offerDescription`	string	The description of the offer requested.
`offerTypeId`	integer	The id of the offer type.
`options`	array
`Event`	object
`artistId`	integer	The id given to the artist by the booking agent.
`artistName`	string	The name of the artist being booked.
`endDate`	string	The date the event will end.
`eventName`	string	The name of the event or show in the booking.
`isPremiumSeat`	boolean	Indicates whether the ticket is a premium ticket (TRUE) for example Official Platinum Ticket or a standard seat (FALSE)
`majorCategory`	string	The main category of the event.
`minorCategory`	string	The sub-category of the event.
`numberOfHours`	integer	The number of hours the event is scheduled to last.
`offerTypes`	array
`onSaleDate`	string	The date booking is opened for the event.
`options`	array
`outdoorEvent`	boolean	Indicates whether the event will be outdoors.
`preSaleDate`	string	The date that booking is opened for pre-sale tickets.
`refundable`	string	Indicates that the booking is refundable
`sequence`	integer	The sequential order of the event when multiple events are being booked.
`startDate`	string	The start date of the event.
`ticketHolders`	array
`ticketLimit`	integer	The ticket limit per person.
`ticketSalesType`	string	The type of tickets sold.
`ticketType`	string	Shows ticket type.
`totalCost`	number	The total cost including taxes fees and surcharges.
`venueCode`	string	The vendor’s id number for the venue.
`venueName`	string	The name of the venue
`RentalCar`	object
`carClassCode`	string	ACRISS or other identifying car classification code
`endDate`	string	The date the car will be returned.
`isDomestic`	boolean	Indicates if trip is considered domestic by Partner.
`options`	array
`rentalCarAgency`	string	The name of the agency renting the car.
`rentalCarPickupLocation`	string	The actual pickup location at origin.
`startDate`	string	The date on which the car will be picked up.
`totalCost`	number	The total cost of the rental car.
`Credentials`	object
`password`	string	Password set by AWP for the Partner. AWP will validate each request using Partner’s ACCAM User Id and Password.
`userName`	string	The user name assigned to the partner by AWP.
`Cookie`	object
`additionalItems`	array	Additional items already selected as purchased by customer (these products will not optimimized)
`cookies`	array
`customers`	array
`events`	array
`incidents`	array
`lodgings`	array
`products`	array	Array of products passed to AWP
`providers`	array
`rentalCars`	array
`treatmentTracker`	array
`vehicles`	array