Retrieve Existing Advertiser

This endpoint retrieves the list of advertiser IDs which are already connected into chain property (hotel) with same currency with Su.

Endpoint

POST

https://connect-sandbox.su-api.com/SUAPI/jservice/vrbo/advertiser/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.


Request

{
    "hotel_id": "AWSTEST"
}

Response


Success Response

{
    "Status": "Success",
    "Message": "No existing connection found.",
    "Data": [],
    "Trace-ID": ""
}
{
    "Status": "Success",
    "Message": "List of already connected advertiser id.",
    "Data": [
        {
            "advr_id": "100001",
            "currency": "NZD",
            "connection_name": "",
            "version": ""
        }
    ],
    "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 array of objects

The response data, the root element.


advr_id string

The unique identifier generated for the advertiser.


currency string

The currency associated with the advertiser account.

connection_name string

The name of the connection or integration (if any).

version string

Indicates the API or connection version information.


Trace-ID string

Unique ID for tracing the API request.


Error Response

{
    "Status": "Fail",
    "Errors": [
        {
            "Code": "400",
            "ShortText": "hotelid: Invalid HotelCode (:hotelid)"
        }
    ],
    "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?