Create Listing

This endpoint creates a new property listing on VRBO with details such as property information, occupancy, facilities, and location.

Endpoint

POST

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

---

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 assigned by the provider when the property was created.

---

room_id string (Required)

The unique room ID associated with the property.

---

rate_id string (Required)

The unique rate ID for the room.

---

advertiser_id string (Required)

The advertiser ID associated with this listing.

---

occupancy integer (Required)

Maximum number of guests allowed for the listing.

---

multiplier integer (Required)

Multiplier factor used for rate calculations.

---

surcharge integer (Required)

Any additional surcharge applicable to the property or room.

---

property_name string (Optional)

The human-readable name of the property.

---

property_type string (Optional)

Type of the property.

---

position object (Optional)

Geographical coordinates of the property.

---

latitude number (Optional)

Latitude coordinate of the property.

---

longitude number (Optional)

Longitude coordinate of the property.

---

physical_address object (Optional)

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

---

city_name string (Required)

The city where the property is located.

---

state_name string (Optional)

The state or region of the property.

---

country_code string (Required)

The country code in ISO format.

---

postal_code string (Optional)

Postal code of the property.

---

address_line string (Optional)

Street or locality of the property.

---

text array (Optional)

Contains text descriptions of the property in different languages or locales.

---

facilities array (Optional)

A list of facilities or amenities available at the property.

---

facility_id string (Required)

Unique identifier for the facility.

---

is_available boolean (Required)

Indicates whether the facility is available.

---

instances array (Optional)

Contains key-value pairs representing specific details of the facility.

---

key string (Required)

The type of the facility instance.

---

value string (Required)

The value associated with the key.

---

Request

{
  "hotel_id": "AWSTEST",
  "room_id": "100020",
  "rate_id": "12345",
  "advertiser_id": "100003",
  "occupancy": 8,
  "multiplier": 9,
  "surcharge": 10,
  "property_name": "SKY1",
  "property_type": "APART_HOTEL",
  "position": {
    "latitude": 21.192572,
    "longitude": 72.799736
  },
  "physical_address": {
    "city_name": "Surat",
    "state_name": "Gujarat",
    "country_code": "IND",
    "postal_code": "395009",
    "address_line": "Adajan"
  },
  "text": [],
  "facilities": [
    {
      "facility_id": "614",
      "is_available": true,
      "instances": [
        {
          "key": "site-location-description",
          "value": "this is city centerr"
        },
        {
          "key": "location",
          "value": "SITE_LOCATION"
        }
      ]
    },
    {
      "facility_id": "551",
      "is_available": true,
      "instances": [
        {
          "key": "mandatory",
          "value": "true"
        },
        {
          "key": "recommended",
          "value": ""
        }
      ]
    }
  ]
}

---

Response

Success Response

{
  "staah_listing_id": "100006041",
  "staah_unit_id": "500006041",
  "vrbo_listing_id": "73845690",
  "vrbo_unit_id": "318512988",
  "rmid": 4317
}

---

Success Response - Body Elements

staah_listing_id string

Unique listing ID assigned by Staah.

---

staah_unit_id string

Unique unit ID assigned by Staah.

---

vrbo_listing_id string

VRBO listing ID assigned after successful creation.

---

vrbo_unit_id string

VRBO unit ID assigned after successful creation.

---

rmid integer

The room master ID or internal identifier.

---

Error Response

Validation Error

{
  "Status": "Fail",
  "Errors": [
    {
      "Code": "400",
      "ShortText": "hotel_id: Invalid HotelCode (:hotelid)"
    },
    {
      "Code": "852",
      "ShortText": "room_id - is invalid or not found!"
    },
    {
      "Code": "856",
      "ShortText": "rate_id - is invalid or not found!"
    },
    {
      "Code": "2002",
      "ShortText": "Advertiser Id is required"
    },
    {
      "Code": "872",
      "ShortText": "NumberOfGuests: Value is not a nonnegative (a non-negative integer) or is greater than 999 , found :value_replace"
    },
    {
      "Code": "955",
      "ShortText": "Multiplier is required"
    },
    {
      "Code": "958",
      "ShortText": "Surcharge 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 array

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.