Sign in

v1

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

Create a group reservation

This endpoint allows the creation of a group reservation, based on an array of quotes

post/reservations-v3/group

Request body

namestring required
sourcestring

Source of reservation

status'confirmed' | 'reserved' | 'awaiting_payment' | 'inquiry' | 'canceled' | 'closed' | 'declined' | 'expired'
reservedUntil-1 | 0.5 | 0.25 | 0.17 | 12 | 24 | 36 | 48 | 72

Indicates for how long a reservation is valid after creation (in hours)

notestring

The reservation notes

couponsstring[]

List of coupons

chargeMethod'PER_GROUP' | 'PER_RESERVATION' required

The charge method for the group reservation (PER_GROUP method is not applicable to to accounting users)

Example request

{
  "quoteAndRatePlanIds": [
    {
      "quoteId": "6213b03e7f0ba50032296f4a",
      "ratePlanId": "default-rateplan-id"
    },
    {
      "quoteId": "6213b03e7f0ba50032296f4b",
      "ratePlanId": "36ft523e7f0ba500323hf736"
    }
  ],
  "name": "guesty-company-trip",
  "source": "Manual",
  "status": "reserved",
  "reservedUntil": 36,
  "groupBooker": {
    "_id": "6213b03e7f0ba50032296f4a",
    "fullName": "Full Name"
  },
  "coupons": [
    "VeryCoolCoupon",
    "VeryCoolCoupon2"
  ],
  "chargeMethod": "PER_RESERVATION"
}

Response

The group reservation has been created successfuly

_idobject required
accountIdobject required
sendQuoteIdobject
platformstring required
namestring required
sourcestring required
bookerIdstring
createdAtstring date-time required
notestring required
confirmationCodestring required

Example response

{
  "platform": "direct",
  "name": "guesty-company-trip",
  "source": "manual"
}