Listing Pull

This endpoint fetches all property listings for a given advertiser, including their status, book-ability, and any missing mandatory content.

Endpoint

POST

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

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

hotel_id string (Required)

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


advertiser_id string (Required)

The unique advertiser id for which property listings are to be fetched.


Request

{
    "hotel_id": "AWSTEST",
    "advertiser_id": "100001"
}

Response


Success Response

{
    "Status": "Success",
    "Data": {
        "listings": [
            {
                "listing_status": "Activate",
                "id": "128264777",
                "name": "Wasser Lodge",
                "property_minimum_content_missing": [],
                "is_bookable": true,
                "is_bookable_message": ""
            },
            {
                "listing_status": "Activate",
                "id": "128191711",
                "name": "Berg Lodge",
                "property_minimum_content_missing": [],
                "is_bookable": true,
                "is_bookable_message": ""
            },
            {
                "listing_status": "Activate",
                "name": "Freiheit Lodge",
                "id": "128177104",
                "property_minimum_content_missing": [],
                "is_bookable": true,
                "is_bookable_message": ""
            }
        ]
    },
    "Message": "Listing fetched successfully",
    "Trace-ID": ""
}
{
    "Status": "Success",
    "Data": {
        "listings": []
    },
    "Message": "Listing fetched successfully",
    "Trace-ID": ""
}

Success Response - Body Elements

Status string

Indicates the result of the API call.

Will be "Success" for successful operations.


Message string

The message in the response.


Data object

The response data, the root element.


listings array

Contains the list of property listings associated with the provided advertiser_id.


listing_status string

Indicates the current status of the listing.


id string

The unique identifier for each listing.


name string

The name of the property as registered in the provider’s system.


property_minimum_content_missing array

Lists the missing mandatory content elements (for example, images, descriptions, amenities) required for the listing to be bookable.


is_bookable boolean

Indicates whether the listing is currently bookable (true) or not (false).


is_bookable_message string

Provides a descriptive message explaining why the listing is not bookable (if is_bookable is false). Returns an empty string if the listing is bookable.


Trace-ID string

Unique ID for tracing the API request.


Error Response

{
    "Status": "Fail",
    "Errors": [],
    "Message": "No records exist with advertiser Id - 13",
    "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.

Last updated

Was this helpful?