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. Requires agent_key (contact admin@cgctransfers.com.au to obtain one).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| pax | Yes | ||
| date | Yes | YYYY-MM-DD | |
| name | Yes | Passenger name | |
| time | Yes | HH:MM 24h | |
| Yes | Passenger email (pay link goes here) | ||
| notes | No | ||
| phone | Yes | Passenger phone | |
| 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 | ||
| pickup | Yes | ||
| dropoff | Yes | ||
| luggage | No | Optional. Large suitcases. If left out, assumed to be what the chosen vehicle holds (never more than one per passenger). | |
| vehicle | No | Vehicle choice; defaults to sedan. crafter = VW Crafter (up to 11 passengers), one van for a group too big for one Carnival; crafter-trailer = the same van towing a luggage trailer, for a big group with more luggage than the van takes (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. | |
| 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, full-size pram or similar (takes the space of three large bags, so sedans drop out). | |
| 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_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. | |
| 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. |