Reservations
This endpoint allows you to import reservations.
post
https://api.mobile-calendar.com
/get/reservations
Import reservations
The request below gets reservations for January 1, 2021, through January 28, 2021
and for rooms with ID 5630 and 5645.
If there is no
room_ids parameter, the API will return reservations for all rooms.{
"from" : "2021-01-01",
"to" : "2021-01-28",
"room_ids" : [5630, 5645]
}
You can find the room ID in the rooms details form.
Field | Level | Type | Description |
status | L0 | string | Responsne status success | errror |
data | L0 | array | Main object "Reservations" |
errors | L0 | array | Informations about erros |
reservation_id | L1 | integer | Reservation ID |
reservation_number | L1 | integer | Number of reservation |
room_id | L1 | integer | Room ID |
room_name | L1 | string | Room name |
days_of_stay | L1 | integer | Days of stay |
arrival | L1 | date | Arrival date format : YYYY-MM-DD |
departure | L1 | date | Departure date format : YYYY-MM-DD |
checkin | L1 | string | Check-in time format : HH:ss |
checkout | L1 | string | Check-out time format : HH:ss |
check_in_status | L1 | string | Check-in status, values: NONE, CHECKED-IN, CHECKED-OUT |
adults | L1 | integer | Adults count |
children | L1 | integer | Children count |
client_id | L1 | integer | Client's ID |
forename | L1 | string | Client's forename |
name | L1 | string | Client's name |
phone | L1 | string | Client's phone number |
email | L1 | string | Client's e-mail address |
payment_status | L1 | string | Payment status values: NO_PAYMENT, PREPAYMENT_PAID, FULL_AMOUNT_PAID, WAITING_FOR_PAYMENT |
prepayment | L1 | decimal | prepayment amount format: 100 / 100.00 |
prepayment_to | L1 | date | Prepayment to date format : YYYY-MM-DD |
price_per_stay | L1 | decimal | Price per stay format: 100 / 100.00 |
currency | L1 | string(3) | Price currency, 3-character currency format compatilbe with ISO 4217 Standard |
additional_informations | L1 | string | Additional informations about booking |
source_id | L1 | integer | Source ID |
source | L1 | string | Source name i.e. booking.com / airbnb |
display_color | L1 | string(#hex) | Reservation color displayed on the calendar format(HEX): #ff1122 |
door_code | L1 | string | Code to open the door |
add_date | L1 | date | Add date format : YYYY-MM-DD HH:ii:ss |
edit_date | L1 | date | Last edit date format : YYYY-MM-DD HH:ii:ss |
Error | Description |
Set date range.
Field "From" and "To" is required. | Field From and To are required parameters |
Incorrect format of "From" and/or "To" fields. Correct format YYYY-MM-DD | Invalid date format. The correct format is: YYYY-MM-DD |
"From" date can not be greater than or equal to "To" date. Incorrect date "From" or "To" | Date From can not be greather than to date |
Maximum date range is 90 days | The maximum range for dates is 90 days |
Add room IDs | If you set room_idsparameter, then you must enter value |
Wrong room IDs | You entered the wrong room ID or the rooms are not assigned to your account |
HTTP status 200 OK.
Note that the HTTP 200 OK code does not mean the answer is correct at all!
{
"status": "error",
"data": [],
"errors": [
"Incorrect format of \"From\" and/or \"To\" fields. Correct format YYYY-MM-DD",
"Incorrect date \"From\" or \"To\""
]
}
Last modified 4mo ago