Request a booking
request_bookingLodge a booking. On success this returns a secure checkout_url: give it to the customer to pay directly (their card, never through you). No payment is ever taken through this tool itself. A pickup on a closed day or inside a blackout window is refused (accepted:false) before anything is lodged. Stops on the way (up to 4 each way): stops, and return_stops on a return, the same as the get_quote you quoted; the booking is made at the booking form's own total with the stops in it. An airport pickup needs flight, the flight number they land on, and a return whose way back starts at an airport needs return_flight. The one time there is no flight: the customer is dropping off a hire car at the airport first (hire_car true). Places are checked as in get_quote, and booked where they really are. Booking for someone else (the customer books and pays, another person travels): add passenger_name, passenger_mobile (the driver contacts this number) and passenger_email. When the booking is paid the passenger gets their own confirmation by email, without the price; the customer gets the full confirmation, the receipt and the pay link. Leave them out when the customer is travelling. Requires agent_key (contact admin@cgctransfers.com.au to obtain one).
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"agent_key": "<agent_key>",
"pickup": "<pickup>",
"dropoff": "<dropoff>",
"date": "<date>",
"time": "<time>",
"pax": "<pax>",
"name": "<name>",
"phone": "<phone>",
"email": "<email>",
"terms_accepted": "<terms_accepted>"
},
"name": "request_booking"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| pax | Yes | ||
| date | Yes | YYYY-MM-DD | |
| name | Yes | The customer's name: the person booking and paying (the passenger too, unless passenger_name is given) | |
| time | Yes | HH:MM 24h | |
| Yes | The customer's email: the pay link, the confirmation and the receipt go here | ||
| notes | No | ||
| phone | Yes | The customer's mobile | |
| stops | No | Optional: stops on the way, in order, up to 4, each a street address or a hotel or venue name with its suburb; use the same stops as the get_quote you quoted. One way, this is the booking form's Multi-stop; on a return these are the stops on the way there (its Multi-stop return). The booking carries the stops and is made at the booking form's own total. | |
| flight | No | The flight number they land on (e.g. QF512, JQ 430). Required for an airport pickup (Gold Coast, Brisbane or Ballina airport): without it nothing is booked, unless hire_car is true. "qf 512" and "Qantas 512" are booked as QF512; anything that is not a flight number is turned back. | |
| pickup | Yes | ||
| dropoff | Yes | ||
| luggage | No | Optional. Large suitcases (a pram or stroller counts as one). If left out, assumed to be what the chosen vehicle holds (never more than one per passenger). | |
| vehicle | No | Vehicle choice; defaults to sedan. transporter = the 12-seater Transporter (up to 11 passengers), one vehicle for a group too big for one Carnival; for 9-11 people it takes up to 8 large bags, so a group with more luggage books 2-carnivals (two Kia Carnivals). There is no trailer. get_quote with pax gives the live seat, child-seat and luggage limits. Any other value is refused (accepted:false, "Unknown vehicle"), never booked as a different vehicle. | |
| carry_on | No | Optional. Carry-on bags. | |
| hire_car | No | True only when the customer is dropping off a hire car at the airport first, so there is no flight to land on: that airport pickup (or the way back from the airport) is then booked without a flight number, as the booking form's "Continue without a flight number" does. Never otherwise. | |
| platform | No | Which channel this booking comes from (attribution) | |
| seat_qty | No | Child seats by type, priced into the booking and pay link ($35 each): {seat index: quantity}. Indices follow the booking form list: 0 rear-facing 0-3yrs, 1 forward-facing 6mths-3yrs, 2 harnessed booster 3-6yrs, 3 booster with adult seatbelt 6yrs+. | |
| agent_key | Yes | Issued gateway key | |
| oversized | No | Optional. Surfboard, golf bag, bike box or similar (takes the space of three large bags, so sedans drop out). Not for a pram or stroller: count it in luggage and book the Carnival, not the sedan. | |
| meet_greet | No | Optional. Add the Brisbane Airport in-terminal meet and greet ($49). Gold Coast Airport pickups include it already. | |
| child_seats | No | Child seats required ($35 each, supplied and fitted). Prefer seat_qty, which prices the seats into the booking and pay link. | |
| heard_about | No | Optional. How the customer heard about CGC, from their own answer: one of the booking form's 'How did you hear about us?' options, exactly as written (Google search; Google ad; Bing / Microsoft search; ChatGPT; Claude; Other AI assistant (Gemini, Copilot, etc.); Booked with you before; Friend or family recommended you; Hotel / accommodation recommended you; Facebook / Instagram / social media; Other). Leave out if they didn't say. Never guess, and never pick an AI option just because the booking comes through an AI. | |
| heard_other | No | Optional. The customer's own words, up to 100 characters (e.g. 'saw your van at the airport'). The booking keeps them with an 'Other' answer. | |
| return_date | No | Optional, YYYY-MM-DD. With return_time, books the return leg on the same reservation (5% return discount applies). | |
| return_time | No | Optional, HH:MM 24h, in 5-minute steps. Required if return_date is given. | |
| return_stops | No | Optional, only with return_date and return_time: stops on the way back, in order, up to 4, same rules as stops. Not copied from stops: leave out for none. | |
| return_flight | No | Return trips whose way back starts at an airport: the flight number they land on for it (e.g. VA500). Required then, unless hire_car is true. Leave out otherwise. | |
| return_pickup | No | Optional, only with return_date and return_time: where the return trip picks up, if not the first trip's drop-off (in to one hotel, back from another). Defaults to the first trip reversed. With different return addresses each trip is priced at its own fare and the return discount comes off the cheaper trip, as on the booking form; use the same return_pickup and return_dropoff as the get_quote you quoted. | |
| passenger_name | No | Optional, only when someone else is travelling (the customer is booking for them): the travelling passenger's name. Leave out when the customer is travelling. | |
| return_dropoff | No | Optional, only with return_date and return_time: where the return trip drops off, if not the first trip's pickup. Defaults to the first trip reversed. | |
| terms_accepted | Yes | REQUIRED, must be true. Confirms the customer has been shown and has accepted the booking terms at https://cgctransfers.com.au/bookingtermsandconditions/ -- do not set this without an explicit yes from the customer. | |
| passenger_email | No | Optional, with passenger_name: the travelling passenger's email, exactly as given. When the booking is paid they get their own confirmation there, without the price. A value that is not an email address is refused (accepted:false) and nothing is booked. | |
| passenger_mobile | No | Optional, with passenger_name: the travelling passenger's mobile. The driver contacts this number on the day, so ask for it. |