v1

latestOpenAPI 3.0.32026-07-2632131.4 MB

Reservations

Create a reservation

Use this request to create a direct booking. Note: This endpoint is soon to be deprecated. Please use this endpoint instead.

post/reservations

Request body

listingIdstring required

Unique Id

checkInDateLocalizedstring required

Date of the format YYYY-MM-DD

checkOutDateLocalizedstring required

Date of the format YYYY-MM-DD

statusstring required

Reservation status

guestIdstring

Unique Id

Example request

{
  "listingId": "563e0b6a08a2710e00057b82",
  "checkInDateLocalized": "2023-01-01",
  "checkOutDateLocalized": "2023-01-04",
  "status": "confirmed",
  "money": {
    "invoiceItems": [
      {
        "secondIdentifier": "MANAGEMENT"
      }
    ],
    "currency": "USD"
  },
  "guest": {
    "firstName": "Tony",
    "lastName": "Stark",
    "phone": "+97777777",
    "email": "tony@stark.com"
  },
  "guestId": "563e0b6a08a2710e00057b82"
}

Response

The inserted object

flagboolean

accountingEnabledboolean

isBMAppliedboolean

pulledByDailySyncboolean

manuallyCreatedboolean

_idstring

Unique Id

statusstring

checkInstring

checkOutstring

nightsCountnumber

guestsCountnumber

listingIdstring

Unique Id

checkInDateLocalizedstring

checkOutDateLocalizedstring

accountIdstring

Unique Id

guestIdstring

Unique Id

sourcestring

secondarySourcestring

Reservation website name. Should be present in case 'source' is one of ['BE-API', 'Booking Engine', 'website']. If absent, it means we failed to extract the secondary source information.

confirmationCodestring

isReturningGuestboolean

confirmedAtstring

importedAtstring

createdAtstring

lastUpdatedAtstring

__vnumber

conversationIdstring

Unique Id

idstring

Unique Id

isMidStayboolean

lastStayListingIdstring

Unique Id

Example response

{
  "integration": {
    "_id": "563e0b6a08a2710e00057b82"
  },
  "atTimeOfConfirmation": {
    "channelCommission": {
      "_id": "563e0b6a08a2710e00057b82"
    },
    "taxes": [
      {
        "_id": "563e0b6a08a2710e00057b82"
      }
    ]
  },
  "_id": "563e0b6a08a2710e00057b82",
  "checkIn": "2021-08-17T07:00:00.000Z",
  "checkOut": "2021-08-17T07:00:00.000Z",
  "money": {
    "invoiceItems": [
      {
        "_id": "563e0b6a08a2710e00057b82"
      }
    ],
    "payments": [
      {
        "authenticationRequiredData": {
          "lastAuthMsgSentDate": "2021-08-16T08:38:20.280Z"
        },
        "createdAt": "2021-08-16T08:38:20.280Z",
        "attempts": [
          {
            "createdAt": "2021-08-16T08:38:20.280Z",
            "_id": "563e0b6a08a2710e00057b82",
            "payload": {
              "payment_intent": {
                "id": "563e0b6a08a2710e00057b82",
                "charges": {
                  "data": [
                    {
                      "metadata": {
                        "accountId": "563e0b6a08a2710e00057b82",
                        "reservationId": "563e0b6a08a2710e00057b82",
                        "listingId": "563e0b6a08a2710e00057b82"
                      }
                    }
                  ]
                },
                "metadata": {
                  "accountId": "563e0b6a08a2710e00057b82",
                  "reservationId": "563e0b6a08a2710e00057b82",
                  "listingId": "563e0b6a08a2710e00057b82"
                }
              }
            }
          }
        ],
        "_id": "563e0b6a08a2710e00057b82",
        "shouldBePaidAt": "2021-08-16T08:38:20.280Z",
        "paymentMethodId": "563e0b6a08a2710e00057b82",
        "guestId": "563e0b6a08a2710e00057b82"
      }
    ]
  },
  "listingId": "563e0b6a08a2710e00057b82",
  "accountId": "563e0b6a08a2710e00057b82",
  "guestId": "563e0b6a08a2710e00057b82",
  "mtl": {
    "_id": "563e0b6a08a2710e00057b82"
  },
  "confirmedAt": "2021-08-17T07:00:00.000Z",
  "importedAt": "2021-08-17T07:00:00.000Z",
  "additionalFeesAtCreation": [
    {
      "_id": "563e0b6a08a2710e00057b82",
      "accountId": "563e0b6a08a2710e00057b82"
    }
  ],
  "createdAt": "2021-08-17T07:00:00.000Z",
  "lastUpdatedAt": "2021-08-17T07:00:00.000Z",
  "conversationId": "563e0b6a08a2710e00057b82",
  "id": "563e0b6a08a2710e00057b82",
  "lastStayListingId": "563e0b6a08a2710e00057b82",
  "stay": {
    "id": "563e0b6a08a2710e00057b82",
    "unitTypeId": "563e0b6a08a2710e00057b82",
    "unitId": "563e0b6a08a2710e00057b82"
  }
}