Creating a Reservation Claim

With an invoice, you must generate a reservation claim object to proceed with the booking. This object represents all data required to finalize the booking and incorporates much of the data gathered to this point in the reservation workflow.

The reservation claim object requires, at a minimum, these four items:

• The InventoryChannelID, the number used to retrieve tee times during search and inventory.
• The TeeTimeRateID, the ID for the tee time you wish to book.
• The Invoice, generated in the previous step.
• A list of PaymentOptions. This is an array containing the methods by which you intend to pay for the tee time. See Payment Options and the Wallet for more information on valid payment types. A booking with a standard credit card number will be used in the following example.

Note that for credit card payment types, the amount you are required to pay must be equal to Pricing.DueOnline. Even if no money is due online, you must specify at least one payment type to copmlete the booking.

Here is an example ReservationClaim object:

The full detail of the ReservationClaim object may be found at the API Specification.

One field of particular note is the GuestInfo object. If you are checking out with a guest token, this object must contain at least a phone number to complete the booking, as follows:

The FirstName and LastName fields are used to override a guest customer's name - this is provided to the tee sheet, and is useful as generating a guest token does not require this data (although it is not required); the EmailAddress field is used by affiliates to book as another customer while authenticated under a service account: see Affiliate Payments for more information on booking as an affiliate.

Now that we have generated a ReservationClaim object, we can proceed with the actual booking.

Booking the Tee Time

Booking a tee time is a simple POST to the AddReservation endpoint, as follows:

You will notice that much of the information returned is familiar from the input and previous steps. Of note in the response is the ReservationID. This number may be leveraged to retrieve reservation details at a later time for the customer, using the GetReservation endpoint.

Click to continue to: Conclusion.

Return to the end-to-end example index.