Listing Status Retrieve

This endpoint is used to retrieve the current status (for example, bookable, deactivated) of a specific property listing on the VRBO platform.

Endpoint

POST

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

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.


listing_id string (Required)

The unique identifier of the property listing which want to retrieve.


Request

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

Response

Success Response

{
    "Status": "Success",
    "Message": "Listing status retrieve successfully.",
    "Data": {
        "status": "deactivated",
        "status_msg": ""
    },
    "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.


status string

Represents the current status of the property listing.


status_msg string

Provides additional information or context about the current listing status, if any.


Trace-ID string

Unique ID for tracing the API request.


Error Response

{
    "Status": "Fail",
    "Errors": [
        {
            "Code": "1396",
            "ShortText": "Listing is not mapped or not found"
        }
    ],
    "Message": ""
}

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.

Last updated

Was this helpful?