Service

Name Add Reservation Quote
Description Add a quote for a reservation
Method POST
URL /reservations/{reservation}/quotes
Example /api/reservations/123456789/quotes
Access OWNER, MANAGER

HTTP Headers

Authorization eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUyJ9...

Parameters

Fields Type Required Description
reservation number yes Reservation id
check_in date yes Check in date.
check_out date yes Check out date.
adults number yes How many adults.
children number yes How many children.
lodging_tax number yes If apply lodging tax over rent, fill only in percent.
sales_tax number yes If apply sales tax over rent, fill only in percent.
pet_fee number yes If apply fee per pets.
cleaning_fee number yes If apply fee per cleaning property after used.
guest_quantity number yes Quantity of guest.
guest_price number no Price per additional guest.
damage_deposit number yes Value for security damage deposit.
price number yes Value of price for nights.
message text no Message for the traveler.
other_fees array no Other fees applied to the quote.
attachment file no Files with information about the reservation.

Parameter: other_fees

Fields Type Required Description
[name] text yes Name of the fee.
[value] number yes Value of the fee.
[type] number yes Value: 1 - fixed, 2 - percent.
[tax] bool yes If fee is taxable.

Response

            
                {
                    "code": "R111",
                    "message": "Success",
                }
            
            

Response Codes

Code Message Cause Possible Frontend Message [Behavior]
EC000 Internal error in API Internal error connecting the database "Oops! Looks like we hit a snag. Try closing the app and reopening it."
EC001 User not found Token user id doesn't match our records "Sorry, We couldn't find your information!"
EC003 Reservation not found Reservation id doesn't match our records "Sorry, We couldn't find that reservation!"
EC011 Status not found Status doesn't match our records "Oops! Looks like we hit a snag. Try closing the app and reopening it."
EC024 Range of date not valid The range of date is not valid Please enter valid dates
EC025 Error when try to send email Error trying to send the email
EC028 Reservation no available in that date The reservation's dates are not available "This property is not available on these dates"
EC031 Reservation not belong to that user The user logged in is not the reservation's traveler or the owner "Sorry, you do not have access to that reservation!"
R000 Fail The reservation quote wasn't created
R111 Success The reservation quote was successful [Show it in the reservation details]
SC006 User no authorization The token role is not valid for using the API services "You have been logged out." - [Take the user to the login screen]
SC014 Expired token The token has expired "You have been logged out." - [Take the user to the login screen]
VID150 Invalid input for message Message is empty or it has only characters not allowed(" ", ', ’, ‘, ’, ", &, \, <, >, --) "Please fill out this field" - "Please enter a valid message"
VID177 Invalid input for guest_price Guest_price is not a number Guest fee must be a number
VID178 Invalid input for guest_quantity Guest_quantity is not a number "Please select an item from the list"
VID187 Invalid input for cleaning_fee Cleaning_fee is not a number or it has more than 7 digits "Cleaning fee must have only numbers"
VID189 Invalid input for pet_fee Pet_fee is not a number or it has more than 7 digits "Pet fee must have only numbers"
VID191 Invalid input for lodging_tax Lodging_tax is not a number or it has more than 5 digits "Lodging tax must have only numbers"
VID192 Invalid input for sales_tax Sales_tax is not a number or it has more than 5 digits "Sales tax must have only numbers"
VID193 Invalid input for damage_deposit Damage_deposit is not a number or it has more than 7 digits "Damage deposit must have only numbers"
VID202 Invalid input for check_in Check_in doesn't meet the date's format "Please enter a valid Check In date"
VID203 Invalid input for check_out Check_out doesn't meet the date's format "Please enter a valid Check Out date"
VID209 Invalid input for array other_fees Other_fees is not an array with less than 5 items [Call the API again using a valid value for other_fees]
VID210 Invalid input for name in other_fees "x" Name in other_fees has more than 80 characters or it has only characters not allowed "Please enter a valid fee name"
VID211 Invalid input for value in other_fees "x" Value in other_fees is not a number or it has more than 7 digits "Fee value must have only numbers"
VID213 Invalid input for type in other_fees "x" Type in other_fees is not in [0, 1] [Call the API again using a valid value for type in other_fees]
VID229 Invalid input for adults Adults is empty or it is not a number [Call the API again using a valid value for adults] - "Please select an item in the list"
VID230 Invalid input for children Children is empty or it is not a number [Call the API again using a valid value for children] - "Please select an item in the list"
VID234 Invalid input for reservation Reservation id is not a number "Sorry, We couldn't find that reservation!" - [Call the API again using a valid value for reservation id]
VID236 Invalid input for nights_price Nights_price is not a number Nights price must be a number