TravelPaths
Defined in: src/travel/types.gen.ts:2
Properties
Section titled “Properties”/v1/trips
Section titled “/v1/trips”/v1/trips:
object
Defined in: src/travel/types.gen.ts:3
delete?
Section titled “delete?”
optionaldelete?:undefined
get:
object
List trips
Description
Section titled “Description”Lists trips according to the filters passed in the query string.
get.parameters
Section titled “get.parameters”parameters:
object
get.parameters.cookie?
Section titled “get.parameters.cookie?”
optionalcookie?:undefined
get.parameters.header?
Section titled “get.parameters.header?”
optionalheader?:undefined
get.parameters.path?
Section titled “get.parameters.path?”
optionalpath?:undefined
get.parameters.query?
Section titled “get.parameters.query?”
optionalquery?:object
get.parameters.query.cursor?
Section titled “get.parameters.query.cursor?”
optionalcursor?:string|null
get.parameters.query.last_updated_after?
Section titled “get.parameters.query.last_updated_after?”
optionallast_updated_after?:string|null
get.parameters.query.limit?
Section titled “get.parameters.query.limit?”
optionallimit?:number|null
get.requestBody?
Section titled “get.requestBody?”
optionalrequestBody?:undefined
get.responses
Section titled “get.responses”responses:
object
get.responses.200
Section titled “get.responses.200”200:
object
Description
Section titled “Description”A page with a list of trips.
get.responses.200.content
Section titled “get.responses.200.content”content:
object
get.responses.200.content.application/json
Section titled “get.responses.200.content.application/json”application/json:
object
get.responses.200.content.application/json.items
Section titled “get.responses.200.content.application/json.items”items:
object[]
get.responses.200.content.application/json.next_cursor?
Section titled “get.responses.200.content.application/json.next_cursor?”
optionalnext_cursor?:string|null
get.responses.200.headers
Section titled “get.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.400
Section titled “get.responses.400”400:
object
Description
Section titled “Description”Bad request
get.responses.400.content?
Section titled “get.responses.400.content?”
optionalcontent?:undefined
get.responses.400.headers
Section titled “get.responses.400.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.401
Section titled “get.responses.401”401:
object
Description
Section titled “Description”Unauthorized
get.responses.401.content?
Section titled “get.responses.401.content?”
optionalcontent?:undefined
get.responses.401.headers
Section titled “get.responses.401.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.403
Section titled “get.responses.403”403:
object
Description
Section titled “Description”Forbidden
get.responses.403.content?
Section titled “get.responses.403.content?”
optionalcontent?:undefined
get.responses.403.headers
Section titled “get.responses.403.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.500
Section titled “get.responses.500”500:
object
Description
Section titled “Description”Internal server error
get.responses.500.content?
Section titled “get.responses.500.content?”
optionalcontent?:undefined
get.responses.500.headers
Section titled “get.responses.500.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalhead?:undefined
options?
Section titled “options?”
optionaloptions?:undefined
parameters
Section titled “parameters”parameters:
object
parameters.cookie?
Section titled “parameters.cookie?”
optionalcookie?:undefined
parameters.header?
Section titled “parameters.header?”
optionalheader?:undefined
parameters.path?
Section titled “parameters.path?”
optionalpath?:undefined
parameters.query?
Section titled “parameters.query?”
optionalquery?:undefined
patch?
Section titled “patch?”
optionalpatch?:undefined
optionalpost?:undefined
optionalput?:undefined
trace?
Section titled “trace?”
optionaltrace?:undefined
/v1/trips/{trip_id}
Section titled “/v1/trips/{trip_id}”/v1/trips/{trip_id}:
object
Defined in: src/travel/types.gen.ts:23
delete?
Section titled “delete?”
optionaldelete?:undefined
get:
object
Get trip
Description
Section titled “Description”Retrieves a trip by ID.
get.parameters
Section titled “get.parameters”parameters:
object
get.parameters.cookie?
Section titled “get.parameters.cookie?”
optionalcookie?:undefined
get.parameters.header?
Section titled “get.parameters.header?”
optionalheader?:undefined
get.parameters.path
Section titled “get.parameters.path”path:
object
get.parameters.path.trip_id
Section titled “get.parameters.path.trip_id”trip_id:
string
get.parameters.query?
Section titled “get.parameters.query?”
optionalquery?:undefined
get.requestBody?
Section titled “get.requestBody?”
optionalrequestBody?:undefined
get.responses
Section titled “get.responses”responses:
object
get.responses.200
Section titled “get.responses.200”200:
object
Description
Section titled “Description”The trip that was retrieved.
get.responses.200.content
Section titled “get.responses.200.content”content:
object
get.responses.200.content.application/json
Section titled “get.responses.200.content.application/json”application/json:
object
get.responses.200.content.application/json.billable_at?
Section titled “get.responses.200.content.application/json.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:30Zget.responses.200.content.application/json.booker_user_id
Section titled “get.responses.200.content.application/json.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_cky0xs54b004h01pidi0pcuz1get.responses.200.content.application/json.created_at
Section titled “get.responses.200.content.application/json.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:30Zget.responses.200.content.application/json.ends_at?
Section titled “get.responses.200.content.application/json.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:30Zget.responses.200.content.application/json.id
Section titled “get.responses.200.content.application/json.id”id:
string
Description
Section titled “Description”The ID of the trip.
Example
Section titled “Example”trip_cl9rh1n8g001e0j84w6fb4fd1get.responses.200.content.application/json.name?
Section titled “get.responses.200.content.application/json.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 Janeiroget.responses.200.content.application/json.starts_at?
Section titled “get.responses.200.content.application/json.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:30Zget.responses.200.content.application/json.status
Section titled “get.responses.200.content.application/json.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"
get.responses.200.content.application/json.traveler?
Section titled “get.responses.200.content.application/json.traveler?”
optionaltraveler?:object
get.responses.200.content.application/json.traveler.guest_email?
Section titled “get.responses.200.content.application/json.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.comget.responses.200.content.application/json.traveler.name?
Section titled “get.responses.200.content.application/json.traveler.name?”
optionalname?:object
get.responses.200.content.application/json.traveler.name.first_name?
Section titled “get.responses.200.content.application/json.traveler.name.first_name?”
optionalfirst_name?: … | …
Description
Section titled “Description”The traveler’s first name.
Example
Section titled “Example”Johnget.responses.200.content.application/json.traveler.name.last_name?
Section titled “get.responses.200.content.application/json.traveler.name.last_name?”
optionallast_name?: … | …
Description
Section titled “Description”The traveler’s last name.
Example
Section titled “Example”Doeget.responses.200.content.application/json.traveler.name.middle_name?
Section titled “get.responses.200.content.application/json.traveler.name.middle_name?”
optionalmiddle_name?: … | … | …
Description
Section titled “Description”The traveler’s middle name.
Example
Section titled “Example”Paulget.responses.200.content.application/json.traveler.name.suffix?
Section titled “get.responses.200.content.application/json.traveler.name.suffix?”
optionalsuffix?: … | … | …
Description
Section titled “Description”The suffix in the traveler’s name.
Example
Section titled “Example”Jr.get.responses.200.content.application/json.traveler.type
Section titled “get.responses.200.content.application/json.traveler.type”type:
"EMPLOYEE"|"GUEST"
get.responses.200.content.application/json.traveler.user_id?
Section titled “get.responses.200.content.application/json.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_cky0xs54b004h01pidi0pcuz1get.responses.200.content.application/json.updated_at
Section titled “get.responses.200.content.application/json.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:30Zget.responses.200.content.application/json.version
Section titled “get.responses.200.content.application/json.version”version:
number
Format: int32
Description
Section titled “Description”The current version of the trip.
Example
Section titled “Example”2get.responses.200.headers
Section titled “get.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.400
Section titled “get.responses.400”400:
object
Description
Section titled “Description”Bad request
get.responses.400.content?
Section titled “get.responses.400.content?”
optionalcontent?:undefined
get.responses.400.headers
Section titled “get.responses.400.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.401
Section titled “get.responses.401”401:
object
Description
Section titled “Description”Unauthorized
get.responses.401.content?
Section titled “get.responses.401.content?”
optionalcontent?:undefined
get.responses.401.headers
Section titled “get.responses.401.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.403
Section titled “get.responses.403”403:
object
Description
Section titled “Description”Forbidden
get.responses.403.content?
Section titled “get.responses.403.content?”
optionalcontent?:undefined
get.responses.403.headers
Section titled “get.responses.403.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.404
Section titled “get.responses.404”404:
object
Description
Section titled “Description”Not Found
get.responses.404.content?
Section titled “get.responses.404.content?”
optionalcontent?:undefined
get.responses.404.headers
Section titled “get.responses.404.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.500
Section titled “get.responses.500”500:
object
Description
Section titled “Description”Internal server error
get.responses.500.content?
Section titled “get.responses.500.content?”
optionalcontent?:undefined
get.responses.500.headers
Section titled “get.responses.500.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalhead?:undefined
options?
Section titled “options?”
optionaloptions?:undefined
parameters
Section titled “parameters”parameters:
object
parameters.cookie?
Section titled “parameters.cookie?”
optionalcookie?:undefined
parameters.header?
Section titled “parameters.header?”
optionalheader?:undefined
parameters.path?
Section titled “parameters.path?”
optionalpath?:undefined
parameters.query?
Section titled “parameters.query?”
optionalquery?:undefined
patch?
Section titled “patch?”
optionalpatch?:undefined
optionalpost?:undefined
optionalput?:undefined
trace?
Section titled “trace?”
optionaltrace?:undefined
/v1/trips/{trip_id}/bookings
Section titled “/v1/trips/{trip_id}/bookings”/v1/trips/{trip_id}/bookings:
object
Defined in: src/travel/types.gen.ts:43
delete?
Section titled “delete?”
optionaldelete?:undefined
get:
object
List trip bookings
Description
Section titled “Description”Lists the bookings within a trip.
get.parameters
Section titled “get.parameters”parameters:
object
get.parameters.cookie?
Section titled “get.parameters.cookie?”
optionalcookie?:undefined
get.parameters.header?
Section titled “get.parameters.header?”
optionalheader?:undefined
get.parameters.path
Section titled “get.parameters.path”path:
object
get.parameters.path.trip_id
Section titled “get.parameters.path.trip_id”trip_id:
string
get.parameters.query?
Section titled “get.parameters.query?”
optionalquery?:object
get.parameters.query.cursor?
Section titled “get.parameters.query.cursor?”
optionalcursor?:string|null
get.parameters.query.limit?
Section titled “get.parameters.query.limit?”
optionallimit?:number|null
get.requestBody?
Section titled “get.requestBody?”
optionalrequestBody?:undefined
get.responses
Section titled “get.responses”responses:
object
get.responses.200
Section titled “get.responses.200”200:
object
Description
Section titled “Description”A page with a list of bookings.
get.responses.200.content
Section titled “get.responses.200.content”content:
object
get.responses.200.content.application/json
Section titled “get.responses.200.content.application/json”application/json:
object
get.responses.200.content.application/json.items
Section titled “get.responses.200.content.application/json.items”items:
object[]
get.responses.200.content.application/json.next_cursor?
Section titled “get.responses.200.content.application/json.next_cursor?”
optionalnext_cursor?:string|null
get.responses.200.headers
Section titled “get.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.400
Section titled “get.responses.400”400:
object
Description
Section titled “Description”Bad request
get.responses.400.content?
Section titled “get.responses.400.content?”
optionalcontent?:undefined
get.responses.400.headers
Section titled “get.responses.400.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.401
Section titled “get.responses.401”401:
object
Description
Section titled “Description”Unauthorized
get.responses.401.content?
Section titled “get.responses.401.content?”
optionalcontent?:undefined
get.responses.401.headers
Section titled “get.responses.401.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.403
Section titled “get.responses.403”403:
object
Description
Section titled “Description”Forbidden
get.responses.403.content?
Section titled “get.responses.403.content?”
optionalcontent?:undefined
get.responses.403.headers
Section titled “get.responses.403.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.404
Section titled “get.responses.404”404:
object
Description
Section titled “Description”Not Found
get.responses.404.content?
Section titled “get.responses.404.content?”
optionalcontent?:undefined
get.responses.404.headers
Section titled “get.responses.404.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.500
Section titled “get.responses.500”500:
object
Description
Section titled “Description”Internal server error
get.responses.500.content?
Section titled “get.responses.500.content?”
optionalcontent?:undefined
get.responses.500.headers
Section titled “get.responses.500.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalhead?:undefined
options?
Section titled “options?”
optionaloptions?:undefined
parameters
Section titled “parameters”parameters:
object
parameters.cookie?
Section titled “parameters.cookie?”
optionalcookie?:undefined
parameters.header?
Section titled “parameters.header?”
optionalheader?:undefined
parameters.path?
Section titled “parameters.path?”
optionalpath?:undefined
parameters.query?
Section titled “parameters.query?”
optionalquery?:undefined
patch?
Section titled “patch?”
optionalpatch?:undefined
optionalpost?:undefined
optionalput?:undefined
trace?
Section titled “trace?”
optionaltrace?:undefined
/v1/trips/{trip_id}/bookings/{booking_id}
Section titled “/v1/trips/{trip_id}/bookings/{booking_id}”/v1/trips/{trip_id}/bookings/{booking_id}:
object
Defined in: src/travel/types.gen.ts:63
delete?
Section titled “delete?”
optionaldelete?:undefined
get:
object
Get booking
Description
Section titled “Description”Retrieves a booking by trip and booking ID.
get.parameters
Section titled “get.parameters”parameters:
object
get.parameters.cookie?
Section titled “get.parameters.cookie?”
optionalcookie?:undefined
get.parameters.header?
Section titled “get.parameters.header?”
optionalheader?:undefined
get.parameters.path
Section titled “get.parameters.path”path:
object
get.parameters.path.booking_id
Section titled “get.parameters.path.booking_id”booking_id:
string
get.parameters.path.trip_id
Section titled “get.parameters.path.trip_id”trip_id:
string
get.parameters.query?
Section titled “get.parameters.query?”
optionalquery?:undefined
get.requestBody?
Section titled “get.requestBody?”
optionalrequestBody?:undefined
get.responses
Section titled “get.responses”responses:
object
get.responses.200
Section titled “get.responses.200”200:
object
Description
Section titled “Description”The booking that was retrieved.
get.responses.200.content
Section titled “get.responses.200.content”content:
object
get.responses.200.content.application/json
Section titled “get.responses.200.content.application/json”application/json:
object
get.responses.200.content.application/json.booking_data
Section titled “get.responses.200.content.application/json.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?: …;address_line_2?: …;administrative_area?: …;city?: …;coordinates?: …;country?: …;postal_code?: …;timezone?: …; };time: {local_time: …;timestamp?: …; }; };pickup: {location: {address_line_1?: …;address_line_2?: …;administrative_area?: …;city?: …;coordinates?: …;country?: …;postal_code?: …;timezone?: …; };time: {local_time: …;timestamp?: …; }; };rental_company?:string|null; };type:"CAR_RENTAL"; } | {lodging_details: {brand_name?:string|null;chain_name?:string|null;contact_information?: {email?: …;fax?: …;phone?: …; };display_name:string;location?: {address_line_1?: …;address_line_2?: …;administrative_area?: …;city?: …;coordinates?: …;country?: …;postal_code?: …;timezone?: …; };star_rating?:number|null; };reservation_details: {check_in_time: {local_time:string;timestamp?: … | … | …; };checkout_time: {local_time:string;timestamp?: … | … | …; };confirmation_code?:string|null;room?: {bed_count?: …;bed_type?: …;description?: …;display_name?: …; }; };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?: …; address_line_2?: …; administrative_area?: …; city?: …; coordinates?: …; country?: …; postal_code?: …; timezone?: …; }; time: { local_time: …; timestamp?: …; }; }; pickup: { location: { address_line_1?: …; address_line_2?: …; administrative_area?: …; city?: …; coordinates?: …; country?: …; postal_code?: …; timezone?: …; }; time: { local_time: …; timestamp?: …; }; }; 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?: …
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?: …
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?: …
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?: …
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?: …
reservation_details.drop_off.location.country?
Section titled “reservation_details.drop_off.location.country?”
optionalcountry?: …
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?: …
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?: …
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: …
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?: …
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?: …
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?: …
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?: …
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?: …
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?: …
reservation_details.pickup.location.country?
Section titled “reservation_details.pickup.location.country?”
optionalcountry?: …
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?: …
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?: …
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: …
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?: …
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?: …; fax?: …; phone?: …; }; display_name: string; location?: { address_line_1?: …; address_line_2?: …; administrative_area?: …; city?: …; coordinates?: …; country?: …; postal_code?: …; timezone?: …; }; star_rating?: number | null; }; reservation_details: { check_in_time: { local_time: string; timestamp?: … | … | …; }; checkout_time: { local_time: string; timestamp?: … | … | …; }; confirmation_code?: string | null; room?: { bed_count?: …; bed_type?: …; description?: …; display_name?: …; }; }; 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?: …
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?: …
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?: …
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?: …
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?: …
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?: …
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?: …
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?: …
lodging_details.location.country?
Section titled “lodging_details.location.country?”
optionalcountry?: …
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?: …
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?: …
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?: … | … | …
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?: … | … | …
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?: …
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?: …
Description
Section titled “Description”The kind of bed.
Example
Section titled “Example”DOUBLEreservation_details.room.description?
Section titled “reservation_details.room.description?”
optionaldescription?: …
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?: …
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
get.responses.200.content.application/json.created_at
Section titled “get.responses.200.content.application/json.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:30Zget.responses.200.content.application/json.id
Section titled “get.responses.200.content.application/json.id”id:
string
Description
Section titled “Description”The ID of the booking.
Example
Section titled “Example”booking_cl9t5dnu800040m3071dandeqget.responses.200.content.application/json.source
Section titled “get.responses.200.content.application/json.source”source:
"BREX_TRAVEL"|"EXTERNAL"
get.responses.200.content.application/json.status
Section titled “get.responses.200.content.application/json.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"
get.responses.200.content.application/json.trip_id
Section titled “get.responses.200.content.application/json.trip_id”trip_id:
string
Description
Section titled “Description”The ID of the trip to which this booking belongs.
Example
Section titled “Example”trip_cl9rh1n8g001e0j84w6fb4fd1get.responses.200.content.application/json.type
Section titled “get.responses.200.content.application/json.type”type:
"CAR_RENTAL"|"LODGING"|"AIR"|"RAIL"
get.responses.200.content.application/json.updated_at
Section titled “get.responses.200.content.application/json.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:30Zget.responses.200.content.application/json.version
Section titled “get.responses.200.content.application/json.version”version:
number
Format: int32
Description
Section titled “Description”The current version of the booking.
Example
Section titled “Example”2get.responses.200.headers
Section titled “get.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.400
Section titled “get.responses.400”400:
object
Description
Section titled “Description”Bad request
get.responses.400.content?
Section titled “get.responses.400.content?”
optionalcontent?:undefined
get.responses.400.headers
Section titled “get.responses.400.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.401
Section titled “get.responses.401”401:
object
Description
Section titled “Description”Unauthorized
get.responses.401.content?
Section titled “get.responses.401.content?”
optionalcontent?:undefined
get.responses.401.headers
Section titled “get.responses.401.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.403
Section titled “get.responses.403”403:
object
Description
Section titled “Description”Forbidden
get.responses.403.content?
Section titled “get.responses.403.content?”
optionalcontent?:undefined
get.responses.403.headers
Section titled “get.responses.403.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.404
Section titled “get.responses.404”404:
object
Description
Section titled “Description”Not Found
get.responses.404.content?
Section titled “get.responses.404.content?”
optionalcontent?:undefined
get.responses.404.headers
Section titled “get.responses.404.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.500
Section titled “get.responses.500”500:
object
Description
Section titled “Description”Internal server error
get.responses.500.content?
Section titled “get.responses.500.content?”
optionalcontent?:undefined
get.responses.500.headers
Section titled “get.responses.500.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalhead?:undefined
options?
Section titled “options?”
optionaloptions?:undefined
parameters
Section titled “parameters”parameters:
object
parameters.cookie?
Section titled “parameters.cookie?”
optionalcookie?:undefined
parameters.header?
Section titled “parameters.header?”
optionalheader?:undefined
parameters.path?
Section titled “parameters.path?”
optionalpath?:undefined
parameters.query?
Section titled “parameters.query?”
optionalquery?:undefined
patch?
Section titled “patch?”
optionalpatch?:undefined
optionalpost?:undefined
optionalput?:undefined
trace?
Section titled “trace?”
optionaltrace?:undefined