Skip to navigation

Concepts and domain glossary

View as Markdown

Integration organization — The organization selected during OAuth consent. It owns the end-customer channel and messaging.

Inventory Course — A golf course exposed to the resolved principal. Its effective access tier and booking window can differ by role.

Tee Time — A course-local start with bounded capacity and selections such as holes and cart. Its capacity (max_players) comes from the course’s players per tee time (max_players_per_tee_time: 4 by default, 5 when the course allows fivesomes) when the Tee Time is created. A Tee Time keeps that capacity if the course setting changes later, so the two can differ.

Availability offer — A short-lived, encrypted, authenticated selection returned by /availability. It binds principal, course, Tee Time, quantity, pricing, policy, and expiry. It is not a hold.

Cart policy — Each availability offer returns requirements.cart_policy: included, not_included, or walking_only. This is the effective policy for that Tee Time after course restrictions and rotation rules. included has no additional cart charge; not_included uses the configured fee, which can also be zero; walking_only prohibits riding. requirements.cart remains the selected walking/riding option, and cart_requirement tells you whether riding is optional, required, or unavailable. Read the policy from each offer rather than inferring it from price or course amenities. Existing request fields are unchanged.

Reservation — One atomic booking for one course. It may contain 1–12 Tee Time allocations and at most 50 golfers. All allocations succeed together or none do.

Allocation — A quantity booked against one offered Tee Time. Multi-Tee-Time group Reservations are one Reservation, not loosely associated bookings.

Guest Golfer — The primary customer identity supplied by the integration. At least an email or phone is required.

Known companion — Optional names supplied within an allocation. These are not independent customer identities.

Pay at Course — The only v1 payment method. amount_due_now_minor is always zero.

Cancellation eligibility — The current policy-aware decision. Fee-required or started play cannot be cancelled through v1.

Reconciliation watermark — updated_through freezes a paginated list run. next_updated_after is the next run’s exclusive lower bound with a one-millisecond overlap.

Request ID — The Request-Id response header and matching meta.request_id or error.request_id. Save it for support.