Create New Listing

This endpoint retrieves detailed information of an Airbnb listing, including property attributes, location, facilities, amenities, check-in/out instructions, and availability status.

Endpoint

POST

https://connect-sandbox.su-api.com/SUAPI/jservice/airbnb/listing/create

---

Header

-app-id: App Id
Authorization: Basic Authorization
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

hotelid alphanumeric (Required)

Specifies the required node hotelid contains the IT provider's hotel id for which the provider wishes to add mapping information.

---

channelhotelid alphanumeric (Required)

Specifies the unique hotel ID used in the external distribution channel or PMS (Property Management System).

---

roomid alphanumeric (Required)

Property's Room / Listing ID.

---

rateid alphanumeric (Required)

Property's rate ID.

---

multiplier numeric (Required)

Multiplier to increase / decrease rates. Both, absolute and percentage value is considered.

---

surcharge numeric (Required)

Additional Charges to added(if any).

---

occupancy numeric (Required)

Number of guests for this room/rate combination applies.

---

name alphanumeric (Required)

Listing’s title, maximum 50 characters. Can include a maximum of 5 capitalized letters.

---

property_type_group enum (Optional)

Generalized group of the property types. Obtain the required enum values through the Master Data API.

---

property_type_category enum (Optional)

Category of the property. Obtain the required enum values through the Master Data API.

---

room_type_category enum (Optional)

Room type category. Describes whether the listing is a shared room, private room, or entire home. Obtain the required enum values through the Master Data API.

---

listing_views enum (Optional)

Indicates the view of the listing. Obtain the required enum values through the Master Data API.

---

apt string (Optional)

Apartment/unit number. Non-special characters only.

---

street string (Optional)

Street address. Should include number, street name, and street suffix.

---

city string (Optional)

city of the listing.

---

state string (Optional)

State, territory, district, or province. For US states use the official two-letter abbreviation

---

lng numeric (Optional)

Longitude of the location of the listing.

---

lat numeric (Optional)

Latitude of the location of the listing.

---

zipcode string (Optional)

Zip or postal code.

---

country_code string (Optional)

Listing's capitalized, two-letter country code in ISO 3166-1 alpha-2 format.

---

directions string (Optional)

Directions to the property. Provided only to confirmed guests.

---

display_exact_location_to_guest enum (Optional)

Whether the map displays to guests the property's exact location or an approximate circle. Default is false.

---

person_capacity numeric (Optional)

Maximum number of guests that can be accommodated. Default is 1.

---

check_in_option object (Optional)

How guests will check in.

---

category enum (Required)

The type of check in the Host offers. Obtain the required enum values through the Master Data API.

---

instruction string (Required)

Instructions for guests on how to check in. Only shared with confirmed guests.

---

check_out_tasks object (Optional)

Tasks guests must complete while checking out. Obtain the required enum values through the Master Data API.

checkout task value as key

Example

"GATHER_TOWELS":

{

            "is_present": true,

            "task_detail": "gather towels description"

        }

---

is_present boolean (Required)

Whether the checkout task is present or not. Set to false to delete a task.

---

task_detail string (Optional)

Checkout task instructions, maximum 140 characters.

---

facilities object (Optional)

---

facility_id numeric (Required)

id of the facility which listing is supported. Obtain the required facilities values through the Master Data API.

---

is_available boolean (Required)

facility is available or not. Set to false to delete a facility from listing.

---

instances array of objects (Optional)

If facility supports instances, it can be set with instances. Obtain the required values through the Master Data API.

---

key enum (Required)

supported instance in facility. Obtain field_code value from facility object in Master data API.

---

value (Required)

Value of the instances. Check the type of value using the field_type field from the Master Data API If field_type = string, then the value can be any text string.

If field_type = enum, then the value must match one of the options listed in the values array under instances.

If multiple_values_allowed = yes for a facility, then multiple values can be provided, separated by commas.

---

Request

{
  "hotelid": "SUTEST01",
  "channelhotelid": "511039958",
  "roomid": "RT04",
  "rateid": "RP958",
  "multiplier": "1",
  "surcharge": "0",
  "occupancy": "1",
  "name": "Heaven Feels House",
  "property_type_group": "houses",
  "property_type_category": "hut",
  "room_type_category": "shared_room",
  "listing_views": [
    "BAY_VIEW"
  ],
  "apt": "Apt 32",
  "street": "pal RTO",
  "city": "Surat",
  "state": "Gujarat",
  "lng": 72.782675,
  "lat": -14.4455455,
  "zipcode": "395005",
  "country_code": "IN",
  "directions": "opp rajhansh multiplex",
  "display_exact_location_to_guest": true,
  "person_capacity": 5,
  "check_in_option": {
    "category": "lockbox",
    "instruction": "instruction"
  },
  "check_out_tasks": {
    "GATHER_TOWELS": {
      "is_present": true,
      "task_detail": "gather towels description"
    }
  },
  "facilities": [
    {
      "facility_id": 689,
      "is_available": true,
      "instances": [
        {
          "key": "ac_options",
          "value": "central , portable"
        }
      ]
    },
    {
      "facility_id": 691,
      "is_available": true,
      "instances": [
        {
          "key": "fireplace_types",
          "value": "electric , gas"
        }
      ]
    },
    {
      "facility_id": 698,
      "is_available": true,
      "instances": [
        {
          "key": "workspace_setup_types",
          "value": "ergonomic_chair"
        },
        {
          "key": "privacy",
          "value": "private_space"
        }
      ]
    },
    {
      "facility_id": 702,
      "is_available": true
    },
    {
      "facility_id": 708,
      "is_available": true,
      "instances": [
        {
          "key": "number_of_spaces",
          "value": 6
        }
      ]
    },
    {
      "facility_id": 712,
      "is_available": true,
      "instances": [
        {
          "key": "brand",
          "value": "LG"
        },
        {
          "key": "fridge_type",
          "value": "mini_fridge"
        }
      ]
    },
    {
      "facility_id": 720,
      "is_available": true,
      "instances": [
        {
          "key": "stove_type",
          "value": "electric"
        },
        {
          "key": "brand",
          "value": "panasonic"
        },
        {
          "key": "number_of_burners",
          "value": 2
        },
        {
          "key": "stove_materials",
          "value": "stainless_steel"
        }
      ]
    }
  ]
}

---

Response

---

Success Response

{
  "Status": "Success",
  "Data": {
    "listing": {
      "listing_views": [
        "BAY_VIEW"
      ],
      "has_availability": false,
      "lng": 72.782675,
      "lat": 21.182063,
      "person_capacity": 5,
      "property_type_group": "houses",
      "display_exact_location_to_guest": true,
      "zipcode": "394510",
      "name": "Heaven Feels House",
      "state": "Gujarat",
      "synchronization_category": "sync_all",
      "street": "5QJM+R3F, Hazira - Adajan Road",
      "property_type_category": "hut",
      "quality_standards": {
        "state": "GOOD"
      },
      "apt": "Apt 32",
      "city": "Surat",
      "country_code": "IN",
      "directions": "opp rajhansh multiplex",
      "has_active_disaster": false,
      "reservation_issues": [],
      "id": "1559213514575692094",
      "check_out_tasks": {
        "GATHER_TOWELS": {
          "is_present": true,
          "task_detail": "gather towels description"
        }
      },
      "host_roles": [
        {
          "is_primary_host": true,
          "user_id": "511039958",
          "is_super_host": false,
          "type": "OWNER"
        }
      ],
      "tier": "marketplace",
      "categories": [],
      "check_in_option": {
        "category": "lockbox",
        "instruction": "instruction"
      },
      "room_type_category": "shared_room",
      "facilities": [
        {
          "facility_id": 720,
          "is_available": true,
          "instances": [
            {
              "key": "stove_materials",
              "value": "STAINLESS_STEEL"
            },
            {
              "key": "brand",
              "value": "panasonic"
            },
            {
              "key": "stove_type",
              "value": "ELECTRIC"
            },
            {
              "key": "number_of_burners",
              "value": 2
            }
          ]
        },
        {
          "facility_id": 712,
          "is_available": true,
          "instances": [
            {
              "key": "brand",
              "value": "LG"
            },
            {
              "key": "fridge_type",
              "value": "MINI_FRIDGE"
            }
          ]
        },
        {
          "facility_id": 708,
          "is_available": true,
          "instances": [
            {
              "key": "number_of_spaces",
              "value": 6
            }
          ]
        },
        {
          "facility_id": 702,
          "is_available": true
        },
        {
          "facility_id": 689,
          "is_available": true,
          "instances": [
            {
              "key": "ac_options",
              "value": "PORTABLE,CENTRAL"
            }
          ]
        },
        {
          "facility_id": 698,
          "is_available": true,
          "instances": [
            {
              "key": "workspace_setup_types",
              "value": "ERGONOMIC_CHAIR"
            },
            {
              "key": "privacy",
              "value": "PRIVATE_SPACE"
            }
          ]
        },
        {
          "facility_id": 691,
          "is_available": true,
          "instances": [
            {
              "key": "fireplace_types",
              "value": "ELECTRIC,GAS"
            }
          ]
        }
      ]
    },
    "id": "1559213514575692094"
  },
  "Message": "Listing added successfully"
}

---

Success Response - Body Elements

Status string

Indicates the result of the API call. Will always be "Success" in the case of a successful response.

---

Data object

The response data element containing the listing details.

---

listing object

The complete listing information returned after processing the request.

---

listing_views array

Indicates the view types applied to the listing.

---

has_availability boolean

Indicates whether the listing is available for booking.

---

lng numeric

Longitude of the listing.

---

lat enum

Latitude of the listing.

---

person_capacity enum

Maximum number of guests allowed.

---

property_type_group enum

General category the property belongs to (e.g., houses).

---

display_exact_location_to_guest boolean

Indicates if the exact location is visible to guests.

---

zipcode string

Zip or postal code.

---

name string

Listing’s title.

---

state string

State of the listing.

---

synchronization_category string

Sync configuration category.

---

street string

Street address of the listing.

---

property_type_category enum

Specific property type category.

---

quality_standards object

Overall condition of the listing (e.g., "GOOD").

---

apt string

Apartment/unit number.

---

city string

City of the listing.

---

country_code string

Two-letter ISO country code.

---

directions string

Directions to the property (for confirmed guests only).

---

has_active_disaster boolean

Indicates if the listing is in a disaster-affected area.

---

reservation_issues array

List of reservation issues (if any).

---

id string

Listing ID created/updated by Airbnb.

---

check_out_tasks object

Tasks guests must complete at checkout.

---

host_roles array

List of host roles assigned to the listing.

---

tier string

Listing tier (e.g., "marketplace").

---

categories array

Airbnb categories applied to the listing.

---

check_in_option object

Check-in method and instructions.

---

room_type_category enum

Defines room type (shared/private/entire home).

---

facilities array List of supported facilities (with facility_id, is_available, and optional instances).

---

id string

The created listing ID.

---

Message string

Message describing the success of the operation.

---

Error Response

Error 1

{
  "Status": "Fail",
  "Errors": [
    {
      "Code": "1163",
      "ShortText": "Room and rateplan combination already mapped"
    }
  ]
}

---

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.