GUguesty
Reservations

Get a reservation

Changed on

This allows you to obtain details about a specific reservation.

NOTE:

  • To include the check-in and check-out times of a reservations include the parameters: listing.defaultCheckInTime, plannedArrival, listing.defaultCheckOutTime and plannedDeparture. Planned arrival and departure times override the default times.
  • Use checkInDateLocalized and checkOutDateLocalized to retrieve the reservation according to the location of the listing.

Note: This endpoint is soon to be deprecated. Please use this endpoint instead.

get/reservations/{id}

Request

  • Base URL
    https://open-api.guesty.com/v1
  • URL
    https://open-api.guesty.com/v1/reservations/{id}
  • Auth
    API key in header authorization

Path parameters

idstring required

Reservation ID

Query parameters

fieldsstring

Reservation fields to retrieve, separated by space

Response

Reservation object

flagboolean
accountingEnabledboolean
isBMAppliedboolean
pulledByDailySyncboolean
manuallyCreatedboolean
_idstring

Unique Guesty listing/unit type ID.

statusstring
checkInstring
checkOutstring
nightsCountnumber
guestsCountnumber
listingIdstring

Unique Guesty listing/unit type ID.

checkInDateLocalizedstring
checkOutDateLocalizedstring
accountIdstring

Unique Guesty listing/unit type ID.

guestIdstring

Unique Guesty listing/unit type 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 Guesty listing/unit type ID.

idstring

Unique Guesty listing/unit type ID.

isMidStayboolean
lastStayListingIdstring

Unique Guesty listing/unit type 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"
  }
}

Changes

  • 3122b8618183Revision changes
    • warning

      removed the optional property from the response with the status

    • info

      api operation id reservationsV2Get was added

    • info

      endpoint deprecated