---
title: TravelPaths
editUrl: false
head: []
template: doc
prev: false
next: false
sidebar:
  hidden: false
  attrs: {}
pagefind: true
draft: false
---

Defined in: [src/travel/types.gen.ts:2](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/types.gen.ts#L2)

## Properties

### /v1/trips

> **/v1/trips**: `object`

Defined in: [src/travel/types.gen.ts:3](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/types.gen.ts#L3)

#### delete?

> `optional` **delete?**: `undefined`

#### get

> **get**: `object`

List trips

##### Description

Lists trips according to the filters passed in the query string.

##### get.parameters

> **parameters**: `object`

##### get.parameters.cookie?

> `optional` **cookie?**: `undefined`

##### get.parameters.header?

> `optional` **header?**: `undefined`

##### get.parameters.path?

> `optional` **path?**: `undefined`

##### get.parameters.query?

> `optional` **query?**: `object`

##### get.parameters.query.cursor?

> `optional` **cursor?**: `string` \| `null`

##### get.parameters.query.last\_updated\_after?

> `optional` **last\_updated\_after?**: `string` \| `null`

##### get.parameters.query.limit?

> `optional` **limit?**: `number` \| `null`

##### get.requestBody?

> `optional` **requestBody?**: `undefined`

##### get.responses

> **responses**: `object`

##### get.responses.200

> **200**: `object`

###### Description

A page with a list of trips.

##### get.responses.200.content

> **content**: `object`

##### get.responses.200.content.application/json

> **application/json**: `object`

##### get.responses.200.content.application/json.items

> **items**: `object`[]

##### get.responses.200.content.application/json.next\_cursor?

> `optional` **next\_cursor?**: `string` \| `null`

##### get.responses.200.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.400

> **400**: `object`

###### Description

Bad request

##### get.responses.400.content?

> `optional` **content?**: `undefined`

##### get.responses.400.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.401

> **401**: `object`

###### Description

Unauthorized

##### get.responses.401.content?

> `optional` **content?**: `undefined`

##### get.responses.401.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.403

> **403**: `object`

###### Description

Forbidden

##### get.responses.403.content?

> `optional` **content?**: `undefined`

##### get.responses.403.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.500

> **500**: `object`

###### Description

Internal server error

##### get.responses.500.content?

> `optional` **content?**: `undefined`

##### get.responses.500.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

#### head?

> `optional` **head?**: `undefined`

#### options?

> `optional` **options?**: `undefined`

#### parameters

> **parameters**: `object`

##### parameters.cookie?

> `optional` **cookie?**: `undefined`

##### parameters.header?

> `optional` **header?**: `undefined`

##### parameters.path?

> `optional` **path?**: `undefined`

##### parameters.query?

> `optional` **query?**: `undefined`

#### patch?

> `optional` **patch?**: `undefined`

#### post?

> `optional` **post?**: `undefined`

#### put?

> `optional` **put?**: `undefined`

#### trace?

> `optional` **trace?**: `undefined`

***

### /v1/trips/\{trip\_id\}

> **/v1/trips/\{trip\_id\}**: `object`

Defined in: [src/travel/types.gen.ts:23](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/types.gen.ts#L23)

#### delete?

> `optional` **delete?**: `undefined`

#### get

> **get**: `object`

Get trip

##### Description

Retrieves a trip by ID.

##### get.parameters

> **parameters**: `object`

##### get.parameters.cookie?

> `optional` **cookie?**: `undefined`

##### get.parameters.header?

> `optional` **header?**: `undefined`

##### get.parameters.path

> **path**: `object`

##### get.parameters.path.trip\_id

> **trip\_id**: `string`

##### get.parameters.query?

> `optional` **query?**: `undefined`

##### get.requestBody?

> `optional` **requestBody?**: `undefined`

##### get.responses

> **responses**: `object`

##### get.responses.200

> **200**: `object`

###### Description

The trip that was retrieved.

##### get.responses.200.content

> **content**: `object`

##### get.responses.200.content.application/json

> **application/json**: `object`

##### get.responses.200.content.application/json.billable\_at?

> `optional` **billable\_at?**: `string` \| `null`

Format: date-time

###### Description

The time when the trip became billable. If absent, the trip is currently not billable.

###### Example

```ts
2017-12-27T15:42:30Z
```

##### get.responses.200.content.application/json.booker\_user\_id

> **booker\_user\_id**: `string`

###### 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

```ts
cuuser_cky0xs54b004h01pidi0pcuz1
```

##### get.responses.200.content.application/json.created\_at

> **created\_at**: `string`

Format: date-time

###### Description

The time when the trip was created.

###### Example

```ts
2017-12-27T15:42:30Z
```

##### get.responses.200.content.application/json.ends\_at?

> `optional` **ends\_at?**: `string` \| `null`

Format: date-time

###### Description

The time when the last booking in the trip ends.

###### Example

```ts
2017-12-27T15:42:30Z
```

##### get.responses.200.content.application/json.id

> **id**: `string`

###### Description

The ID of the trip.

###### Example

```ts
trip_cl9rh1n8g001e0j84w6fb4fd1
```

##### get.responses.200.content.application/json.name?

> `optional` **name?**: `string` \| `null`

###### Description

The name of the trip as seen in the dashboard.

###### Example

```ts
Trip to Rio de Janeiro
```

##### get.responses.200.content.application/json.starts\_at?

> `optional` **starts\_at?**: `string` \| `null`

Format: date-time

###### Description

The time when the first booking in the trip starts.

###### Example

```ts
2017-12-27T15:42:30Z
```

##### 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?

> `optional` **traveler?**: `object`

##### get.responses.200.content.application/json.traveler.guest\_email?

> `optional` **guest\_email?**: `string` \| `null`

###### Description

If the traveler is a guest, this is their email.

###### Example

```ts
guest@gmail.com
```

##### get.responses.200.content.application/json.traveler.name?

> `optional` **name?**: `object`

##### get.responses.200.content.application/json.traveler.name.first\_name?

> `optional` **first\_name?**: ... \| ...

###### Description

The traveler's first name.

###### Example

```ts
John
```

##### get.responses.200.content.application/json.traveler.name.last\_name?

> `optional` **last\_name?**: ... \| ...

###### Description

The traveler's last name.

###### Example

```ts
Doe
```

##### get.responses.200.content.application/json.traveler.name.middle\_name?

> `optional` **middle\_name?**: ... \| ... \| ...

###### Description

The traveler's middle name.

###### Example

```ts
Paul
```

##### get.responses.200.content.application/json.traveler.name.suffix?

> `optional` **suffix?**: ... \| ... \| ...

###### Description

The suffix in the traveler's name.

###### Example

```ts
Jr.
```

##### get.responses.200.content.application/json.traveler.type

> **type**: `"EMPLOYEE"` \| `"GUEST"`

##### get.responses.200.content.application/json.traveler.user\_id?

> `optional` **user\_id?**: `string` \| `null`

###### Description

If the traveler is an employee, this is their user ID.

###### Example

```ts
cuuser_cky0xs54b004h01pidi0pcuz1
```

##### get.responses.200.content.application/json.updated\_at

> **updated\_at**: `string`

Format: date-time

###### Description

The time when the latest trip update happened.

###### Example

```ts
2017-12-27T15:42:30Z
```

##### get.responses.200.content.application/json.version

> **version**: `number`

Format: int32

###### Description

The current version of the trip.

###### Example

```ts
2
```

##### get.responses.200.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.400

> **400**: `object`

###### Description

Bad request

##### get.responses.400.content?

> `optional` **content?**: `undefined`

##### get.responses.400.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.401

> **401**: `object`

###### Description

Unauthorized

##### get.responses.401.content?

> `optional` **content?**: `undefined`

##### get.responses.401.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.403

> **403**: `object`

###### Description

Forbidden

##### get.responses.403.content?

> `optional` **content?**: `undefined`

##### get.responses.403.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.404

> **404**: `object`

###### Description

Not Found

##### get.responses.404.content?

> `optional` **content?**: `undefined`

##### get.responses.404.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.500

> **500**: `object`

###### Description

Internal server error

##### get.responses.500.content?

> `optional` **content?**: `undefined`

##### get.responses.500.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

#### head?

> `optional` **head?**: `undefined`

#### options?

> `optional` **options?**: `undefined`

#### parameters

> **parameters**: `object`

##### parameters.cookie?

> `optional` **cookie?**: `undefined`

##### parameters.header?

> `optional` **header?**: `undefined`

##### parameters.path?

> `optional` **path?**: `undefined`

##### parameters.query?

> `optional` **query?**: `undefined`

#### patch?

> `optional` **patch?**: `undefined`

#### post?

> `optional` **post?**: `undefined`

#### put?

> `optional` **put?**: `undefined`

#### trace?

> `optional` **trace?**: `undefined`

***

### /v1/trips/\{trip\_id\}/bookings

> **/v1/trips/\{trip\_id\}/bookings**: `object`

Defined in: [src/travel/types.gen.ts:43](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/types.gen.ts#L43)

#### delete?

> `optional` **delete?**: `undefined`

#### get

> **get**: `object`

List trip bookings

##### Description

Lists the bookings within a trip.

##### get.parameters

> **parameters**: `object`

##### get.parameters.cookie?

> `optional` **cookie?**: `undefined`

##### get.parameters.header?

> `optional` **header?**: `undefined`

##### get.parameters.path

> **path**: `object`

##### get.parameters.path.trip\_id

> **trip\_id**: `string`

##### get.parameters.query?

> `optional` **query?**: `object`

##### get.parameters.query.cursor?

> `optional` **cursor?**: `string` \| `null`

##### get.parameters.query.limit?

> `optional` **limit?**: `number` \| `null`

##### get.requestBody?

> `optional` **requestBody?**: `undefined`

##### get.responses

> **responses**: `object`

##### get.responses.200

> **200**: `object`

###### Description

A page with a list of bookings.

##### get.responses.200.content

> **content**: `object`

##### get.responses.200.content.application/json

> **application/json**: `object`

##### get.responses.200.content.application/json.items

> **items**: `object`[]

##### get.responses.200.content.application/json.next\_cursor?

> `optional` **next\_cursor?**: `string` \| `null`

##### get.responses.200.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.400

> **400**: `object`

###### Description

Bad request

##### get.responses.400.content?

> `optional` **content?**: `undefined`

##### get.responses.400.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.401

> **401**: `object`

###### Description

Unauthorized

##### get.responses.401.content?

> `optional` **content?**: `undefined`

##### get.responses.401.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.403

> **403**: `object`

###### Description

Forbidden

##### get.responses.403.content?

> `optional` **content?**: `undefined`

##### get.responses.403.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.404

> **404**: `object`

###### Description

Not Found

##### get.responses.404.content?

> `optional` **content?**: `undefined`

##### get.responses.404.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.500

> **500**: `object`

###### Description

Internal server error

##### get.responses.500.content?

> `optional` **content?**: `undefined`

##### get.responses.500.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

#### head?

> `optional` **head?**: `undefined`

#### options?

> `optional` **options?**: `undefined`

#### parameters

> **parameters**: `object`

##### parameters.cookie?

> `optional` **cookie?**: `undefined`

##### parameters.header?

> `optional` **header?**: `undefined`

##### parameters.path?

> `optional` **path?**: `undefined`

##### parameters.query?

> `optional` **query?**: `undefined`

#### patch?

> `optional` **patch?**: `undefined`

#### post?

> `optional` **post?**: `undefined`

#### put?

> `optional` **put?**: `undefined`

#### trace?

> `optional` **trace?**: `undefined`

***

### /v1/trips/\{trip\_id\}/bookings/\{booking\_id\}

> **/v1/trips/\{trip\_id\}/bookings/\{booking\_id\}**: `object`

Defined in: [src/travel/types.gen.ts:63](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/types.gen.ts#L63)

#### delete?

> `optional` **delete?**: `undefined`

#### get

> **get**: `object`

Get booking

##### Description

Retrieves a booking by trip and booking ID.

##### get.parameters

> **parameters**: `object`

##### get.parameters.cookie?

> `optional` **cookie?**: `undefined`

##### get.parameters.header?

> `optional` **header?**: `undefined`

##### get.parameters.path

> **path**: `object`

##### get.parameters.path.booking\_id

> **booking\_id**: `string`

##### get.parameters.path.trip\_id

> **trip\_id**: `string`

##### get.parameters.query?

> `optional` **query?**: `undefined`

##### get.requestBody?

> `optional` **requestBody?**: `undefined`

##### get.responses

> **responses**: `object`

##### get.responses.200

> **200**: `object`

###### Description

The booking that was retrieved.

##### get.responses.200.content

> **content**: `object`

##### get.responses.200.content.application/json

> **application/json**: `object`

##### 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

###### 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

> **journeys**: `object`[]

###### Description

The journeys that make up this booking.

###### known\_traveler\_number?

> `optional` **known\_traveler\_number?**: `object`

###### known\_traveler\_number.document\_number

> **document\_number**: `string`

###### Description

The actual document number.

###### Example

```ts
1231231
```

###### known\_traveler\_number.issuing\_country

> **issuing\_country**: `string`

###### Description

The country that issued this document.

###### Example

```ts
BR
```

###### redress\_number?

> `optional` **redress\_number?**: `object`

###### redress\_number.document\_number

> **document\_number**: `string`

###### Description

The actual document number.

###### Example

```ts
1231231
```

###### redress\_number.issuing\_country

> **issuing\_country**: `string`

###### Description

The country that issued this document.

###### Example

```ts
BR
```

###### tickets

> **tickets**: `object`[]

###### Description

The flight tickets in this booking.

###### type

> **type**: `"AIR"`

###### Description

discriminator enum property added by openapi-typescript

***

###### 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

> **car\_details**: `object`

###### car\_details.car\_class?

> `optional` **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"`

###### car\_details.display\_name

> **display\_name**: `string`

###### Description

The name of the car as displayed to the user.

###### Example

```ts
Intermediate car
```

###### reservation\_details

> **reservation\_details**: `object`

###### reservation\_details.confirmation\_code?

> `optional` **confirmation\_code?**: `string` \| `null`

###### Description

The confirmation code given by the vendor.

###### Example

```ts
7003XBQ504
```

###### reservation\_details.drop\_off

> **drop\_off**: `object`

###### reservation\_details.drop\_off.location

> **location**: `object`

###### reservation\_details.drop\_off.location.address\_line\_1?

> `optional` **address\_line\_1?**: ...

###### Description

The first line of the address.

###### Example

```ts
Av. Vinte de Janeiro, S/N
```

###### reservation\_details.drop\_off.location.address\_line\_2?

> `optional` **address\_line\_2?**: ...

###### Description

The second line of the address.

###### Example

```ts
Ilha do Governador
```

###### reservation\_details.drop\_off.location.administrative\_area?

> `optional` **administrative\_area?**: ...

###### 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

```ts
RJ
```

###### reservation\_details.drop\_off.location.city?

> `optional` **city?**: ...

###### Description

The city where the address is located.

###### Example

```ts
Rio de Janeiro
```

###### reservation\_details.drop\_off.location.coordinates?

> `optional` **coordinates?**: ...

###### reservation\_details.drop\_off.location.country?

> `optional` **country?**: ...

###### 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

```ts
Brazil
```

###### reservation\_details.drop\_off.location.postal\_code?

> `optional` **postal\_code?**: ...

###### Description

The postal code of the given address.

###### Example

```ts
21941-900
```

###### reservation\_details.drop\_off.location.timezone?

> `optional` **timezone?**: ...

###### Description

The timezone in the given address.

###### Example

```ts
America/Sao_Paulo
```

###### reservation\_details.drop\_off.time

> **time**: `object`

###### reservation\_details.drop\_off.time.local\_time

> **local\_time**: ...

Format: date-time

###### Description

The local time in the relevant location in the ISO 8601 format.

###### reservation\_details.drop\_off.time.timestamp?

> `optional` **timestamp?**: ...

Format: date-time

###### Description

An ISO 8601 timestamp.

###### Example

```ts
2017-12-27T15:42:30Z
```

###### reservation\_details.pickup

> **pickup**: `object`

###### reservation\_details.pickup.location

> **location**: `object`

###### reservation\_details.pickup.location.address\_line\_1?

> `optional` **address\_line\_1?**: ...

###### Description

The first line of the address.

###### Example

```ts
Av. Vinte de Janeiro, S/N
```

###### reservation\_details.pickup.location.address\_line\_2?

> `optional` **address\_line\_2?**: ...

###### Description

The second line of the address.

###### Example

```ts
Ilha do Governador
```

###### reservation\_details.pickup.location.administrative\_area?

> `optional` **administrative\_area?**: ...

###### 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

```ts
RJ
```

###### reservation\_details.pickup.location.city?

> `optional` **city?**: ...

###### Description

The city where the address is located.

###### Example

```ts
Rio de Janeiro
```

###### reservation\_details.pickup.location.coordinates?

> `optional` **coordinates?**: ...

###### reservation\_details.pickup.location.country?

> `optional` **country?**: ...

###### 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

```ts
Brazil
```

###### reservation\_details.pickup.location.postal\_code?

> `optional` **postal\_code?**: ...

###### Description

The postal code of the given address.

###### Example

```ts
21941-900
```

###### reservation\_details.pickup.location.timezone?

> `optional` **timezone?**: ...

###### Description

The timezone in the given address.

###### Example

```ts
America/Sao_Paulo
```

###### reservation\_details.pickup.time

> **time**: `object`

###### reservation\_details.pickup.time.local\_time

> **local\_time**: ...

Format: date-time

###### Description

The local time in the relevant location in the ISO 8601 format.

###### reservation\_details.pickup.time.timestamp?

> `optional` **timestamp?**: ...

Format: date-time

###### Description

An ISO 8601 timestamp.

###### Example

```ts
2017-12-27T15:42:30Z
```

###### reservation\_details.rental\_company?

> `optional` **rental\_company?**: `string` \| `null`

###### Description

Name of car rental company.

###### Example

```ts
Catch-A-Ride
```

###### type

> **type**: `"CAR_RENTAL"`

###### Description

discriminator enum property added by openapi-typescript

***

###### 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

> **lodging\_details**: `object`

###### lodging\_details.brand\_name?

> `optional` **brand\_name?**: `string` \| `null`

###### Description

The brand name of the hotel.

###### Example

```ts
Marriott Hotels
```

###### lodging\_details.chain\_name?

> `optional` **chain\_name?**: `string` \| `null`

###### Description

The name of the hotel chain.

###### Example

```ts
Accor Hotels
```

###### lodging\_details.contact\_information?

> `optional` **contact\_information?**: `object`

###### lodging\_details.contact\_information.email?

> `optional` **email?**: ...

###### Description

The email address of the venue.

###### Example

```ts
city@hotelchain.com
```

###### lodging\_details.contact\_information.fax?

> `optional` **fax?**: ...

###### Description

The fax number of the venue.

###### Example

```ts
12345554321
```

###### lodging\_details.contact\_information.phone?

> `optional` **phone?**: ...

###### Description

The phone number of the venue.

###### Example

```ts
12345554321
```

###### lodging\_details.display\_name

> **display\_name**: `string`

###### Description

The name of the venue as displayed to the user.

###### Example

```ts
Fancy Hotel
```

###### lodging\_details.location?

> `optional` **location?**: `object`

###### lodging\_details.location.address\_line\_1?

> `optional` **address\_line\_1?**: ...

###### Description

The first line of the address.

###### Example

```ts
Av. Vinte de Janeiro, S/N
```

###### lodging\_details.location.address\_line\_2?

> `optional` **address\_line\_2?**: ...

###### Description

The second line of the address.

###### Example

```ts
Ilha do Governador
```

###### lodging\_details.location.administrative\_area?

> `optional` **administrative\_area?**: ...

###### 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

```ts
RJ
```

###### lodging\_details.location.city?

> `optional` **city?**: ...

###### Description

The city where the address is located.

###### Example

```ts
Rio de Janeiro
```

###### lodging\_details.location.coordinates?

> `optional` **coordinates?**: ...

###### lodging\_details.location.country?

> `optional` **country?**: ...

###### 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

```ts
Brazil
```

###### lodging\_details.location.postal\_code?

> `optional` **postal\_code?**: ...

###### Description

The postal code of the given address.

###### Example

```ts
21941-900
```

###### lodging\_details.location.timezone?

> `optional` **timezone?**: ...

###### Description

The timezone in the given address.

###### Example

```ts
America/Sao_Paulo
```

###### lodging\_details.star\_rating?

> `optional` **star\_rating?**: `number` \| `null`

Format: float

###### Description

The star rating of the hotel. Some hotels have half stars.

###### Example

```ts
3.5
```

###### reservation\_details

> **reservation\_details**: `object`

###### reservation\_details.check\_in\_time

> **check\_in\_time**: `object`

###### reservation\_details.check\_in\_time.local\_time

> **local\_time**: `string`

Format: date-time

###### Description

The local time in the relevant location in the ISO 8601 format.

###### reservation\_details.check\_in\_time.timestamp?

> `optional` **timestamp?**: ... \| ... \| ...

Format: date-time

###### Description

An ISO 8601 timestamp.

###### Example

```ts
2017-12-27T15:42:30Z
```

###### reservation\_details.checkout\_time

> **checkout\_time**: `object`

###### reservation\_details.checkout\_time.local\_time

> **local\_time**: `string`

Format: date-time

###### Description

The local time in the relevant location in the ISO 8601 format.

###### reservation\_details.checkout\_time.timestamp?

> `optional` **timestamp?**: ... \| ... \| ...

Format: date-time

###### Description

An ISO 8601 timestamp.

###### Example

```ts
2017-12-27T15:42:30Z
```

###### reservation\_details.confirmation\_code?

> `optional` **confirmation\_code?**: `string` \| `null`

###### Description

Confirmation code provided by the vendor.

###### Example

```ts
7003XBQ504
```

###### reservation\_details.room?

> `optional` **room?**: `object`

###### reservation\_details.room.bed\_count?

> `optional` **bed\_count?**: ...

Format: int32

###### Description

The number of beds.

###### Example

```ts
1
```

###### reservation\_details.room.bed\_type?

> `optional` **bed\_type?**: ...

###### Description

The kind of bed.

###### Example

```ts
DOUBLE
```

###### reservation\_details.room.description?

> `optional` **description?**: ...

###### Description

A description of the room.

###### Example

```ts
Superior room
```

###### reservation\_details.room.display\_name?

> `optional` **display\_name?**: ...

###### Description

The name of the room as displayed to the user.

###### Example

```ts
Standard room
```

###### type

> **type**: `"LODGING"`

###### Description

discriminator enum property added by openapi-typescript

***

###### Type Literal

\{ `journeys`: `object`[]; `type`: `"RAIL"`; \}

###### journeys

> **journeys**: `object`[]

###### Description

The journeys that make up this booking.

###### type

> **type**: `"RAIL"`

###### Description

discriminator enum property added by openapi-typescript

##### get.responses.200.content.application/json.created\_at

> **created\_at**: `string`

Format: date-time

###### Description

The time when the booking was created.

###### Example

```ts
2017-12-27T15:42:30Z
```

##### get.responses.200.content.application/json.id

> **id**: `string`

###### Description

The ID of the booking.

###### Example

```ts
booking_cl9t5dnu800040m3071dandeq
```

##### get.responses.200.content.application/json.source

> **source**: `"BREX_TRAVEL"` \| `"EXTERNAL"`

##### 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

> **trip\_id**: `string`

###### Description

The ID of the trip to which this booking belongs.

###### Example

```ts
trip_cl9rh1n8g001e0j84w6fb4fd1
```

##### get.responses.200.content.application/json.type

> **type**: `"CAR_RENTAL"` \| `"LODGING"` \| `"AIR"` \| `"RAIL"`

##### get.responses.200.content.application/json.updated\_at

> **updated\_at**: `string`

Format: date-time

###### Description

The time when the booking was last updated.

###### Example

```ts
2017-12-27T15:42:30Z
```

##### get.responses.200.content.application/json.version

> **version**: `number`

Format: int32

###### Description

The current version of the booking.

###### Example

```ts
2
```

##### get.responses.200.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.400

> **400**: `object`

###### Description

Bad request

##### get.responses.400.content?

> `optional` **content?**: `undefined`

##### get.responses.400.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.401

> **401**: `object`

###### Description

Unauthorized

##### get.responses.401.content?

> `optional` **content?**: `undefined`

##### get.responses.401.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.403

> **403**: `object`

###### Description

Forbidden

##### get.responses.403.content?

> `optional` **content?**: `undefined`

##### get.responses.403.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.404

> **404**: `object`

###### Description

Not Found

##### get.responses.404.content?

> `optional` **content?**: `undefined`

##### get.responses.404.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.500

> **500**: `object`

###### Description

Internal server error

##### get.responses.500.content?

> `optional` **content?**: `undefined`

##### get.responses.500.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

#### head?

> `optional` **head?**: `undefined`

#### options?

> `optional` **options?**: `undefined`

#### parameters

> **parameters**: `object`

##### parameters.cookie?

> `optional` **cookie?**: `undefined`

##### parameters.header?

> `optional` **header?**: `undefined`

##### parameters.path?

> `optional` **path?**: `undefined`

##### parameters.query?

> `optional` **query?**: `undefined`

#### patch?

> `optional` **patch?**: `undefined`

#### post?

> `optional` **post?**: `undefined`

#### put?

> `optional` **put?**: `undefined`

#### trace?

> `optional` **trace?**: `undefined`