# YGO API

## Docs
- [Overview](https://docs.ygo.ai/overview-355704m0.md): 
- [Core Concepts](https://docs.ygo.ai/core-concepts-355705m0.md): 
- [Authentication](https://docs.ygo.ai/authentication-355706m0.md): 
- [Quickstart Guide](https://docs.ygo.ai/quickstart-guide-355707m0.md): 
- [AI Search & Trip Planning](https://docs.ygo.ai/ai-search-trip-planning-355720m0.md): 
- [Booking Flow](https://docs.ygo.ai/booking-flow-355718m0.md): 
- [Environments](https://docs.ygo.ai/environments-355708m0.md): 
- [Product Search (Classic)](https://docs.ygo.ai/product-search-classic-465576f0.md): 

## API Docs
- General [Check API health status](https://docs.ygo.ai/check-api-health-status-3955041e0.md): Verify that the API and its critical internal and external dependencies are operational. Use this endpoint for monitoring, load balancer health checks, and deployment validation.
- General [Get current API key context](https://docs.ygo.ai/get-current-api-key-context-3955042e0.md): Returns the Organization ID and Project ID associated with the API key used in the request. Use this endpoint to:
- AI Search & Trip Planning [Send message to YGO AI](https://docs.ygo.ai/send-message-to-ygo-ai-3955048e0.md): Process travel queries using YGO AI's advanced multi-agent system with augmented, multi-source hotel data. Supports natural language, structured data, or hybrid inputs for maximum flexibility.
- Product Search (Classic) [Search for hotel & package offers](https://docs.ygo.ai/search-for-hotel-package-offers-3954479e0.md): The **classic way** to search for hotels and hotel+flight packages provided by connected Amadeus & Peakwork supply. 
- Product Search (Classic) [Get transfers for booking](https://docs.ygo.ai/get-transfers-for-booking-3954502e0.md): Discover available airport transfer options for an existing booking. This endpoint provides curated transfer services (private vehicles, shared shuttles, luxury transfers) that are precisely matched to your booking's flight times and hotel location. The system queries multiple transfer providers to ensure comprehensive coverage and competitive pricing. Transfer options include detailed vehicle information, capacity limits, pricing breakdowns, pickup/dropoff details, and cancellation policies. Provider selection can be influenced via the project settings. Results are localized based on the requested language for optimal customer experience.
- Product Search (Classic) [Get package price calendar](https://docs.ygo.ai/get-package-price-calendar-3955040e0.md): Retrieve a calendar of the cheapest package prices for a destination across multiple departure airports, durations, and dates. Returns a structured response organized by departure airport → nights → departure date, with each date showing the minimum price, arrival airport, offer details, and whether it's the absolute cheapest option. Defaults to all German airports if no departure airports specified. This endpoint provides data for building flexible date search interfaces and price comparison calendars.
- Bookings [Get or create open booking](https://docs.ygo.ai/get-or-create-open-booking-3955002e0.md): Retrieve the current open booking (shopping cart) for a main trip product (see it as an "anchor") and user, or automatically create a new one if none exists. The ProductID must reference a main trip product which is either a hotel-only, hotel+flight package, or pre-bundled trip. Additional items like activities and transfers can be added to this booking later in a shopping cart fashion. This endpoint provides idempotent behavior - calling it multiple times with the same ProductID and UserID returns the same booking. If multiple open bookings are found for a user-product combination (edge case), the system logs a warning and returns the first one. The returned booking object includes complete trip details, traveler information, contact data, items, pricing, and payment status. This endpoint is essential for implementing persistent shopping cart functionality across user sessions. The UserID parameter identifies the end customer.
- Bookings [Update open booking](https://docs.ygo.ai/update-open-booking-3955029e0.md): Update an existing open booking (shopping cart) with modified details including traveler information, contact data, added items (activities, transfers), and pricing. The endpoint validates booking ownership, ensures the ProductID hasn't changed, cleans invalid items, validates voucher codes, and optionally performs real-time availability checks. Query parameters control availability checking behavior: `checkAvailability=true` validates item availability, while `checkBeforePayment=true` performs comprehensive pre-payment validation including price verification with the package provider. The UserID parameter identifies the end customer.
- Bookings [Update booking status and trigger workflows](https://docs.ygo.ai/update-booking-status-and-trigger-workflows-3955034e0.md): Update a booking's status to reflect payment completion, cancellation, or other lifecycle changes. Critical status transitions trigger automated workflows: transitioning to 'paid' automatically books items with suppliers, skipping items marked for manual booking or requiring pickup selection. The system synchronizes status changes to connected midoffice and supplier systems based on configured integrations. Status transitions must move forward in the booking lifecycle - reversing to 'open' status is not permitted. The UserID parameter identifies the end customer.
- Bookings [List bookings ](https://docs.ygo.ai/list-bookings-3955036e0.md): Retrieve a filtered and paginated list of bookings. Supports filtering by user,  status (e.g., only paid bookings), product ID (all bookings for a specific trip), date ranges (bookings created within a time period), and host (bookings from specific whitelabel domains). Results can be sorted by creation date in ascending or descending order, and paginated using limit/offset parameters. 
- Bookings [Get booking](https://docs.ygo.ai/get-booking-3955038e0.md): Retrieve a complete booking object by its unique 8-character booking ID. The endpoint validates ownership, ensuring the booking belongs to the authenticated user. Returns the full booking structure including trip information, items (activities, transfers), traveler details, contact information, pricing, payment data, and booking status. The UserID parameter identifies the end customer.

## Schemas
- Schemas [PackageSearchRequest](https://docs.ygo.ai/packagesearchrequest-658021d0.md): 
- Schemas [GetTransfersRequest](https://docs.ygo.ai/gettransfersrequest-658094d0.md): 
- Schemas [GetOpenBookingRequest](https://docs.ygo.ai/getopenbookingrequest-658114d0.md): 
- Schemas [SaveOpenBookingRequest](https://docs.ygo.ai/saveopenbookingrequest-658127d0.md): 
- Schemas [SaveBookingStatusRequest](https://docs.ygo.ai/savebookingstatusrequest-658130d0.md): 
- Schemas [ListBookingsRequest](https://docs.ygo.ai/listbookingsrequest-658131d0.md): 
- Schemas [GetBookingRequest](https://docs.ygo.ai/getbookingrequest-658132d0.md): 
- Schemas [GetPackageCalendarRequest](https://docs.ygo.ai/getpackagecalendarrequest-658133d0.md): 
- Schemas [Product](https://docs.ygo.ai/product-658022d0.md): 
- Schemas [TransferOptionsResponse](https://docs.ygo.ai/transferoptionsresponse-658095d0.md): 
- Schemas [Booking](https://docs.ygo.ai/booking-658115d0.md): 
- Schemas [ProductTexts](https://docs.ygo.ai/producttexts-658023d0.md): 
- Schemas [TransferOption](https://docs.ygo.ai/transferoption-658096d0.md): 
- Schemas [BookingDetails](https://docs.ygo.ai/bookingdetails-658116d0.md): 
- Schemas [TripReference](https://docs.ygo.ai/tripreference-658128d0.md): 
- Schemas [PackageCalendarResponse](https://docs.ygo.ai/packagecalendarresponse-658134d0.md): 
- Schemas [LocaleContent](https://docs.ygo.ai/localecontent-658024d0.md): 
- Schemas [Trip](https://docs.ygo.ai/trip-658117d0.md): 
- Schemas [BookingItemInput](https://docs.ygo.ai/bookingiteminput-658129d0.md): 
- Schemas [PackageCalendarDate](https://docs.ygo.ai/packagecalendardate-658135d0.md): 
- Schemas [ProductImage](https://docs.ygo.ai/productimage-658025d0.md): 
- Schemas [TransferImage](https://docs.ygo.ai/transferimage-658097d0.md): 
- Schemas [BookingItem](https://docs.ygo.ai/bookingitem-658118d0.md): 
- Schemas [ProductDetails](https://docs.ygo.ai/productdetails-658026d0.md): 
- Schemas [PickupInformation](https://docs.ygo.ai/pickupinformation-658098d0.md): 
- Schemas [Traveller](https://docs.ygo.ai/traveller-658119d0.md): 
- Schemas [PackageOffer](https://docs.ygo.ai/packageoffer-658027d0.md): 
- Schemas [PickupLocation](https://docs.ygo.ai/pickuplocation-658099d0.md): 
- Schemas [TourOperator](https://docs.ygo.ai/touroperator-658028d0.md): 
- Schemas [Pickup](https://docs.ygo.ai/pickup-658100d0.md): 
- Schemas [Image](https://docs.ygo.ai/image-658120d0.md): 
- Schemas [Accommodation](https://docs.ygo.ai/accommodation-658029d0.md): 
- Schemas [CheckPickup](https://docs.ygo.ai/checkpickup-658101d0.md): 
- Schemas [Room](https://docs.ygo.ai/room-658030d0.md): 
- Schemas [TransferRemark](https://docs.ygo.ai/transferremark-658102d0.md): 
- Schemas [Transport](https://docs.ygo.ai/transport-658031d0.md): 
- Schemas [CancellationPolicy](https://docs.ygo.ai/cancellationpolicy-658103d0.md): 
- Schemas [Flight](https://docs.ygo.ai/flight-658032d0.md): 
- Schemas [Airport](https://docs.ygo.ai/airport-658033d0.md): 
- Schemas [Price](https://docs.ygo.ai/price-658034d0.md): 
- Schemas [PriceByPax](https://docs.ygo.ai/pricebypax-658035d0.md): 
- Schemas [SuccessResponse](https://docs.ygo.ai/successresponse-658036d0.md): 
- Schemas [ErrorResponse](https://docs.ygo.ai/errorresponse-658037d0.md): 
- Schemas [Hotel](https://docs.ygo.ai/hotel-658057d0.md): 
- Schemas [HotelFeatures](https://docs.ygo.ai/hotelfeatures-658058d0.md): 
- Schemas [FeatureState](https://docs.ygo.ai/featurestate-658059d0.md): 
- Schemas [RoomFeatures](https://docs.ygo.ai/roomfeatures-658060d0.md): 
- Schemas [RoomContent](https://docs.ygo.ai/roomcontent-658061d0.md): 
- Schemas [Facility](https://docs.ygo.ai/facility-658062d0.md): 
- Response [Unauthorized](https://docs.ygo.ai/unauthorized-658038d0.md):