OwnerRez

https://www.ownerrez.com/support/
Admin
OwnerRez is a vacation rental property management platform that helps hosts manage bookings,...
Tokens:4,130,101
Snippets:83,969
Trust Score:9.9
Update:4 months ago
Show doc for...
Tokens:
Raw
### Example - Lodging Configuration Index

Source: https://www.ownerrez.com/support/articles/channel-management-api-integrations-booking-com-setup-connecting-private-beta

Provides an example of how to retrieve configuration details for multiple lodgings.

```APIDOC
## Example - Lodging Configuration Index

### Description
Demonstrates how to retrieve configuration settings for a list of lodgings efficiently.

### Method
GET

### Endpoint
`/api/v1/channel-integration/lodging/configuration/index`

### Parameters
#### Query Parameters
- **lodgingIds** (string) - Required - Comma-separated list of lodging IDs.

### Response
#### Success Response (200)
- **configurations** (object) - An object where keys are lodging IDs and values are their configuration details.
  - **lodgingId** (object) - Configuration details for the lodging.

### Response Example
```json
{
  "configurations": {
    "1001": {
      "minStay": 2,
      "maxStay": 30
    },
    "1002": {
      "minStay": 3,
      "maxStay": 14
    }
  }
}
```
```

--------------------------------

### Example GET Request for Advertiser Index

Source: https://www.ownerrez.com/support/articles/api-channel-integration-setup-configuration

This example shows how to make a GET request to the advertiser index endpoint. Ensure you include the User-Agent and Content-Type headers.

```http
User-Agent: My Awesome App/1.0
Content-Type: application/xml
GET https://fast.ownerrez.com/haapi/haxml/advertiserindex?type=HaXmlSandbox&key=contactus
```

--------------------------------

### Example - Lodging Configuration

Source: https://www.ownerrez.com/support/articles/channel-management-api-integrations-booking-com-setup-connecting-private-beta

Provides an example of how to retrieve the configuration details for a specific lodging.

```APIDOC
## Example - Lodging Configuration

### Description
Shows how to fetch the specific configuration settings for a given lodging using its ID.

### Method
GET

### Endpoint
`/api/v1/channel-integration/lodging/{lodgingId}/configuration`

### Parameters
#### Path Parameters
- **lodgingId** (integer) - Required - The ID of the lodging.

### Response
#### Success Response (200)
- **configuration** (object) - The configuration details for the lodging.
  - **minStay** (integer) - Minimum nights required for a stay.
  - **maxStay** (integer) - Maximum nights allowed for a stay.
  - **checkInDays** (array) - Allowed check-in days of the week.

### Response Example
```json
{
  "configuration": {
    "minStay": 2,
    "maxStay": 30,
    "checkInDays": ["Monday", "Friday", "Saturday"]
  }
}
```
```

--------------------------------

### Filtered Review Index API Response Example

Source: https://www.ownerrez.com/support/articles/api-channel-integration-example-review-index

An example of the XML response when filtering reviews by a start date. The response will contain only reviews published on or after the specified date.

```xml
<reviewContentIndex>  
	<documentVersion>1.1</documentVersion>  
	<advertiser>  
		<advertiserId>ora7ccdcde40x</advertiserId>  
	</advertiser>  
</reviewContentIndex>
```
Tokens:
Raw