POST api/HA/CreateBooking

Request Information

URI Parameters

None.

Body Parameters

bookingRequest
NameDescriptionTypeAdditional information
documentVersion

DocumentVersionType

None.

bookingRequestDetails

HaxmlBookingRequestDetails

None.

Request Formats

application/json, text/json

Sample:
{
  "documentVersionField": 0,
  "bookingRequestDetailsField": {
    "advertiserAssignedIdField": "sample string 1",
    "listingExternalIdField": "sample string 2",
    "unitExternalIdField": "sample string 3",
    "inquiryIdField": "sample string 4",
    "propertyUrlField": "sample string 5",
    "listingChannelField": 0,
    "masterListingChannelField": 0,
    "masterListingChannelFieldSpecified": true,
    "clientIPAddressField": "sample string 7",
    "messageField": "sample string 8",
    "inquirerField": {
      "titleField": "sample string 1",
      "firstNameField": "sample string 2",
      "lastNameField": "sample string 3",
      "emailAddressField": "sample string 4",
      "phoneCountryCodeField": "sample string 5",
      "phoneNumberField": "sample string 6",
      "phoneExtField": "sample string 7",
      "addressField": {
        "additionalAddressLine1Field": "sample string 1",
        "addressLine1Field": "sample string 2",
        "addressLine2Field": "sample string 3",
        "addressLine3Field": "sample string 4",
        "addressLine4Field": "sample string 5",
        "addressLine5Field": "sample string 6",
        "countryField": "sample string 7",
        "postalCodeField": "sample string 8",
        "relField": 0,
        "relFieldSpecified": true
      },
      "localeField": 0,
      "localeFieldSpecified": true
    },
    "commissionField": {
      "reservationCommissionInvoicingTypeField": "sample string 1",
      "bookingCommissionPercentField": 2.0,
      "bookingCommissionPercentFieldSpecified": true,
      "commissionField": {
        "currencyField": 0,
        "valueField": 1.0
      }
    },
    "olbMetaField": {
      "serviceFeeField": {
        "currencyField": 0,
        "valueField": 1.0
      }
    },
    "reservationField": {
      "numberOfAdultsField": "sample string 1",
      "numberOfChildrenField": "sample string 2",
      "numberOfPetsField": "sample string 3",
      "reservationDatesField": {
        "beginDateField": "2025-12-10T06:00:13.4411251+00:00",
        "endDateField": "2025-12-10T06:00:13.4411251+00:00"
      },
      "checkinTimeField": "sample string 4",
      "checkoutTimeField": "sample string 5",
      "reservationOriginationDateField": "2025-12-10T06:00:13.4411251+00:00"
    },
    "orderItemListField": [
      {
        "descriptionField": "sample string 1",
        "externalIdField": "sample string 2",
        "feeTypeField": 0,
        "nameField": "sample string 3",
        "preTaxAmountField": {
          "currencyField": 0,
          "valueField": 1.0
        },
        "productIdField": "sample string 4",
        "statusField": 0,
        "statusFieldSpecified": true,
        "taxRateField": 6.0,
        "taxRateFieldSpecified": true,
        "totalAmountField": {
          "currencyField": 0,
          "valueField": 1.0
        }
      },
      {
        "descriptionField": "sample string 1",
        "externalIdField": "sample string 2",
        "feeTypeField": 0,
        "nameField": "sample string 3",
        "preTaxAmountField": {
          "currencyField": 0,
          "valueField": 1.0
        },
        "productIdField": "sample string 4",
        "statusField": 0,
        "statusFieldSpecified": true,
        "taxRateField": 6.0,
        "taxRateFieldSpecified": true,
        "totalAmountField": {
          "currencyField": 0,
          "valueField": 1.0
        }
      }
    ],
    "paymentScheduleItemListField": [
      {
        "amountField": {
          "currencyField": 0,
          "valueField": 1.0
        },
        "descriptionField": "sample string 1",
        "dueDateField": "2025-12-10T06:00:13.4411251+00:00",
        "externalIdField": "sample string 3",
        "refundableField": true,
        "refundableFieldSpecified": true,
        "refundDescriptionField": "sample string 6",
        "refundPercentField": 7.0,
        "refundPercentFieldSpecified": true
      },
      {
        "amountField": {
          "currencyField": 0,
          "valueField": 1.0
        },
        "descriptionField": "sample string 1",
        "dueDateField": "2025-12-10T06:00:13.4411251+00:00",
        "externalIdField": "sample string 3",
        "refundableField": true,
        "refundableFieldSpecified": true,
        "refundDescriptionField": "sample string 6",
        "refundPercentField": 7.0,
        "refundPercentFieldSpecified": true
      }
    ],
    "paymentFormField": {
      "itemField": null
    },
    "trackingUuidField": "sample string 9",
    "travelerSourceField": "sample string 10"
  }
}

application/xml, text/xml

Sample:
<bookingRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <documentVersion>1.2</documentVersion>
  <bookingRequestDetails>
    <advertiserAssignedId>sample string 1</advertiserAssignedId>
    <listingExternalId>sample string 2</listingExternalId>
    <unitExternalId>sample string 3</unitExternalId>
    <inquiryId>sample string 4</inquiryId>
    <propertyUrl>sample string 5</propertyUrl>
    <listingChannel>A1VACATIONS</listingChannel>
    <masterListingChannel>A1VACATIONS</masterListingChannel>
    <clientIPAddress>sample string 7</clientIPAddress>
    <message>sample string 8</message>
    <inquirer locale="da_DK">
      <title>sample string 1</title>
      <firstName>sample string 2</firstName>
      <lastName>sample string 3</lastName>
      <emailAddress>sample string 4</emailAddress>
      <phoneCountryCode>sample string 5</phoneCountryCode>
      <phoneNumber>sample string 6</phoneNumber>
      <phoneExt>sample string 7</phoneExt>
      <address rel="HOME">
        <additionalAddressLine1>sample string 1</additionalAddressLine1>
        <addressLine1>sample string 2</addressLine1>
        <addressLine2>sample string 3</addressLine2>
        <addressLine3>sample string 4</addressLine3>
        <addressLine4>sample string 5</addressLine4>
        <addressLine5>sample string 6</addressLine5>
        <country>sample string 7</country>
        <postalCode>sample string 8</postalCode>
      </address>
    </inquirer>
    <commission>
      <reservationCommissionInvoicingType>sample string 1</reservationCommissionInvoicingType>
      <bookingCommissionPercent>2</bookingCommissionPercent>
      <commission currency="AUD">1</commission>
    </commission>
    <olbMeta>
      <serviceFee currency="AUD">1</serviceFee>
    </olbMeta>
    <reservation>
      <numberOfAdults>sample string 1</numberOfAdults>
      <numberOfChildren>sample string 2</numberOfChildren>
      <numberOfPets>sample string 3</numberOfPets>
      <reservationDates>
        <beginDate>2025-12-10</beginDate>
        <endDate>2025-12-10</endDate>
      </reservationDates>
      <checkinTime>sample string 4</checkinTime>
      <checkoutTime>sample string 5</checkoutTime>
      <reservationOriginationDate>2025-12-10T06:00:13.4411251+00:00</reservationOriginationDate>
    </reservation>
    <orderItemList>
      <orderItem>
        <description>sample string 1</description>
        <externalId>sample string 2</externalId>
        <feeType>ACTIVITY</feeType>
        <name>sample string 3</name>
        <preTaxAmount currency="AUD">1</preTaxAmount>
        <productId>sample string 4</productId>
        <status>PENDING</status>
        <taxRate>6</taxRate>
        <totalAmount currency="AUD">1</totalAmount>
      </orderItem>
      <orderItem>
        <description>sample string 1</description>
        <externalId>sample string 2</externalId>
        <feeType>ACTIVITY</feeType>
        <name>sample string 3</name>
        <preTaxAmount currency="AUD">1</preTaxAmount>
        <productId>sample string 4</productId>
        <status>PENDING</status>
        <taxRate>6</taxRate>
        <totalAmount currency="AUD">1</totalAmount>
      </orderItem>
    </orderItemList>
    <paymentScheduleItemList>
      <paymentScheduleItem>
        <amount currency="AUD">1</amount>
        <description>sample string 1</description>
        <dueDate>2025-12-10</dueDate>
        <externalId>sample string 3</externalId>
        <refundable>true</refundable>
        <refundDescription>sample string 6</refundDescription>
        <refundPercent>7</refundPercent>
      </paymentScheduleItem>
      <paymentScheduleItem>
        <amount currency="AUD">1</amount>
        <description>sample string 1</description>
        <dueDate>2025-12-10</dueDate>
        <externalId>sample string 3</externalId>
        <refundable>true</refundable>
        <refundDescription>sample string 6</refundDescription>
        <refundPercent>7</refundPercent>
      </paymentScheduleItem>
    </paymentScheduleItemList>
    <paymentForm />
    <trackingUuid>sample string 9</trackingUuid>
    <travelerSource>sample string 10</travelerSource>
  </bookingRequestDetails>
</bookingRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HaxmlBookingResponseType
NameDescriptionTypeAdditional information
documentVersion

HaxmlBookingResponseTypeDocumentVersion

None.

Item

Object

None.

Response Formats

application/json, text/json

Sample:
{
  "documentVersionField": 0,
  "itemField": {}
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.