Returns an optimized quote request

POST

/optimizations

POST

/Core/CoreGatewayAPI/optimizations

import { AllianzPartnerServicesClient } from "allianz-partner-services";
async function main() {
    const client = new AllianzPartnerServicesClient();
    await client.core.optimizations.create({
        fsDistributorCode: "FS-Distributor-Code",
        body: {
            additionalItems: [
                {
                    cost: 12,
                    currencyType: "USD",
                    description: "extracost",
                    externalIdentifier: "12",
                    name: "Bob",
                    options: [
                        {
                            optionName: "option1",
                            optionValue: "12",
                        },
                    ],
                    quantity: 123,
                    sequence: 11,
                    totalCost: 3371,
                },
            ],
            credentials: {
                password: "cap_t_1",
                userName: "cap_t_1",
            },
            customerAddress: {
                address1: "3305 Street1",
                address2: "PO Box 303",
                city: "Victoria",
                country: "US",
                postalCode: "77901",
                region: "13",
            },
            customers: [
                {
                    address: {
                        address1: "customerAddress1",
                        address2: "customerAddress2",
                        city: "Richmond",
                        country: "Henrico",
                        postalCode: "23294",
                        region: "USA",
                    },
                    age: 0,
                    assistanceType: "Test",
                    birthDate: new Date("2019-01-25T00:00:00.000Z"),
                    canPersist: true,
                    customerId: "123",
                    customerType: "Adult",
                    demographicInfo: {
                        occupation: "qa",
                        ownershipStatus: "rent",
                        residenceType: "Condo",
                        yearsAtResidence: 8,
                    },
                    discountType: "AutomationTestType",
                    emailAddress: "qa@test.com",
                    firstName: "customerFirstName",
                    gender: "Male",
                    includeForPricing: true,
                    includeInGroupDetermination: false,
                    lastName: "costomerLastName",
                    motorRelated: [
                        {
                            licenceStatus: "hasIt",
                        },
                    ],
                    memberships: [
                        {
                            level: "membership_level",
                            name: "membership_name",
                            number: "memberhsip_number",
                            type: "membership_type",
                        },
                    ],
                    middleInitial: "o",
                    nationality: "usa",
                    okToContact: false,
                    options: [
                        {
                            optionName: "CustomerOptionTest",
                            optionValue: "12",
                        },
                    ],
                    phones: [
                        {
                            areaCode: "512",
                            countryCode: "001",
                            isPrimary: true,
                            number: "8765309",
                            type: "Home",
                        },
                    ],
                    relationshipToPrimary: "SELF",
                    salutation: "MR",
                    sequence: 10,
                    suffix: "Sir",
                    title: "QA Analyst",
                    totalCost: 500,
                    statusQualificationMiles: 300,
                    statusQualificationSegments: 400,
                    statusQualificationAmount: 200,
                    statusCardSpend: 100,
                },
            ],
            events: [
                {
                    artistId: 13,
                    artistName: "B52",
                    endDate: new Date("2021-11-23T13:55:45"),
                    eventEndDateLocal: new Date("2021-11-23T13:55:45"),
                    eventName: "None",
                    isPremiumSeat: true,
                    isOvernightEvent: true,
                    majorCategory: "None",
                    minorCategory: "a",
                    numberOfHours: 12,
                    offerTypes: [
                        {
                            offerDescription: "123445",
                            offerTypeId: 1111,
                            options: [
                                {
                                    optionName: "NameOfOption55",
                                    optionValue: "A",
                                },
                            ],
                        },
                    ],
                    onSaleDate: new Date("2021-11-19T13:55:45"),
                    options: [
                        {
                            optionName: "OptionA",
                            optionValue: "110011",
                        },
                    ],
                    outdoorEvent: true,
                    preSaleDate: new Date("2021-11-19T13:55:45"),
                    refundable: "true",
                    sequence: 1,
                    startDate: new Date("2021-11-20T13:55:45"),
                    eventStartDateLocal: new Date("2021-11-20T13:55:45"),
                    ticketLimit: 7,
                    ticketSalesType: "salesman",
                    ticketType: "typeOfTicket",
                    totalCost: 500,
                    venue: {
                        city: "El Paso",
                        code: "TX",
                        country: "US",
                        region: "Southwest",
                    },
                    venueName: "Astrodome",
                    venuePostalCode: "77979",
                },
            ],
            features: [
                {
                    code: "test_not_defined_code",
                    alternatives: [
                        {},
                    ],
                },
            ],
            gadget: {
                browserType: "IE",
                browserVersion: "10",
                deviceCategory: "None",
                deviceType: "APPLE",
                font: "ariel",
                httpRequestHeaders: "e",
                ipAddress: "10.0.0.7",
                isCookiesAllowed: true,
                language: "en",
                operatingSystem: "win5",
                operatingSystemVersion: "1",
                referringUrl: "www.google.com",
                requestingPlatform: "None",
                requestingPlatformVersion: "2",
                screenSize: "1",
                userAgent: "Mozilla/5.0 (Windows NT 6.1; WOW64; rv:54.0) Gecko/20100101 Firefox/54.0",
            },
            incidents: {
                incidentType: "string",
            },
            lodgings: [
                {
                    accommodationType: "hotel",
                    address: {
                        address1: "121 Saluria",
                        address2: "P.O.Box 202",
                        city: "Brussels",
                        country: "Belgium",
                        postalCode: "22011",
                        region: "Europe",
                    },
                    agencyRating: 1,
                    availability: "yes",
                    brandCategory: "brandCategory",
                    cancelationPolicyType: "no_cancel",
                    carbonMonoxideDetector: true,
                    chain: "Omni",
                    checkInDate: new Date("2021-11-20T13:55:45"),
                    checkInDateLocal: new Date("2021-11-20T13:55:45"),
                    checkOutDate: new Date("2021-11-23T13:55:45"),
                    checkOutDateLocal: new Date("2021-11-23T13:55:45"),
                    crib: false,
                    destination: {
                        city: "Boston",
                        code: "MA",
                        country: "FR",
                        region: "NW",
                    },
                    eventName: "Event1",
                    fireExtinguisher: true,
                    hostName: "OmniHotel",
                    hostStatus: "Excellent",
                    hotTub: true,
                    indoorFirePlace: true,
                    instantBooking: true,
                    levelOfService: "Top",
                    locationCategory: "5",
                    locationType: "TypeLocation",
                    name: "NameName",
                    numberOfBedRooms: 1,
                    numberOfBookingUnits: 3,
                    options: [
                        {
                            optionName: "Opt1",
                            optionValue: "9685847",
                        },
                    ],
                    petsAllowed: true,
                    propertyType: "Hotel",
                    rateType: "Credit",
                    refundable: "false",
                    rollaway: true,
                    roomType: "Suite",
                    smokeDetector: true,
                    smokingAllowed: false,
                    starRating: 5,
                    thumbRating: 3,
                    totalCost: 500,
                    zone: "B",
                },
            ],
            partner: {
                distributorCode: "cap_t_1",
                externalCode: "123",
                externalSubCode: "321",
            },
            providers: [
                {
                    isPrimary: true,
                    options: [
                        {
                            optionName: "Name1",
                            optionValue: "Value1",
                        },
                    ],
                    providerCode: "R7_Journey",
                    providerName: "NameProvider",
                    providerType: "Serious",
                },
            ],
            rentalCars: [
                {
                    carClassCode: "CY",
                    destination: {
                        city: "San Antonio",
                        code: "ab",
                        country: "USA",
                        region: "South",
                    },
                    endDate: new Date("2021-11-23T13:55:45"),
                    endDateLocal: new Date("2021-11-23T13:55:45"),
                    isDomestic: true,
                    options: [
                        {
                            optionName: "1Name1Name",
                            optionValue: "1Value1Value",
                        },
                    ],
                    origin: {
                        city: "San Antonio",
                        code: "ab",
                        country: "USA",
                        region: "South",
                    },
                    rentalCarAgency: "hertz",
                    rentalCarPickupLocation: "SA",
                    startDate: new Date("2021-11-20T13:55:45"),
                    startDateLocal: new Date("2021-11-20T13:55:45"),
                    totalCost: 500,
                },
            ],
            requestDetail: {
                bookingId: "123",
                businessUnit: "CA",
                campaigns: [
                    {},
                ],
                clientVersion: "123",
                costIncludes: [
                    "1",
                    "2",
                ],
                currency: "USD",
                cxid: "200624114637",
                dataSource: "TRAVEL",
                exchangeRate: 1,
                experimentVariant: "exp_var_val",
                isCustomerFamiliarWithProduct: true,
                mainBookingCorePurchaseDate: new Date("2020-06-26T11:46:37"),
                itemDeliveryMethod: "44444",
                language: "no",
                localTimestamp: new Date("2020-06-26T11:46:37"),
                offerVersionId: 2,
                options: [
                    {},
                ],
                paymentMethod: "Cash",
                savedCompanionCount: 2,
                purchaseDate: new Date("2021-11-19T13:55:45"),
                redemptionPoints: 23243,
                requestCategories: [
                    "Airfare",
                ],
                requestChannel: "WEB",
                requestedDate: new Date("2021-11-19T13:55:45"),
                requestOrigin: "Standard",
                requestOriginPage: "page1",
                requestingHost: "4q42545",
                salesOriginType: "internet",
                searchPreference: {
                    flexibleDates: true,
                    includeNearbyAirports: true,
                    includeWeekends: true,
                    maxPrice: 100000,
                    minPrice: 10,
                    searchByPrice: true,
                    searchBySchedule: true,
                },
                sequence: 17,
                sessionId: "persist_auto_test_20201008113245",
                trafficSource: "google",
                transactionId: "iwantapires",
                usePromotionCode: false,
                vertical: "TRAVEL1",
                visitorId: "333",
                widgetKey: "keykey",
            },
            travel: {
                autoTrain: true,
                brandedFare: "test0detail",
                classOfService: "economy",
                connection: "direct",
                departureDate: new Date("2021-11-20T13:55:45"),
                departureDateLocal: new Date("2021-11-20T13:55:45"),
                destination: {
                    city: "San Francisco",
                    code: "YYY",
                    country: "US",
                    region: "CA",
                },
                includesConnection: false,
                isDomestic: true,
                options: [
                    {
                        optionName: "123",
                        optionValue: "12",
                    },
                ],
                origin: {
                    city: "Dallas/Ft Worth",
                    code: "DFW",
                    country: "US",
                    region: "TX",
                },
                refundable: "true",
                returnDate: new Date("2021-11-23T13:55:45"),
                returnDateLocal: new Date("2021-11-23T13:55:45"),
                routeGroup: "direct",
                rewardMiles: 0,
                ticketSalesType: "agent",
                totalCost: 500,
                travelAgent: "None",
                travelLegs: [
                    {
                        destination: {
                            city: "Dallas/Ft Worth",
                            code: "DFW",
                            country: "US",
                            region: "TX",
                        },
                        origin: {
                            city: "Dallas/Ft Worth",
                            code: "DFW",
                            country: "US",
                            region: "TX",
                        },
                        sequence: 14,
                    },
                ],
                travelPurpose: "leisure",
                travelSegments: [
                    {
                        arrivalDate: new Date("2021-11-20T13:55:45"),
                        brandedFare: "test1Seg",
                        departureDate: new Date("2021-11-20T13:55:45"),
                        destination: {
                            city: "San Francisco",
                            code: "SFO",
                            country: "US",
                            region: "CA",
                        },
                        distanceTraveled: 100,
                        fareClass: "economy",
                        includesConnection: true,
                        isDomestic: true,
                        layoverDuration: 1,
                        options: [
                            {
                                optionName: "TravelSegmentOptionTest",
                                optionValue: "12",
                            },
                        ],
                        origin: {
                            city: "Dallas/Ft Worth",
                            code: "DFW",
                            country: "US",
                            region: "TX",
                        },
                        routeGroup: "direct",
                        sequence: 15,
                        travelLegs: [
                            {
                                arrivalDate: new Date("2021-11-20T13:55:45"),
                                brandedFare: "test2Leg",
                                classOfService: "economy",
                                departureDate: new Date("2021-11-20T13:55:45"),
                                destination: {
                                    city: "San Francisco",
                                    code: "SFO",
                                    country: "US",
                                    region: "CA",
                                },
                                equipmentType: "1",
                                isDomestic: true,
                                options: [
                                    {
                                        optionName: "TravelLegOptionTest",
                                        optionValue: "12",
                                    },
                                ],
                                origin: {
                                    city: "Dallas/Ft Worth",
                                    code: "DFW",
                                    country: "US",
                                    region: "TX",
                                },
                                routeGroup: "direct",
                                routeNumber: "12",
                                seatAvailability: 0,
                                seatCapacity: 12,
                                sequence: 16,
                                travelDuration: 10,
                            },
                        ],
                    },
                ],
                tripDuration: 7,
                tripIndicator: "Round-trip",
            },
            products: {
                productCode: "string",
                supplierCode: "string",
            },
            vehicles: {},
        },
    });
}
main();

200Successful

{
  "features": [
    {
      "code": "GRUP_12065",
      "alternatives": [
        "OFFR_19765"
      ],
      "expirationDate": "2020-07-12 14:25:11"
    }
  ],
  "locations": [
    {
      "controlType": "string",
      "locationCode": "string",
      "locationType": "Custom",
      "offers": [
        {
          "contentCode": "string",
          "contentType": "string",
          "id": "string",
          "messages": [
            {
              "compiledMessage": "string",
              "messageComponents": [
                {
                  "imageURL": "string",
                  "sequence": 1,
                  "style": "string",
                  "text": "string"
                }
              ],
              "messageTag": "string"
            }
          ],
          "sequence": 1
        }
      ],
      "output": "string",
      "outputJSON": {},
      "outputType": "string",
      "status": {
        "code": "string",
        "errorText": "string",
        "message": "string",
        "reason": "string"
      },
      "templateCode": "string",
      "templateType": "string",
      "treatmentCode": "string",
      "autoRender": true,
      "variation": [
        {
          "changesets": [
            {
              "conditions": [
                {
                  "attributeName": "string",
                  "attributeValue": "string",
                  "booleanValue": true,
                  "class": "string",
                  "compare": "<",
                  "matchCase": true,
                  "maximumCount": 1.1,
                  "minimumCount": 1.1,
                  "name": "string",
                  "numericValue": "string",
                  "operator": "string",
                  "selector": "string",
                  "type": "Exists",
                  "value": "string"
                }
              ],
              "instructions": [
                {
                  "action": "setTextContent",
                  "attributeName": "string",
                  "attributeValue": "string",
                  "booleanValue": true,
                  "class": "string",
                  "content": "string",
                  "element": "string",
                  "event": "string",
                  "numericValue": "string",
                  "position": "string",
                  "script": "string",
                  "selector": "string",
                  "value": "string"
                }
              ],
              "name": "string",
              "selector": "string",
              "triggers": [
                {
                  "event": "string",
                  "selector": "string",
                  "type": "string"
                }
              ]
            }
          ],
          "responseOfferId": "string",
          "validations": [
            {
              "attributeName": "string",
              "attributeValue": "string",
              "booleanValue": true,
              "class": "string",
              "compare": "<",
              "matchCase": true,
              "maximumCount": 1.1,
              "minimumCount": 1.1,
              "name": "string",
              "numericValue": "string",
              "operator": "string",
              "selector": "string",
              "type": "Exists",
              "value": "string"
            }
          ],
          "variationCode": "string"
        }
      ]
    }
  ],
  "products": [
    {
      "coverageAmount": 1.1,
      "externalCode": "string",
      "groupPrices": [
        {
          "adminFee": 1.1,
          "sequenceName": "string",
          "price": 1.1,
          "sequence": 1
        }
      ],
      "isAvailable": true,
      "offerId": "string",
      "prices": [
        {
          "isAvailable": true,
          "isIncluded": true,
          "options": [
            {
              "optionName": "string",
              "optionValue": "string"
            }
          ],
          "price": 1.1,
          "priceHash": "string",
          "sequences": [
            {
              "name": "string",
              "value": 1
            }
          ],
          "stepName": "string",
          "stepType": "string"
        }
      ],
      "pricingModelCode": "string",
      "pricingModelDescription": "string",
      "pricingModelMaxAmount": 1.1,
      "pricingModelMinAmount": 1.1,
      "productCode": "string",
      "productDescription": "string",
      "productHtmlContent": "string",
      "productName": "string",
      "productSpecificMessages": [
        {
          "text": "string",
          "type": "string",
          "uri": "string"
        }
      ],
      "productType": "string",
      "quoteId": "string",
      "sequenceNames": "string",
      "sequences": [
        {
          "sequence1": 1,
          "sequence2": 1,
          "sequence3": 1
        }
      ],
      "supplierCode": "string",
      "totalAdminFee": 1.1,
      "totalPrice": 1.1,
      "totalPriceHash": "string",
      "totalTax": 1.1,
      "totalPoints": 1.1
    }
  ],
  "status": {
    "code": "Success",
    "creationDate": "string",
    "errorText": "string",
    "machineName": "string",
    "message": "string",
    "processId": 1,
    "reason": "string",
    "version": "string"
  },
  "transactionDetails": {
    "controlType": "string",
    "cxid": "string",
    "populationCode": "string",
    "responseID": "string",
    "subPopulationCode": "string",
    "treatmentId": "string",
    "treecode": "string",
    "segmentcode": "string"
  }
}

Request

Offer and product details

additionalItemslist of objectsOptional

Additional items already selected as purchased by customer (these products will not optimized)

credentialsobjectOptional

Partner Credentials

customerAddressobjectOptional

Object describing the address of customer, company or other entity

customerslist of objectsOptional

eventslist of objectsOptional

featureslist of objectsOptional

Describes the feature/alternatives that were previously selected

gadgetobjectOptional

Gadget Information

incidentsobjectOptional

Incident Information

lodgingslist of objectsOptional

partnerobjectOptional

Partner Information

providerslist of objectsOptional

rentalCarslist of objectsOptional

requestDetailobjectOptional

Request Details

travelobjectOptional

Travel Information

productsobjectOptional

Request Product

vehiclesobjectOptional

Vehicle Information

Response

Success

featureslist of objectsOptional

Use this to specify the feature/alternatives that were returned in the response

locationslist of objectsOptional

Array of locations which are affected by response

productslist of objectsOptional

Array of products with prices

statusobjectOptional

System generated response status object

transactionDetailsobjectOptional

Object holding transaction related information