Experience the difference of "Elite".

Getting Started

Core Concepts

Overview

Bookings & Quotes

Damage Protection

Data Management

Deposits

Email Template Library

Fields

Guests

Hosted Websites

Integrations

Listing Site Integration

Messaging

My Account

Payment Processing

Privacy & Security

Properties

Property Management

Property Sharing

Quotes

Rates

Renter Agreements

Reporting

Reviews

Rules

Security Deposits

Suppressed Email Addresses

Tags

Taxes

Team Access

Technical Stuff

Travel Insurance

Verified Email Domains

Widgets

WordPress Plugin

Channel Management

Channel Management

API Integrations

Calendar Import/Export

Channel Bridge

Integrations

OwnerRez APIs

Payment Processing

Testing

Change Log

2023

2022

2021

2020

2019

API for Channel Integration - Example - Booking Creation

This uses a surcharge id which is the id prefixed with ORSUR example this charge `https://..../settings/surcharges/102513996/` is `ORSUR102513996`

cURL example:

curl --user ${ownerrez_user}:${ownerrez_key} --location --request POST "${ownerrez_api}/haolb/createbooking" \

XML payload:

<bookingRequest>
<documentVersion>1.3</documentVersion>
<bookingRequestDetails>
<advertiserAssignedId>ora7ccdcde3fx</advertiserAssignedId>
<listingExternalId>orp5b2abax</listingExternalId>
<unitExternalId>orp5b2abax</unitExternalId>
<clientIPAddress>127.0.0.1</clientIPAddress>
<message>Please provide a crib.</message>
<inquirer locale="en_US">
<title>Ms.</title>
<firstName>Amy</firstName>
<lastName>Smith</lastName>
<emailAddress>amy@gmail.com</emailAddress>
<phoneNumber> 5125551212</phoneNumber>
<address rel="BILLING">
<addressLine1>10 Main Street</addressLine1>
<addressLine3>Austin</addressLine3>
<addressLine4>TX</addressLine4>
<country>US</country>
<postalCode>12345</postalCode>
</address>
</inquirer>
<commission/>
<olbMeta>
<serviceFee currency="USD">125.50</serviceFee>
</olbMeta>
<reservation>
<numberOfAdults>2</numberOfAdults>
<numberOfChildren>0</numberOfChildren>
<numberOfPets>0</numberOfPets>
<reservationDates>
<beginDate>2023-03-16</beginDate>
<endDate>2023-03-21</endDate>
</reservationDates>
<reservationOriginationDate>2020-08-21T09:30:47Z</reservationOriginationDate>
</reservation>
<orderItemList>
<orderItem>
<feeType>RENTAL</feeType>
<name>5 nights</name>
<preTaxAmount currency="GBP">1605.00</preTaxAmount>
<status>PENDING</status>
<taxRate>0.000000</taxRate>
<totalAmount currency="GBP">1605.00</totalAmount>
</orderItem>
<orderItem>
<externalId>ORSUR102513996</externalId>
<feeType>MISC</feeType>
<name>Cleaning fee based on £150.00 per stay</name>
<preTaxAmount currency="GBP">150.00</preTaxAmount>
<status>PENDING</status>
<taxRate>0.000000</taxRate>
<totalAmount currency="GBP">150.00</totalAmount>
</orderItem>
</orderItemList>
<paymentScheduleItemList>
<paymentScheduleItem>
<amount currency="GBP">877.50</amount>
<dueDate>2023-08-21</dueDate>
</paymentScheduleItem>
<paymentScheduleItem>
<amount currency="GBP">877.50</amount>
<dueDate>2024-02-17</dueDate>
</paymentScheduleItem>
</paymentScheduleItemList>
<paymentForm>
<paymentCard>
<paymentFormType>CARD</paymentFormType>
<billingAddress rel="BILLING">
<addressLine1>10 Main Street</addressLine1>
<addressLine3>Austin</addressLine3>
<addressLine4>TX</addressLine4>
<country>US</country>
<postalCode>12345</postalCode>
</billingAddress>
<cvv>123</cvv>
<expiration>02/2020</expiration>
<nameOnCard>Amy Smith</nameOnCard>
<number>4111111111111111</number>
<paymentCardDescriptor>
<paymentFormType>CARD</paymentFormType>
<cardCode>VISA</cardCode>
<cardType>CREDIT</cardType>
</paymentCardDescriptor>
</paymentCard>
</paymentForm>
<trackingUuid>20c98eb5-b596-4e1a-b74d-a391e3fd2a93</trackingUuid>
<travelerSource>source sub site</travelerSource>
</bookingRequestDetails>
</bookingRequest>'`

```

<bookingResponse>
<documentVersion>1.4</documentVersion>
<bookingResponseDetails>
<advertiserAssignedId>ora7ccdcde3fx</advertiserAssignedId>
<listingExternalId>orp5b2abax</listingExternalId>
<unitExternalId>orp5b2abax</unitExternalId>
<externalId>ORB320055</externalId>
<guestProfileExternalId>ORG602093585</guestProfileExternalId>
<locale>en_US</locale>
<orderList>
<order>
<currency>GBP</currency>
<orderItemList>
<orderItem>
<feeType>RENTAL</feeType>
<name>Rent</name>
<preTaxAmount currency="GBP">1605.00</preTaxAmount>
<status>ACCEPTED</status>
<taxRate>0.000000</taxRate>
<totalAmount currency="GBP">1605.00</totalAmount>
</orderItem>
<orderItem>
<externalId>ORSUR102513996</externalId>
<feeType>MISC</feeType>
<name>Cleaning Fee</name>
<preTaxAmount currency="GBP">150.00</preTaxAmount>
<status>ACCEPTED</status>
<taxRate>0.000000</taxRate>
<totalAmount currency="GBP">150.00</totalAmount>
</orderItem>
</orderItemList>
<paymentSchedule>
<acceptedPaymentForms>
<paymentInvoiceDescriptor>
<paymentFormType>INVOICE</paymentFormType>
<paymentNote>Card processing disabled. Contact PM.</paymentNote>
</paymentInvoiceDescriptor>
</acceptedPaymentForms>
<paymentScheduleItemList>
<paymentScheduleItem>
<amount currency="GBP">877.50</amount>
<dueDate>2023-08-21</dueDate>
<refundable>false</refundable>
</paymentScheduleItem>
<paymentScheduleItem>
<amount currency="GBP">877.50</amount>
<dueDate>2024-02-17</dueDate>
<refundable>false</refundable>
</paymentScheduleItem>
</paymentScheduleItemList>
</paymentSchedule>
<reservationCancellationPolicy>
<description>Strict</description>
</reservationCancellationPolicy>
</order>
</orderList>
<rentalAgreement>
<url>https://stage.orez.io/v1/l/4b31da0a5dc348a5803d5ac32525a0c6</url>
</rentalAgreement>
<reservationPaymentStatus>UNPAID</reservationPaymentStatus>
<reservation>
<numberOfAdults>2</numberOfAdults>
<numberOfChildren>0</numberOfChildren>
<numberOfPets>0</numberOfPets>
<reservationDates>
<beginDate>2023-03-16</beginDate>
<endDate>2023-03-21</endDate>
</reservationDates>
<reservationOriginationDate>2020-08-21T09:30:47Z</reservationOriginationDate>
</reservation>
<reservationStatus>CONFIRMED</reservationStatus>
</bookingResponseDetails>
</bookingResponse>