Order Image
Reorders images for a VRBO listing according to the sequence of image_ids provided.
Endpoint
POST

https://connect-sandbox.su-api.com/SUAPI/jservice/vrboimage/orderHeader
app-id: YOUR_APP_ID
Authorization: YOUR_API_KEY
Content-Type: application/jsonapp-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 integer (Required)
VRBO listing ID where images exist.
image_ids array (Required)
List of image IDs in the desired order.
Request
{
"hotel_id": "AWSTEST",
"listing_id": "73845690",
"image_ids": [
"3476ea84-75c0-4a6c-b75d-2ab6db680d46",
"3dcdd566-c243-4719-b585-f0688162ed6a"
]
}Response
Success Response
{
"Status": "Success",
"Data": {
"images": [
{
"id": "3476ea84-75c0-4a6c-b75d-2ab6db680d46",
"image_url": "https://static.otaswitch.com/images/ceb4c47b2f5206340f34ae94b576ea75.jpeg",
"tags": [],
"show_first": true,
"order": 1
},
{
"id": "3dcdd566-c243-4719-b585-f0688162ed6a",
"image_url": "https://static.otaswitch.com/images/ceb4c47b2f5206340f34ae94b576ea75.jpeg",
"tags": [],
"show_first": false,
"order": 2
}
]
},
"Message": "Image order successfully",
"Trace-ID": ""
}Success Response - Body Elements
Status string
Indicates the result of the API call.
Data object
The response data, the root element.
images array
Array of the images.
id string
Unique identifier of the images.
image_url string
URL of the image.
tags array
List of tags associated with the image.
show_first boolean
Indicates if this image will be displayed first.
order integer
Order of the image in the listing.
Message string
The message in the response.
Trace-ID string
Unique ID for tracing the API request.
Error Response
{
"Status": "Fail",
"Errors": [
{
"Code": "400",
"ShortText": "hotel_id: Invalid HotelCode (:hotelid)"
},
{
"Code": "2004",
"ShortText": "Listing Id is required"
},
{
"Code": "1391",
"ShortText": "image_ids is invalid or not found!"
}
],
"Message": "",
"Trace-ID": ""
}Error Response - Body Elements
Status string
Indicates the result of the API call.
Errors array
The response error, the root element.
Code string
Specific error code that helps identify the type of error.
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?