Endpoints

Booking Endpoints

Booking Endpoints

These endpoints allow you to create, manage, and retrieve golf course bookings.

Create a Booking

Code
 
POST /bookings

Creates a new golf course booking.

Request Body

Code
 
{
  "courseId": "course_123",
  "date": "2023-07-15",
  "teeTime": "08:30",
  "players": 4,
  "agencyBookingReference": "AG-12345",
  "playerDetails": [
    {
      "firstName": "John",
      "lastName": "Smith",
      "email": "[email protected]",
      "phone": "+1 234 567 8900",
      "handicap": 15
    },
    // Additional players...
  ],
  "specialRequests": "Buggy required for 2 players",
  "contactLanguage": "en"
}

Required Fields

Field	Type	Description
courseId	string	ID of the course to book
date	string	Booking date (YYYY-MM-DD)
teeTime	string	Requested tee time (HH)
players	integer	Number of players (1-4)
agencyBookingReference	string	Your internal booking reference
playerDetails	array	Array of player information objects

Response

Code
 
{
  "id": "booking_456",
  "status": "confirmed",
  "bookingReference": "GG-987654",
  "agencyBookingReference": "AG-12345",
  "course": {
    "id": "course_123",
    "name": "Marbella Golf Country Club"
  },
  "date": "2023-07-15",
  "teeTime": "08:30",
  "players": 4,
  "playerDetails": [
    // Player details...
  ],
  "pricing": {
    "currency": "EUR",
    "greenFee": 85.00,
    "totalAmount": 340.00,
    "priceBreakdown": {
      "greenFee": 85.00,
      "players": 4,
      "extras": []
    }
  },
  "specialRequests": "Buggy required for 2 players",
  "createdAt": "2023-06-01T14:22:33Z",
  "confirmationSentTo": "[email protected]"
}

Get Booking Details

Code
 
GET /bookings/{bookingId}

Retrieves details of a specific booking.

Path Parameters

Parameter	Type	Description
bookingId	string	ID of the booking to retrieve

Response

Returns the booking object with the same structure as the create booking response.

List Agency Bookings

Code
 
GET /bookings

Retrieves a list of all bookings made by your agency.

Query Parameters

Parameter	Type	Description
page	integer	Page number for pagination (default: 1)
limit	integer	Number of results per page (default: 20, max: 100)
status	string	Filter by booking status (confirmed, pending, cancelled)
startDate	string	Filter for bookings on or after this date (YYYY-MM-DD)
endDate	string	Filter for bookings on or before this date (YYYY-MM-DD)
agencyBookingReference	string	Filter by your internal booking reference

Response

Code
 
{
  "data": [
    {
      "id": "booking_456",
      "status": "confirmed",
      "bookingReference": "GG-987654",
      "agencyBookingReference": "AG-12345",
      "course": {
        "id": "course_123",
        "name": "Marbella Golf Country Club"
      },
      "date": "2023-07-15",
      "teeTime": "08:30",
      "players": 4,
      "pricing": {
        "currency": "EUR",
        "totalAmount": 340.00
      },
      "createdAt": "2023-06-01T14:22:33Z"
    },
    // More bookings...
  ],
  "pagination": {
    "totalItems": 128,
    "totalPages": 7,
    "currentPage": 1,
    "limit": 20
  }
}

Update a Booking

Code
 
PATCH /bookings/{bookingId}

Updates an existing booking. Only certain fields can be modified after booking creation.

Path Parameters

Parameter	Type	Description
bookingId	string	ID of the booking to update

Request Body

Code
 
{
  "players": 3,
  "playerDetails": [
    // Updated player details...
  ],
  "specialRequests": "Updated request: Buggy required for all players",
  "agencyBookingReference": "AG-12345-UPDATED"
}

Modifiable Fields

Field	Description
players	Number of players (can only be reduced, not increased)
playerDetails	Player information
specialRequests	Special requests or notes
agencyBookingReference	Your internal booking reference

Response

Returns the updated booking object.

Cancel a Booking

Code
 
DELETE /bookings/{bookingId}

Cancels an existing booking.

Path Parameters

Parameter	Type	Description
bookingId	string	ID of the booking to cancel

Query Parameters

Parameter	Type	Description
cancellationReason	string	Optional reason for cancellation

Response

Code
 
{
  "id": "booking_456",
  "status": "cancelled",
  "bookingReference": "GG-987654",
  "cancellationDetails": {
    "cancelledAt": "2023-06-05T09:12:45Z",
    "cancelledBy": "agency",
    "refundAmount": 340.00,
    "cancellationFee": 0.00,
    "reason": "Customer request: travel plans changed"
  }
}

Booking Webhook Notifications

When the status of a booking changes, a webhook notification will be sent to your configured endpoint if you have set up webhooks. See the Webhooks section for more details on configuring and handling webhook notifications.