Generate Advertiser

This endpoint generates an advertiser ID for a specific property (hotel) on the VRBO platform.

Endpoint

POST

https://connect-sandbox.su-api.com/SUAPI/jservice/vrbo/advertiser/generate

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": "Advertiser id generate successfully",
    "Data": {
        "advertId": "100004",
        "advr_status": true
    },
    "Trace-ID": ""
}
{
    "Status": "Success",
    "Message": "Advertiser id is already mapped",
    "Data": [],
    "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.


advertId string

The unique identifier generated for the advertiser.


advr_status boolean

Indicates whether the advertiser is approved (true) or not-approved (false).


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?