Ordering Image
This endpoint allows you to update the order of images for a hotel or a room. The request must include the hotel_id, channel_hotel_id, and an array of photo_ids to be put in an order.
Endpoint
POST
Header
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.
channel_hotel_id string (Required)
The unique id for the hotel on the specific channel.
channel_room_id string (Required)
The unique ID of the room on channel for the hotel.
photo_id string (Required)
A unique identifier for the photo being submitted.
Sample Request
Image Order for Property
Image Order for Room
Response
Sample Success Response
Success Response Body Elements
Indicates the result of the API call.
Data object
An array of tags containing the order of the images.
Message string
A message indicating the result of the operation.
Errors
Sample Error Response 1
Sample Error Response 2
Sample Error Response 3
Error Response Body Elements
Status string
Indicates the result of the API call, which will be always "Fail" in case of an error response.
Error array
Array that contains details about any errors that occurred during the API call. Each object in the Errors array contains the following properties:
Code string
Specific error code that helps identify the type of error.
ShortText string
A short description of the error.
Message string
A message providing more information about the error.
Last updated
Was this helpful?