Skip to navigation
Examples

Quote examples

Sample JSON Quote Request and Quote Response messages from the JSON Service Integration Guide.

Credentials in these samples are placeholders. Use the partner credentials Allianz issues for each environment.

Quote request

Quote request
{
  "additionalItems": [
    {
      "cost": 35.0,
      "currencyType": "USD",
      "description": "Seat reservations",
      "quantity": 2,
      "totalCost": 70.0
    },
    {
      "cost": 29.0,
      "currencyType": "USD",
      "description": "A la carte dining",
      "quantity": 2,
      "totalCost": 58.0
    }
  ],
  "credentials": {
    "password": "YOUR_PASSWORD",
    "userName": "AirlineCompany"
  },
  "customerAddress": {
    "country": "US",
    "postalCode": "10023",
    "region": "NY"
  },
  "customers": [
    {
      "birthDate": "1980-05-10T00:00:00",
      "customerId": "//7TZTpcyiAlExmaYers6Q==",
      "customerType": "PRIMARY",
      "firstName": "John",
      "gender": "Male",
      "lastName": "",
      "memberships": [
        {
          "name": "AirlineCompany",
          "type": "Gold"
        }
      ],
      "phones": [
        {
          "areaCode": "212",
          "number": "2121234567"
        }
      ],
      "sequence": 0
    },
    {
      "birthDate": "1983-08-23",
      "customerType": "OTHER",
      "firstName": "Mary",
      "gender": "Female",
      "lastName": "",
      "sequence": 1
    }
  ],
  "gadget": {
    "deviceCategory": "Desktop",
    "deviceType": "Apple",
    "ipAddress": "199.111.182.226",
    "requestingPlatform": "None"
  },
  "partner": {
    "externalCode": "F999999"
  },
  "providers": [
    {
      "providerCode": "BEL",
      "providerName": "ABC Airline"
    },
    {
      "providerCode": "SWR",
      "providerName": "DEF Airline"
    }
  ],
  "rentalCars": [
    {
      "carClassCode": "ECAR",
      "destination": {
        "code": "CDG",
        "country": "FR",
        "region": ""
      },
      "endDate": "2018-12-31T07:45:00",
      "isDomestic": false,
      "origin": {
        "code": "JFK",
        "country": "US",
        "region": "NY"
      },
      "rentalCarAgency": "Hertz",
      "startDate": "2018-12-17T11:00:00",
      "totalCost": 274.42
    }
  ],
  "requestDetail": {
    "businessUnit": "US",
    "currency": "USD",
    "dataSource": "TRAVEL",
    "language": "en",
    "offerVersionId": 1,
    "requestCategories": [
      "Airfare"
    ],
    "requestedDate": "2018-08-15T09:39:17",
    "requestOrigin": "Standard",
    "requestOriginPage": "Review",
    "sessionId": "L13AKELA930SS7"
  },
  "travel": {
    "classOfService": "COACH_CLASS",
    "departureDate": "2018-12-16T17:30:00",
    "destination": {
      "code": "CDG",
      "country": "FR",
      "region": ""
    },
    "includesConnection": true,
    "isDomestic": false,
    "membershipStatus": "yes",
    "origin": {
      "code": "JFK",
      "country": "US",
      "region": "NY"
    },
    "refundable": "False",
    "returnDate": "2018-12-31T07:25:00",
    "totalCost": 2562.84,
    "tripIndicator": "ROUND_TRIP"
  }
}
credentials.password

The Partner password will differ from UAT and production environments.

customerAddress.region

In the US the region element is required in order to return quotes that comply with state-level laws.

customers[].customerType

The first insured listed will be “PRIMARY”, subsequent insured individuals will have “OTHER”.

customers[].sequence

If more than one person is insured the sequence must iterate for each individual listed.

gadget

The gadget object contains information about the device used by the customer.

partner.externalCode

The externalCode is a unique code assigned by AWP to a Partner and corresponds to the Accam element in the Purchase Request.

providers

The providers array contains information about the airlines.

rentalCars

The rentalCars array contains details about any rental cars associated with the quote.

requestDetail

This determines Partner’s first level segmentation.

travel.destination.code

Three character IATA airport code.

travel.origin.code

Three character IATA airport code.

Quote response

Quote response
{
  "status": {
    "code": "Success",
    "creationDate": "8/15/2018 2:29:48 PM",
    "processId": "1536",
    "version": "2.0.6773.25295"
  },
  "products": [
    {
      "isAvailable": true,
      "externalCode": "001004037",
      "individualPrices": [
        {
          "adminFee": 0,
          "price": 96.11,
          "sequence": 0
        },
        {
          "adminFee": 0,
          "price": 96.11,
          "sequence": 1
        }
      ],
      "prices": [
        {
          "isAvailable": true,
          "isIncluded": false,
          "price": 96.11,
          "priceHashed": "TadYwhq55K2r6LE651z6bgFBZKKFmHrC7pZISHePxSYwMDEwMDQwMzdfQUEw",
          "priceHash": "TadYwhq55K2r6LE651z6bgFBZKKFmHrC7pZISHePxSY=",
          "sequences": [
            {
              "name": "Customer",
              "value": 0
            }
          ]
        },
        {
          "isAvailable": true,
          "isIncluded": false,
          "price": 96.11,
          "priceHashed": "MWMubXtO5LScahir3WPH0LQcXDUzB5DbW4TBN8Ua7L0wMDEwMDQwMzdfQUEx",
          "priceHash": "MWMubXtO5LScahir3WPH0LQcXDUzB5DbW4TBN8Ua7L0=",
          "sequences": [
            {
              "name": "Customer",
              "value": 1
            }
          ]
        }
      ],
      "pricingModelCode": "001004037",
      "pricingModelMinAmount": 26.25,
      "productCode": "001004037",
      "productName": "IATP wEMC 7.5",
      "supplierCode": "AWP",
      "totalPrice": 192.22,
      "totalPriceHashed": "CiQIyJfTb7Hv7mtd5/nvRVAcP6mx2MJ2mpmMfQb1IJMwMDEwMDQwMzdfQUE=",
      "totalPriceHash": "CiQIyJfTb7Hv7mtd5/nvRVAcP6mx2MJ2mpmMfQb1IJM=",
      "quoteId": "2052521881115360218",
      "offerId": "2052521881115360221"
    },
    {
      "isAvailable": true,
      "externalCode": "NoProduct",
      "prices": [
        {
          "isAvailable": true,
          "isIncluded": false,
          "price": 0,
          "priceHashed": "Z6TRYyB3G9f6m1xFtX5d1rrNq96EExhif/FgypAGvLJOb1Byb2R1Y3Q=",
          "priceHash": "Z6TRYyB3G9f6m1xFtX5d1rrNq96EExhif/FgypAGvLI="
        }
      ],
      "pricingModelCode": "No Product",
      "pricingModelDescription": "FLAT",
      "productCode": "NoProduct",
      "productName": "No Product",
      "supplierCode": "AWP",
      "totalPrice": 0,
      "totalPriceHashed": "Z6TRYyB3G9f6m1xFtX5d1rrNq96EExhif/FgypAGvLJOb1Byb2R1Y3Q=",
      "totalPriceHash": "Z6TRYyB3G9f6m1xFtX5d1rrNq96EExhif/FgypAGvLI=",
      "quoteId": "2052521881115360219",
      "offerId": "2052521881115360221"
    }
  ],
  "locations": [
    {
      "locationCode": "LOCN_8431",
      "locationType": "HTML",
      "autoRender": false,
      "output": "<!-- HTML markup -->",
      "outputType": "Component",
      "selector": "divAWPoffer",
      "status": {
        "code": "Success"
      },
      "offers": [
        {
          "contentCode": "TMPL_13851",
          "contentType": "Template",
          "id": "2052521881115360220",
          "sequence": 0
        },
        {
          "contentCode": "OFFR_10262",
          "contentType": "Offer",
          "id": "2052521881115360221",
          "sequence": 1,
          "messages": [
            {
              "messageSequence": 0,
              "messageTag": "OPTION_DESC",
              "compiledMessage": "<!-- HTML markup -->"
            },
            {
              "messageSequence": 0,
              "messageTag": "INTRO",
              "compiledMessage": "<!-- HTML markup -->"
            },
            {
              "messageSequence": 1,
              "messageTag": "OPTION_DESC",
              "compiledMessage": "No, I choose not to protect my <strong>$2,562.84</strong> trip. I understand by declining insurance I am responsible for all cancellation fees and expenses."
            },
            {
              "messageSequence": 0,
              "messageTag": "HEADER",
              "compiledMessage": "<!-- HTML markup -->"
            },
            {
              "messageSequence": 0,
              "messageTag": "DISCLAIMER",
              "compiledMessage": "Recommended by AGA Service Company, the licensed producer and administrator of this plan. This insurance is offered by a third party, Allianz Global Assistance, not Airline Company. Plans underwritten by Jefferson Insurance Company or BCS Insurance Company.</p>"
            },
            {
              "messageSequence": 0,
              "messageTag": "IMAGE_MESSAGE",
              "compiledMessage": "/content/images/logos/allianz_logo.gif"
            },
            {
              "messageSequence": 0,
              "messageTag": "FOOTER",
              "compiledMessage": "Terms, conditions and exclusions apply. See coverage <a style=\"display: inline-block; \" target=\"_blank\" class=\"aa-pop-win-lrg\" href=\"https://www.allianzworldwidepartners.com/usa/terms-and- conditions/001004037\">details<span class=\"hidden-accessible\"> (about trip protection). Opens another site in a new window that may not meet accessibility guidelines.</span> <span class=\"icon-newpage\" aria-hidden=\"true\"></span></a>.<p class=\"aaMediumGray\">"
            }
          ]
        }
      ],
      "templateType": "FC",
      "templateCode": "TMPL_13851"
    }
  ],
  "transactionDetails": {
    "controlType": "Champion",
    "cxid": "2052521881115360202",
    "responseId": "2052521881115360201",
    "segmentCode": "SGMT_21051",
    "treatmentId": "10262",
    "treeCode": "TREE_9381"
  },
  "cookies": [
    {
      "content": "Champion",
      "includeInRequest": false,
      "name": "G-ID_79531",
      "noOfDays": 3,
      "expirationDate": "2018-08-18T14:29:48-04:00",
      "type": "Experiment"
    }
  ]
}
products[].productCode

The product code returned in the quote response must be passed to AWP in the Purchase Request message.

products[].quoteId

The quote ID is a unique code assigned to a quote and must be passed back to AWP in the Purchase Request message.

locations[].output

The output element contains a complete HTML message to be used by the Partner to display a quote to the customer.

locations[].offers

The offers array contains the individual message components contained in the full HTML message above in the output element.

Quote Web Service

How the quote flow works.

Quote request dictionary

Every element you can send.

Quote response dictionary

Every element AWP returns.