Get Listing Info

This endpoint retrieves detailed information about a VRBO property listing, including property details, amenities, policies, images, and unit configurations.

Endpoint

POST

https://connect-sandbox.su-api.com/SUAPI/jservice/vrbo/property/retrieve

Header

app-id: YOUR_APP_ID
Authorization: YOUR_API_KEY
Content-Type: application/json
Header
Type
Required
Description

app-id

string

Yes

Your application ID. Required for authentication.

Authorization

string

Yes

Your API key for authorization. Required for authentication.

Content-Type

string

Yes

Must be set to application/json.

Attributes

hotel_id string (Required)

The unique property ID as assigned by the provider upon creation of the property.

listing_id string (Required)

VRBO listing ID.

Request

{
  "hotel_id": "AWSTEST",
  "listing_id": "73384756"
}

Response

Success Response

{
"Status": "Success",
"Data": {
"property_name": "XYZ hotel 1",
"reference_property_name": "XYZ hotel",
"property_type": "APARTMENT",
"default_locale":"en-US",
"position": {
"latitude": 36.021018,
"longitude": -5.614816
},
"physical_address": {
      "city_name": "Tarifa",
      "state_name": "abc",
      "country_code": "IND",
      "postal_code": "11380",
      "address_line": "ok line",
      "display_address": true
    },
"text": [
      {
        "key": "owner-list-story",
        "values": [
          {
            "value": "owner-list-story - ok",
            "locale": "fr-FR"
          }
        ]
      },
      {...},
      {...}
    ],
"amenities": [
 {
        "facility_id": 551,
        "instances": [
          {
            "key": "mandatory",
            "value": "TRUE"
          }
        ]
      },
 {...}
],
},
"booking_policy": {
      "booking_type": "INSTANT",
      "accepted_payment_forms": {
        "payment_card_descriptors": [
          {
            "code": "MASTERCARD",
            "type": "CREDIT"
          },
          {
            "type": "CREDIT",
            "code": "VISA"
          }
        ],
        "payment_invoice_descriptors": [
          {
            "type": "BANKTRANSFER"
          }
        ]
      }
    },
"stay_policy": {
  "children_policy": {...},
  "max_occupancy_policy": {...},
  "check_in_policy": {...},
  "check_out_policy": {...},
  "pets_policy": {...},
  "smoking_policy": {...},
  "custom_policies": {...},
  "events_policy": {...},
  "rental_agreement_url": "https://xyz.com/ayx/ty.pdf"
},
"cancellation_policy_configs": {...},
"images": [...],
"units": {...}
},
"Message": "Listing Info fetched successfully", 
"Trace-ID": ""
}

Success Response - Body Elements

Status string

Indicates the result of the API call.

Will be "Success" for successful operations.

Data object

The response data, the root element.

property_name string

This is the name of the property.

reference_property_name string

This is the reference name of the property.

property_type string

The type of the property.

default_locale string

The default locale of the property.

position object

The geographical coordinates of the property. Latitude represents the north-south position and longitude represents the east-west position.

latitude number

Latitude of the property.

longitude number

Longitude of the property.

physical_address object

Contains the address details of the property including street, city, state, postal code, and country.

city_name string

City where the property is located.

state_name string

State or region name of the property.

country_code string

ISO country code.

postal_code string

ZIP or postal code of the property.

address_line string

Full street address.

display_address boolean

Indicates if the address is displayed publicly on VRBO.

text array

Contains text descriptions of the property in different locales.

Each item in the array includes the following fields:

key string

The unique identifier or label representing the type of text content.

values array A list of localized text entries for the given key. Each object includes:

value string

The actual text or description for the property.

locale string

The language or locale code for the text value.

amenities array

A list of amenities available at the property.

facility_id number

Unique identifier for each amenity or facility.

instances array

List of key-value pairs describing specific conditions.

key string

Describes the attribute type.

value boolean

Indicates the value or status for the key.

id string

Unique ID of the amenity.

name string

Name of the amenity.

booking_policy object

Contains rules related to booking for the property. See Booking Policy documentation for detailed structure.

booking_type string

Specifies booking type such as "INSTANT" or "REQUEST".

accepted_payment_formsobject

Lists accepted payment types for this property.

payment_card_descriptors array

Array of supported payment cards (for example, VISA, MASTERCARD).

code string

Card code.

type string

Card type.

stay_policy object

Contains rules related to guest stay. See Stay Policy documentation for detailed structure.

children_policy object

Defines child stay and age-related rules.

max_occupancy_policy object

Maximum number of guests allowed per booking.

check_in_policy object

Details about check-in time and process.

check_out_policy object

Details about check-out time and process.

pets_policy object

Defines whether pets are allowed and under what conditions.

smoking_policy object

Smoking rules applicable to the property.

custom_policies object

Any custom rules added by the property owner.

events_policy object

Rules for events, gatherings, or parties at the property.

rental_agreement_url object

URL link to the rental agreement document.

cancellation_policy_configs object

Contains default and override cancellation policies. See Cancellation Policy documentation for detailed structure.

images array

List of images associated with the property.

id string

Unique identifier for the image resource.

image_url string

Direct URL to the property image hosted on the provider’s server.

tags array

List of descriptive tags associated with the image. Each tag object includes:

value string

The tag name or label for the image.

locale string

Language code for the tag description.

show_first boolean

Indicates whether the image should appear first in the gallery or listing.

order integer

Defines the display order of the image within the property gallery.

units object

Contains unit-level details for the property.

unit_id string

Unique ID for the unit.

unit_type string

Type of unit.

Message string

The message in the response.

Trace-ID string

Unique ID for tracing the API request.

Error Response

{
  "Status": "Fail",
  "Errors": [
    {
      "Code": "400",
      "ShortText": "hotel_id: Invalid HotelCode (:hotelid)"
    },
    {
      "Code": "2004",
      "ShortText": "Listing Id is required"
    }
  ],
  "Message": "",
  "Trace-ID": ""
}

Error Response - Body Elements

Status string

Indicates the result of the API call.

Will be always "Fail" in case of an error response.

Errors object

The response error, the root element.

Code string

Specific error code that helps identify the type of error.

For example: "400" indicates a bad request.

ShortText string

A short description of the error.

Message string

The message in the response.

Trace-ID string

Unique ID for tracing the API request.

PreviousVRBO ListingNextListing Pull

Last updated

Was this helpful?