CLcloudbeds
Reservation

postReservation

Changed on

Adds a reservation to the selected property

post/postReservation

Request

  • Base URL
    https://api.cloudbeds.com/api/v1.3
  • URL
    https://api.cloudbeds.com/api/v1.3/postReservation
  • Auth
    • API key in header x-api-key
    • or OAuth 2
      Authorization code
      Scopes: write:reservation

Request body application/x-www-form-urlencoded

propertyIDstring nullable

Property ID

sourceIDstring nullable

The source ID for this reservation. Accepted formats:<br /> "s-{id}" for primary sources (no suffix), or<br /> "ss-{id}-0" / "ss-{id}-1" for third-party sources (suffix required: 0 = channel-collect, 1 = hotel-collect). The format must match the source type.

thirdPartyIdentifierstring nullable

If it was received from a booking channel, this can be an identifier from that channel.

startDatestring date

Check-In date.

endDatestring date

Check-Out date.

guestFirstNamestring

First name of the guest

guestLastNamestring

Last name of the guest

guestGender'M' | 'F' | 'N/A' nullable
guestCountrystring

Valid ISO-Code for Country (2 characters)

guestNationalitystring nullable

Guest nationality (citizenship). ISO-Code for Country (2 characters). Distinct from guestCountry, which is the address country.

guestZipstring

ZIP Code

guestEmailstring

Guest email

guestPhonestring nullable

Guest main phone number

guestRequirementsobject[] nullable

Object with guest requirements information.

estimatedArrivalTimestring time nullable

Estimated Arrival Time, 24-hour format.

paymentMethod'cash' | 'credit' | 'ebanking' | 'pay_pal'

Payment Method of choice.

cardTokenstring nullable

Credit Card identifier. Payment Method must be credit. This field should be filled with credit card identifier according to gateway. Only available for Stripe and should send the Customer ID.

paymentAuthorizationCodestring nullable

Transaction identifier. Payment Method must be credit. This field should be filled with transaction identifier according to gateway. Only available for Stripe and it should be filled with Charge ID associated to the Payment Intent.

promoCodestring nullable

Promotional code. Required for specials and packages that uses it. "rateID" parameter required for using "promoCode".

allotmentBlockCodestring nullable

Allotment block code to add reservation to allotment block.

eventCodestring nullable

Event (group profile) code the reservation will be added to.

dateCreatedstring date-time nullable

Date reservation was made. Defaults to current date if omitted.

sendEmailConfirmationboolean nullable

Send confirmation email to guest.

Response

200 Response

successboolean

Returns if the request could be completed

reservationIDstring

Reservation identifier

status'not_confirmed' | 'confirmed'

Reservation status<br /> 'not_confirmed' - Reservation is pending confirmation<br /> 'confirmed' - Reservation is confirmed<br />

guestIDstring

Guest ID

guestFirstNamestring

Guest First Name

guestLastNamestring

Guest Last Name

guestGender'M' | 'F' | 'N/A' nullable

Guest Gender

guestEmailstring

Guest Email

startDatestring date

Reservation CheckIn date

endDatestring date

Reservation CheckOut date

dateCreatedstring date-time

Reservation creation datetime

grandTotalnumber

Grand Total

messagestring nullable

To be used in case any error occurs (if success = false). If success = true, it does not exist.

Changes

  • 6f4f997d5f7aRevision changes
    • warning

      removed the request property

    • info

      added the new optional request property

    • info

      added the new optional request property