Sign in

v1

latestOpenAPI 3.0.32026-07-2632131.4 MB
Reservations Open Api [Beta]

Retrieve Reservations

Retrieve multiple reservations by ID. Use this endpoint to get all the relevant information about your reservation including the financial breakdown and guest details

get/reservations-v3

Query parameters

reservationIdsstring[] required

Reservation IDs from Guesty

[
  "5f92cbf10cf217478ba93561",
  "5f92cbf10cf217478ba93562"
]
includePaymentsTemplateboolean

Include payments template information in the response

mergeAccommodationFarePriceComponentsboolean

If set to true, Markups, ExtraPersonFee, and Discounts are hidden from both the nightly rates and invoice items—they are included within the Accommodation Fee (AF). If set to false, these components are itemized separately in the response.

mergeInclusiveTaxesboolean

If set to true, inclusive taxes are merged into their respective line items. If set to false, inclusive taxes are shown as separate line items. If not supplied, the parameter is not passed to the underlying service (default behavior).

Response

Success

_idobject required
groupIdobject
sendQuoteIdobject
integrationIdobject
preApproveStateboolean
bookerIdstring required
platformstring required
quoteIdobject required
accountIdobject required
sourcestring required
confirmedAtstring date-time
reservedAtstring date-time
reservedUntil-1 | 0.5 | 0.25 | 0.17 | 12 | 24 | 36 | 48 | 72
canceledAtstring date-time
isAssignedboolean
moneyIdstring
specialRequestsstring
keyCodestring
alteredAtstring date-time
conversationIdstring
conversationExternalIdstring
transportationobject
agentBookingboolean
reasonForVisit'business' | 'leisure' | 'family' | 'event' | 'other'
canceledBy'OWNER' | 'GUEST' | 'TEAM_MEMBER' | 'HOST'
cancellationReasonstring
cancellationNotestring
pointOfSalestring
creationFlow'OPEN_API' | 'INTERNAL' | 'RESERVATIONS_UPLOAD' | 'MAILER'
originstring
originIdstring
importedAtstring date-time
manuallyCreatedboolean
uploadedAtstring date-time

Date when reservation was uploaded through reservations upload feature

unifiedIdstring
isUsingVCCboolean
createdAtstring date-time required
bookingDatestring date-time
status'confirmed' | 'reserved' | 'awaiting_payment' | 'inquiry' | 'canceled' | 'closed' | 'declined' | 'expired' required
confirmationCodestring required

Example response

[
  {
    "stay": [
      {
        "checkInDateLocalized": "2021-12-20",
        "checkOutDateLocalized": "2021-12-22",
        "guestsCount": 3,
        "numberOfGuests": {
          "numberOfAdults": 3,
          "numberOfChildren": 0,
          "numberOfInfants": 0
        },
        "unitTypeId": "5e384c9fc2700d002670b61b",
        "unitId": "5e384c9fc2700d002670b61b",
        "ratePlanId": "5e384c9fc2700d002670b61b"
      }
    ],
    "bookerId": "df7hf01cnduhdb2125854dj8",
    "platform": "direct",
    "source": "fb-campaign-01",
    "moneyId": "df7hf01cnduhdb2125854dj8",
    "specialRequests": "notes, requests",
    "keyCode": "code for the key",
    "conversationId": "df7hf01cnduhdb2125854dj8",
    "conversationExternalId": "1231234234234",
    "creationInfo": {
      "owner": {
        "_id": "5e384c9fc2700d002670b61b",
        "fullName": "John Doe",
        "email": "john.doe@gmail.com",
        "phone": "+1 123 456 7890",
        "locale": "en-US"
      }
    },
    "origin": "YourPorter",
    "originId": "external-id-example",
    "importedAt": "2023-04-28T17:20:53.767Z",
    "manuallyCreated": true,
    "uploadedAt": "2023-04-28T17:20:53.767Z",
    "unifiedId": "unified-id-example",
    "channelMetadata": {
      "channelMetadata": {}
    },
    "guestPreferences": {
      "guestPreferences": {
        "smoking": false
      }
    },
    "ratePlans": [
      {
        "name": "1231234234234",
        "mealPlan": "1231234234234",
        "cancellationPolicy": "1231234234234",
        "cancellationPolicyDescription": "1231234234234"
      }
    ],
    "channelsSyncState": {
      "channelsSyncState": {
        "listing": {
          "unlockOnListingId": "listing-id",
          "syncMode": "DISABLED"
        }
      }
    }
  }
]