TravelComponents
Defined in: src/travel/types.gen.ts:85
Properties
Section titled “Properties”headers
Section titled “headers”headers:
never
Defined in: src/travel/types.gen.ts:792
parameters
Section titled “parameters”parameters:
never
Defined in: src/travel/types.gen.ts:790
pathItems
Section titled “pathItems”pathItems:
never
Defined in: src/travel/types.gen.ts:793
requestBodies
Section titled “requestBodies”requestBodies:
never
Defined in: src/travel/types.gen.ts:791
responses
Section titled “responses”responses:
never
Defined in: src/travel/types.gen.ts:789
schemas
Section titled “schemas”schemas:
object
Defined in: src/travel/types.gen.ts:86
Address
Section titled “Address”Address:
object
Description
Section titled “Description”A location. All fields are optional, but the object will hold as much information as possible.
Address.address_line_1?
Section titled “Address.address_line_1?”
optionaladdress_line_1?:string|null
Description
Section titled “Description”The first line of the address.
Example
Section titled “Example”Av. Vinte de Janeiro, S/NAddress.address_line_2?
Section titled “Address.address_line_2?”
optionaladdress_line_2?:string|null
Description
Section titled “Description”The second line of the address.
Example
Section titled “Example”Ilha do GovernadorAddress.administrative_area?
Section titled “Address.administrative_area?”
optionaladministrative_area?:string|null
Description
Section titled “Description”Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name.
Example
Section titled “Example”RJAddress.city?
Section titled “Address.city?”
optionalcity?:string|null
Description
Section titled “Description”The city where the address is located.
Example
Section titled “Example”Rio de JaneiroAddress.coordinates?
Section titled “Address.coordinates?”
optionalcoordinates?:object
Address.coordinates.latitude
Section titled “Address.coordinates.latitude”latitude:
number
Format: double
Example
Section titled “Example”-22.8145373Address.coordinates.longitude
Section titled “Address.coordinates.longitude”longitude:
number
Format: double
Example
Section titled “Example”-43.2465548Address.country?
Section titled “Address.country?”
optionalcountry?:string|null
Description
Section titled “Description”The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country.
Example
Section titled “Example”BrazilAddress.postal_code?
Section titled “Address.postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”The postal code of the given address.
Example
Section titled “Example”21941-900Address.timezone?
Section titled “Address.timezone?”
optionaltimezone?:string|null
Description
Section titled “Description”The timezone in the given address.
Example
Section titled “Example”America/Sao_PauloAddress.GeoCoordinates
Section titled “Address.GeoCoordinates”Address.GeoCoordinates:
object
Description
Section titled “Description”The coordinates of an address.
Address.GeoCoordinates.latitude
Section titled “Address.GeoCoordinates.latitude”latitude:
number
Format: double
Example
Section titled “Example”-22.8145373Address.GeoCoordinates.longitude
Section titled “Address.GeoCoordinates.longitude”longitude:
number
Format: double
Example
Section titled “Example”-43.2465548AirBookingData
Section titled “AirBookingData”AirBookingData:
object
Description
Section titled “Description”Air-specific booking information.
AirBookingData.journeys
Section titled “AirBookingData.journeys”journeys:
object[]
Description
Section titled “Description”The journeys that make up this booking.
AirBookingData.known_traveler_number?
Section titled “AirBookingData.known_traveler_number?”
optionalknown_traveler_number?:object
AirBookingData.known_traveler_number.document_number
Section titled “AirBookingData.known_traveler_number.document_number”document_number:
string
Description
Section titled “Description”The actual document number.
Example
Section titled “Example”1231231AirBookingData.known_traveler_number.issuing_country
Section titled “AirBookingData.known_traveler_number.issuing_country”issuing_country:
string
Description
Section titled “Description”The country that issued this document.
Example
Section titled “Example”BRAirBookingData.redress_number?
Section titled “AirBookingData.redress_number?”
optionalredress_number?:object
AirBookingData.redress_number.document_number
Section titled “AirBookingData.redress_number.document_number”document_number:
string
Description
Section titled “Description”The actual document number.
Example
Section titled “Example”1231231AirBookingData.redress_number.issuing_country
Section titled “AirBookingData.redress_number.issuing_country”issuing_country:
string
Description
Section titled “Description”The country that issued this document.
Example
Section titled “Example”BRAirBookingData.tickets
Section titled “AirBookingData.tickets”tickets:
object[]
Description
Section titled “Description”The flight tickets in this booking.
AirBookingData.type
Section titled “AirBookingData.type”type:
"AIR"
Description
Section titled “Description”discriminator enum property added by openapi-typescript
AirBookingData.CabinClass
Section titled “AirBookingData.CabinClass”AirBookingData.CabinClass:
"BUSINESS"|"ECONOMY"|"PREMIUM_ECONOMY"|"FIRST"
Description
Section titled “Description”The cabin class of a flight.
Example
Section titled “Example”ECONOMY@enum {string}AirBookingData.DocumentNumber
Section titled “AirBookingData.DocumentNumber”AirBookingData.DocumentNumber:
object
Description
Section titled “Description”A document number such as a redress number or a known traveler number.
AirBookingData.DocumentNumber.document_number
Section titled “AirBookingData.DocumentNumber.document_number”document_number:
string
Description
Section titled “Description”The actual document number.
Example
Section titled “Example”1231231AirBookingData.DocumentNumber.issuing_country
Section titled “AirBookingData.DocumentNumber.issuing_country”issuing_country:
string
Description
Section titled “Description”The country that issued this document.
Example
Section titled “Example”BRAirBookingData.Flight
Section titled “AirBookingData.Flight”AirBookingData.Flight:
object
Description
Section titled “Description”A flight taken by the traveler.
AirBookingData.Flight.arrival_time
Section titled “AirBookingData.Flight.arrival_time”arrival_time:
object
AirBookingData.Flight.arrival_time.local_time
Section titled “AirBookingData.Flight.arrival_time.local_time”local_time:
string
Format: date-time
Description
Section titled “Description”The local time in the relevant location in the ISO 8601 format.
AirBookingData.Flight.arrival_time.timestamp?
Section titled “AirBookingData.Flight.arrival_time.timestamp?”
optionaltimestamp?:string|null
Format: date-time
Description
Section titled “Description”An ISO 8601 timestamp.
Example
Section titled “Example”2017-12-27T15:42:30ZAirBookingData.Flight.cabin_class?
Section titled “AirBookingData.Flight.cabin_class?”
optionalcabin_class?:"BUSINESS"|"ECONOMY"|"PREMIUM_ECONOMY"|"FIRST"
AirBookingData.Flight.confirmation_code?
Section titled “AirBookingData.Flight.confirmation_code?”
optionalconfirmation_code?:string|null
Description
Section titled “Description”The airline confirmation code.
Example
Section titled “Example”PWZRTQAirBookingData.Flight.departure_time
Section titled “AirBookingData.Flight.departure_time”departure_time:
object
AirBookingData.Flight.departure_time.local_time
Section titled “AirBookingData.Flight.departure_time.local_time”local_time:
string
Format: date-time
Description
Section titled “Description”The local time in the relevant location in the ISO 8601 format.
AirBookingData.Flight.departure_time.timestamp?
Section titled “AirBookingData.Flight.departure_time.timestamp?”
optionaltimestamp?:string|null
Format: date-time
Description
Section titled “Description”An ISO 8601 timestamp.
Example
Section titled “Example”2017-12-27T15:42:30ZAirBookingData.Flight.destination
Section titled “AirBookingData.Flight.destination”destination:
object
AirBookingData.Flight.destination.airport_code
Section titled “AirBookingData.Flight.destination.airport_code”airport_code:
string
Description
Section titled “Description”The 3-letter IATA code of the airport.
Example
Section titled “Example”GIGAirBookingData.Flight.destination.airport_location?
Section titled “AirBookingData.Flight.destination.airport_location?”
optionalairport_location?:object
AirBookingData.Flight.destination.airport_location.address_line_1?
Section titled “AirBookingData.Flight.destination.airport_location.address_line_1?”
optionaladdress_line_1?:string|null
Description
Section titled “Description”The first line of the address.
Example
Section titled “Example”Av. Vinte de Janeiro, S/NAirBookingData.Flight.destination.airport_location.address_line_2?
Section titled “AirBookingData.Flight.destination.airport_location.address_line_2?”
optionaladdress_line_2?:string|null
Description
Section titled “Description”The second line of the address.
Example
Section titled “Example”Ilha do GovernadorAirBookingData.Flight.destination.airport_location.administrative_area?
Section titled “AirBookingData.Flight.destination.airport_location.administrative_area?”
optionaladministrative_area?:string|null
Description
Section titled “Description”Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name.
Example
Section titled “Example”RJAirBookingData.Flight.destination.airport_location.city?
Section titled “AirBookingData.Flight.destination.airport_location.city?”
optionalcity?:string|null
Description
Section titled “Description”The city where the address is located.
Example
Section titled “Example”Rio de JaneiroAirBookingData.Flight.destination.airport_location.coordinates?
Section titled “AirBookingData.Flight.destination.airport_location.coordinates?”
optionalcoordinates?:object
AirBookingData.Flight.destination.airport_location.coordinates.latitude
Section titled “AirBookingData.Flight.destination.airport_location.coordinates.latitude”latitude:
number
Format: double
Example
Section titled “Example”-22.8145373AirBookingData.Flight.destination.airport_location.coordinates.longitude
Section titled “AirBookingData.Flight.destination.airport_location.coordinates.longitude”longitude:
number
Format: double
Example
Section titled “Example”-43.2465548AirBookingData.Flight.destination.airport_location.country?
Section titled “AirBookingData.Flight.destination.airport_location.country?”
optionalcountry?:string|null
Description
Section titled “Description”The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country.
Example
Section titled “Example”BrazilAirBookingData.Flight.destination.airport_location.postal_code?
Section titled “AirBookingData.Flight.destination.airport_location.postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”The postal code of the given address.
Example
Section titled “Example”21941-900AirBookingData.Flight.destination.airport_location.timezone?
Section titled “AirBookingData.Flight.destination.airport_location.timezone?”
optionaltimezone?:string|null
Description
Section titled “Description”The timezone in the given address.
Example
Section titled “Example”America/Sao_PauloAirBookingData.Flight.destination.gate?
Section titled “AirBookingData.Flight.destination.gate?”
optionalgate?:string|null
Description
Section titled “Description”The gate for boarding or leaving the plane.
Example
Section titled “Example”B13AirBookingData.Flight.destination.terminal?
Section titled “AirBookingData.Flight.destination.terminal?”
optionalterminal?:string|null
Description
Section titled “Description”The terminal name and/or number.
Example
Section titled “Example”T2AirBookingData.Flight.duration?
Section titled “AirBookingData.Flight.duration?”
optionalduration?:string|null
Description
Section titled “Description”The duration of the flight in the ISO 8601 PnYnMnDTnHnMnS format.
Example
Section titled “Example”PT4h20MAirBookingData.Flight.marketing_flight?
Section titled “AirBookingData.Flight.marketing_flight?”
optionalmarketing_flight?:object
AirBookingData.Flight.marketing_flight.airline_code
Section titled “AirBookingData.Flight.marketing_flight.airline_code”airline_code:
string
Description
Section titled “Description”The IATA code for the airline.
Example
Section titled “Example”G3AirBookingData.Flight.marketing_flight.airline_name?
Section titled “AirBookingData.Flight.marketing_flight.airline_name?”
optionalairline_name?:string|null
Description
Section titled “Description”The name of the airline.
Example
Section titled “Example”GOL Linhas Aereas S.A.AirBookingData.Flight.marketing_flight.number
Section titled “AirBookingData.Flight.marketing_flight.number”number:
string
Description
Section titled “Description”The number of the flight.
Example
Section titled “Example”1234AirBookingData.Flight.operating_flight?
Section titled “AirBookingData.Flight.operating_flight?”
optionaloperating_flight?:object
AirBookingData.Flight.operating_flight.airline_code
Section titled “AirBookingData.Flight.operating_flight.airline_code”airline_code:
string
Description
Section titled “Description”The IATA code for the airline.
Example
Section titled “Example”G3AirBookingData.Flight.operating_flight.airline_name?
Section titled “AirBookingData.Flight.operating_flight.airline_name?”
optionalairline_name?:string|null
Description
Section titled “Description”The name of the airline.
Example
Section titled “Example”GOL Linhas Aereas S.A.AirBookingData.Flight.operating_flight.number
Section titled “AirBookingData.Flight.operating_flight.number”number:
string
Description
Section titled “Description”The number of the flight.
Example
Section titled “Example”1234AirBookingData.Flight.origin
Section titled “AirBookingData.Flight.origin”origin:
object
AirBookingData.Flight.origin.airport_code
Section titled “AirBookingData.Flight.origin.airport_code”airport_code:
string
Description
Section titled “Description”The 3-letter IATA code of the airport.
Example
Section titled “Example”GIGAirBookingData.Flight.origin.airport_location?
Section titled “AirBookingData.Flight.origin.airport_location?”
optionalairport_location?:object
AirBookingData.Flight.origin.airport_location.address_line_1?
Section titled “AirBookingData.Flight.origin.airport_location.address_line_1?”
optionaladdress_line_1?:string|null
Description
Section titled “Description”The first line of the address.
Example
Section titled “Example”Av. Vinte de Janeiro, S/NAirBookingData.Flight.origin.airport_location.address_line_2?
Section titled “AirBookingData.Flight.origin.airport_location.address_line_2?”
optionaladdress_line_2?:string|null
Description
Section titled “Description”The second line of the address.
Example
Section titled “Example”Ilha do GovernadorAirBookingData.Flight.origin.airport_location.administrative_area?
Section titled “AirBookingData.Flight.origin.airport_location.administrative_area?”
optionaladministrative_area?:string|null
Description
Section titled “Description”Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name.
Example
Section titled “Example”RJAirBookingData.Flight.origin.airport_location.city?
Section titled “AirBookingData.Flight.origin.airport_location.city?”
optionalcity?:string|null
Description
Section titled “Description”The city where the address is located.
Example
Section titled “Example”Rio de JaneiroAirBookingData.Flight.origin.airport_location.coordinates?
Section titled “AirBookingData.Flight.origin.airport_location.coordinates?”
optionalcoordinates?:object
AirBookingData.Flight.origin.airport_location.coordinates.latitude
Section titled “AirBookingData.Flight.origin.airport_location.coordinates.latitude”latitude:
number
Format: double
Example
Section titled “Example”-22.8145373AirBookingData.Flight.origin.airport_location.coordinates.longitude
Section titled “AirBookingData.Flight.origin.airport_location.coordinates.longitude”longitude:
number
Format: double
Example
Section titled “Example”-43.2465548AirBookingData.Flight.origin.airport_location.country?
Section titled “AirBookingData.Flight.origin.airport_location.country?”
optionalcountry?:string|null
Description
Section titled “Description”The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country.
Example
Section titled “Example”BrazilAirBookingData.Flight.origin.airport_location.postal_code?
Section titled “AirBookingData.Flight.origin.airport_location.postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”The postal code of the given address.
Example
Section titled “Example”21941-900AirBookingData.Flight.origin.airport_location.timezone?
Section titled “AirBookingData.Flight.origin.airport_location.timezone?”
optionaltimezone?:string|null
Description
Section titled “Description”The timezone in the given address.
Example
Section titled “Example”America/Sao_PauloAirBookingData.Flight.origin.gate?
Section titled “AirBookingData.Flight.origin.gate?”
optionalgate?:string|null
Description
Section titled “Description”The gate for boarding or leaving the plane.
Example
Section titled “Example”B13AirBookingData.Flight.origin.terminal?
Section titled “AirBookingData.Flight.origin.terminal?”
optionalterminal?:string|null
Description
Section titled “Description”The terminal name and/or number.
Example
Section titled “Example”T2AirBookingData.Flight.seat?
Section titled “AirBookingData.Flight.seat?”
optionalseat?:object
AirBookingData.Flight.seat.number
Section titled “AirBookingData.Flight.seat.number”number:
string
Description
Section titled “Description”The seat number.
Example
Section titled “Example”31DAirBookingData.Flight.seat.status?
Section titled “AirBookingData.Flight.seat.status?”
optionalstatus?:"CANCELED"|"PENDING"|"CONFIRMED"
AirBookingData.FlightEndpoint
Section titled “AirBookingData.FlightEndpoint”AirBookingData.FlightEndpoint:
object
Description
Section titled “Description”The place where a flight departs from or arrives at.
AirBookingData.FlightEndpoint.airport_code
Section titled “AirBookingData.FlightEndpoint.airport_code”airport_code:
string
Description
Section titled “Description”The 3-letter IATA code of the airport.
Example
Section titled “Example”GIGAirBookingData.FlightEndpoint.airport_location?
Section titled “AirBookingData.FlightEndpoint.airport_location?”
optionalairport_location?:object
AirBookingData.FlightEndpoint.airport_location.address_line_1?
Section titled “AirBookingData.FlightEndpoint.airport_location.address_line_1?”
optionaladdress_line_1?:string|null
Description
Section titled “Description”The first line of the address.
Example
Section titled “Example”Av. Vinte de Janeiro, S/NAirBookingData.FlightEndpoint.airport_location.address_line_2?
Section titled “AirBookingData.FlightEndpoint.airport_location.address_line_2?”
optionaladdress_line_2?:string|null
Description
Section titled “Description”The second line of the address.
Example
Section titled “Example”Ilha do GovernadorAirBookingData.FlightEndpoint.airport_location.administrative_area?
Section titled “AirBookingData.FlightEndpoint.airport_location.administrative_area?”
optionaladministrative_area?:string|null
Description
Section titled “Description”Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name.
Example
Section titled “Example”RJAirBookingData.FlightEndpoint.airport_location.city?
Section titled “AirBookingData.FlightEndpoint.airport_location.city?”
optionalcity?:string|null
Description
Section titled “Description”The city where the address is located.
Example
Section titled “Example”Rio de JaneiroAirBookingData.FlightEndpoint.airport_location.coordinates?
Section titled “AirBookingData.FlightEndpoint.airport_location.coordinates?”
optionalcoordinates?:object
AirBookingData.FlightEndpoint.airport_location.coordinates.latitude
Section titled “AirBookingData.FlightEndpoint.airport_location.coordinates.latitude”latitude:
number
Format: double
Example
Section titled “Example”-22.8145373AirBookingData.FlightEndpoint.airport_location.coordinates.longitude
Section titled “AirBookingData.FlightEndpoint.airport_location.coordinates.longitude”longitude:
number
Format: double
Example
Section titled “Example”-43.2465548AirBookingData.FlightEndpoint.airport_location.country?
Section titled “AirBookingData.FlightEndpoint.airport_location.country?”
optionalcountry?:string|null
Description
Section titled “Description”The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country.
Example
Section titled “Example”BrazilAirBookingData.FlightEndpoint.airport_location.postal_code?
Section titled “AirBookingData.FlightEndpoint.airport_location.postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”The postal code of the given address.
Example
Section titled “Example”21941-900AirBookingData.FlightEndpoint.airport_location.timezone?
Section titled “AirBookingData.FlightEndpoint.airport_location.timezone?”
optionaltimezone?:string|null
Description
Section titled “Description”The timezone in the given address.
Example
Section titled “Example”America/Sao_PauloAirBookingData.FlightEndpoint.gate?
Section titled “AirBookingData.FlightEndpoint.gate?”
optionalgate?:string|null
Description
Section titled “Description”The gate for boarding or leaving the plane.
Example
Section titled “Example”B13AirBookingData.FlightEndpoint.terminal?
Section titled “AirBookingData.FlightEndpoint.terminal?”
optionalterminal?:string|null
Description
Section titled “Description”The terminal name and/or number.
Example
Section titled “Example”T2AirBookingData.FlightNumber
Section titled “AirBookingData.FlightNumber”AirBookingData.FlightNumber:
object
Description
Section titled “Description”The flight number, including carrier information.
AirBookingData.FlightNumber.airline_code
Section titled “AirBookingData.FlightNumber.airline_code”airline_code:
string
Description
Section titled “Description”The IATA code for the airline.
Example
Section titled “Example”G3AirBookingData.FlightNumber.airline_name?
Section titled “AirBookingData.FlightNumber.airline_name?”
optionalairline_name?:string|null
Description
Section titled “Description”The name of the airline.
Example
Section titled “Example”GOL Linhas Aereas S.A.AirBookingData.FlightNumber.number
Section titled “AirBookingData.FlightNumber.number”number:
string
Description
Section titled “Description”The number of the flight.
Example
Section titled “Example”1234AirBookingData.FlightSeat
Section titled “AirBookingData.FlightSeat”AirBookingData.FlightSeat:
object
Description
Section titled “Description”Seat information in a flight.
AirBookingData.FlightSeat.number
Section titled “AirBookingData.FlightSeat.number”number:
string
Description
Section titled “Description”The seat number.
Example
Section titled “Example”31DAirBookingData.FlightSeat.status?
Section titled “AirBookingData.FlightSeat.status?”
optionalstatus?:"CANCELED"|"PENDING"|"CONFIRMED"
AirBookingData.FlightSeatStatus
Section titled “AirBookingData.FlightSeatStatus”AirBookingData.FlightSeatStatus:
"CANCELED"|"PENDING"|"CONFIRMED"
Description
Section titled “Description”The status of a flight seat.
Example
Section titled “Example”CONFIRMED@enum {string}AirBookingData.FlightTicket
Section titled “AirBookingData.FlightTicket”AirBookingData.FlightTicket:
object
Description
Section titled “Description”A flight ticket.
AirBookingData.FlightTicket.issue_date?
Section titled “AirBookingData.FlightTicket.issue_date?”
optionalissue_date?:string|null
Format: date
Description
Section titled “Description”The date when the ticket was issued.
Example
Section titled “Example”2017-12-27AirBookingData.FlightTicket.number
Section titled “AirBookingData.FlightTicket.number”number:
string
Description
Section titled “Description”The ticket number provided by the airline.
Example
Section titled “Example”0017959463925AirBookingData.Journey
Section titled “AirBookingData.Journey”AirBookingData.Journey:
object
Description
Section titled “Description”A journey is composed of one or more flight segments that take a passenger from an origin to a final destination. E.g. if a traveler is doing a round trip from GIG to SFO, but they need to make a connection in IAH in each direction, the booking will contain 2 journeys. The first will contain 2 segments: GIG > IAH, and IAH > SFO. The second journey will also contain 2 segments: SFO > IAH, and IAH > GIG.
AirBookingData.Journey.cabin_display_name?
Section titled “AirBookingData.Journey.cabin_display_name?”
optionalcabin_display_name?:string|null
Description
Section titled “Description”The cabin name as shown by the airline.
Example
Section titled “Example”Flexible EconomyAirBookingData.Journey.flights
Section titled “AirBookingData.Journey.flights”flights:
object[]
Description
Section titled “Description”The flights that make up this journey.
AirBookingData.Journey.status
Section titled “AirBookingData.Journey.status”status:
"PROCESSING"|"CANCELED"|"REFUNDED"|"IN_PROGRESS"|"APPROVAL_DENIED"|"PENDING"|"CONFIRMED"|"HOLD"|"COMPLETED"|"VOIDED"|"UNCONFIRMED"|"AIRLINE_CONTROL"|"PAYMENT_DECLINED"|"SCHEDULE_CHANGE"|"APPROVAL_REQUESTED"|"CANCELLATION_IN_PROGRESS"
Booking
Section titled “Booking”Booking:
object
Description
Section titled “Description”A booking representation.
Booking.booking_data
Section titled “Booking.booking_data”booking_data: {
journeys:object[];known_traveler_number?: {document_number:string;issuing_country:string; };redress_number?: {document_number:string;issuing_country:string; };tickets:object[];type:"AIR"; } | {car_details: {car_class?:"OTHER"|"ECONOMY"|"COMPACT"|"INTERMEDIATE"|"PREMIUM"|"LUXURY"|"CONVERTIBLE"|"COMPACT_SUV"|"INTERMEDIATE_SUV"|"PREMIUM_SUV"|"LUXURY_SUV"|"MINI_VAN"|"PASSENGER_VAN"|"PICKUP_TRUCK"|"HYBRID"|"ELECTRIC"|"MINI"|"STANDARD"|"FULL_SIZE"|"SUV"|"SPORTS"|"SPECIAL"|"RECREATIONAL_VEHICLE";display_name:string; };reservation_details: {confirmation_code?:string|null;drop_off: {location: {address_line_1?:string|null;address_line_2?:string|null;administrative_area?:string|null;city?:string|null;coordinates?: {latitude:number;longitude:number; };country?:string|null;postal_code?:string|null;timezone?:string|null; };time: {local_time:string;timestamp?:string|null; }; };pickup: {location: {address_line_1?:string|null;address_line_2?:string|null;administrative_area?:string|null;city?:string|null;coordinates?: {latitude:number;longitude:number; };country?:string|null;postal_code?:string|null;timezone?:string|null; };time: {local_time:string;timestamp?:string|null; }; };rental_company?:string|null; };type:"CAR_RENTAL"; } | {lodging_details: {brand_name?:string|null;chain_name?:string|null;contact_information?: {email?:string|null;fax?:string|null;phone?:string|null; };display_name:string;location?: {address_line_1?:string|null;address_line_2?:string|null;administrative_area?:string|null;city?:string|null;coordinates?: {latitude:number;longitude:number; };country?:string|null;postal_code?:string|null;timezone?:string|null; };star_rating?:number|null; };reservation_details: {check_in_time: {local_time:string;timestamp?:string|null; };checkout_time: {local_time:string;timestamp?:string|null; };confirmation_code?:string|null;room?: {bed_count?:number|null;bed_type?:string|null;description?:string|null;display_name?:string|null; }; };type:"LODGING"; } | {journeys:object[];type:"RAIL"; }
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ journeys: object[]; known_traveler_number?: { document_number: string; issuing_country: string; }; redress_number?: { document_number: string; issuing_country: string; }; tickets: object[]; type: "AIR"; }
journeys
Section titled “journeys”journeys:
object[]
Description
Section titled “Description”The journeys that make up this booking.
known_traveler_number?
Section titled “known_traveler_number?”
optionalknown_traveler_number?:object
known_traveler_number.document_number
Section titled “known_traveler_number.document_number”document_number:
string
Description
Section titled “Description”The actual document number.
Example
Section titled “Example”1231231known_traveler_number.issuing_country
Section titled “known_traveler_number.issuing_country”issuing_country:
string
Description
Section titled “Description”The country that issued this document.
Example
Section titled “Example”BRredress_number?
Section titled “redress_number?”
optionalredress_number?:object
redress_number.document_number
Section titled “redress_number.document_number”document_number:
string
Description
Section titled “Description”The actual document number.
Example
Section titled “Example”1231231redress_number.issuing_country
Section titled “redress_number.issuing_country”issuing_country:
string
Description
Section titled “Description”The country that issued this document.
Example
Section titled “Example”BRtickets
Section titled “tickets”tickets:
object[]
Description
Section titled “Description”The flight tickets in this booking.
type:
"AIR"
Description
Section titled “Description”discriminator enum property added by openapi-typescript
Type Literal
Section titled “Type Literal”{ car_details: { car_class?: "OTHER" | "ECONOMY" | "COMPACT" | "INTERMEDIATE" | "PREMIUM" | "LUXURY" | "CONVERTIBLE" | "COMPACT_SUV" | "INTERMEDIATE_SUV" | "PREMIUM_SUV" | "LUXURY_SUV" | "MINI_VAN" | "PASSENGER_VAN" | "PICKUP_TRUCK" | "HYBRID" | "ELECTRIC" | "MINI" | "STANDARD" | "FULL_SIZE" | "SUV" | "SPORTS" | "SPECIAL" | "RECREATIONAL_VEHICLE"; display_name: string; }; reservation_details: { confirmation_code?: string | null; drop_off: { location: { address_line_1?: string | null; address_line_2?: string | null; administrative_area?: string | null; city?: string | null; coordinates?: { latitude: number; longitude: number; }; country?: string | null; postal_code?: string | null; timezone?: string | null; }; time: { local_time: string; timestamp?: string | null; }; }; pickup: { location: { address_line_1?: string | null; address_line_2?: string | null; administrative_area?: string | null; city?: string | null; coordinates?: { latitude: number; longitude: number; }; country?: string | null; postal_code?: string | null; timezone?: string | null; }; time: { local_time: string; timestamp?: string | null; }; }; rental_company?: string | null; }; type: "CAR_RENTAL"; }
car_details
Section titled “car_details”car_details:
object
car_details.car_class?
Section titled “car_details.car_class?”
optionalcar_class?:"OTHER"|"ECONOMY"|"COMPACT"|"INTERMEDIATE"|"PREMIUM"|"LUXURY"|"CONVERTIBLE"|"COMPACT_SUV"|"INTERMEDIATE_SUV"|"PREMIUM_SUV"|"LUXURY_SUV"|"MINI_VAN"|"PASSENGER_VAN"|"PICKUP_TRUCK"|"HYBRID"|"ELECTRIC"|"MINI"|"STANDARD"|"FULL_SIZE"|"SUV"|"SPORTS"|"SPECIAL"|"RECREATIONAL_VEHICLE"
car_details.display_name
Section titled “car_details.display_name”display_name:
string
Description
Section titled “Description”The name of the car as displayed to the user.
Example
Section titled “Example”Intermediate carreservation_details
Section titled “reservation_details”reservation_details:
object
reservation_details.confirmation_code?
Section titled “reservation_details.confirmation_code?”
optionalconfirmation_code?:string|null
Description
Section titled “Description”The confirmation code given by the vendor.
Example
Section titled “Example”7003XBQ504reservation_details.drop_off
Section titled “reservation_details.drop_off”drop_off:
object
reservation_details.drop_off.location
Section titled “reservation_details.drop_off.location”location:
object
reservation_details.drop_off.location.address_line_1?
Section titled “reservation_details.drop_off.location.address_line_1?”
optionaladdress_line_1?:string|null
Description
Section titled “Description”The first line of the address.
Example
Section titled “Example”Av. Vinte de Janeiro, S/Nreservation_details.drop_off.location.address_line_2?
Section titled “reservation_details.drop_off.location.address_line_2?”
optionaladdress_line_2?:string|null
Description
Section titled “Description”The second line of the address.
Example
Section titled “Example”Ilha do Governadorreservation_details.drop_off.location.administrative_area?
Section titled “reservation_details.drop_off.location.administrative_area?”
optionaladministrative_area?:string|null
Description
Section titled “Description”Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name.
Example
Section titled “Example”RJreservation_details.drop_off.location.city?
Section titled “reservation_details.drop_off.location.city?”
optionalcity?:string|null
Description
Section titled “Description”The city where the address is located.
Example
Section titled “Example”Rio de Janeiroreservation_details.drop_off.location.coordinates?
Section titled “reservation_details.drop_off.location.coordinates?”
optionalcoordinates?:object
reservation_details.drop_off.location.coordinates.latitude
Section titled “reservation_details.drop_off.location.coordinates.latitude”latitude:
number
Format: double
Example
Section titled “Example”-22.8145373reservation_details.drop_off.location.coordinates.longitude
Section titled “reservation_details.drop_off.location.coordinates.longitude”longitude:
number
Format: double
Example
Section titled “Example”-43.2465548reservation_details.drop_off.location.country?
Section titled “reservation_details.drop_off.location.country?”
optionalcountry?:string|null
Description
Section titled “Description”The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country.
Example
Section titled “Example”Brazilreservation_details.drop_off.location.postal_code?
Section titled “reservation_details.drop_off.location.postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”The postal code of the given address.
Example
Section titled “Example”21941-900reservation_details.drop_off.location.timezone?
Section titled “reservation_details.drop_off.location.timezone?”
optionaltimezone?:string|null
Description
Section titled “Description”The timezone in the given address.
Example
Section titled “Example”America/Sao_Pauloreservation_details.drop_off.time
Section titled “reservation_details.drop_off.time”time:
object
reservation_details.drop_off.time.local_time
Section titled “reservation_details.drop_off.time.local_time”local_time:
string
Format: date-time
Description
Section titled “Description”The local time in the relevant location in the ISO 8601 format.
reservation_details.drop_off.time.timestamp?
Section titled “reservation_details.drop_off.time.timestamp?”
optionaltimestamp?:string|null
Format: date-time
Description
Section titled “Description”An ISO 8601 timestamp.
Example
Section titled “Example”2017-12-27T15:42:30Zreservation_details.pickup
Section titled “reservation_details.pickup”pickup:
object
reservation_details.pickup.location
Section titled “reservation_details.pickup.location”location:
object
reservation_details.pickup.location.address_line_1?
Section titled “reservation_details.pickup.location.address_line_1?”
optionaladdress_line_1?:string|null
Description
Section titled “Description”The first line of the address.
Example
Section titled “Example”Av. Vinte de Janeiro, S/Nreservation_details.pickup.location.address_line_2?
Section titled “reservation_details.pickup.location.address_line_2?”
optionaladdress_line_2?:string|null
Description
Section titled “Description”The second line of the address.
Example
Section titled “Example”Ilha do Governadorreservation_details.pickup.location.administrative_area?
Section titled “reservation_details.pickup.location.administrative_area?”
optionaladministrative_area?:string|null
Description
Section titled “Description”Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name.
Example
Section titled “Example”RJreservation_details.pickup.location.city?
Section titled “reservation_details.pickup.location.city?”
optionalcity?:string|null
Description
Section titled “Description”The city where the address is located.
Example
Section titled “Example”Rio de Janeiroreservation_details.pickup.location.coordinates?
Section titled “reservation_details.pickup.location.coordinates?”
optionalcoordinates?:object
reservation_details.pickup.location.coordinates.latitude
Section titled “reservation_details.pickup.location.coordinates.latitude”latitude:
number
Format: double
Example
Section titled “Example”-22.8145373reservation_details.pickup.location.coordinates.longitude
Section titled “reservation_details.pickup.location.coordinates.longitude”longitude:
number
Format: double
Example
Section titled “Example”-43.2465548reservation_details.pickup.location.country?
Section titled “reservation_details.pickup.location.country?”
optionalcountry?:string|null
Description
Section titled “Description”The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country.
Example
Section titled “Example”Brazilreservation_details.pickup.location.postal_code?
Section titled “reservation_details.pickup.location.postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”The postal code of the given address.
Example
Section titled “Example”21941-900reservation_details.pickup.location.timezone?
Section titled “reservation_details.pickup.location.timezone?”
optionaltimezone?:string|null
Description
Section titled “Description”The timezone in the given address.
Example
Section titled “Example”America/Sao_Pauloreservation_details.pickup.time
Section titled “reservation_details.pickup.time”time:
object
reservation_details.pickup.time.local_time
Section titled “reservation_details.pickup.time.local_time”local_time:
string
Format: date-time
Description
Section titled “Description”The local time in the relevant location in the ISO 8601 format.
reservation_details.pickup.time.timestamp?
Section titled “reservation_details.pickup.time.timestamp?”
optionaltimestamp?:string|null
Format: date-time
Description
Section titled “Description”An ISO 8601 timestamp.
Example
Section titled “Example”2017-12-27T15:42:30Zreservation_details.rental_company?
Section titled “reservation_details.rental_company?”
optionalrental_company?:string|null
Description
Section titled “Description”Name of car rental company.
Example
Section titled “Example”Catch-A-Ridetype:
"CAR_RENTAL"
Description
Section titled “Description”discriminator enum property added by openapi-typescript
Type Literal
Section titled “Type Literal”{ lodging_details: { brand_name?: string | null; chain_name?: string | null; contact_information?: { email?: string | null; fax?: string | null; phone?: string | null; }; display_name: string; location?: { address_line_1?: string | null; address_line_2?: string | null; administrative_area?: string | null; city?: string | null; coordinates?: { latitude: number; longitude: number; }; country?: string | null; postal_code?: string | null; timezone?: string | null; }; star_rating?: number | null; }; reservation_details: { check_in_time: { local_time: string; timestamp?: string | null; }; checkout_time: { local_time: string; timestamp?: string | null; }; confirmation_code?: string | null; room?: { bed_count?: number | null; bed_type?: string | null; description?: string | null; display_name?: string | null; }; }; type: "LODGING"; }
lodging_details
Section titled “lodging_details”lodging_details:
object
lodging_details.brand_name?
Section titled “lodging_details.brand_name?”
optionalbrand_name?:string|null
Description
Section titled “Description”The brand name of the hotel.
Example
Section titled “Example”Marriott Hotelslodging_details.chain_name?
Section titled “lodging_details.chain_name?”
optionalchain_name?:string|null
Description
Section titled “Description”The name of the hotel chain.
Example
Section titled “Example”Accor Hotelslodging_details.contact_information?
Section titled “lodging_details.contact_information?”
optionalcontact_information?:object
lodging_details.contact_information.email?
Section titled “lodging_details.contact_information.email?”
optionalemail?:string|null
Description
Section titled “Description”The email address of the venue.
Example
Section titled “Example”city@hotelchain.comlodging_details.contact_information.fax?
Section titled “lodging_details.contact_information.fax?”
optionalfax?:string|null
Description
Section titled “Description”The fax number of the venue.
Example
Section titled “Example”12345554321lodging_details.contact_information.phone?
Section titled “lodging_details.contact_information.phone?”
optionalphone?:string|null
Description
Section titled “Description”The phone number of the venue.
Example
Section titled “Example”12345554321lodging_details.display_name
Section titled “lodging_details.display_name”display_name:
string
Description
Section titled “Description”The name of the venue as displayed to the user.
Example
Section titled “Example”Fancy Hotellodging_details.location?
Section titled “lodging_details.location?”
optionallocation?:object
lodging_details.location.address_line_1?
Section titled “lodging_details.location.address_line_1?”
optionaladdress_line_1?:string|null
Description
Section titled “Description”The first line of the address.
Example
Section titled “Example”Av. Vinte de Janeiro, S/Nlodging_details.location.address_line_2?
Section titled “lodging_details.location.address_line_2?”
optionaladdress_line_2?:string|null
Description
Section titled “Description”The second line of the address.
Example
Section titled “Example”Ilha do Governadorlodging_details.location.administrative_area?
Section titled “lodging_details.location.administrative_area?”
optionaladministrative_area?:string|null
Description
Section titled “Description”Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name.
Example
Section titled “Example”RJlodging_details.location.city?
Section titled “lodging_details.location.city?”
optionalcity?:string|null
Description
Section titled “Description”The city where the address is located.
Example
Section titled “Example”Rio de Janeirolodging_details.location.coordinates?
Section titled “lodging_details.location.coordinates?”
optionalcoordinates?:object
lodging_details.location.coordinates.latitude
Section titled “lodging_details.location.coordinates.latitude”latitude:
number
Format: double
Example
Section titled “Example”-22.8145373lodging_details.location.coordinates.longitude
Section titled “lodging_details.location.coordinates.longitude”longitude:
number
Format: double
Example
Section titled “Example”-43.2465548lodging_details.location.country?
Section titled “lodging_details.location.country?”
optionalcountry?:string|null
Description
Section titled “Description”The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country.
Example
Section titled “Example”Brazillodging_details.location.postal_code?
Section titled “lodging_details.location.postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”The postal code of the given address.
Example
Section titled “Example”21941-900lodging_details.location.timezone?
Section titled “lodging_details.location.timezone?”
optionaltimezone?:string|null
Description
Section titled “Description”The timezone in the given address.
Example
Section titled “Example”America/Sao_Paulolodging_details.star_rating?
Section titled “lodging_details.star_rating?”
optionalstar_rating?:number|null
Format: float
Description
Section titled “Description”The star rating of the hotel. Some hotels have half stars.
Example
Section titled “Example”3.5reservation_details
Section titled “reservation_details”reservation_details:
object
reservation_details.check_in_time
Section titled “reservation_details.check_in_time”check_in_time:
object
reservation_details.check_in_time.local_time
Section titled “reservation_details.check_in_time.local_time”local_time:
string
Format: date-time
Description
Section titled “Description”The local time in the relevant location in the ISO 8601 format.
reservation_details.check_in_time.timestamp?
Section titled “reservation_details.check_in_time.timestamp?”
optionaltimestamp?:string|null
Format: date-time
Description
Section titled “Description”An ISO 8601 timestamp.
Example
Section titled “Example”2017-12-27T15:42:30Zreservation_details.checkout_time
Section titled “reservation_details.checkout_time”checkout_time:
object
reservation_details.checkout_time.local_time
Section titled “reservation_details.checkout_time.local_time”local_time:
string
Format: date-time
Description
Section titled “Description”The local time in the relevant location in the ISO 8601 format.
reservation_details.checkout_time.timestamp?
Section titled “reservation_details.checkout_time.timestamp?”
optionaltimestamp?:string|null
Format: date-time
Description
Section titled “Description”An ISO 8601 timestamp.
Example
Section titled “Example”2017-12-27T15:42:30Zreservation_details.confirmation_code?
Section titled “reservation_details.confirmation_code?”
optionalconfirmation_code?:string|null
Description
Section titled “Description”Confirmation code provided by the vendor.
Example
Section titled “Example”7003XBQ504reservation_details.room?
Section titled “reservation_details.room?”
optionalroom?:object
reservation_details.room.bed_count?
Section titled “reservation_details.room.bed_count?”
optionalbed_count?:number|null
Format: int32
Description
Section titled “Description”The number of beds.
Example
Section titled “Example”1reservation_details.room.bed_type?
Section titled “reservation_details.room.bed_type?”
optionalbed_type?:string|null
Description
Section titled “Description”The kind of bed.
Example
Section titled “Example”DOUBLEreservation_details.room.description?
Section titled “reservation_details.room.description?”
optionaldescription?:string|null
Description
Section titled “Description”A description of the room.
Example
Section titled “Example”Superior roomreservation_details.room.display_name?
Section titled “reservation_details.room.display_name?”
optionaldisplay_name?:string|null
Description
Section titled “Description”The name of the room as displayed to the user.
Example
Section titled “Example”Standard roomtype:
"LODGING"
Description
Section titled “Description”discriminator enum property added by openapi-typescript
Type Literal
Section titled “Type Literal”{ journeys: object[]; type: "RAIL"; }
journeys
Section titled “journeys”journeys:
object[]
Description
Section titled “Description”The journeys that make up this booking.
type:
"RAIL"
Description
Section titled “Description”discriminator enum property added by openapi-typescript
Booking.created_at
Section titled “Booking.created_at”created_at:
string
Format: date-time
Description
Section titled “Description”The time when the booking was created.
Example
Section titled “Example”2017-12-27T15:42:30ZBooking.id
Section titled “Booking.id”id:
string
Description
Section titled “Description”The ID of the booking.
Example
Section titled “Example”booking_cl9t5dnu800040m3071dandeqBooking.source
Section titled “Booking.source”source:
"BREX_TRAVEL"|"EXTERNAL"
Booking.status
Section titled “Booking.status”status:
"PROCESSING"|"CANCELED"|"REFUNDED"|"IN_PROGRESS"|"APPROVAL_DENIED"|"PENDING"|"CONFIRMED"|"HOLD"|"COMPLETED"|"VOIDED"|"UNCONFIRMED"|"AIRLINE_CONTROL"|"PAYMENT_DECLINED"|"SCHEDULE_CHANGE"|"APPROVAL_REQUESTED"|"CANCELLATION_IN_PROGRESS"
Booking.trip_id
Section titled “Booking.trip_id”trip_id:
string
Description
Section titled “Description”The ID of the trip to which this booking belongs.
Example
Section titled “Example”trip_cl9rh1n8g001e0j84w6fb4fd1Booking.type
Section titled “Booking.type”type:
"CAR_RENTAL"|"LODGING"|"AIR"|"RAIL"
Booking.updated_at
Section titled “Booking.updated_at”updated_at:
string
Format: date-time
Description
Section titled “Description”The time when the booking was last updated.
Example
Section titled “Example”2017-12-27T15:42:30ZBooking.version
Section titled “Booking.version”version:
number
Format: int32
Description
Section titled “Description”The current version of the booking.
Example
Section titled “Example”2Booking.Data
Section titled “Booking.Data”Booking.Data: {
journeys:object[];known_traveler_number?: {document_number:string;issuing_country:string; };redress_number?: {document_number:string;issuing_country:string; };tickets:object[];type:"AIR"; } | {car_details: {car_class?:"OTHER"|"ECONOMY"|"COMPACT"|"INTERMEDIATE"|"PREMIUM"|"LUXURY"|"CONVERTIBLE"|"COMPACT_SUV"|"INTERMEDIATE_SUV"|"PREMIUM_SUV"|"LUXURY_SUV"|"MINI_VAN"|"PASSENGER_VAN"|"PICKUP_TRUCK"|"HYBRID"|"ELECTRIC"|"MINI"|"STANDARD"|"FULL_SIZE"|"SUV"|"SPORTS"|"SPECIAL"|"RECREATIONAL_VEHICLE";display_name:string; };reservation_details: {confirmation_code?:string|null;drop_off: {location: {address_line_1?:string|null;address_line_2?:string|null;administrative_area?:string|null;city?:string|null;coordinates?: {latitude:number;longitude:number; };country?:string|null;postal_code?:string|null;timezone?:string|null; };time: {local_time:string;timestamp?:string|null; }; };pickup: {location: {address_line_1?:string|null;address_line_2?:string|null;administrative_area?:string|null;city?:string|null;coordinates?: {latitude:number;longitude:number; };country?:string|null;postal_code?:string|null;timezone?:string|null; };time: {local_time:string;timestamp?:string|null; }; };rental_company?:string|null; };type:"CAR_RENTAL"; } | {lodging_details: {brand_name?:string|null;chain_name?:string|null;contact_information?: {email?:string|null;fax?:string|null;phone?:string|null; };display_name:string;location?: {address_line_1?:string|null;address_line_2?:string|null;administrative_area?:string|null;city?:string|null;coordinates?: {latitude:number;longitude:number; };country?:string|null;postal_code?:string|null;timezone?:string|null; };star_rating?:number|null; };reservation_details: {check_in_time: {local_time:string;timestamp?:string|null; };checkout_time: {local_time:string;timestamp?:string|null; };confirmation_code?:string|null;room?: {bed_count?:number|null;bed_type?:string|null;description?:string|null;display_name?:string|null; }; };type:"LODGING"; } | {journeys:object[];type:"RAIL"; }
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ journeys: object[]; known_traveler_number?: { document_number: string; issuing_country: string; }; redress_number?: { document_number: string; issuing_country: string; }; tickets: object[]; type: "AIR"; }
journeys
Section titled “journeys”journeys:
object[]
Description
Section titled “Description”The journeys that make up this booking.
known_traveler_number?
Section titled “known_traveler_number?”
optionalknown_traveler_number?:object
known_traveler_number.document_number
Section titled “known_traveler_number.document_number”document_number:
string
Description
Section titled “Description”The actual document number.
Example
Section titled “Example”1231231known_traveler_number.issuing_country
Section titled “known_traveler_number.issuing_country”issuing_country:
string
Description
Section titled “Description”The country that issued this document.
Example
Section titled “Example”BRredress_number?
Section titled “redress_number?”
optionalredress_number?:object
redress_number.document_number
Section titled “redress_number.document_number”document_number:
string
Description
Section titled “Description”The actual document number.
Example
Section titled “Example”1231231redress_number.issuing_country
Section titled “redress_number.issuing_country”issuing_country:
string
Description
Section titled “Description”The country that issued this document.
Example
Section titled “Example”BRtickets
Section titled “tickets”tickets:
object[]
Description
Section titled “Description”The flight tickets in this booking.
type:
"AIR"
Description
Section titled “Description”discriminator enum property added by openapi-typescript
Type Literal
Section titled “Type Literal”{ car_details: { car_class?: "OTHER" | "ECONOMY" | "COMPACT" | "INTERMEDIATE" | "PREMIUM" | "LUXURY" | "CONVERTIBLE" | "COMPACT_SUV" | "INTERMEDIATE_SUV" | "PREMIUM_SUV" | "LUXURY_SUV" | "MINI_VAN" | "PASSENGER_VAN" | "PICKUP_TRUCK" | "HYBRID" | "ELECTRIC" | "MINI" | "STANDARD" | "FULL_SIZE" | "SUV" | "SPORTS" | "SPECIAL" | "RECREATIONAL_VEHICLE"; display_name: string; }; reservation_details: { confirmation_code?: string | null; drop_off: { location: { address_line_1?: string | null; address_line_2?: string | null; administrative_area?: string | null; city?: string | null; coordinates?: { latitude: number; longitude: number; }; country?: string | null; postal_code?: string | null; timezone?: string | null; }; time: { local_time: string; timestamp?: string | null; }; }; pickup: { location: { address_line_1?: string | null; address_line_2?: string | null; administrative_area?: string | null; city?: string | null; coordinates?: { latitude: number; longitude: number; }; country?: string | null; postal_code?: string | null; timezone?: string | null; }; time: { local_time: string; timestamp?: string | null; }; }; rental_company?: string | null; }; type: "CAR_RENTAL"; }
car_details
Section titled “car_details”car_details:
object
car_details.car_class?
Section titled “car_details.car_class?”
optionalcar_class?:"OTHER"|"ECONOMY"|"COMPACT"|"INTERMEDIATE"|"PREMIUM"|"LUXURY"|"CONVERTIBLE"|"COMPACT_SUV"|"INTERMEDIATE_SUV"|"PREMIUM_SUV"|"LUXURY_SUV"|"MINI_VAN"|"PASSENGER_VAN"|"PICKUP_TRUCK"|"HYBRID"|"ELECTRIC"|"MINI"|"STANDARD"|"FULL_SIZE"|"SUV"|"SPORTS"|"SPECIAL"|"RECREATIONAL_VEHICLE"
car_details.display_name
Section titled “car_details.display_name”display_name:
string
Description
Section titled “Description”The name of the car as displayed to the user.
Example
Section titled “Example”Intermediate carreservation_details
Section titled “reservation_details”reservation_details:
object
reservation_details.confirmation_code?
Section titled “reservation_details.confirmation_code?”
optionalconfirmation_code?:string|null
Description
Section titled “Description”The confirmation code given by the vendor.
Example
Section titled “Example”7003XBQ504reservation_details.drop_off
Section titled “reservation_details.drop_off”drop_off:
object
reservation_details.drop_off.location
Section titled “reservation_details.drop_off.location”location:
object
reservation_details.drop_off.location.address_line_1?
Section titled “reservation_details.drop_off.location.address_line_1?”
optionaladdress_line_1?:string|null
Description
Section titled “Description”The first line of the address.
Example
Section titled “Example”Av. Vinte de Janeiro, S/Nreservation_details.drop_off.location.address_line_2?
Section titled “reservation_details.drop_off.location.address_line_2?”
optionaladdress_line_2?:string|null
Description
Section titled “Description”The second line of the address.
Example
Section titled “Example”Ilha do Governadorreservation_details.drop_off.location.administrative_area?
Section titled “reservation_details.drop_off.location.administrative_area?”
optionaladministrative_area?:string|null
Description
Section titled “Description”Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name.
Example
Section titled “Example”RJreservation_details.drop_off.location.city?
Section titled “reservation_details.drop_off.location.city?”
optionalcity?:string|null
Description
Section titled “Description”The city where the address is located.
Example
Section titled “Example”Rio de Janeiroreservation_details.drop_off.location.coordinates?
Section titled “reservation_details.drop_off.location.coordinates?”
optionalcoordinates?:object
reservation_details.drop_off.location.coordinates.latitude
Section titled “reservation_details.drop_off.location.coordinates.latitude”latitude:
number
Format: double
Example
Section titled “Example”-22.8145373reservation_details.drop_off.location.coordinates.longitude
Section titled “reservation_details.drop_off.location.coordinates.longitude”longitude:
number
Format: double
Example
Section titled “Example”-43.2465548reservation_details.drop_off.location.country?
Section titled “reservation_details.drop_off.location.country?”
optionalcountry?:string|null
Description
Section titled “Description”The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country.
Example
Section titled “Example”Brazilreservation_details.drop_off.location.postal_code?
Section titled “reservation_details.drop_off.location.postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”The postal code of the given address.
Example
Section titled “Example”21941-900reservation_details.drop_off.location.timezone?
Section titled “reservation_details.drop_off.location.timezone?”
optionaltimezone?:string|null
Description
Section titled “Description”The timezone in the given address.
Example
Section titled “Example”America/Sao_Pauloreservation_details.drop_off.time
Section titled “reservation_details.drop_off.time”time:
object
reservation_details.drop_off.time.local_time
Section titled “reservation_details.drop_off.time.local_time”local_time:
string
Format: date-time
Description
Section titled “Description”The local time in the relevant location in the ISO 8601 format.
reservation_details.drop_off.time.timestamp?
Section titled “reservation_details.drop_off.time.timestamp?”
optionaltimestamp?:string|null
Format: date-time
Description
Section titled “Description”An ISO 8601 timestamp.
Example
Section titled “Example”2017-12-27T15:42:30Zreservation_details.pickup
Section titled “reservation_details.pickup”pickup:
object
reservation_details.pickup.location
Section titled “reservation_details.pickup.location”location:
object
reservation_details.pickup.location.address_line_1?
Section titled “reservation_details.pickup.location.address_line_1?”
optionaladdress_line_1?:string|null
Description
Section titled “Description”The first line of the address.
Example
Section titled “Example”Av. Vinte de Janeiro, S/Nreservation_details.pickup.location.address_line_2?
Section titled “reservation_details.pickup.location.address_line_2?”
optionaladdress_line_2?:string|null
Description
Section titled “Description”The second line of the address.
Example
Section titled “Example”Ilha do Governadorreservation_details.pickup.location.administrative_area?
Section titled “reservation_details.pickup.location.administrative_area?”
optionaladministrative_area?:string|null
Description
Section titled “Description”Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name.
Example
Section titled “Example”RJreservation_details.pickup.location.city?
Section titled “reservation_details.pickup.location.city?”
optionalcity?:string|null
Description
Section titled “Description”The city where the address is located.
Example
Section titled “Example”Rio de Janeiroreservation_details.pickup.location.coordinates?
Section titled “reservation_details.pickup.location.coordinates?”
optionalcoordinates?:object
reservation_details.pickup.location.coordinates.latitude
Section titled “reservation_details.pickup.location.coordinates.latitude”latitude:
number
Format: double
Example
Section titled “Example”-22.8145373reservation_details.pickup.location.coordinates.longitude
Section titled “reservation_details.pickup.location.coordinates.longitude”longitude:
number
Format: double
Example
Section titled “Example”-43.2465548reservation_details.pickup.location.country?
Section titled “reservation_details.pickup.location.country?”
optionalcountry?:string|null
Description
Section titled “Description”The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country.
Example
Section titled “Example”Brazilreservation_details.pickup.location.postal_code?
Section titled “reservation_details.pickup.location.postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”The postal code of the given address.
Example
Section titled “Example”21941-900reservation_details.pickup.location.timezone?
Section titled “reservation_details.pickup.location.timezone?”
optionaltimezone?:string|null
Description
Section titled “Description”The timezone in the given address.
Example
Section titled “Example”America/Sao_Pauloreservation_details.pickup.time
Section titled “reservation_details.pickup.time”time:
object
reservation_details.pickup.time.local_time
Section titled “reservation_details.pickup.time.local_time”local_time:
string
Format: date-time
Description
Section titled “Description”The local time in the relevant location in the ISO 8601 format.
reservation_details.pickup.time.timestamp?
Section titled “reservation_details.pickup.time.timestamp?”
optionaltimestamp?:string|null
Format: date-time
Description
Section titled “Description”An ISO 8601 timestamp.
Example
Section titled “Example”2017-12-27T15:42:30Zreservation_details.rental_company?
Section titled “reservation_details.rental_company?”
optionalrental_company?:string|null
Description
Section titled “Description”Name of car rental company.
Example
Section titled “Example”Catch-A-Ridetype:
"CAR_RENTAL"
Description
Section titled “Description”discriminator enum property added by openapi-typescript
Type Literal
Section titled “Type Literal”{ lodging_details: { brand_name?: string | null; chain_name?: string | null; contact_information?: { email?: string | null; fax?: string | null; phone?: string | null; }; display_name: string; location?: { address_line_1?: string | null; address_line_2?: string | null; administrative_area?: string | null; city?: string | null; coordinates?: { latitude: number; longitude: number; }; country?: string | null; postal_code?: string | null; timezone?: string | null; }; star_rating?: number | null; }; reservation_details: { check_in_time: { local_time: string; timestamp?: string | null; }; checkout_time: { local_time: string; timestamp?: string | null; }; confirmation_code?: string | null; room?: { bed_count?: number | null; bed_type?: string | null; description?: string | null; display_name?: string | null; }; }; type: "LODGING"; }
lodging_details
Section titled “lodging_details”lodging_details:
object
lodging_details.brand_name?
Section titled “lodging_details.brand_name?”
optionalbrand_name?:string|null
Description
Section titled “Description”The brand name of the hotel.
Example
Section titled “Example”Marriott Hotelslodging_details.chain_name?
Section titled “lodging_details.chain_name?”
optionalchain_name?:string|null
Description
Section titled “Description”The name of the hotel chain.
Example
Section titled “Example”Accor Hotelslodging_details.contact_information?
Section titled “lodging_details.contact_information?”
optionalcontact_information?:object
lodging_details.contact_information.email?
Section titled “lodging_details.contact_information.email?”
optionalemail?:string|null
Description
Section titled “Description”The email address of the venue.
Example
Section titled “Example”city@hotelchain.comlodging_details.contact_information.fax?
Section titled “lodging_details.contact_information.fax?”
optionalfax?:string|null
Description
Section titled “Description”The fax number of the venue.
Example
Section titled “Example”12345554321lodging_details.contact_information.phone?
Section titled “lodging_details.contact_information.phone?”
optionalphone?:string|null
Description
Section titled “Description”The phone number of the venue.
Example
Section titled “Example”12345554321lodging_details.display_name
Section titled “lodging_details.display_name”display_name:
string
Description
Section titled “Description”The name of the venue as displayed to the user.
Example
Section titled “Example”Fancy Hotellodging_details.location?
Section titled “lodging_details.location?”
optionallocation?:object
lodging_details.location.address_line_1?
Section titled “lodging_details.location.address_line_1?”
optionaladdress_line_1?:string|null
Description
Section titled “Description”The first line of the address.
Example
Section titled “Example”Av. Vinte de Janeiro, S/Nlodging_details.location.address_line_2?
Section titled “lodging_details.location.address_line_2?”
optionaladdress_line_2?:string|null
Description
Section titled “Description”The second line of the address.
Example
Section titled “Example”Ilha do Governadorlodging_details.location.administrative_area?
Section titled “lodging_details.location.administrative_area?”
optionaladministrative_area?:string|null
Description
Section titled “Description”Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name.
Example
Section titled “Example”RJlodging_details.location.city?
Section titled “lodging_details.location.city?”
optionalcity?:string|null
Description
Section titled “Description”The city where the address is located.
Example
Section titled “Example”Rio de Janeirolodging_details.location.coordinates?
Section titled “lodging_details.location.coordinates?”
optionalcoordinates?:object
lodging_details.location.coordinates.latitude
Section titled “lodging_details.location.coordinates.latitude”latitude:
number
Format: double
Example
Section titled “Example”-22.8145373lodging_details.location.coordinates.longitude
Section titled “lodging_details.location.coordinates.longitude”longitude:
number
Format: double
Example
Section titled “Example”-43.2465548lodging_details.location.country?
Section titled “lodging_details.location.country?”
optionalcountry?:string|null
Description
Section titled “Description”The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country.
Example
Section titled “Example”Brazillodging_details.location.postal_code?
Section titled “lodging_details.location.postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”The postal code of the given address.
Example
Section titled “Example”21941-900lodging_details.location.timezone?
Section titled “lodging_details.location.timezone?”
optionaltimezone?:string|null
Description
Section titled “Description”The timezone in the given address.
Example
Section titled “Example”America/Sao_Paulolodging_details.star_rating?
Section titled “lodging_details.star_rating?”
optionalstar_rating?:number|null
Format: float
Description
Section titled “Description”The star rating of the hotel. Some hotels have half stars.
Example
Section titled “Example”3.5reservation_details
Section titled “reservation_details”reservation_details:
object
reservation_details.check_in_time
Section titled “reservation_details.check_in_time”check_in_time:
object
reservation_details.check_in_time.local_time
Section titled “reservation_details.check_in_time.local_time”local_time:
string
Format: date-time
Description
Section titled “Description”The local time in the relevant location in the ISO 8601 format.
reservation_details.check_in_time.timestamp?
Section titled “reservation_details.check_in_time.timestamp?”
optionaltimestamp?:string|null
Format: date-time
Description
Section titled “Description”An ISO 8601 timestamp.
Example
Section titled “Example”2017-12-27T15:42:30Zreservation_details.checkout_time
Section titled “reservation_details.checkout_time”checkout_time:
object
reservation_details.checkout_time.local_time
Section titled “reservation_details.checkout_time.local_time”local_time:
string
Format: date-time
Description
Section titled “Description”The local time in the relevant location in the ISO 8601 format.
reservation_details.checkout_time.timestamp?
Section titled “reservation_details.checkout_time.timestamp?”
optionaltimestamp?:string|null
Format: date-time
Description
Section titled “Description”An ISO 8601 timestamp.
Example
Section titled “Example”2017-12-27T15:42:30Zreservation_details.confirmation_code?
Section titled “reservation_details.confirmation_code?”
optionalconfirmation_code?:string|null
Description
Section titled “Description”Confirmation code provided by the vendor.
Example
Section titled “Example”7003XBQ504reservation_details.room?
Section titled “reservation_details.room?”
optionalroom?:object
reservation_details.room.bed_count?
Section titled “reservation_details.room.bed_count?”
optionalbed_count?:number|null
Format: int32
Description
Section titled “Description”The number of beds.
Example
Section titled “Example”1reservation_details.room.bed_type?
Section titled “reservation_details.room.bed_type?”
optionalbed_type?:string|null
Description
Section titled “Description”The kind of bed.
Example
Section titled “Example”DOUBLEreservation_details.room.description?
Section titled “reservation_details.room.description?”
optionaldescription?:string|null
Description
Section titled “Description”A description of the room.
Example
Section titled “Example”Superior roomreservation_details.room.display_name?
Section titled “reservation_details.room.display_name?”
optionaldisplay_name?:string|null
Description
Section titled “Description”The name of the room as displayed to the user.
Example
Section titled “Example”Standard roomtype:
"LODGING"
Description
Section titled “Description”discriminator enum property added by openapi-typescript
Type Literal
Section titled “Type Literal”{ journeys: object[]; type: "RAIL"; }
journeys
Section titled “journeys”journeys:
object[]
Description
Section titled “Description”The journeys that make up this booking.
type:
"RAIL"
Description
Section titled “Description”discriminator enum property added by openapi-typescript
Description
Section titled “Description”Type-specific booking data.
Booking.Source
Section titled “Booking.Source”Booking.Source:
"BREX_TRAVEL"|"EXTERNAL"
Description
Section titled “Description”The original source of a booking:
* BREX_TRAVEL - The booking was created via Brex Travel.
* EXTERNAL - The booking was manually inserted, e.g. a hotel room block for a group event.
Example
Section titled “Example”BREX_TRAVEL@enum {string}Booking.Time
Section titled “Booking.Time”Booking.Time:
object
Description
Section titled “Description”A time within a booking, including local time in the relevant location, and a timestamp when possible.
Booking.Time.local_time
Section titled “Booking.Time.local_time”local_time:
string
Format: date-time
Description
Section titled “Description”The local time in the relevant location in the ISO 8601 format.
Booking.Time.timestamp?
Section titled “Booking.Time.timestamp?”
optionaltimestamp?:string|null
Format: date-time
Description
Section titled “Description”An ISO 8601 timestamp.
Example
Section titled “Example”2017-12-27T15:42:30ZBooking.Type
Section titled “Booking.Type”Booking.Type:
"CAR_RENTAL"|"LODGING"|"AIR"|"RAIL"
Description
Section titled “Description”The type of a booking.
Example
Section titled “Example”AIR@enum {string}BookingStatus
Section titled “BookingStatus”BookingStatus:
"PROCESSING"|"CANCELED"|"REFUNDED"|"IN_PROGRESS"|"APPROVAL_DENIED"|"PENDING"|"CONFIRMED"|"HOLD"|"COMPLETED"|"VOIDED"|"UNCONFIRMED"|"AIRLINE_CONTROL"|"PAYMENT_DECLINED"|"SCHEDULE_CHANGE"|"APPROVAL_REQUESTED"|"CANCELLATION_IN_PROGRESS"
Description
Section titled “Description”The status of the booking:
* HOLD - The booking is a hold, and may be canceled without being charged.
* PENDING - Some action needs to be completed before the booking is confirmed. Usually the action is the payment being confirmed.
* CONFIRMED - The booking is confirmed.
* COMPLETED - The booking has already happened.
* CANCELED - The booking has been canceled.
* IN_PROGRESS - The booking is currently in progress.
* REFUNDED - A refund has been issued. It may or may not be a full refund.
* VOIDED - Voided is similar to (and can be treated the same as) canceled.
* PROCESSING - The booking has been created or changed, but confirmation from the vendor has not been received yet.
* UNCONFIRMED - The booking was in the PROCESSING state for too long and some action is probably required to get this booking confirmed.
* AIRLINE_CONTROL - The airline has taken control of the booking and further updates may not be visible.
* PAYMENT_DECLINED - The payment for the booking has failed.
* SCHEDULE_CHANGE - Some change has happened to the booking schedule, e.g. the flight getting canceled and the passenger reallocated to another flight. Travel support should reach out to confirm the traveler accepts the new schedule.
* APPROVAL_REQUESTED - The booking is subject to approval, and it is waiting for a review.
* APPROVAL_DENIED - A reviewer has denied the booking, or the deadline to approve the booking has passed and it got canceled.
* CANCELLATION_IN_PROGRESS - The booking is currently being canceled.
Example
Section titled “Example”CONFIRMED@enum {string}CarRentalBookingData
Section titled “CarRentalBookingData”CarRentalBookingData:
object
Description
Section titled “Description”Car rental-specific booking information.
CarRentalBookingData.car_details
Section titled “CarRentalBookingData.car_details”car_details:
object
CarRentalBookingData.car_details.car_class?
Section titled “CarRentalBookingData.car_details.car_class?”
optionalcar_class?:"OTHER"|"ECONOMY"|"COMPACT"|"INTERMEDIATE"|"PREMIUM"|"LUXURY"|"CONVERTIBLE"|"COMPACT_SUV"|"INTERMEDIATE_SUV"|"PREMIUM_SUV"|"LUXURY_SUV"|"MINI_VAN"|"PASSENGER_VAN"|"PICKUP_TRUCK"|"HYBRID"|"ELECTRIC"|"MINI"|"STANDARD"|"FULL_SIZE"|"SUV"|"SPORTS"|"SPECIAL"|"RECREATIONAL_VEHICLE"
CarRentalBookingData.car_details.display_name
Section titled “CarRentalBookingData.car_details.display_name”display_name:
string
Description
Section titled “Description”The name of the car as displayed to the user.
Example
Section titled “Example”Intermediate carCarRentalBookingData.reservation_details
Section titled “CarRentalBookingData.reservation_details”reservation_details:
object
CarRentalBookingData.reservation_details.confirmation_code?
Section titled “CarRentalBookingData.reservation_details.confirmation_code?”
optionalconfirmation_code?:string|null
Description
Section titled “Description”The confirmation code given by the vendor.
Example
Section titled “Example”7003XBQ504CarRentalBookingData.reservation_details.drop_off
Section titled “CarRentalBookingData.reservation_details.drop_off”drop_off:
object
CarRentalBookingData.reservation_details.drop_off.location
Section titled “CarRentalBookingData.reservation_details.drop_off.location”location:
object
CarRentalBookingData.reservation_details.drop_off.location.address_line_1?
Section titled “CarRentalBookingData.reservation_details.drop_off.location.address_line_1?”
optionaladdress_line_1?:string|null
Description
Section titled “Description”The first line of the address.
Example
Section titled “Example”Av. Vinte de Janeiro, S/NCarRentalBookingData.reservation_details.drop_off.location.address_line_2?
Section titled “CarRentalBookingData.reservation_details.drop_off.location.address_line_2?”
optionaladdress_line_2?:string|null
Description
Section titled “Description”The second line of the address.
Example
Section titled “Example”Ilha do GovernadorCarRentalBookingData.reservation_details.drop_off.location.administrative_area?
Section titled “CarRentalBookingData.reservation_details.drop_off.location.administrative_area?”
optionaladministrative_area?:string|null
Description
Section titled “Description”Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name.
Example
Section titled “Example”RJCarRentalBookingData.reservation_details.drop_off.location.city?
Section titled “CarRentalBookingData.reservation_details.drop_off.location.city?”
optionalcity?:string|null
Description
Section titled “Description”The city where the address is located.
Example
Section titled “Example”Rio de JaneiroCarRentalBookingData.reservation_details.drop_off.location.coordinates?
Section titled “CarRentalBookingData.reservation_details.drop_off.location.coordinates?”
optionalcoordinates?:object
CarRentalBookingData.reservation_details.drop_off.location.coordinates.latitude
Section titled “CarRentalBookingData.reservation_details.drop_off.location.coordinates.latitude”latitude:
number
Format: double
Example
Section titled “Example”-22.8145373CarRentalBookingData.reservation_details.drop_off.location.coordinates.longitude
Section titled “CarRentalBookingData.reservation_details.drop_off.location.coordinates.longitude”longitude:
number
Format: double
Example
Section titled “Example”-43.2465548CarRentalBookingData.reservation_details.drop_off.location.country?
Section titled “CarRentalBookingData.reservation_details.drop_off.location.country?”
optionalcountry?:string|null
Description
Section titled “Description”The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country.
Example
Section titled “Example”BrazilCarRentalBookingData.reservation_details.drop_off.location.postal_code?
Section titled “CarRentalBookingData.reservation_details.drop_off.location.postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”The postal code of the given address.
Example
Section titled “Example”21941-900CarRentalBookingData.reservation_details.drop_off.location.timezone?
Section titled “CarRentalBookingData.reservation_details.drop_off.location.timezone?”
optionaltimezone?:string|null
Description
Section titled “Description”The timezone in the given address.
Example
Section titled “Example”America/Sao_PauloCarRentalBookingData.reservation_details.drop_off.time
Section titled “CarRentalBookingData.reservation_details.drop_off.time”time:
object
CarRentalBookingData.reservation_details.drop_off.time.local_time
Section titled “CarRentalBookingData.reservation_details.drop_off.time.local_time”local_time:
string
Format: date-time
Description
Section titled “Description”The local time in the relevant location in the ISO 8601 format.
CarRentalBookingData.reservation_details.drop_off.time.timestamp?
Section titled “CarRentalBookingData.reservation_details.drop_off.time.timestamp?”
optionaltimestamp?:string|null
Format: date-time
Description
Section titled “Description”An ISO 8601 timestamp.
Example
Section titled “Example”2017-12-27T15:42:30ZCarRentalBookingData.reservation_details.pickup
Section titled “CarRentalBookingData.reservation_details.pickup”pickup:
object
CarRentalBookingData.reservation_details.pickup.location
Section titled “CarRentalBookingData.reservation_details.pickup.location”location:
object
CarRentalBookingData.reservation_details.pickup.location.address_line_1?
Section titled “CarRentalBookingData.reservation_details.pickup.location.address_line_1?”
optionaladdress_line_1?:string|null
Description
Section titled “Description”The first line of the address.
Example
Section titled “Example”Av. Vinte de Janeiro, S/NCarRentalBookingData.reservation_details.pickup.location.address_line_2?
Section titled “CarRentalBookingData.reservation_details.pickup.location.address_line_2?”
optionaladdress_line_2?:string|null
Description
Section titled “Description”The second line of the address.
Example
Section titled “Example”Ilha do GovernadorCarRentalBookingData.reservation_details.pickup.location.administrative_area?
Section titled “CarRentalBookingData.reservation_details.pickup.location.administrative_area?”
optionaladministrative_area?:string|null
Description
Section titled “Description”Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name.
Example
Section titled “Example”RJCarRentalBookingData.reservation_details.pickup.location.city?
Section titled “CarRentalBookingData.reservation_details.pickup.location.city?”
optionalcity?:string|null
Description
Section titled “Description”The city where the address is located.
Example
Section titled “Example”Rio de JaneiroCarRentalBookingData.reservation_details.pickup.location.coordinates?
Section titled “CarRentalBookingData.reservation_details.pickup.location.coordinates?”
optionalcoordinates?:object
CarRentalBookingData.reservation_details.pickup.location.coordinates.latitude
Section titled “CarRentalBookingData.reservation_details.pickup.location.coordinates.latitude”latitude:
number
Format: double
Example
Section titled “Example”-22.8145373CarRentalBookingData.reservation_details.pickup.location.coordinates.longitude
Section titled “CarRentalBookingData.reservation_details.pickup.location.coordinates.longitude”longitude:
number
Format: double
Example
Section titled “Example”-43.2465548CarRentalBookingData.reservation_details.pickup.location.country?
Section titled “CarRentalBookingData.reservation_details.pickup.location.country?”
optionalcountry?:string|null
Description
Section titled “Description”The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country.
Example
Section titled “Example”BrazilCarRentalBookingData.reservation_details.pickup.location.postal_code?
Section titled “CarRentalBookingData.reservation_details.pickup.location.postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”The postal code of the given address.
Example
Section titled “Example”21941-900CarRentalBookingData.reservation_details.pickup.location.timezone?
Section titled “CarRentalBookingData.reservation_details.pickup.location.timezone?”
optionaltimezone?:string|null
Description
Section titled “Description”The timezone in the given address.
Example
Section titled “Example”America/Sao_PauloCarRentalBookingData.reservation_details.pickup.time
Section titled “CarRentalBookingData.reservation_details.pickup.time”time:
object
CarRentalBookingData.reservation_details.pickup.time.local_time
Section titled “CarRentalBookingData.reservation_details.pickup.time.local_time”local_time:
string
Format: date-time
Description
Section titled “Description”The local time in the relevant location in the ISO 8601 format.
CarRentalBookingData.reservation_details.pickup.time.timestamp?
Section titled “CarRentalBookingData.reservation_details.pickup.time.timestamp?”
optionaltimestamp?:string|null
Format: date-time
Description
Section titled “Description”An ISO 8601 timestamp.
Example
Section titled “Example”2017-12-27T15:42:30ZCarRentalBookingData.reservation_details.rental_company?
Section titled “CarRentalBookingData.reservation_details.rental_company?”
optionalrental_company?:string|null
Description
Section titled “Description”Name of car rental company.
Example
Section titled “Example”Catch-A-RideCarRentalBookingData.type
Section titled “CarRentalBookingData.type”type:
"CAR_RENTAL"
Description
Section titled “Description”discriminator enum property added by openapi-typescript
CarRentalBookingData.CarClass
Section titled “CarRentalBookingData.CarClass”CarRentalBookingData.CarClass:
"OTHER"|"ECONOMY"|"COMPACT"|"INTERMEDIATE"|"PREMIUM"|"LUXURY"|"CONVERTIBLE"|"COMPACT_SUV"|"INTERMEDIATE_SUV"|"PREMIUM_SUV"|"LUXURY_SUV"|"MINI_VAN"|"PASSENGER_VAN"|"PICKUP_TRUCK"|"HYBRID"|"ELECTRIC"|"MINI"|"STANDARD"|"FULL_SIZE"|"SUV"|"SPORTS"|"SPECIAL"|"RECREATIONAL_VEHICLE"
Description
Section titled “Description”The kind of car.
Example
Section titled “Example”INTERMEDIATE@enum {string}CarRentalBookingData.CarDetails
Section titled “CarRentalBookingData.CarDetails”CarRentalBookingData.CarDetails:
object
Description
Section titled “Description”Information on a rental car.
CarRentalBookingData.CarDetails.car_class?
Section titled “CarRentalBookingData.CarDetails.car_class?”
optionalcar_class?:"OTHER"|"ECONOMY"|"COMPACT"|"INTERMEDIATE"|"PREMIUM"|"LUXURY"|"CONVERTIBLE"|"COMPACT_SUV"|"INTERMEDIATE_SUV"|"PREMIUM_SUV"|"LUXURY_SUV"|"MINI_VAN"|"PASSENGER_VAN"|"PICKUP_TRUCK"|"HYBRID"|"ELECTRIC"|"MINI"|"STANDARD"|"FULL_SIZE"|"SUV"|"SPORTS"|"SPECIAL"|"RECREATIONAL_VEHICLE"
CarRentalBookingData.CarDetails.display_name
Section titled “CarRentalBookingData.CarDetails.display_name”display_name:
string
Description
Section titled “Description”The name of the car as displayed to the user.
Example
Section titled “Example”Intermediate carCarRentalBookingData.RentalEndpoint
Section titled “CarRentalBookingData.RentalEndpoint”CarRentalBookingData.RentalEndpoint:
object
Description
Section titled “Description”Information about the car pickup or drop-off.
CarRentalBookingData.RentalEndpoint.location
Section titled “CarRentalBookingData.RentalEndpoint.location”location:
object
CarRentalBookingData.RentalEndpoint.location.address_line_1?
Section titled “CarRentalBookingData.RentalEndpoint.location.address_line_1?”
optionaladdress_line_1?:string|null
Description
Section titled “Description”The first line of the address.
Example
Section titled “Example”Av. Vinte de Janeiro, S/NCarRentalBookingData.RentalEndpoint.location.address_line_2?
Section titled “CarRentalBookingData.RentalEndpoint.location.address_line_2?”
optionaladdress_line_2?:string|null
Description
Section titled “Description”The second line of the address.
Example
Section titled “Example”Ilha do GovernadorCarRentalBookingData.RentalEndpoint.location.administrative_area?
Section titled “CarRentalBookingData.RentalEndpoint.location.administrative_area?”
optionaladministrative_area?:string|null
Description
Section titled “Description”Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name.
Example
Section titled “Example”RJCarRentalBookingData.RentalEndpoint.location.city?
Section titled “CarRentalBookingData.RentalEndpoint.location.city?”
optionalcity?:string|null
Description
Section titled “Description”The city where the address is located.
Example
Section titled “Example”Rio de JaneiroCarRentalBookingData.RentalEndpoint.location.coordinates?
Section titled “CarRentalBookingData.RentalEndpoint.location.coordinates?”
optionalcoordinates?:object
CarRentalBookingData.RentalEndpoint.location.coordinates.latitude
Section titled “CarRentalBookingData.RentalEndpoint.location.coordinates.latitude”latitude:
number
Format: double
Example
Section titled “Example”-22.8145373CarRentalBookingData.RentalEndpoint.location.coordinates.longitude
Section titled “CarRentalBookingData.RentalEndpoint.location.coordinates.longitude”longitude:
number
Format: double
Example
Section titled “Example”-43.2465548CarRentalBookingData.RentalEndpoint.location.country?
Section titled “CarRentalBookingData.RentalEndpoint.location.country?”
optionalcountry?:string|null
Description
Section titled “Description”The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country.
Example
Section titled “Example”BrazilCarRentalBookingData.RentalEndpoint.location.postal_code?
Section titled “CarRentalBookingData.RentalEndpoint.location.postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”The postal code of the given address.
Example
Section titled “Example”21941-900CarRentalBookingData.RentalEndpoint.location.timezone?
Section titled “CarRentalBookingData.RentalEndpoint.location.timezone?”
optionaltimezone?:string|null
Description
Section titled “Description”The timezone in the given address.
Example
Section titled “Example”America/Sao_PauloCarRentalBookingData.RentalEndpoint.time
Section titled “CarRentalBookingData.RentalEndpoint.time”time:
object
CarRentalBookingData.RentalEndpoint.time.local_time
Section titled “CarRentalBookingData.RentalEndpoint.time.local_time”local_time:
string
Format: date-time
Description
Section titled “Description”The local time in the relevant location in the ISO 8601 format.
CarRentalBookingData.RentalEndpoint.time.timestamp?
Section titled “CarRentalBookingData.RentalEndpoint.time.timestamp?”
optionaltimestamp?:string|null
Format: date-time
Description
Section titled “Description”An ISO 8601 timestamp.
Example
Section titled “Example”2017-12-27T15:42:30ZCarRentalBookingData.ReservationDetails
Section titled “CarRentalBookingData.ReservationDetails”CarRentalBookingData.ReservationDetails:
object
Description
Section titled “Description”Information on a car reservation such as pickup, drop-off, etc.
CarRentalBookingData.ReservationDetails.confirmation_code?
Section titled “CarRentalBookingData.ReservationDetails.confirmation_code?”
optionalconfirmation_code?:string|null
Description
Section titled “Description”The confirmation code given by the vendor.
Example
Section titled “Example”7003XBQ504CarRentalBookingData.ReservationDetails.drop_off
Section titled “CarRentalBookingData.ReservationDetails.drop_off”drop_off:
object
CarRentalBookingData.ReservationDetails.drop_off.location
Section titled “CarRentalBookingData.ReservationDetails.drop_off.location”location:
object
CarRentalBookingData.ReservationDetails.drop_off.location.address_line_1?
Section titled “CarRentalBookingData.ReservationDetails.drop_off.location.address_line_1?”
optionaladdress_line_1?:string|null
Description
Section titled “Description”The first line of the address.
Example
Section titled “Example”Av. Vinte de Janeiro, S/NCarRentalBookingData.ReservationDetails.drop_off.location.address_line_2?
Section titled “CarRentalBookingData.ReservationDetails.drop_off.location.address_line_2?”
optionaladdress_line_2?:string|null
Description
Section titled “Description”The second line of the address.
Example
Section titled “Example”Ilha do GovernadorCarRentalBookingData.ReservationDetails.drop_off.location.administrative_area?
Section titled “CarRentalBookingData.ReservationDetails.drop_off.location.administrative_area?”
optionaladministrative_area?:string|null
Description
Section titled “Description”Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name.
Example
Section titled “Example”RJCarRentalBookingData.ReservationDetails.drop_off.location.city?
Section titled “CarRentalBookingData.ReservationDetails.drop_off.location.city?”
optionalcity?:string|null
Description
Section titled “Description”The city where the address is located.
Example
Section titled “Example”Rio de JaneiroCarRentalBookingData.ReservationDetails.drop_off.location.coordinates?
Section titled “CarRentalBookingData.ReservationDetails.drop_off.location.coordinates?”
optionalcoordinates?:object
CarRentalBookingData.ReservationDetails.drop_off.location.coordinates.latitude
Section titled “CarRentalBookingData.ReservationDetails.drop_off.location.coordinates.latitude”latitude:
number
Format: double
Example
Section titled “Example”-22.8145373CarRentalBookingData.ReservationDetails.drop_off.location.coordinates.longitude
Section titled “CarRentalBookingData.ReservationDetails.drop_off.location.coordinates.longitude”longitude:
number
Format: double
Example
Section titled “Example”-43.2465548CarRentalBookingData.ReservationDetails.drop_off.location.country?
Section titled “CarRentalBookingData.ReservationDetails.drop_off.location.country?”
optionalcountry?:string|null
Description
Section titled “Description”The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country.
Example
Section titled “Example”BrazilCarRentalBookingData.ReservationDetails.drop_off.location.postal_code?
Section titled “CarRentalBookingData.ReservationDetails.drop_off.location.postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”The postal code of the given address.
Example
Section titled “Example”21941-900CarRentalBookingData.ReservationDetails.drop_off.location.timezone?
Section titled “CarRentalBookingData.ReservationDetails.drop_off.location.timezone?”
optionaltimezone?:string|null
Description
Section titled “Description”The timezone in the given address.
Example
Section titled “Example”America/Sao_PauloCarRentalBookingData.ReservationDetails.drop_off.time
Section titled “CarRentalBookingData.ReservationDetails.drop_off.time”time:
object
CarRentalBookingData.ReservationDetails.drop_off.time.local_time
Section titled “CarRentalBookingData.ReservationDetails.drop_off.time.local_time”local_time:
string
Format: date-time
Description
Section titled “Description”The local time in the relevant location in the ISO 8601 format.
CarRentalBookingData.ReservationDetails.drop_off.time.timestamp?
Section titled “CarRentalBookingData.ReservationDetails.drop_off.time.timestamp?”
optionaltimestamp?:string|null
Format: date-time
Description
Section titled “Description”An ISO 8601 timestamp.
Example
Section titled “Example”2017-12-27T15:42:30ZCarRentalBookingData.ReservationDetails.pickup
Section titled “CarRentalBookingData.ReservationDetails.pickup”pickup:
object
CarRentalBookingData.ReservationDetails.pickup.location
Section titled “CarRentalBookingData.ReservationDetails.pickup.location”location:
object
CarRentalBookingData.ReservationDetails.pickup.location.address_line_1?
Section titled “CarRentalBookingData.ReservationDetails.pickup.location.address_line_1?”
optionaladdress_line_1?:string|null
Description
Section titled “Description”The first line of the address.
Example
Section titled “Example”Av. Vinte de Janeiro, S/NCarRentalBookingData.ReservationDetails.pickup.location.address_line_2?
Section titled “CarRentalBookingData.ReservationDetails.pickup.location.address_line_2?”
optionaladdress_line_2?:string|null
Description
Section titled “Description”The second line of the address.
Example
Section titled “Example”Ilha do GovernadorCarRentalBookingData.ReservationDetails.pickup.location.administrative_area?
Section titled “CarRentalBookingData.ReservationDetails.pickup.location.administrative_area?”
optionaladministrative_area?:string|null
Description
Section titled “Description”Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name.
Example
Section titled “Example”RJCarRentalBookingData.ReservationDetails.pickup.location.city?
Section titled “CarRentalBookingData.ReservationDetails.pickup.location.city?”
optionalcity?:string|null
Description
Section titled “Description”The city where the address is located.
Example
Section titled “Example”Rio de JaneiroCarRentalBookingData.ReservationDetails.pickup.location.coordinates?
Section titled “CarRentalBookingData.ReservationDetails.pickup.location.coordinates?”
optionalcoordinates?:object
CarRentalBookingData.ReservationDetails.pickup.location.coordinates.latitude
Section titled “CarRentalBookingData.ReservationDetails.pickup.location.coordinates.latitude”latitude:
number
Format: double
Example
Section titled “Example”-22.8145373CarRentalBookingData.ReservationDetails.pickup.location.coordinates.longitude
Section titled “CarRentalBookingData.ReservationDetails.pickup.location.coordinates.longitude”longitude:
number
Format: double
Example
Section titled “Example”-43.2465548CarRentalBookingData.ReservationDetails.pickup.location.country?
Section titled “CarRentalBookingData.ReservationDetails.pickup.location.country?”
optionalcountry?:string|null
Description
Section titled “Description”The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country.
Example
Section titled “Example”BrazilCarRentalBookingData.ReservationDetails.pickup.location.postal_code?
Section titled “CarRentalBookingData.ReservationDetails.pickup.location.postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”The postal code of the given address.
Example
Section titled “Example”21941-900CarRentalBookingData.ReservationDetails.pickup.location.timezone?
Section titled “CarRentalBookingData.ReservationDetails.pickup.location.timezone?”
optionaltimezone?:string|null
Description
Section titled “Description”The timezone in the given address.
Example
Section titled “Example”America/Sao_PauloCarRentalBookingData.ReservationDetails.pickup.time
Section titled “CarRentalBookingData.ReservationDetails.pickup.time”time:
object
CarRentalBookingData.ReservationDetails.pickup.time.local_time
Section titled “CarRentalBookingData.ReservationDetails.pickup.time.local_time”local_time:
string
Format: date-time
Description
Section titled “Description”The local time in the relevant location in the ISO 8601 format.
CarRentalBookingData.ReservationDetails.pickup.time.timestamp?
Section titled “CarRentalBookingData.ReservationDetails.pickup.time.timestamp?”
optionaltimestamp?:string|null
Format: date-time
Description
Section titled “Description”An ISO 8601 timestamp.
Example
Section titled “Example”2017-12-27T15:42:30ZCarRentalBookingData.ReservationDetails.rental_company?
Section titled “CarRentalBookingData.ReservationDetails.rental_company?”
optionalrental_company?:string|null
Description
Section titled “Description”Name of car rental company.
Example
Section titled “Example”Catch-A-RideLodgingBookingData
Section titled “LodgingBookingData”LodgingBookingData:
object
Description
Section titled “Description”Lodging-specific booking information.
LodgingBookingData.lodging_details
Section titled “LodgingBookingData.lodging_details”lodging_details:
object
LodgingBookingData.lodging_details.brand_name?
Section titled “LodgingBookingData.lodging_details.brand_name?”
optionalbrand_name?:string|null
Description
Section titled “Description”The brand name of the hotel.
Example
Section titled “Example”Marriott HotelsLodgingBookingData.lodging_details.chain_name?
Section titled “LodgingBookingData.lodging_details.chain_name?”
optionalchain_name?:string|null
Description
Section titled “Description”The name of the hotel chain.
Example
Section titled “Example”Accor HotelsLodgingBookingData.lodging_details.contact_information?
Section titled “LodgingBookingData.lodging_details.contact_information?”
optionalcontact_information?:object
LodgingBookingData.lodging_details.contact_information.email?
Section titled “LodgingBookingData.lodging_details.contact_information.email?”
optionalemail?:string|null
Description
Section titled “Description”The email address of the venue.
Example
Section titled “Example”city@hotelchain.comLodgingBookingData.lodging_details.contact_information.fax?
Section titled “LodgingBookingData.lodging_details.contact_information.fax?”
optionalfax?:string|null
Description
Section titled “Description”The fax number of the venue.
Example
Section titled “Example”12345554321LodgingBookingData.lodging_details.contact_information.phone?
Section titled “LodgingBookingData.lodging_details.contact_information.phone?”
optionalphone?:string|null
Description
Section titled “Description”The phone number of the venue.
Example
Section titled “Example”12345554321LodgingBookingData.lodging_details.display_name
Section titled “LodgingBookingData.lodging_details.display_name”display_name:
string
Description
Section titled “Description”The name of the venue as displayed to the user.
Example
Section titled “Example”Fancy HotelLodgingBookingData.lodging_details.location?
Section titled “LodgingBookingData.lodging_details.location?”
optionallocation?:object
LodgingBookingData.lodging_details.location.address_line_1?
Section titled “LodgingBookingData.lodging_details.location.address_line_1?”
optionaladdress_line_1?:string|null
Description
Section titled “Description”The first line of the address.
Example
Section titled “Example”Av. Vinte de Janeiro, S/NLodgingBookingData.lodging_details.location.address_line_2?
Section titled “LodgingBookingData.lodging_details.location.address_line_2?”
optionaladdress_line_2?:string|null
Description
Section titled “Description”The second line of the address.
Example
Section titled “Example”Ilha do GovernadorLodgingBookingData.lodging_details.location.administrative_area?
Section titled “LodgingBookingData.lodging_details.location.administrative_area?”
optionaladministrative_area?:string|null
Description
Section titled “Description”Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name.
Example
Section titled “Example”RJLodgingBookingData.lodging_details.location.city?
Section titled “LodgingBookingData.lodging_details.location.city?”
optionalcity?:string|null
Description
Section titled “Description”The city where the address is located.
Example
Section titled “Example”Rio de JaneiroLodgingBookingData.lodging_details.location.coordinates?
Section titled “LodgingBookingData.lodging_details.location.coordinates?”
optionalcoordinates?:object
LodgingBookingData.lodging_details.location.coordinates.latitude
Section titled “LodgingBookingData.lodging_details.location.coordinates.latitude”latitude:
number
Format: double
Example
Section titled “Example”-22.8145373LodgingBookingData.lodging_details.location.coordinates.longitude
Section titled “LodgingBookingData.lodging_details.location.coordinates.longitude”longitude:
number
Format: double
Example
Section titled “Example”-43.2465548LodgingBookingData.lodging_details.location.country?
Section titled “LodgingBookingData.lodging_details.location.country?”
optionalcountry?:string|null
Description
Section titled “Description”The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country.
Example
Section titled “Example”BrazilLodgingBookingData.lodging_details.location.postal_code?
Section titled “LodgingBookingData.lodging_details.location.postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”The postal code of the given address.
Example
Section titled “Example”21941-900LodgingBookingData.lodging_details.location.timezone?
Section titled “LodgingBookingData.lodging_details.location.timezone?”
optionaltimezone?:string|null
Description
Section titled “Description”The timezone in the given address.
Example
Section titled “Example”America/Sao_PauloLodgingBookingData.lodging_details.star_rating?
Section titled “LodgingBookingData.lodging_details.star_rating?”
optionalstar_rating?:number|null
Format: float
Description
Section titled “Description”The star rating of the hotel. Some hotels have half stars.
Example
Section titled “Example”3.5LodgingBookingData.reservation_details
Section titled “LodgingBookingData.reservation_details”reservation_details:
object
LodgingBookingData.reservation_details.check_in_time
Section titled “LodgingBookingData.reservation_details.check_in_time”check_in_time:
object
LodgingBookingData.reservation_details.check_in_time.local_time
Section titled “LodgingBookingData.reservation_details.check_in_time.local_time”local_time:
string
Format: date-time
Description
Section titled “Description”The local time in the relevant location in the ISO 8601 format.
LodgingBookingData.reservation_details.check_in_time.timestamp?
Section titled “LodgingBookingData.reservation_details.check_in_time.timestamp?”
optionaltimestamp?:string|null
Format: date-time
Description
Section titled “Description”An ISO 8601 timestamp.
Example
Section titled “Example”2017-12-27T15:42:30ZLodgingBookingData.reservation_details.checkout_time
Section titled “LodgingBookingData.reservation_details.checkout_time”checkout_time:
object
LodgingBookingData.reservation_details.checkout_time.local_time
Section titled “LodgingBookingData.reservation_details.checkout_time.local_time”local_time:
string
Format: date-time
Description
Section titled “Description”The local time in the relevant location in the ISO 8601 format.
LodgingBookingData.reservation_details.checkout_time.timestamp?
Section titled “LodgingBookingData.reservation_details.checkout_time.timestamp?”
optionaltimestamp?:string|null
Format: date-time
Description
Section titled “Description”An ISO 8601 timestamp.
Example
Section titled “Example”2017-12-27T15:42:30ZLodgingBookingData.reservation_details.confirmation_code?
Section titled “LodgingBookingData.reservation_details.confirmation_code?”
optionalconfirmation_code?:string|null
Description
Section titled “Description”Confirmation code provided by the vendor.
Example
Section titled “Example”7003XBQ504LodgingBookingData.reservation_details.room?
Section titled “LodgingBookingData.reservation_details.room?”
optionalroom?:object
LodgingBookingData.reservation_details.room.bed_count?
Section titled “LodgingBookingData.reservation_details.room.bed_count?”
optionalbed_count?:number|null
Format: int32
Description
Section titled “Description”The number of beds.
Example
Section titled “Example”1LodgingBookingData.reservation_details.room.bed_type?
Section titled “LodgingBookingData.reservation_details.room.bed_type?”
optionalbed_type?:string|null
Description
Section titled “Description”The kind of bed.
Example
Section titled “Example”DOUBLELodgingBookingData.reservation_details.room.description?
Section titled “LodgingBookingData.reservation_details.room.description?”
optionaldescription?:string|null
Description
Section titled “Description”A description of the room.
Example
Section titled “Example”Superior roomLodgingBookingData.reservation_details.room.display_name?
Section titled “LodgingBookingData.reservation_details.room.display_name?”
optionaldisplay_name?:string|null
Description
Section titled “Description”The name of the room as displayed to the user.
Example
Section titled “Example”Standard roomLodgingBookingData.type
Section titled “LodgingBookingData.type”type:
"LODGING"
Description
Section titled “Description”discriminator enum property added by openapi-typescript
LodgingBookingData.ContactInfo
Section titled “LodgingBookingData.ContactInfo”LodgingBookingData.ContactInfo:
object
Description
Section titled “Description”Contact information of a venue.
LodgingBookingData.ContactInfo.email?
Section titled “LodgingBookingData.ContactInfo.email?”
optionalemail?:string|null
Description
Section titled “Description”The email address of the venue.
Example
Section titled “Example”city@hotelchain.comLodgingBookingData.ContactInfo.fax?
Section titled “LodgingBookingData.ContactInfo.fax?”
optionalfax?:string|null
Description
Section titled “Description”The fax number of the venue.
Example
Section titled “Example”12345554321LodgingBookingData.ContactInfo.phone?
Section titled “LodgingBookingData.ContactInfo.phone?”
optionalphone?:string|null
Description
Section titled “Description”The phone number of the venue.
Example
Section titled “Example”12345554321LodgingBookingData.LodgingDetails
Section titled “LodgingBookingData.LodgingDetails”LodgingBookingData.LodgingDetails:
object
Description
Section titled “Description”Information on a lodging venue.
LodgingBookingData.LodgingDetails.brand_name?
Section titled “LodgingBookingData.LodgingDetails.brand_name?”
optionalbrand_name?:string|null
Description
Section titled “Description”The brand name of the hotel.
Example
Section titled “Example”Marriott HotelsLodgingBookingData.LodgingDetails.chain_name?
Section titled “LodgingBookingData.LodgingDetails.chain_name?”
optionalchain_name?:string|null
Description
Section titled “Description”The name of the hotel chain.
Example
Section titled “Example”Accor HotelsLodgingBookingData.LodgingDetails.contact_information?
Section titled “LodgingBookingData.LodgingDetails.contact_information?”
optionalcontact_information?:object
LodgingBookingData.LodgingDetails.contact_information.email?
Section titled “LodgingBookingData.LodgingDetails.contact_information.email?”
optionalemail?:string|null
Description
Section titled “Description”The email address of the venue.
Example
Section titled “Example”city@hotelchain.comLodgingBookingData.LodgingDetails.contact_information.fax?
Section titled “LodgingBookingData.LodgingDetails.contact_information.fax?”
optionalfax?:string|null
Description
Section titled “Description”The fax number of the venue.
Example
Section titled “Example”12345554321LodgingBookingData.LodgingDetails.contact_information.phone?
Section titled “LodgingBookingData.LodgingDetails.contact_information.phone?”
optionalphone?:string|null
Description
Section titled “Description”The phone number of the venue.
Example
Section titled “Example”12345554321LodgingBookingData.LodgingDetails.display_name
Section titled “LodgingBookingData.LodgingDetails.display_name”display_name:
string
Description
Section titled “Description”The name of the venue as displayed to the user.
Example
Section titled “Example”Fancy HotelLodgingBookingData.LodgingDetails.location?
Section titled “LodgingBookingData.LodgingDetails.location?”
optionallocation?:object
LodgingBookingData.LodgingDetails.location.address_line_1?
Section titled “LodgingBookingData.LodgingDetails.location.address_line_1?”
optionaladdress_line_1?:string|null
Description
Section titled “Description”The first line of the address.
Example
Section titled “Example”Av. Vinte de Janeiro, S/NLodgingBookingData.LodgingDetails.location.address_line_2?
Section titled “LodgingBookingData.LodgingDetails.location.address_line_2?”
optionaladdress_line_2?:string|null
Description
Section titled “Description”The second line of the address.
Example
Section titled “Example”Ilha do GovernadorLodgingBookingData.LodgingDetails.location.administrative_area?
Section titled “LodgingBookingData.LodgingDetails.location.administrative_area?”
optionaladministrative_area?:string|null
Description
Section titled “Description”Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name.
Example
Section titled “Example”RJLodgingBookingData.LodgingDetails.location.city?
Section titled “LodgingBookingData.LodgingDetails.location.city?”
optionalcity?:string|null
Description
Section titled “Description”The city where the address is located.
Example
Section titled “Example”Rio de JaneiroLodgingBookingData.LodgingDetails.location.coordinates?
Section titled “LodgingBookingData.LodgingDetails.location.coordinates?”
optionalcoordinates?:object
LodgingBookingData.LodgingDetails.location.coordinates.latitude
Section titled “LodgingBookingData.LodgingDetails.location.coordinates.latitude”latitude:
number
Format: double
Example
Section titled “Example”-22.8145373LodgingBookingData.LodgingDetails.location.coordinates.longitude
Section titled “LodgingBookingData.LodgingDetails.location.coordinates.longitude”longitude:
number
Format: double
Example
Section titled “Example”-43.2465548LodgingBookingData.LodgingDetails.location.country?
Section titled “LodgingBookingData.LodgingDetails.location.country?”
optionalcountry?:string|null
Description
Section titled “Description”The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country.
Example
Section titled “Example”BrazilLodgingBookingData.LodgingDetails.location.postal_code?
Section titled “LodgingBookingData.LodgingDetails.location.postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”The postal code of the given address.
Example
Section titled “Example”21941-900LodgingBookingData.LodgingDetails.location.timezone?
Section titled “LodgingBookingData.LodgingDetails.location.timezone?”
optionaltimezone?:string|null
Description
Section titled “Description”The timezone in the given address.
Example
Section titled “Example”America/Sao_PauloLodgingBookingData.LodgingDetails.star_rating?
Section titled “LodgingBookingData.LodgingDetails.star_rating?”
optionalstar_rating?:number|null
Format: float
Description
Section titled “Description”The star rating of the hotel. Some hotels have half stars.
Example
Section titled “Example”3.5LodgingBookingData.ReservationDetails
Section titled “LodgingBookingData.ReservationDetails”LodgingBookingData.ReservationDetails:
object
Description
Section titled “Description”Information on a reservation such as check-in, checkout, etc.
LodgingBookingData.ReservationDetails.check_in_time
Section titled “LodgingBookingData.ReservationDetails.check_in_time”check_in_time:
object
LodgingBookingData.ReservationDetails.check_in_time.local_time
Section titled “LodgingBookingData.ReservationDetails.check_in_time.local_time”local_time:
string
Format: date-time
Description
Section titled “Description”The local time in the relevant location in the ISO 8601 format.
LodgingBookingData.ReservationDetails.check_in_time.timestamp?
Section titled “LodgingBookingData.ReservationDetails.check_in_time.timestamp?”
optionaltimestamp?:string|null
Format: date-time
Description
Section titled “Description”An ISO 8601 timestamp.
Example
Section titled “Example”2017-12-27T15:42:30ZLodgingBookingData.ReservationDetails.checkout_time
Section titled “LodgingBookingData.ReservationDetails.checkout_time”checkout_time:
object
LodgingBookingData.ReservationDetails.checkout_time.local_time
Section titled “LodgingBookingData.ReservationDetails.checkout_time.local_time”local_time:
string
Format: date-time
Description
Section titled “Description”The local time in the relevant location in the ISO 8601 format.
LodgingBookingData.ReservationDetails.checkout_time.timestamp?
Section titled “LodgingBookingData.ReservationDetails.checkout_time.timestamp?”
optionaltimestamp?:string|null
Format: date-time
Description
Section titled “Description”An ISO 8601 timestamp.
Example
Section titled “Example”2017-12-27T15:42:30ZLodgingBookingData.ReservationDetails.confirmation_code?
Section titled “LodgingBookingData.ReservationDetails.confirmation_code?”
optionalconfirmation_code?:string|null
Description
Section titled “Description”Confirmation code provided by the vendor.
Example
Section titled “Example”7003XBQ504LodgingBookingData.ReservationDetails.room?
Section titled “LodgingBookingData.ReservationDetails.room?”
optionalroom?:object
LodgingBookingData.ReservationDetails.room.bed_count?
Section titled “LodgingBookingData.ReservationDetails.room.bed_count?”
optionalbed_count?:number|null
Format: int32
Description
Section titled “Description”The number of beds.
Example
Section titled “Example”1LodgingBookingData.ReservationDetails.room.bed_type?
Section titled “LodgingBookingData.ReservationDetails.room.bed_type?”
optionalbed_type?:string|null
Description
Section titled “Description”The kind of bed.
Example
Section titled “Example”DOUBLELodgingBookingData.ReservationDetails.room.description?
Section titled “LodgingBookingData.ReservationDetails.room.description?”
optionaldescription?:string|null
Description
Section titled “Description”A description of the room.
Example
Section titled “Example”Superior roomLodgingBookingData.ReservationDetails.room.display_name?
Section titled “LodgingBookingData.ReservationDetails.room.display_name?”
optionaldisplay_name?:string|null
Description
Section titled “Description”The name of the room as displayed to the user.
Example
Section titled “Example”Standard roomLodgingBookingData.Room
Section titled “LodgingBookingData.Room”LodgingBookingData.Room:
object
Description
Section titled “Description”Information on a room that was booked.
LodgingBookingData.Room.bed_count?
Section titled “LodgingBookingData.Room.bed_count?”
optionalbed_count?:number|null
Format: int32
Description
Section titled “Description”The number of beds.
Example
Section titled “Example”1LodgingBookingData.Room.bed_type?
Section titled “LodgingBookingData.Room.bed_type?”
optionalbed_type?:string|null
Description
Section titled “Description”The kind of bed.
Example
Section titled “Example”DOUBLELodgingBookingData.Room.description?
Section titled “LodgingBookingData.Room.description?”
optionaldescription?:string|null
Description
Section titled “Description”A description of the room.
Example
Section titled “Example”Superior roomLodgingBookingData.Room.display_name?
Section titled “LodgingBookingData.Room.display_name?”
optionaldisplay_name?:string|null
Description
Section titled “Description”The name of the room as displayed to the user.
Example
Section titled “Example”Standard roomPage_Booking_
Section titled “Page_Booking_”Page_Booking_:
object
Page_Booking_.items
Section titled “Page_Booking_.items”items:
object[]
Page_Booking_.next_cursor?
Section titled “Page_Booking_.next_cursor?”
optionalnext_cursor?:string|null
Page_Trip_
Section titled “Page_Trip_”Page_Trip_:
object
Page_Trip_.items
Section titled “Page_Trip_.items”items:
object[]
Page_Trip_.next_cursor?
Section titled “Page_Trip_.next_cursor?”
optionalnext_cursor?:string|null
RailBookingData
Section titled “RailBookingData”RailBookingData:
object
Description
Section titled “Description”Rail-specific booking information.
RailBookingData.journeys
Section titled “RailBookingData.journeys”journeys:
object[]
Description
Section titled “Description”The journeys that make up this booking.
RailBookingData.type
Section titled “RailBookingData.type”type:
"RAIL"
Description
Section titled “Description”discriminator enum property added by openapi-typescript
RailBookingData.RailClass
Section titled “RailBookingData.RailClass”RailBookingData.RailClass:
"EXECUTIVE"|"BUSINESS"|"FIRST"|"STANDARD"|"SLEEPER"|"STANDARD_PREMIUM"|"BUSINESS_PREMIUM"|"COACH"|"ROOM"
Description
Section titled “Description”The class of travel for a rail leg.
Example
Section titled “Example”SLEEPER@enum {string}RailBookingData.RailJourney
Section titled “RailBookingData.RailJourney”RailBookingData.RailJourney:
object
Description
Section titled “Description”A journey is composed of the legs that take a passenger from an origin to a final destination. E.g. if a traveler is going from Aberdeen to London, but they need to change trains in Edinburgh, the booking will contain 1 journey composed of 2 legs. The first leg is Aberdeen to Edinburgh, and the second is Edinburgh to London.
RailBookingData.RailJourney.legs
Section titled “RailBookingData.RailJourney.legs”legs:
object[]
Description
Section titled “Description”The legs that make up this journey.
RailBookingData.RailLeg
Section titled “RailBookingData.RailLeg”RailBookingData.RailLeg:
object
Description
Section titled “Description”A leg is a portion of the journey between two consecutive stops.
RailBookingData.RailLeg.arrival_time
Section titled “RailBookingData.RailLeg.arrival_time”arrival_time:
object
RailBookingData.RailLeg.arrival_time.local_time
Section titled “RailBookingData.RailLeg.arrival_time.local_time”local_time:
string
Format: date-time
Description
Section titled “Description”The local time in the relevant location in the ISO 8601 format.
RailBookingData.RailLeg.arrival_time.timestamp?
Section titled “RailBookingData.RailLeg.arrival_time.timestamp?”
optionaltimestamp?:string|null
Format: date-time
Description
Section titled “Description”An ISO 8601 timestamp.
Example
Section titled “Example”2017-12-27T15:42:30ZRailBookingData.RailLeg.departure_time
Section titled “RailBookingData.RailLeg.departure_time”departure_time:
object
RailBookingData.RailLeg.departure_time.local_time
Section titled “RailBookingData.RailLeg.departure_time.local_time”local_time:
string
Format: date-time
Description
Section titled “Description”The local time in the relevant location in the ISO 8601 format.
RailBookingData.RailLeg.departure_time.timestamp?
Section titled “RailBookingData.RailLeg.departure_time.timestamp?”
optionaltimestamp?:string|null
Format: date-time
Description
Section titled “Description”An ISO 8601 timestamp.
Example
Section titled “Example”2017-12-27T15:42:30ZRailBookingData.RailLeg.destination
Section titled “RailBookingData.RailLeg.destination”destination:
object
RailBookingData.RailLeg.destination.location?
Section titled “RailBookingData.RailLeg.destination.location?”
optionallocation?:object
RailBookingData.RailLeg.destination.location.address_line_1?
Section titled “RailBookingData.RailLeg.destination.location.address_line_1?”
optionaladdress_line_1?:string|null
Description
Section titled “Description”The first line of the address.
Example
Section titled “Example”Av. Vinte de Janeiro, S/NRailBookingData.RailLeg.destination.location.address_line_2?
Section titled “RailBookingData.RailLeg.destination.location.address_line_2?”
optionaladdress_line_2?:string|null
Description
Section titled “Description”The second line of the address.
Example
Section titled “Example”Ilha do GovernadorRailBookingData.RailLeg.destination.location.administrative_area?
Section titled “RailBookingData.RailLeg.destination.location.administrative_area?”
optionaladministrative_area?:string|null
Description
Section titled “Description”Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name.
Example
Section titled “Example”RJRailBookingData.RailLeg.destination.location.city?
Section titled “RailBookingData.RailLeg.destination.location.city?”
optionalcity?:string|null
Description
Section titled “Description”The city where the address is located.
Example
Section titled “Example”Rio de JaneiroRailBookingData.RailLeg.destination.location.coordinates?
Section titled “RailBookingData.RailLeg.destination.location.coordinates?”
optionalcoordinates?:object
RailBookingData.RailLeg.destination.location.coordinates.latitude
Section titled “RailBookingData.RailLeg.destination.location.coordinates.latitude”latitude:
number
Format: double
Example
Section titled “Example”-22.8145373RailBookingData.RailLeg.destination.location.coordinates.longitude
Section titled “RailBookingData.RailLeg.destination.location.coordinates.longitude”longitude:
number
Format: double
Example
Section titled “Example”-43.2465548RailBookingData.RailLeg.destination.location.country?
Section titled “RailBookingData.RailLeg.destination.location.country?”
optionalcountry?:string|null
Description
Section titled “Description”The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country.
Example
Section titled “Example”BrazilRailBookingData.RailLeg.destination.location.postal_code?
Section titled “RailBookingData.RailLeg.destination.location.postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”The postal code of the given address.
Example
Section titled “Example”21941-900RailBookingData.RailLeg.destination.location.timezone?
Section titled “RailBookingData.RailLeg.destination.location.timezone?”
optionaltimezone?:string|null
Description
Section titled “Description”The timezone in the given address.
Example
Section titled “Example”America/Sao_PauloRailBookingData.RailLeg.destination.name?
Section titled “RailBookingData.RailLeg.destination.name?”
optionalname?:string|null
Description
Section titled “Description”The name of the station.
Example
Section titled “Example”London - King's CrossRailBookingData.RailLeg.destination.type?
Section titled “RailBookingData.RailLeg.destination.type?”
optionaltype?:"INDIVIDUAL"|"GROUP"|"METRO"|"BUS_STOP"|"FERRY_TERMINAL"
RailBookingData.RailLeg.duration?
Section titled “RailBookingData.RailLeg.duration?”
optionalduration?:string|null
Description
Section titled “Description”PT4h20M
Example
Section titled “Example”PT4h20MRailBookingData.RailLeg.origin
Section titled “RailBookingData.RailLeg.origin”origin:
object
RailBookingData.RailLeg.origin.location?
Section titled “RailBookingData.RailLeg.origin.location?”
optionallocation?:object
RailBookingData.RailLeg.origin.location.address_line_1?
Section titled “RailBookingData.RailLeg.origin.location.address_line_1?”
optionaladdress_line_1?:string|null
Description
Section titled “Description”The first line of the address.
Example
Section titled “Example”Av. Vinte de Janeiro, S/NRailBookingData.RailLeg.origin.location.address_line_2?
Section titled “RailBookingData.RailLeg.origin.location.address_line_2?”
optionaladdress_line_2?:string|null
Description
Section titled “Description”The second line of the address.
Example
Section titled “Example”Ilha do GovernadorRailBookingData.RailLeg.origin.location.administrative_area?
Section titled “RailBookingData.RailLeg.origin.location.administrative_area?”
optionaladministrative_area?:string|null
Description
Section titled “Description”Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name.
Example
Section titled “Example”RJRailBookingData.RailLeg.origin.location.city?
Section titled “RailBookingData.RailLeg.origin.location.city?”
optionalcity?:string|null
Description
Section titled “Description”The city where the address is located.
Example
Section titled “Example”Rio de JaneiroRailBookingData.RailLeg.origin.location.coordinates?
Section titled “RailBookingData.RailLeg.origin.location.coordinates?”
optionalcoordinates?:object
RailBookingData.RailLeg.origin.location.coordinates.latitude
Section titled “RailBookingData.RailLeg.origin.location.coordinates.latitude”latitude:
number
Format: double
Example
Section titled “Example”-22.8145373RailBookingData.RailLeg.origin.location.coordinates.longitude
Section titled “RailBookingData.RailLeg.origin.location.coordinates.longitude”longitude:
number
Format: double
Example
Section titled “Example”-43.2465548RailBookingData.RailLeg.origin.location.country?
Section titled “RailBookingData.RailLeg.origin.location.country?”
optionalcountry?:string|null
Description
Section titled “Description”The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country.
Example
Section titled “Example”BrazilRailBookingData.RailLeg.origin.location.postal_code?
Section titled “RailBookingData.RailLeg.origin.location.postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”The postal code of the given address.
Example
Section titled “Example”21941-900RailBookingData.RailLeg.origin.location.timezone?
Section titled “RailBookingData.RailLeg.origin.location.timezone?”
optionaltimezone?:string|null
Description
Section titled “Description”The timezone in the given address.
Example
Section titled “Example”America/Sao_PauloRailBookingData.RailLeg.origin.name?
Section titled “RailBookingData.RailLeg.origin.name?”
optionalname?:string|null
Description
Section titled “Description”The name of the station.
Example
Section titled “Example”London - King's CrossRailBookingData.RailLeg.origin.type?
Section titled “RailBookingData.RailLeg.origin.type?”
optionaltype?:"INDIVIDUAL"|"GROUP"|"METRO"|"BUS_STOP"|"FERRY_TERMINAL"
RailBookingData.RailLeg.rail_class?
Section titled “RailBookingData.RailLeg.rail_class?”
optionalrail_class?:"EXECUTIVE"|"BUSINESS"|"FIRST"|"STANDARD"|"SLEEPER"|"STANDARD_PREMIUM"|"BUSINESS_PREMIUM"|"COACH"|"ROOM"
RailBookingData.RailLeg.seat?
Section titled “RailBookingData.RailLeg.seat?”
optionalseat?:object
RailBookingData.RailLeg.seat.coach_number?
Section titled “RailBookingData.RailLeg.seat.coach_number?”
optionalcoach_number?:string|null
Description
Section titled “Description”The number of the coach.
Example
Section titled “Example”12RailBookingData.RailLeg.seat.seat_number?
Section titled “RailBookingData.RailLeg.seat.seat_number?”
optionalseat_number?:string|null
Description
Section titled “Description”The number of the seat.
Example
Section titled “Example”41RailBookingData.RailLeg.vehicle?
Section titled “RailBookingData.RailLeg.vehicle?”
optionalvehicle?:object
RailBookingData.RailLeg.vehicle.carrier?
Section titled “RailBookingData.RailLeg.vehicle.carrier?”
optionalcarrier?:string|null
Description
Section titled “Description”The carrier that operates this leg. E.g. Amtrak, Thameslink.
Example
Section titled “Example”AmtrakRailBookingData.RailLeg.vehicle.timetable_id?
Section titled “RailBookingData.RailLeg.vehicle.timetable_id?”
optionaltimetable_id?:string|null
Description
Section titled “Description”The timetable ID for the vehicle. The concept is similar to a flight number.
Example
Section titled “Example”L79727RailBookingData.RailLeg.vehicle.type?
Section titled “RailBookingData.RailLeg.vehicle.type?”
optionaltype?:"METRO"|"TRAIN"|"BUS"|"FERRY"|"WALK"|"TAXI"|"TRAM"|"TUBE"
RailBookingData.RailSeat
Section titled “RailBookingData.RailSeat”RailBookingData.RailSeat:
object
Description
Section titled “Description”A seat in a train leg.
RailBookingData.RailSeat.coach_number?
Section titled “RailBookingData.RailSeat.coach_number?”
optionalcoach_number?:string|null
Description
Section titled “Description”The number of the coach.
Example
Section titled “Example”12RailBookingData.RailSeat.seat_number?
Section titled “RailBookingData.RailSeat.seat_number?”
optionalseat_number?:string|null
Description
Section titled “Description”The number of the seat.
Example
Section titled “Example”41RailBookingData.RailStation
Section titled “RailBookingData.RailStation”RailBookingData.RailStation:
object
Description
Section titled “Description”An endpoint in a rail leg.
RailBookingData.RailStation.location?
Section titled “RailBookingData.RailStation.location?”
optionallocation?:object
RailBookingData.RailStation.location.address_line_1?
Section titled “RailBookingData.RailStation.location.address_line_1?”
optionaladdress_line_1?:string|null
Description
Section titled “Description”The first line of the address.
Example
Section titled “Example”Av. Vinte de Janeiro, S/NRailBookingData.RailStation.location.address_line_2?
Section titled “RailBookingData.RailStation.location.address_line_2?”
optionaladdress_line_2?:string|null
Description
Section titled “Description”The second line of the address.
Example
Section titled “Example”Ilha do GovernadorRailBookingData.RailStation.location.administrative_area?
Section titled “RailBookingData.RailStation.location.administrative_area?”
optionaladministrative_area?:string|null
Description
Section titled “Description”Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name.
Example
Section titled “Example”RJRailBookingData.RailStation.location.city?
Section titled “RailBookingData.RailStation.location.city?”
optionalcity?:string|null
Description
Section titled “Description”The city where the address is located.
Example
Section titled “Example”Rio de JaneiroRailBookingData.RailStation.location.coordinates?
Section titled “RailBookingData.RailStation.location.coordinates?”
optionalcoordinates?:object
RailBookingData.RailStation.location.coordinates.latitude
Section titled “RailBookingData.RailStation.location.coordinates.latitude”latitude:
number
Format: double
Example
Section titled “Example”-22.8145373RailBookingData.RailStation.location.coordinates.longitude
Section titled “RailBookingData.RailStation.location.coordinates.longitude”longitude:
number
Format: double
Example
Section titled “Example”-43.2465548RailBookingData.RailStation.location.country?
Section titled “RailBookingData.RailStation.location.country?”
optionalcountry?:string|null
Description
Section titled “Description”The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country.
Example
Section titled “Example”BrazilRailBookingData.RailStation.location.postal_code?
Section titled “RailBookingData.RailStation.location.postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”The postal code of the given address.
Example
Section titled “Example”21941-900RailBookingData.RailStation.location.timezone?
Section titled “RailBookingData.RailStation.location.timezone?”
optionaltimezone?:string|null
Description
Section titled “Description”The timezone in the given address.
Example
Section titled “Example”America/Sao_PauloRailBookingData.RailStation.name?
Section titled “RailBookingData.RailStation.name?”
optionalname?:string|null
Description
Section titled “Description”The name of the station.
Example
Section titled “Example”London - King's CrossRailBookingData.RailStation.type?
Section titled “RailBookingData.RailStation.type?”
optionaltype?:"INDIVIDUAL"|"GROUP"|"METRO"|"BUS_STOP"|"FERRY_TERMINAL"
RailBookingData.RailStationType
Section titled “RailBookingData.RailStationType”RailBookingData.RailStationType:
"INDIVIDUAL"|"GROUP"|"METRO"|"BUS_STOP"|"FERRY_TERMINAL"
Description
Section titled “Description”The kind of station. Some rail itineraries include taking a bus or walking between stations, and these are represented as legs in the journey.
* INDIVIDUAL - A regular train station.
* GROUP - Stations grouped together, usually in a major European city. E.g. “London, Any”.
* METRO - A metro/subway station.
* BUS_STOP - A bus stop.
* FERRY_TERMINAL - A ferry terminal.
Example
Section titled “Example”INDIVIDUAL@enum {string}RailBookingData.Vehicle
Section titled “RailBookingData.Vehicle”RailBookingData.Vehicle:
object
Description
Section titled “Description”A vehicle used in a train leg. Some rail itineraries include taking a bus or walking between stations, and these are represented as legs in the journey.
RailBookingData.Vehicle.carrier?
Section titled “RailBookingData.Vehicle.carrier?”
optionalcarrier?:string|null
Description
Section titled “Description”The carrier that operates this leg. E.g. Amtrak, Thameslink.
Example
Section titled “Example”AmtrakRailBookingData.Vehicle.timetable_id?
Section titled “RailBookingData.Vehicle.timetable_id?”
optionaltimetable_id?:string|null
Description
Section titled “Description”The timetable ID for the vehicle. The concept is similar to a flight number.
Example
Section titled “Example”L79727RailBookingData.Vehicle.type?
Section titled “RailBookingData.Vehicle.type?”
optionaltype?:"METRO"|"TRAIN"|"BUS"|"FERRY"|"WALK"|"TAXI"|"TRAM"|"TUBE"
RailBookingData.VehicleType
Section titled “RailBookingData.VehicleType”RailBookingData.VehicleType:
"METRO"|"TRAIN"|"BUS"|"FERRY"|"WALK"|"TAXI"|"TRAM"|"TUBE"
Description
Section titled “Description”The kind of vehicle to be used in a leg. Some rail itineraries include taking a bus or walking between stations, and these are represented as legs in the journey.
* TRAIN - A regular train.
* BUS - A bus.
* FERRY - A ferry.
* WALK- Walking between stations.
* TAXI - A taxi between stations.
* TRAM - Tram/light rail.
* METRO - Metro/subway.
* TUBE - London underground.
Example
Section titled “Example”TRAIN@enum {string}Traveler
Section titled “Traveler”Traveler:
object
Description
Section titled “Description”Information on the person who will be traveling.
Traveler.guest_email?
Section titled “Traveler.guest_email?”
optionalguest_email?:string|null
Description
Section titled “Description”If the traveler is a guest, this is their email.
Example
Section titled “Example”guest@gmail.comTraveler.name?
Section titled “Traveler.name?”
optionalname?:object
Traveler.name.first_name?
Section titled “Traveler.name.first_name?”
optionalfirst_name?:string
Description
Section titled “Description”The traveler’s first name.
Example
Section titled “Example”JohnTraveler.name.last_name?
Section titled “Traveler.name.last_name?”
optionallast_name?:string
Description
Section titled “Description”The traveler’s last name.
Example
Section titled “Example”DoeTraveler.name.middle_name?
Section titled “Traveler.name.middle_name?”
optionalmiddle_name?:string|null
Description
Section titled “Description”The traveler’s middle name.
Example
Section titled “Example”PaulTraveler.name.suffix?
Section titled “Traveler.name.suffix?”
optionalsuffix?:string|null
Description
Section titled “Description”The suffix in the traveler’s name.
Example
Section titled “Example”Jr.Traveler.type
Section titled “Traveler.type”type:
"EMPLOYEE"|"GUEST"
Traveler.user_id?
Section titled “Traveler.user_id?”
optionaluser_id?:string|null
Description
Section titled “Description”If the traveler is an employee, this is their user ID.
Example
Section titled “Example”cuuser_cky0xs54b004h01pidi0pcuz1Traveler.Name
Section titled “Traveler.Name”Traveler.Name:
object
Description
Section titled “Description”The name of the traveler.
Traveler.Name.first_name?
Section titled “Traveler.Name.first_name?”
optionalfirst_name?:string
Description
Section titled “Description”The traveler’s first name.
Example
Section titled “Example”JohnTraveler.Name.last_name?
Section titled “Traveler.Name.last_name?”
optionallast_name?:string
Description
Section titled “Description”The traveler’s last name.
Example
Section titled “Example”DoeTraveler.Name.middle_name?
Section titled “Traveler.Name.middle_name?”
optionalmiddle_name?:string|null
Description
Section titled “Description”The traveler’s middle name.
Example
Section titled “Example”PaulTraveler.Name.suffix?
Section titled “Traveler.Name.suffix?”
optionalsuffix?:string|null
Description
Section titled “Description”The suffix in the traveler’s name.
Example
Section titled “Example”Jr.Traveler.Type
Section titled “Traveler.Type”Traveler.Type:
"EMPLOYEE"|"GUEST"
Description
Section titled “Description”Whether the trip is for an employee or a guest.
Example
Section titled “Example”EMPLOYEE@enum {string}Trip:
object
Description
Section titled “Description”A trip representation.
Trip.billable_at?
Section titled “Trip.billable_at?”
optionalbillable_at?:string|null
Format: date-time
Description
Section titled “Description”The time when the trip became billable. If absent, the trip is currently not billable.
Example
Section titled “Example”2017-12-27T15:42:30ZTrip.booker_user_id
Section titled “Trip.booker_user_id”booker_user_id:
string
Description
Section titled “Description”The ID of the user who booked the trip. If the trip was created on copilot mode, this will be the ID of the user on behalf of whom the trip was booked.
Example
Section titled “Example”cuuser_cky0xs54b004h01pidi0pcuz1Trip.created_at
Section titled “Trip.created_at”created_at:
string
Format: date-time
Description
Section titled “Description”The time when the trip was created.
Example
Section titled “Example”2017-12-27T15:42:30ZTrip.ends_at?
Section titled “Trip.ends_at?”
optionalends_at?:string|null
Format: date-time
Description
Section titled “Description”The time when the last booking in the trip ends.
Example
Section titled “Example”2017-12-27T15:42:30ZTrip.id
Section titled “Trip.id”id:
string
Description
Section titled “Description”The ID of the trip.
Example
Section titled “Example”trip_cl9rh1n8g001e0j84w6fb4fd1Trip.name?
Section titled “Trip.name?”
optionalname?:string|null
Description
Section titled “Description”The name of the trip as seen in the dashboard.
Example
Section titled “Example”Trip to Rio de JaneiroTrip.starts_at?
Section titled “Trip.starts_at?”
optionalstarts_at?:string|null
Format: date-time
Description
Section titled “Description”The time when the first booking in the trip starts.
Example
Section titled “Example”2017-12-27T15:42:30ZTrip.status
Section titled “Trip.status”status:
"DELETED"|"INVITED"|"PROCESSING"|"CANCELED"|"REFUNDED"|"DRAFT"|"IN_PROGRESS"|"APPROVAL_DENIED"|"PENDING"|"HOLD"|"COMPLETED"|"VOIDED"|"UNCONFIRMED"|"AIRLINE_CONTROL"|"PAYMENT_DECLINED"|"SCHEDULE_CHANGE"|"APPROVAL_REQUESTED"|"CANCELLATION_IN_PROGRESS"|"UPCOMING"
Trip.traveler?
Section titled “Trip.traveler?”
optionaltraveler?:object
Trip.traveler.guest_email?
Section titled “Trip.traveler.guest_email?”
optionalguest_email?:string|null
Description
Section titled “Description”If the traveler is a guest, this is their email.
Example
Section titled “Example”guest@gmail.comTrip.traveler.name?
Section titled “Trip.traveler.name?”
optionalname?:object
Trip.traveler.name.first_name?
Section titled “Trip.traveler.name.first_name?”
optionalfirst_name?:string
Description
Section titled “Description”The traveler’s first name.
Example
Section titled “Example”JohnTrip.traveler.name.last_name?
Section titled “Trip.traveler.name.last_name?”
optionallast_name?:string
Description
Section titled “Description”The traveler’s last name.
Example
Section titled “Example”DoeTrip.traveler.name.middle_name?
Section titled “Trip.traveler.name.middle_name?”
optionalmiddle_name?:string|null
Description
Section titled “Description”The traveler’s middle name.
Example
Section titled “Example”PaulTrip.traveler.name.suffix?
Section titled “Trip.traveler.name.suffix?”
optionalsuffix?:string|null
Description
Section titled “Description”The suffix in the traveler’s name.
Example
Section titled “Example”Jr.Trip.traveler.type
Section titled “Trip.traveler.type”type:
"EMPLOYEE"|"GUEST"
Trip.traveler.user_id?
Section titled “Trip.traveler.user_id?”
optionaluser_id?:string|null
Description
Section titled “Description”If the traveler is an employee, this is their user ID.
Example
Section titled “Example”cuuser_cky0xs54b004h01pidi0pcuz1Trip.updated_at
Section titled “Trip.updated_at”updated_at:
string
Format: date-time
Description
Section titled “Description”The time when the latest trip update happened.
Example
Section titled “Example”2017-12-27T15:42:30ZTrip.version
Section titled “Trip.version”version:
number
Format: int32
Description
Section titled “Description”The current version of the trip.
Example
Section titled “Example”2Trip.Status
Section titled “Trip.Status”Trip.Status:
"DELETED"|"INVITED"|"PROCESSING"|"CANCELED"|"REFUNDED"|"DRAFT"|"IN_PROGRESS"|"APPROVAL_DENIED"|"PENDING"|"HOLD"|"COMPLETED"|"VOIDED"|"UNCONFIRMED"|"AIRLINE_CONTROL"|"PAYMENT_DECLINED"|"SCHEDULE_CHANGE"|"APPROVAL_REQUESTED"|"CANCELLATION_IN_PROGRESS"|"UPCOMING"
Description
Section titled “Description”The current status of a trip.
Example
Section titled “Example”UPCOMING@enum {string}