1. Schemas
YGO Client API
v1
  • v2
  • v1
  • Default Module
    • Overview
    • Core Concepts
    • Authentication
    • Quickstart Guide
    • AI Search & Trip Planning
    • Booking Flow
    • Environments
    • General
      • Check API health status
      • Get current API key context
    • AI Search & Trip Planning
      • Send message to YGO AI
    • Product Search (Deprecated)
      • Search for hotel & package offers
      • Get transfers for booking
      • Get package price calendar
    • Bookings
      • Get or create open booking
      • Check offer availability
      • Update open booking
      • Update booking status and trigger workflows
      • List bookings
      • Get booking
    • Schemas
      • Schemas
        • PackageSearchRequest
        • GetPackageCalendarRequest
        • GetBookingRequest
        • ListBookingsRequest
        • SaveBookingStatusRequest
        • SaveOpenBookingRequest
        • GetOpenBookingRequest
        • GetTransfersRequest
        • Product
        • Booking
        • TransferOptionsResponse
        • PackageCalendarResponse
        • ProductTexts
        • BookingDetails
        • TripReference
        • TransferOption
        • PackageCalendarDate
        • LocaleContent
        • BookingItemInput
        • Trip
        • ProductImage
        • TransferImage
        • BookingItem
        • Traveller
        • PickupInformation
        • ProductDetails
        • PackageOffer
        • PickupLocation
        • Image
        • Pickup
        • TourOperator
        • CheckPickup
        • Accommodation
        • TransferRemark
        • Room
        • CancellationPolicy
        • Transport
        • Flight
        • Airport
        • Price
        • PriceByPax
        • SuccessResponse
        • ErrorResponse
        • Hotel
        • HotelFeatures
        • FeatureState
        • RoomFeatures
        • RoomContent
        • Facility
      • Response
        • Unauthorized
  1. Schemas

Product

Complete hotel package product with accommodation, flight, and pricing details

{
    "ID": 0,
    "Type": "hotel",
    "Provider": "string",
    "ProviderID": "string",
    "CountryCode": "string",
    "Latitude": 0,
    "Longitude": 0,
    "Distance": 0,
    "Rating": 0,
    "Price": 0,
    "Texts": {
        "Locales": {
            "property1": {
                "Name": "string",
                "City": "string",
                "Country": "string",
                "Region": "string",
                "ShortText": "string",
                "Description": "string",
                "IntroText": "string",
                "Address": "string"
            },
            "property2": {
                "Name": "string",
                "City": "string",
                "Country": "string",
                "Region": "string",
                "ShortText": "string",
                "Description": "string",
                "IntroText": "string",
                "Address": "string"
            }
        }
    },
    "Images": [
        {
            "URL": "http://example.com",
            "Width": 0,
            "Height": 0,
            "Type": "string"
        }
    ],
    "Details": {
        "Category": 0,
        "RatingAverage": 0,
        "RatingCount": 0,
        "RecommendationScore": 0,
        "Hotel": {
            "HotelbedsCode": 0,
            "LocalizedRooms": {
                "en": [
                    {
                        "RoomCode": "DBL.ST",
                        "Description": "Double Standard Room",
                        "MinPax": 1,
                        "MaxPax": 2
                    }
                ]
            },
            "LocalizedFacilities": {
                "en": [
                    {
                        "FacilityCode": 10,
                        "Description": {
                            "Content": "Swimming Pool"
                        }
                    }
                ]
            },
            "RoomImages": {
                "DBL.ST": [
                    {
                        "URL": "https://cdn.ygo.ai/hotels/12345/rooms/dbl-st-1.jpg",
                        "Width": 1920,
                        "Height": 1080,
                        "Type": "room"
                    }
                ]
            },
            "RoomFeatures": {
                "DBL.ST": {
                    "SquareMeters": 28,
                    "HasBalcony": true,
                    "HasWifi": true
                }
            },
            "Stars": 4.5,
            "Exists": true,
            "PetsAllowed": true,
            "HasPool": true,
            "HasSauna": true,
            "HasSpa": true,
            "HasFitness": true,
            "HasGym": true,
            "HasBalcony": true,
            "Has24hReception": true,
            "HasWifi": true,
            "HasBar": true,
            "HasRestaurant": true,
            "HasElevator": true,
            "HasAirCondition": true,
            "HasBreakfast": true,
            "HasParking": true,
            "WheelchairAccessible": true,
            "Features": {
                "Pool": "yes",
                "Wifi": "yes",
                "Parking": "yes",
                "PetsAllowed": "no",
                "Spa": "unknown"
            }
        },
        "PackageOffers": [
            {
                "TourOperator": {
                    "Code": "string",
                    "Name": "string"
                },
                "Accommodation": {
                    "Code": "string",
                    "LengthOfStay": 0,
                    "ArrivalDate": "2019-08-24",
                    "Rooms": [
                        {
                            "Description": "string",
                            "Code": "string",
                            "Board": "string",
                            "BoardCode": "string"
                        }
                    ]
                },
                "Transport": {
                    "Departure": {
                        "TransportType": "FLIGHT",
                        "DepartureAirport": {
                            "Code": "string",
                            "Name": "string"
                        },
                        "ArrivalAirport": {
                            "Code": "string",
                            "Name": "string"
                        },
                        "DepartureDateTime": "2019-08-24T14:15:22.123Z",
                        "ArrivalDateTime": "2019-08-24T14:15:22.123Z",
                        "FlightNumber": "string",
                        "Airline": {
                            "Code": "string",
                            "Name": "string"
                        },
                        "Duration": 0,
                        "StopOver": 0
                    },
                    "Return": {
                        "TransportType": "FLIGHT",
                        "DepartureAirport": {
                            "Code": "string",
                            "Name": "string"
                        },
                        "ArrivalAirport": {
                            "Code": "string",
                            "Name": "string"
                        },
                        "DepartureDateTime": "2019-08-24T14:15:22.123Z",
                        "ArrivalDateTime": "2019-08-24T14:15:22.123Z",
                        "FlightNumber": "string",
                        "Airline": {
                            "Code": "string",
                            "Name": "string"
                        },
                        "Duration": 0,
                        "StopOver": 0
                    }
                },
                "Price": {
                    "Amount": 850,
                    "Currency": "EUR"
                },
                "PricePerNight": {
                    "Amount": 850,
                    "Currency": "EUR"
                },
                "PricePerPerson": {
                    "Amount": 850,
                    "Currency": "EUR"
                },
                "PricePerPersonPerNight": {
                    "Amount": 850,
                    "Currency": "EUR"
                },
                "Brand": "string",
                "Status": "string",
                "SubStatus": "string"
            }
        ]
    },
    "Status": "offline"
}
Built with