Vacatia API Catalog
/
Berkley API
/
Reservations

Berkley API (1.0.0-BETA2)

Download OpenAPI description
berkley.json
berkley.yaml
Languages
Servers
Mock server
https://tbg-api-docs.vacatia.com/_mock/berkley/
The staging API server
https://porter-staging.vacatia.com/api/
The PRODUCTION API server
https://porter.vacatia.com/api/

Owners

Operations

Properties

Operations

Contracts

Operations

Reservations

Operations

Create a reservation

Request

Path
propertyIdstringrequired
Example: MT-MLR
Bodyapplication/jsonrequired

The reservation

sourceIdstring

The id of the reservation in the third-party system, the reservation's SPI Itinerary ID or RCI Reservation ID for instance.

sourcestringwrite-onlyrequired

Used in selecting the room type waterfall

Enum"exchange""marketing"
startDatestring(date)required
endDatestring(date)required
statusstring
Enum"not_confirmed""confirmed""canceled""checked_in""checked_out""no_show"
exchangeNamestring

The name of the exchange company (e.g. "RCI")

Value"rci"
exchangeGuestTypestring

The type of guest (e.g. "owner")

Enum"resort_home_week_owner""resort_owner""berkley_owner""exchange_member""exchange_member_guest"
requestedAdaUnitboolean

Whether the guest requested an ADA unit

Default false
reservationTypestring
reservationSubtypestring
rciMemberIdstring

The RCI member ID

primaryGuestobject(Guest)required
vacatiaOwnerIdstring

The Vacatia guest ID

Example: "V-0000-0000"
firstNamestringrequired

The guest's first name

Example: "James"
lastNamestringrequired

The guest's last name

Example: "Kirk"
emailAddressstring(email)required

The guest's email address

mailingAddressobject(Address)required

The guest's mailing address

line1string
line2string
citystring
statestring
postalCodestring
countrystring

The ISO 3166-1 alpha-2 country code

homePhonestring

The guest's home phone number

mobilePhonestring

The guest's mobile phone number

additionalGuestsArray of objects(Guest)
accommodationsArray of objects(Accommodation)required

A list of accommodations (must include at least one item)

unitTypeCodestringwrite-onlyrequired

Used in selecting the room type waterfall

Example: "WEST A"
numberOfAdultsinteger>= 1required
numberOfChildreninteger>= 0
notesArray of objects(ReservationNote)write-only
curl -i -X POST \
  https://tbg-api-docs.vacatia.com/_mock/berkley/properties/MT-MLR/reservations \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "sourceId": "string",
    "source": "exchange",
    "startDate": "2019-08-24",
    "endDate": "2019-08-24",
    "status": "not_confirmed",
    "exchangeName": "rci",
    "exchangeGuestType": "resort_home_week_owner",
    "requestedAdaUnit": false,
    "reservationType": "string",
    "reservationSubtype": "string",
    "rciMemberId": "string",
    "primaryGuest": {
      "vacatiaOwnerId": "V-0000-0000",
      "firstName": "James",
      "lastName": "Kirk",
      "emailAddress": "user@example.com",
      "mailingAddress": {
        "line1": "string",
        "line2": "string",
        "city": "string",
        "state": "string",
        "postalCode": "string",
        "country": "string"
      },
      "homePhone": "string",
      "mobilePhone": "string"
    },
    "additionalGuests": [
      {
        "vacatiaOwnerId": "V-0000-0000",
        "firstName": "James",
        "lastName": "Kirk",
        "emailAddress": "user@example.com",
        "mailingAddress": {
          "line1": "string",
          "line2": "string",
          "city": "string",
          "state": "string",
          "postalCode": "string",
          "country": "string"
        },
        "homePhone": "string",
        "mobilePhone": "string"
      }
    ],
    "accommodations": [
      {
        "unitTypeCode": "WEST A",
        "numberOfAdults": 1,
        "numberOfChildren": 0
      }
    ],
    "notes": [
      {
        "note": "Please note that the example guest is allergic to example peanuts."
      }
    ]
  }'

Responses

The new reservation id and the primary guest id

Bodyapplication/json
dataobject(PostPatchReservationResponse)
Response
application/json
{
  "data": {
    "reservationId": "134782164",
    "primaryGuest": { … }
  }
}

Fetch a reservation

Request

Path
propertyIdstringrequired
Example: MT-MLR
reservationIdstringrequired
Example: 0123456789
curl -i -X GET \
  https://tbg-api-docs.vacatia.com/_mock/berkley/properties/MT-MLR/reservations/0123456789 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The requested reservation

Bodyapplication/json
dataobject(Reservation)
Response
application/json
{
  "data": {
    "id": "string",
    "cloudbedsSource": "string",
    "sourceId": "string",
    "startDate": "2019-08-24",
    "endDate": "2019-08-24",
    "status": "not_confirmed",
    "exchangeName": "rci",
    "exchangeGuestType": "resort_home_week_owner",
    "requestedAdaUnit": false,
    "reservationType": "string",
    "reservationSubtype": "string",
    "rciMemberId": "string",
    "primaryGuest": { … },
    "additionalGuests": [ … ],
    "accommodations": [ … ]
  }
}

Update a reservation

Request

Path
propertyIdstringrequired
Example: MT-MLR
reservationIdstringrequired
Example: 0123456789
Bodyapplication/jsonrequired

The reservation changes

statusstring
Enum"not_confirmed""confirmed""canceled""checked_in""checked_out""no_show"
reservationTypestring
reservationSubTypestring
rciMemberIdstring

The RCI member ID

curl -i -X PATCH \
  https://tbg-api-docs.vacatia.com/_mock/berkley/properties/MT-MLR/reservations/0123456789 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "status": "not_confirmed",
    "reservationType": "string",
    "reservationSubType": "string",
    "rciMemberId": "string"
  }'

Responses

The updated reservation

Bodyapplication/json
dataobject(PostPatchReservationResponse)
Response
application/json
{
  "data": {
    "reservationId": "134782164",
    "primaryGuest": { … }
  }
}

Guests

Operations