1. Product Search (Deprecated)
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
        POST
      • Get transfers for booking
        POST
      • Get package price calendar
        POST
    • 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. Product Search (Deprecated)

Get transfers for booking

Deprecated
POST
/v1/getTransfers
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.

Request

Authorization
or
Body Params application/json

Examples

Responses

🟢200OK
application/json
Successfully retrieved transfer options for the booking
Bodyapplication/json

🟠400Bad Request
🟠401Unauthorized
🟠404Record Not Found
🔴500Server Error
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location 'https://api.ygo.ai/v1/v1/getTransfers' \
--header 'Content-Type: application/json' \
--data '{
    "BookingID": "BK-2025-ABC123"
}'
Response Response Example
200 - Booking with available transfer options
{
    "Data": {
        "Options": [
            {
                "Provider": "HBX",
                "Brand": "HBX",
                "Name": "Private Transfer - Mercedes E-Class",
                "Description": "Luxurious private transfer with professional driver. Includes flight monitoring, meet & greet service, and complimentary water.",
                "Direction": "ARRIVAL",
                "Price": {
                    "Amount": 65,
                    "Currency": "EUR"
                },
                "TransferType": "private",
                "RateKey": "TRF-2025-PVT-001",
                "MinPaxCapacity": 1,
                "MaxPaxCapacity": 3,
                "Images": [
                    {
                        "URL": "https://cdn.peakwork.com/transfers/mercedes-eclass.jpg",
                        "Type": "vehicle"
                    }
                ],
                "PickupInformation": {
                    "From": {
                        "Type": "AIRPORT",
                        "Code": "BCN",
                        "Description": "Barcelona El Prat Airport - Terminal 1, Arrivals Hall"
                    },
                    "To": {
                        "Type": "ATLAS",
                        "Code": "123456",
                        "Description": "Hotel Arts Barcelona"
                    },
                    "Date": "2025-11-15",
                    "Time": "10:45",
                    "Pickup": {
                        "Description": "Driver will wait at Arrivals Hall with name sign",
                        "Latitude": 41.2974,
                        "Longitude": 2.0833,
                        "CheckPickup": {
                            "MustCheckPickupTime": true
                        }
                    }
                },
                "TransferRemarks": [
                    {
                        "Type": "IMPORTANT",
                        "Description": "Please provide mobile number for driver contact",
                        "Mandatory": true
                    },
                    {
                        "Type": "INFO",
                        "Description": "Maximum 2 large suitcases per vehicle",
                        "Mandatory": false
                    }
                ],
                "CancellationPolicies": [
                    {
                        "Amount": 65,
                        "From": "2025-11-14T00:00:00Z",
                        "CurrencyID": "EUR",
                        "IsForceMajeure": false
                    },
                    {
                        "Amount": 0,
                        "From": "2025-11-01T00:00:00Z",
                        "CurrencyID": "EUR",
                        "IsForceMajeure": false
                    }
                ]
            },
            {
                "Provider": "Peakwork",
                "Brand": "Peakwork",
                "Name": "Shared Shuttle Service",
                "Description": "Economical shared shuttle with other travelers. Multiple hotel stops en route.",
                "Direction": "ARRIVAL",
                "Price": {
                    "Amount": 18,
                    "Currency": "EUR"
                },
                "TransferType": "shuttle",
                "RateKey": "TRF-2025-SHT-002",
                "MinPaxCapacity": 1,
                "MaxPaxCapacity": 8,
                "PickupInformation": {
                    "From": {
                        "Type": "AIRPORT",
                        "Code": "BCN",
                        "Description": "Barcelona El Prat Airport - Shuttle Bus Stop 3"
                    },
                    "To": {
                        "Type": "ATLAS",
                        "Code": "123456",
                        "Description": "Hotel Arts Barcelona"
                    },
                    "Date": "2025-11-15",
                    "Time": "11:15"
                },
                "TransferRemarks": [
                    {
                        "Type": "INFO",
                        "Description": "Shuttle departs every 30 minutes. Travel time may vary based on number of stops.",
                        "Mandatory": false
                    }
                ],
                "CancellationPolicies": [
                    {
                        "Amount": 18,
                        "From": "2025-11-13T00:00:00Z",
                        "CurrencyID": "EUR",
                        "IsForceMajeure": false
                    }
                ]
            },
            {
                "Provider": "SunnyCars",
                "Brand": "SunnyCars",
                "Name": "Private Transfer - Mercedes E-Class",
                "Description": "Luxurious private transfer with professional driver. Includes flight monitoring and complimentary water.",
                "Direction": "DEPARTURE",
                "Price": {
                    "Amount": 65,
                    "Currency": "EUR"
                },
                "TransferType": "private",
                "RateKey": "TRF-2025-PVT-003",
                "MinPaxCapacity": 1,
                "MaxPaxCapacity": 3,
                "PickupInformation": {
                    "From": {
                        "Type": "ATLAS",
                        "Code": "123456",
                        "Description": "Hotel Arts Barcelona"
                    },
                    "To": {
                        "Type": "AIRPORT",
                        "Code": "BCN",
                        "Description": "Barcelona El Prat Airport - Terminal 1"
                    },
                    "Date": "2025-11-22",
                    "Time": "15:45",
                    "Pickup": {
                        "Description": "Driver will collect from hotel lobby 3 hours before flight",
                        "Latitude": 41.3851,
                        "Longitude": 2.1964,
                        "CheckPickup": {
                            "MustCheckPickupTime": true
                        }
                    }
                },
                "TransferRemarks": [
                    {
                        "Type": "IMPORTANT",
                        "Description": "Please be ready at hotel lobby 15 minutes before scheduled pickup",
                        "Mandatory": true
                    }
                ],
                "CancellationPolicies": [
                    {
                        "Amount": 65,
                        "From": "2025-11-21T00:00:00Z",
                        "CurrencyID": "EUR",
                        "IsForceMajeure": false
                    }
                ]
            }
        ],
        "Success": true
    },
    "Error": null
}
Modified at 2026-04-14 07:23:50
Previous
Search for hotel & package offers
Next
Get package price calendar
Built with