Raw schema
{
"type": "object",
"properties": {
"pickup": {
"type": "string",
"minLength": 4,
"maxLength": 180,
"description": "Required for custom rides and tours: agreed pickup address or hotel, preserved in review and confirmations."
},
"dropoff": {
"type": "string",
"minLength": 4,
"maxLength": 180,
"description": "Required for custom rides: drop-off address."
},
"tourIds": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"amsterdam-city-tour",
"countryside-tour",
"keukenhof-tour",
"aalsmeer-flower-auction",
"dutch-water-defence-line",
"giethoorn-day-trip",
"south-holland-tour",
"rotterdam-kinderdijk",
"kroller-muller",
"efteling-day-trip",
"bruges-day-trip",
"roermond-outlet",
"mall-of-the-netherlands",
"batavia-stad",
"style-outlet-amsterdam"
]
},
"minItems": 1,
"maxItems": 5,
"description": "Tours only; ids from /data/tours.json."
},
"type": {
"type": "string",
"enum": [
"fixed",
"custom",
"tour"
]
},
"car": {
"type": "string",
"enum": [
"bmw5",
"vclass"
],
"description": "BMW 5 Series Touring (bmw5) max 4 passengers, Mercedes V-Class (vclass) max 7 passengers."
},
"date": {
"type": "string",
"format": "date",
"description": "Local date in Europe/Amsterdam."
},
"time": {
"type": "string",
"pattern": "^\\d{2}:\\d{2}$",
"description": "Local time in Europe/Amsterdam, between 04:00 and 20:00."
},
"passengers": {
"type": "integer",
"minimum": 1,
"maximum": 7
},
"luggageLarge": {
"type": "integer",
"minimum": 0,
"maximum": 8,
"default": 0,
"description": "Large check-in suitcases. The BMW takes at most 3; more needs the V-Class (error code luggage)."
},
"luggageSmall": {
"type": "integer",
"minimum": 0,
"maximum": 8,
"default": 0,
"description": "Pieces of hand luggage. The BMW takes at most 3; more needs the V-Class (error code luggage)."
},
"returnTrip": {
"type": "object",
"description": "Airport transfers (fixed) and custom rides only; tours fail with retour_type, and a value that is not an object fails with retour. Books the return leg as well, with the same vehicle, passengers and luggage: on a fixed route the opposite direction between the same address and Schiphol, priced as a second ride at the route price; on a custom ride from the drop-off back to the pickup, where the fare estimate covers both legs and is split evenly over them. The return must be at least one hour after the first ride (retour_order), between 04:00 and 20:00 (retour_hours), not on a blocked date (retour_date_blocked) and at most 2 years ahead (date_range); missing or invalid values fail with retour_date, retour_time or retour_datetime. There is no name card on either leg (meet_greet_unavailable). The request is stored as two linked bookings, bookingId and `<bookingId>-ret` (so bookingId may have at most 51 characters when a returnTrip is sent), confirmed together and paid with one payment request: 25% of the combined price of the legs, or all of it with payment=full.",
"properties": {
"date": {
"type": "string",
"format": "date",
"description": "Local date of the return ride in Europe/Amsterdam."
},
"time": {
"type": "string",
"pattern": "^\\d{2}:\\d{2}$",
"description": "Local pickup time of the return ride in Europe/Amsterdam, between 04:00 and 20:00, at least 1 hour after the first ride."
},
"flight": {
"type": "string",
"maxLength": 24,
"description": "Optional flight number for the return ride."
}
},
"required": [
"date",
"time"
]
},
"routeId": {
"type": "string",
"description": "Fixed routes only; ids from /data/rates.json. The server reprices to the route the address belongs to.",
"enum": [
"ams-spl",
"noord-spl",
"zaandam-spl",
"aveen-spl",
"dh-spl",
"rtm-spl",
"almere-spl",
"almere-buiten-spl",
"utrecht-spl",
"eindhoven-spl"
]
},
"direction": {
"type": "string",
"enum": [
"to",
"from"
],
"description": "Fixed routes only: to or from Schiphol."
},
"address": {
"type": "string",
"minLength": 4,
"maxLength": 180,
"description": "Fixed routes only: the non-airport pickup/drop-off address. The fare follows the route zone of the address (postcode first, then town name; a hotel or town named without a postcode is placed by a server-side lookup, and the selected route applies if that lookup fails). An address whose Dutch postcode is in no fixed-route zone is refused with error code address_zone; book it as a single ride."
},
"payment": {
"type": "string",
"enum": [
"deposit",
"full"
],
"default": "deposit",
"description": "How the customer pays once the ride is confirmed: deposit = a payment request for 25% of the price, rest on the day of the ride; full = a payment request for the full price. With a returnTrip both legs are confirmed together and paid with ONE payment request on these terms (the sum over the legs)."
},
"ticketService": {
"type": "boolean",
"description": "Tours only: attraction ticket purchase assistance, requires 28 days' notice."
},
"driverName": {
"type": "string",
"maxLength": 60,
"description": "Optional. Name of a preferred driver, printed as \"Driver: ...\" in the customer's confirmation and calendar file. Leave it out unless the customer asks for a specific driver; it is not the passenger's name."
},
"flight": {
"type": "string",
"maxLength": 24
},
"notes": {
"type": "string",
"maxLength": 1000
},
"lang": {
"type": "string",
"enum": [
"en",
"nl",
"de",
"fr",
"es",
"ar",
"zh-CN"
],
"description": "Language of the emails the customer receives (the Confirm link, status and payment mails) and of the quote card. Use the customer's own language; default en."
},
"quoteToken": {
"type": "string",
"minLength": 1,
"maxLength": 2048,
"description": "Signed token returned by POST /api/quote. Send unchanged only after the customer approves that quote's total and payment. It binds the normalized journey, vehicle, passengers, payment choice, return trip, options, fare, rules version and 15-minute expiry. HTTP 409 reviewRequired=true means obtain a new quote and renewed customer approval before retrying. Never supply your own price."
},
"name": {
"type": "string",
"minLength": 2,
"maxLength": 100
},
"email": {
"type": "string",
"format": "email"
},
"phone": {
"type": "string",
"minLength": 7,
"maxLength": 30,
"description": "Customer's phone number, with country code (for example +31 6 1234 5678)."
},
"acceptedTerms": {
"type": "boolean",
"const": true,
"description": "Must be an explicit act by the customer after reading the Terms & Conditions. Agents must not set this on a customer's behalf without their consent."
},
"joinGroup": {
"type": "object",
"description": "Optional. Adds this ride to an earlier request so the customer pays for all of them with ONE payment request. Pass the groupId and groupToken that request_booking returned for the earlier request, as {groupId, groupToken} ({id, token} also works). The result says grouped true or false; false means the ride stands alone (see joinRefused) and gets its own Confirm link and payment request.",
"properties": {
"groupId": {
"type": "string"
},
"groupToken": {
"type": "string"
},
"id": {
"type": "string"
},
"token": {
"type": "string"
}
}
}
},
"required": [
"type",
"car",
"date",
"time",
"passengers",
"quoteToken",
"name",
"email",
"phone",
"acceptedTerms"
]
}