> ## Documentation Index > Fetch the complete documentation index at: https://developers.portao3.com.br/llms.txt > Use this file to discover all available pages before exploring further. # Get a trip > Returns a trip: its booked product, passengers and where the booking is. An organization admin can read any trip of the organization; a user can read the trips they travel on. Requesting a trip grants no access to it: someone who booked it for others, and is not on it, doesn't see it. The trip is brought up to date with the travel provider before the answer, so the state you read is current; if the provider can't be reached you get the last recorded one. ## OpenAPI ````yaml /api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/trips/{tripId} openapi: 3.0.3 info: title: Travel version: 1.0.0 description: >- Portão 3 travel API. Every endpoint requires a bearer token in the Authorization header (Authorization: Bearer ) unless its page states otherwise; see the Authentication guide. That requirement is not repeated per endpoint. Generated by tools/openapi from code (routes + security) and the hand-written spec (request/response bodies). Passenger directory, trips and the search proxy (air/hotel/bus/vehicle). Every route validates path, query and body through a zod Input class (`travel/src/domain/*/input`), which documents its parameters and body; responses are the named interfaces in `travel/src/domain/*/response.ts`. Confidence tiers: generated:typed=53 copied:manual=0 unknown=0. servers: - url: https://api.travel.v2.portao3.com.br/ description: production - url: https://api.travel.dev.3pers.com.br/ description: development security: [] tags: - name: Passengers - name: Trips - name: Air search - name: Hotel search - name: Bus search - name: Vehicle search paths: /realms/{realmId}/organizations/{organizationId}/trips/{tripId}: get: tags: - Trips summary: Get a trip description: 'Returns a trip: its booked product, passengers and where the booking is.' operationId: getRealmsByRealmIdOrganizationsByOrganizationIdTripsByTripId parameters: - name: realmId in: path required: true description: |- ID of your realm. Format: `UUID` schema: type: string format: uuid example: f495ff0c-ab54-4f99-8e92-ca8682e4de9b - name: organizationId in: path required: true description: |- ID of the organization the trip belongs to. Format: `UUID` schema: type: string format: uuid example: c4bd3f21-dfbd-44e8-8055-68ba15bed410 - name: tripId in: path required: true description: ID of the trip (24 hexadecimal characters). schema: type: string pattern: ^[0-9a-fA-F]{24}$ example: 6711b4c0d8e1a30012b7c9f2 responses: '200': description: Successful response content: application/json: schema: type: object properties: id: type: string description: ID of the trip. example: 6711b4c0d8e1a30012b7c9f2 realmId: type: string description: ID of the realm the trip belongs to. example: f495ff0c-ab54-4f99-8e92-ca8682e4de9b format: uuid organizationId: type: string description: ID of the organization the trip belongs to. example: c4bd3f21-dfbd-44e8-8055-68ba15bed410 format: uuid createdBy: type: string description: >- ID of the user who created the trip. Omitted when a service did. example: e3553bc1-5e20-4e17-b22a-a796fda0aa99 format: uuid customFields: type: object additionalProperties: {} description: >- Values of the organization's trip custom fields, keyed by the custom field's `slug`. Empty when none were set. --- Example: `{"cost-center":"CC-1020"}` example: cost-center: CC-1020 vertical: type: string enum: - AIR - HOTEL - BUS - VEHICLE description: >- Type of product booked. It tells which shape `productSnapshot` has. example: AIR state: type: string enum: - PENDING - RESERVED - ISSUED - CANCELED description: >- Where the booking is in its life: `PENDING` while the reservation is being made, `RESERVED` once held (until `reservationExpiresAt`), `ISSUED` once ticketed and `CANCELED`. It only moves forward. example: RESERVED status: type: string enum: - PROCESSING_RESERVATION - RESERVATION_FAILED - RESERVED - PROCESSING_ISSUE - ISSUED - PROCESSING_CANCELLATION - CANCELED - AWAITING_MANUAL_CANCELLATION - CANCELLATION_FAILED - FAILED - FAILED_BY_INCONSISTENT_DATA - FAILED_BY_UNAVAILABLE_RESOURCE - FAILED_BY_BUDGET_EXCEEDED - EXPIRED - BLOCKED - UNKNOWN - ISSUANCE_FAILED description: >- Finer-grained status: it also reports work in progress (`PROCESSING_*`) and failures, and can change back and forth. Use `state` to decide what the booking is; use `status` to tell what is happening to it. example: RESERVED reservationExpiresAt: type: string nullable: true description: >- Until when the reservation is held. Past it, a trip that was not issued expires. `null` or omitted when there is no hold. example: '2026-10-02T13:45:12.000Z' format: date-time issuedAt: type: string nullable: true description: When the trip was issued. `null` or omitted until it is. format: date-time originalAmount: type: number description: >- Price before discounts, in cents. Omitted until the price is known. example: 95000 discountAmount: type: number description: >- Discount applied, in cents. Omitted until the price is known. example: 3010 feeAmount: type: number description: Fees added, in cents. Omitted until the price is known. example: 0 totalAmount: type: number description: >- Amount to pay, in cents: `originalAmount` - `discountAmount` + `feeAmount`. Omitted until the price is known. example: 91990 currency: type: string description: >- Currency of the amounts, as the numeric ISO 4217 code (`986` is BRL). example: '986' passengers: type: array items: type: object properties: id: type: string description: >- ID of the passenger, as returned by the passenger endpoints. example: 6710a3f2c9e77b0012a4d5e1 userId: type: string description: >- ID of the organization user the passenger is linked to. Omitted for a passenger who is not a user. A user sees the trips they travel on. example: e3553bc1-5e20-4e17-b22a-a796fda0aa99 format: uuid lead: type: boolean description: >- Whether this passenger is the one responsible for the reservation. example: true name: type: string description: >- Full name, as it appears on the passenger's travel documents. example: Mariana Costa gender: type: string enum: - MALE - FEMALE description: Gender. example: FEMALE birthDate: type: string description: Date of birth (`YYYY-MM-DD`). example: '1990-04-17' required: - id - lead - name - gender - birthDate description: >- A passenger of a trip: who travels, as recorded when the trip was booked. The passenger endpoints serve the full profile. description: The passengers booked on the trip. productSnapshot: anyOf: - type: object properties: journeys: type: array items: type: object properties: id: type: string description: >- ID of the journey, referenced by `tickets[].fares[].journeyId`. example: jour_V1StGXR8Z5jdHi6BmyT2k direction: type: string enum: - DEPARTURE - RETURN description: >- Whether this is the outbound leg (`DEPARTURE`) or the return leg (`RETURN`). example: DEPARTURE origin: type: object properties: iata: type: string description: IATA code of the airport, 3 letters. example: GRU name: type: string nullable: true description: >- Official name of the airport. `null` when unknown. example: >- São Paulo/Guarulhos International Airport shortAddress: type: string nullable: true description: >- Readable single-line address of the airport. `null` when unknown. example: Guarulhos, SP, Brazil locality: type: string nullable: true description: >- City the airport sits in. `null` when unknown. example: Guarulhos administrativeArea: type: string nullable: true description: >- State, as its short code. `null` when unknown. example: SP phoneNumbers: type: array items: type: string example: '551133334444' description: >- Contact phone numbers of the airport, digits only. Empty when none is registered. --- Example: `["551133334444"]` required: - iata - name - shortAddress - locality - administrativeArea - phoneNumbers description: Airport the journey starts at. destination: type: object properties: iata: type: string description: IATA code of the airport, 3 letters. example: GRU name: type: string nullable: true description: >- Official name of the airport. `null` when unknown. example: >- São Paulo/Guarulhos International Airport shortAddress: type: string nullable: true description: >- Readable single-line address of the airport. `null` when unknown. example: Guarulhos, SP, Brazil locality: type: string nullable: true description: >- City the airport sits in. `null` when unknown. example: Guarulhos administrativeArea: type: string nullable: true description: >- State, as its short code. `null` when unknown. example: SP phoneNumbers: type: array items: type: string example: '551133334444' description: >- Contact phone numbers of the airport, digits only. Empty when none is registered. --- Example: `["551133334444"]` required: - iata - name - shortAddress - locality - administrativeArea - phoneNumbers description: Airport the journey ends at. example: iata: SDU name: Rio de Janeiro/Santos Dumont Airport shortAddress: Rio de Janeiro, RJ, Brazil locality: Rio de Janeiro administrativeArea: RJ phoneNumbers: - '552133339999' departureDate: type: string description: >- Departure date and time in the local time of the origin airport, as `YYYY-MM-DDTHH:mm:ss` with no time zone. example: '2026-11-02T08:30:00' arrivalDate: type: string description: >- Arrival date and time in the local time of the destination airport, as `YYYY-MM-DDTHH:mm:ss` with no time zone. example: '2026-11-02T09:35:00' duration: type: string description: >- Total travel time of the journey, connections included, as `HH:mm`. example: '01:05' segments: type: array items: type: object properties: airline: type: object properties: code: type: string description: IATA code of the airline. example: LA name: type: string nullable: true description: >- Commercial name of the airline. `null` when unknown. example: LATAM Airlines logo: type: string nullable: true description: >- URL of the airline's logo. `null` when there is none. example: https://cdn.example.com/airlines/LA.png required: - code - name - logo description: Airline that sells the flight. operation: type: object properties: code: type: string description: IATA code of the airline. example: LA name: type: string nullable: true description: >- Commercial name of the airline. `null` when unknown. example: LATAM Airlines logo: type: string nullable: true description: >- URL of the airline's logo. `null` when there is none. example: https://cdn.example.com/airlines/LA.png required: - code - name - logo description: >- Airline that operates the flight. It differs from `airline` on codeshare flights. origin: type: object properties: iata: type: string description: IATA code of the airport, 3 letters. example: GRU name: type: string nullable: true description: >- Official name of the airport. `null` when unknown. example: >- São Paulo/Guarulhos International Airport shortAddress: type: string nullable: true description: >- Readable single-line address of the airport. `null` when unknown. example: Guarulhos, SP, Brazil locality: type: string nullable: true description: >- City the airport sits in. `null` when unknown. example: Guarulhos administrativeArea: type: string nullable: true description: >- State, as its short code. `null` when unknown. example: SP phoneNumbers: type: array items: type: string example: '551133334444' description: >- Contact phone numbers of the airport, digits only. Empty when none is registered. --- Example: `["551133334444"]` required: - iata - name - shortAddress - locality - administrativeArea - phoneNumbers description: Airport the flight leaves from. destination: type: object properties: iata: type: string description: IATA code of the airport, 3 letters. example: GRU name: type: string nullable: true description: >- Official name of the airport. `null` when unknown. example: >- São Paulo/Guarulhos International Airport shortAddress: type: string nullable: true description: >- Readable single-line address of the airport. `null` when unknown. example: Guarulhos, SP, Brazil locality: type: string nullable: true description: >- City the airport sits in. `null` when unknown. example: Guarulhos administrativeArea: type: string nullable: true description: >- State, as its short code. `null` when unknown. example: SP phoneNumbers: type: array items: type: string example: '551133334444' description: >- Contact phone numbers of the airport, digits only. Empty when none is registered. --- Example: `["551133334444"]` required: - iata - name - shortAddress - locality - administrativeArea - phoneNumbers description: Airport the flight arrives at. example: iata: SDU name: Rio de Janeiro/Santos Dumont Airport shortAddress: Rio de Janeiro, RJ, Brazil locality: Rio de Janeiro administrativeArea: RJ phoneNumbers: - '552133339999' flightNumber: type: string description: >- Number of the flight, without the airline's code. example: '3101' departureDate: type: string description: >- Departure date and time in the local time of the departure airport, as `YYYY-MM-DDTHH:mm:ss` with no time zone. example: '2026-11-02T08:30:00' arrivalDate: type: string description: >- Arrival date and time in the local time of the arrival airport, as `YYYY-MM-DDTHH:mm:ss` with no time zone. example: '2026-11-02T09:35:00' flightType: type: string enum: - CHARTER - ALLOTMENT - REGULAR description: >- Kind of flight: `REGULAR`, `CHARTER` or `ALLOTMENT`. example: REGULAR duration: type: string description: Duration of the flight, as `HH:mm`. example: '01:05' equipment: type: string nullable: true description: >- Aircraft scheduled for the flight, as the airline identifies it. `null` when not informed. example: 32Q cabin: type: string enum: - ECONOMY - PREMIUM_ECONOMY - BUSINESS - FIRST_CLASS - UNDEFINED description: Cabin booked for the flight. example: ECONOMY class: type: string nullable: true description: >- Booking class (RBD) priced for the flight. Each airline defines its own codes. `null` when the airline does not expose it. example: 'Y' fareBasis: type: string nullable: true description: >- Fare basis code priced for the flight. Each airline defines its own codes. `null` when the airline does not expose it. example: YOW flightInfo: description: >- Live information about the flight. `null` until it is first collected, as the departure approaches. example: null type: object properties: state: type: string nullable: true enum: - SCHEDULED - OUT_GATE - IN_AIR - LANDED - IN_GATE - CANCELED - PROPOSED - UNKNOWN - null description: >- Operational state of the flight. `null` when there is no live status yet. example: SCHEDULED updatedAt: type: string nullable: true description: >- When the live status was captured. `null` when there is no live status yet. example: '2026-11-01T18:00:00.000Z' aircraft: description: >- Aircraft operating the flight. `null` when not known yet. type: object properties: registration: type: string nullable: true description: >- Tail registration of the aircraft. `null` when not known yet. example: PR-XBA type: type: string nullable: true description: >- ICAO code of the aircraft type. `null` when not known yet. example: A21N required: - registration - type nullable: true departure: type: object properties: terminal: type: string nullable: true description: >- Terminal at the airport. `null` when not reported yet. example: '2' gate: type: string nullable: true description: >- Gate at the airport. `null` when not reported yet. example: B12 baggage: type: string nullable: true description: >- Baggage belt, reported for arrivals only. `null` for departures and when not reported yet. example: '04' estimatedTime: type: string nullable: true description: >- Estimated time at the gate, in UTC (ISO 8601). `null` when not known yet. example: '2026-11-02T11:30:00.000Z' actualTime: type: string nullable: true description: >- Actual time at the gate, in UTC (ISO 8601), reported once the flight operates. `null` before that. example: '2026-11-02T11:34:00.000Z' timeliness: type: string nullable: true description: >- Punctuality of the flight, such as `OnTime`, `Early` or `Delayed`. `null` when not known. example: OnTime delayMinutes: type: number nullable: true description: >- Delay in minutes; negative when the flight is ahead of schedule. `null` when not known. example: 4 required: - terminal - gate - baggage - estimatedTime - actualTime - timeliness - delayMinutes description: Live status at the departure airport. arrival: type: object properties: terminal: type: string nullable: true description: >- Terminal at the airport. `null` when not reported yet. example: '2' gate: type: string nullable: true description: >- Gate at the airport. `null` when not reported yet. example: B12 baggage: type: string nullable: true description: >- Baggage belt, reported for arrivals only. `null` for departures and when not reported yet. example: '04' estimatedTime: type: string nullable: true description: >- Estimated time at the gate, in UTC (ISO 8601). `null` when not known yet. example: '2026-11-02T11:30:00.000Z' actualTime: type: string nullable: true description: >- Actual time at the gate, in UTC (ISO 8601), reported once the flight operates. `null` before that. example: '2026-11-02T11:34:00.000Z' timeliness: type: string nullable: true description: >- Punctuality of the flight, such as `OnTime`, `Early` or `Delayed`. `null` when not known. example: OnTime delayMinutes: type: number nullable: true description: >- Delay in minutes; negative when the flight is ahead of schedule. `null` when not known. example: 4 required: - terminal - gate - baggage - estimatedTime - actualTime - timeliness - delayMinutes description: Live status at the arrival airport. required: - state - updatedAt - aircraft - departure - arrival nullable: true required: - airline - operation - origin - destination - flightNumber - departureDate - arrivalDate - flightType - duration - equipment - cabin - class - fareBasis - flightInfo description: >- One flight of a journey. A journey with connections has several. description: >- Flights of the journey, in chronological order, connections included. required: - id - direction - origin - destination - departureDate - arrivalDate - duration - segments description: >- One leg of the itinerary: the whole way from an origin to a destination, connections included. description: >- Legs of the itinerary, in travel order: one for a one-way trip, two (outbound and return) for a round trip. tickets: type: array items: type: object properties: passengerId: type: string description: >- ID of the passenger holding this ticket — one of the trip's `passengers[]`. Omitted only if the passenger could not be matched to the trip's passengers. example: 6710a3f2c9e77b0012a4d5e1 fareDescription: type: string description: >- Readable description of the fare of the ticket. example: GRU to SDU, LATAM Airlines, Economy ticketNumber: type: string nullable: true description: >- Number of the ticket, as the airline issued it. `null` until the ticket is issued. example: null fares: type: array items: type: object properties: journeyId: type: string nullable: true description: >- ID of the journey this fare covers — a `journeys[].id`. `null` when the fare covers the whole itinerary. example: jour_V1StGXR8Z5jdHi6BmyT2k currency: type: string description: >- Currency, as the ISO 4217 alphabetic code. example: BRL originalAmount: type: number description: >- Fare before discounts and fees, in cents. example: 95000 discountAmount: type: number description: Discount applied to the fare, in cents. example: 3010 feeAmount: type: number description: Fees added to the fare, in cents. example: 0 amount: type: number description: >- Total charged for the fare, in cents: `originalAmount` - `discountAmount` + `feeAmount`. example: 91990 cancellationPolicies: type: object properties: refundable: type: boolean description: Whether cancelling gives any money back. example: true immediateFine: type: boolean description: >- Whether a fine applies to a cancellation made right after the booking. example: false penalties: type: array items: type: object properties: from: type: string description: >- First day (`YYYY-MM-DD`) on which this tier applies. example: '2026-10-25' currency: type: string description: >- Currency, as the ISO 4217 alphabetic code. example: BRL fineAmount: type: number nullable: true description: >- Fine charged for cancelling from `from` onward, in cents. `null` when the amount is not available. example: 15000 required: - from - currency - fineAmount description: >- One tier of a cancellation penalty schedule. description: >- Penalty tiers, each in effect from its own date. Empty when no scheduled penalty applies. required: - refundable - immediateFine - penalties description: Cancellation rules of the fare. changePolicies: type: object properties: canChange: type: boolean description: >- Whether the fare allows the booking to be changed. example: true immediateFine: type: boolean description: >- Whether a fine applies to a change made right after the booking. example: false penalties: type: array items: type: object properties: from: type: string description: >- First day (`YYYY-MM-DD`) on which this tier applies. example: '2026-10-25' currency: type: string description: >- Currency, as the ISO 4217 alphabetic code. example: BRL fineAmount: type: number nullable: true description: >- Fine charged for changing the booking from `from` onward, in cents. `null` when the amount is not available. example: 8000 required: - from - currency - fineAmount description: One tier of a change penalty schedule. description: >- Penalty tiers, each in effect from its own date. Empty when no scheduled penalty applies. required: - canChange - immediateFine - penalties description: Change rules of the fare. required: - journeyId - currency - originalAmount - discountAmount - feeAmount - amount - cancellationPolicies - changePolicies description: >- The fare of a ticket for one journey, or for the whole itinerary. Amounts are integers in cents. description: >- Fares of the ticket: one per journey, or a single one for the whole itinerary. segments: type: array items: type: object properties: flightNumber: type: string description: >- Number of the flight this ticket covers, without the airline's code. It matches the `flightNumber` of one of the journeys' `segments`. example: '3101' cabin: type: string enum: - ECONOMY - PREMIUM_ECONOMY - BUSINESS - FIRST_CLASS - UNDEFINED description: Cabin of the ticket on this flight. example: ECONOMY class: type: string nullable: true description: >- Booking class (RBD) of the ticket on this flight. Each airline defines its own codes. `null` when the airline does not expose it. example: 'Y' fareBasis: type: string nullable: true description: >- Fare basis code of the ticket on this flight. Each airline defines its own codes. `null` when the airline does not expose it. example: YOW baggages: type: array items: type: object properties: quantity: type: number description: >- Number of pieces included in the allowance. example: 1 weight: type: number nullable: true description: >- Weight allowed per piece, in kg. `null` when the airline sets no weight limit per piece. example: 23 type: type: string enum: - CHECKED - CARRY_ON - PERSONAL_ITEM description: >- Kind of baggage: `CHECKED`, `CARRY_ON` or `PERSONAL_ITEM`. example: CHECKED required: - quantity - weight - type description: >- A baggage allowance of a ticket on one flight. description: >- Baggage allowance of the ticket on this flight. Empty for an infant on an adult's lap. required: - flightNumber - cabin - class - fareBasis - baggages description: >- What a ticket covers on one flight of the itinerary: the cabin, the fare codes and the baggage allowance. description: >- What the ticket covers on each flight of the itinerary. required: - fareDescription - ticketNumber - fares - segments description: >- The ticket of one passenger. It covers the whole itinerary, with a fare per journey or a single fare for all of it. description: >- Tickets of the booking, one per passenger, each covering the whole itinerary. locators: type: array items: type: object properties: type: type: string description: >- Kind of reference, such as `PNR` for an airline's booking code. example: PNR code: type: string description: >- The reference itself, as the supplier issued it. example: ABC123 required: - type - code description: >- A reference that identifies the booking with the supplier, such as an airline's booking code. description: >- Booking references issued by the airlines. Empty until the reservation is confirmed. flightInfoUpdatedAt: type: string nullable: true description: >- When the live flight information was last collected. `null` until it is first collected. example: null format: date-time required: - journeys - tickets - locators - flightInfoUpdatedAt description: >- The booked flight: itinerary, the ticket of each passenger (by ID) with its fares and baggage, and reservation locators. This is the shape of `productSnapshot` when the trip's `vertical` is `AIR`. Amounts are integers in cents. title: Air trip - type: object properties: hotel: type: object properties: name: type: string description: Official name of the hotel. example: Hotel Paulista Plaza chain: type: object properties: brandName: type: string nullable: true description: >- Brand within the chain. `null` when not informed. example: Ibis chainName: type: string nullable: true description: >- Name of the chain. `null` for an independent hotel. example: Accor logo: type: string nullable: true description: >- URL of the chain's logo. `null` when the hotel has no chain with a registered logo. example: https://cdn.example.com/hotels/ibis.svg required: - brandName - chainName - logo description: Chain and brand of the hotel. shortAddress: type: string nullable: true description: >- Readable single-line address of the hotel. `null` when unknown. example: Av. Paulista, 1500, São Paulo, SP, Brazil phoneNumbers: type: array items: type: string example: '551133335555' description: >- Contact phone numbers of the hotel, digits only. Empty when none is registered. --- Example: `["551133335555"]` locality: type: string nullable: true description: City the hotel sits in. `null` when unknown. example: São Paulo administrativeArea: type: string nullable: true description: State, as its short code. `null` when unknown. example: SP checkInTime: type: string nullable: true description: >- Time of day, in the hotel's local time (`HH:mm`), from which guests can check in. `null` when unknown. example: '14:00' checkOutTime: type: string nullable: true description: >- Time of day, in the hotel's local time (`HH:mm`), by which guests must check out. `null` when unknown. example: '12:00' required: - name - chain - shortAddress - phoneNumbers - locality - administrativeArea - checkInTime - checkOutTime description: Hotel where the stay is booked. checkIn: type: string description: Check-in date (`YYYY-MM-DD`). example: '2026-11-02' checkOut: type: string description: Check-out date (`YYYY-MM-DD`). example: '2026-11-04' rooms: type: array items: type: object properties: name: type: string description: Name of the room, as the hotel offers it. example: Standard Room, 1 Queen Bed fare: type: object properties: currency: type: string description: >- Currency, as the ISO 4217 alphabetic code. example: BRL originalAmount: type: number description: >- Fare before discounts and fees, in cents. example: 120000 discountAmount: type: number description: Discount applied to the fare, in cents. example: 8000 feeAmount: type: number description: Fees added to the fare, in cents. example: 0 amount: type: number description: >- Total charged for the fare, in cents: `originalAmount` - `discountAmount` + `feeAmount`. example: 112000 boardType: type: string enum: - ONLY_ROOM - BREAKFAST - HALF_BOARD - FULL_BOARD - ALL_INCLUSIVE description: Meals included in the fare. example: BREAKFAST cancellationPolicies: type: object properties: refundable: type: boolean description: Whether cancelling gives any money back. example: true immediateFine: type: boolean description: >- Whether a fine applies to a cancellation made right after the booking. example: false penalties: type: array items: type: object properties: from: type: string description: >- First day (`YYYY-MM-DD`) on which this tier applies. example: '2026-10-25' currency: type: string description: >- Currency, as the ISO 4217 alphabetic code. example: BRL fineAmount: type: number nullable: true description: >- Fine charged for cancelling from `from` onward, in cents. `null` when the amount is not available. example: 15000 required: - from - currency - fineAmount description: >- One tier of a cancellation penalty schedule. description: >- Penalty tiers, each in effect from its own date. Empty when no scheduled penalty applies. required: - refundable - immediateFine - penalties description: Cancellation rules of the fare. required: - currency - originalAmount - discountAmount - feeAmount - amount - boardType - cancellationPolicies description: Fare of the room. passengersId: type: array items: type: string example: 6710a3f2c9e77b0012a4d5e1 description: >- IDs of the passengers staying in this room — the trip's `passengers[]`. --- Example: `["6710a3f2c9e77b0012a4d5e1"]` required: - name - fare - passengersId description: A booked room. description: Rooms booked for the stay. locators: type: array items: type: object properties: type: type: string description: >- Kind of reference, such as `PNR` for an airline's booking code. example: PNR code: type: string description: >- The reference itself, as the supplier issued it. example: ABC123 required: - type - code description: >- A reference that identifies the booking with the supplier, such as an airline's booking code. description: >- Booking references issued by the hotel. Empty until the reservation is confirmed. required: - hotel - checkIn - checkOut - rooms - locators description: >- The booked hotel stay: the hotel, the dates, the rooms with their fares and guests (by ID), and the reservation locators. This is the shape of `productSnapshot` when the trip's `vertical` is `HOTEL`. Amounts are integers in cents. title: Hotel trip - type: object properties: type: type: string enum: - DIRECT - CONNECTION - ONE_STOP description: >- Kind of trip: `DIRECT`, `CONNECTION` or `ONE_STOP`. example: DIRECT origin: type: object properties: locality: type: string description: City the station sits in. example: São Paulo administrativeArea: type: string description: State, as its short code. example: SP name: type: string nullable: true description: >- Official name of the station. `null` when unknown. example: Terminal Rodoviário Tietê shortAddress: type: string nullable: true description: >- Readable single-line address of the station. `null` when unknown. example: >- Av. Cruzeiro do Sul, 1800, São Paulo, SP, Brazil phoneNumbers: type: array items: type: string example: '551133336666' description: >- Contact phone numbers of the station, digits only. Empty when none is registered. --- Example: `["551133336666"]` required: - locality - administrativeArea - name - shortAddress - phoneNumbers description: Station the trip starts at. destination: type: object properties: locality: type: string description: City the station sits in. example: São Paulo administrativeArea: type: string description: State, as its short code. example: SP name: type: string nullable: true description: >- Official name of the station. `null` when unknown. example: Terminal Rodoviário Tietê shortAddress: type: string nullable: true description: >- Readable single-line address of the station. `null` when unknown. example: >- Av. Cruzeiro do Sul, 1800, São Paulo, SP, Brazil phoneNumbers: type: array items: type: string example: '551133336666' description: >- Contact phone numbers of the station, digits only. Empty when none is registered. --- Example: `["551133336666"]` required: - locality - administrativeArea - name - shortAddress - phoneNumbers description: Station the trip ends at. example: locality: Rio de Janeiro administrativeArea: RJ name: Rodoviária Novo Rio shortAddress: >- Av. Francisco Bicalho, 1, Rio de Janeiro, RJ, Brazil phoneNumbers: - '552133338888' departureDate: type: string description: >- Departure date and time in the local time of the origin station, as `YYYY-MM-DDTHH:mm:ss` with no time zone. example: '2026-11-02T08:30:00' arrivalDate: type: string description: >- Arrival date and time in the local time of the destination station, as `YYYY-MM-DDTHH:mm:ss` with no time zone. example: '2026-11-02T14:45:00' company: type: object properties: name: type: string description: Commercial name of the company. example: Expresso Brasileiro logo: type: string nullable: true description: >- URL of the company's logo. `null` when there is none. example: >- https://cdn.example.com/bus/expresso-brasileiro.png required: - name - logo description: Company that operates the trip. passengerId: type: string description: >- ID of the passenger travelling on this ticket — one of the trip's `passengers[]`. Omitted only if the passenger could not be matched to the trip's passengers. example: 6710a3f2c9e77b0012a4d5e1 segments: type: array items: type: object properties: seatNumber: type: number description: Seat reserved on the segment. example: 12 serviceClass: type: string enum: - SLEEPER_BED - BED - SEMI_BED - EXECUTIVE - CONVENTIONAL - UNDEFINED description: Class of service booked for the segment. example: EXECUTIVE origin: type: object properties: locality: type: string description: City the station sits in. example: São Paulo administrativeArea: type: string description: State, as its short code. example: SP name: type: string nullable: true description: >- Official name of the station. `null` when unknown. example: Terminal Rodoviário Tietê shortAddress: type: string nullable: true description: >- Readable single-line address of the station. `null` when unknown. example: >- Av. Cruzeiro do Sul, 1800, São Paulo, SP, Brazil phoneNumbers: type: array items: type: string example: '551133336666' description: >- Contact phone numbers of the station, digits only. Empty when none is registered. --- Example: `["551133336666"]` required: - locality - administrativeArea - name - shortAddress - phoneNumbers description: Station the segment leaves from. destination: type: object properties: locality: type: string description: City the station sits in. example: São Paulo administrativeArea: type: string description: State, as its short code. example: SP name: type: string nullable: true description: >- Official name of the station. `null` when unknown. example: Terminal Rodoviário Tietê shortAddress: type: string nullable: true description: >- Readable single-line address of the station. `null` when unknown. example: >- Av. Cruzeiro do Sul, 1800, São Paulo, SP, Brazil phoneNumbers: type: array items: type: string example: '551133336666' description: >- Contact phone numbers of the station, digits only. Empty when none is registered. --- Example: `["551133336666"]` required: - locality - administrativeArea - name - shortAddress - phoneNumbers description: Station the segment arrives at. example: locality: Rio de Janeiro administrativeArea: RJ name: Rodoviária Novo Rio shortAddress: >- Av. Francisco Bicalho, 1, Rio de Janeiro, RJ, Brazil phoneNumbers: - '552133338888' departureDate: type: string description: >- Departure date and time in the local time of the origin station, as `YYYY-MM-DDTHH:mm:ss` with no time zone. example: '2026-11-02T08:30:00' arrivalDate: type: string description: >- Arrival date and time in the local time of the destination station, as `YYYY-MM-DDTHH:mm:ss` with no time zone. example: '2026-11-02T14:45:00' duration: type: string nullable: true description: >- Duration of the leg, as `HH:mm`. `null` when not available. example: '06:15' fare: type: object properties: originalAmount: type: number description: >- Fare before discounts and fees, in cents. example: 18000 discountAmount: type: number description: Discount applied to the fare, in cents. example: 1000 feeAmount: type: number description: Fees added to the fare, in cents. example: 500 amount: type: number description: >- Total charged for the fare, in cents: `originalAmount` - `discountAmount` + `feeAmount`. example: 17500 currency: type: string description: >- Currency, as the ISO 4217 alphabetic code. example: BRL cancellationPolicies: type: object properties: refundable: type: boolean description: Whether cancelling gives any money back. example: true immediateFine: type: boolean description: >- Whether a fine applies to a cancellation made right after the booking. example: false penalties: type: array items: type: object properties: from: type: string description: >- First day (`YYYY-MM-DD`) on which this tier applies. example: '2026-10-25' currency: type: string description: >- Currency, as the ISO 4217 alphabetic code. example: BRL fineAmount: type: number nullable: true description: >- Fine charged for cancelling from `from` onward, in cents. `null` when the amount is not available. example: 15000 required: - from - currency - fineAmount description: >- One tier of a cancellation penalty schedule. description: >- Penalty tiers, each in effect from its own date. Empty when no scheduled penalty applies. required: - refundable - immediateFine - penalties description: Cancellation rules of the fare. required: - originalAmount - discountAmount - feeAmount - amount - currency - cancellationPolicies description: Fare of the segment. company: type: object properties: name: type: string description: Commercial name of the company. example: Expresso Brasileiro logo: type: string nullable: true description: >- URL of the company's logo. `null` when there is none. example: >- https://cdn.example.com/bus/expresso-brasileiro.png required: - name - logo description: Operator running this leg. required: - seatNumber - serviceClass - origin - destination - departureDate - arrivalDate - duration - fare - company description: >- One leg of the bus trip, with the seat booked on it. description: >- Segments of the trip, one per leg, each with its seat, fare and operator. routeDirection: type: string enum: - DEPARTURE - RETURN description: >- Whether this booking is the outbound trip (`DEPARTURE`) or the return trip (`RETURN`). example: DEPARTURE boardingInfo: description: >- Boarding pass and, per leg, platform and ticket codes. `null` until it is first collected, as the departure approaches. example: null type: object properties: boardingPass: type: string nullable: true description: >- The boarding pass PDF, base64-encoded. `null` when not available yet. example: JVBERi0xLjcK routes: type: array items: type: object properties: origin: type: string description: City the leg starts in. example: São Paulo destination: type: string description: City the leg ends in. example: Rio de Janeiro platform: type: string nullable: true description: >- Boarding platform at the origin station. `null` when not assigned or not applicable. example: '14' departureDate: type: string description: >- Departure date and time in local time, as `YYYY-MM-DDTHH:mm:ss` with no time zone. example: '2026-11-02T08:30:00' arrivalDate: type: string description: >- Arrival date and time in local time, as `YYYY-MM-DDTHH:mm:ss` with no time zone. example: '2026-11-02T14:45:00' tickets: type: array items: type: object properties: passengerId: type: string description: >- ID of the passenger the ticket belongs to — one of the trip's `passengers[]`. Omitted only if the passenger could not be matched to the trip's passengers. example: 6710a3f2c9e77b0012a4d5e1 locators: type: array items: type: object properties: type: type: string description: >- Kind of reference, such as `PNR` for an airline's booking code. example: PNR code: type: string description: >- The reference itself, as the supplier issued it. example: ABC123 required: - type - code description: >- A reference that identifies the booking with the supplier, such as an airline's booking code. description: >- Booking references of the ticket. Empty when none is available. ticketCode: type: string nullable: true description: >- Code of the ticket. `null` when not available. example: EB123456 qrCode: type: string nullable: true description: >- The boarding QR code image, base64-encoded. `null` when not available. example: iVBORw0KGgo= bpeNumber: type: string nullable: true description: >- Number of the electronic bus ticket (BP-e). `null` when not available. example: >- 35261112345678000190630010000123451000123456 required: - locators - ticketCode - qrCode - bpeNumber description: >- The boarding ticket of one passenger on one leg. description: Tickets of the leg, one per passenger. required: - origin - destination - platform - departureDate - arrivalDate - tickets description: The boarding details of one leg of the trip. description: >- Boarding details per leg. A connection has two legs; direct and one-stop trips have one. required: - boardingPass - routes nullable: true required: - type - origin - destination - departureDate - arrivalDate - company - segments - routeDirection - boardingInfo description: >- The booked bus trip of one passenger (by ID): stations, operator, the legs with their seats and fares, and boarding information. This is the shape of `productSnapshot` when the trip's `vertical` is `BUS`. Amounts are integers in cents. title: Bus trip - type: object properties: groupName: type: string description: >- Commercial group the vehicle belongs to, such as `ECONOMY` or `SUV`. example: ECONOMY class: type: string description: Class of the vehicle within its group. example: INTERMEDIATE name: type: string description: >- Name of the vehicle, as the rental company displays it. example: Fiat Mobi sipp: type: string description: >- SIPP code that classifies the vehicle by size, doors, transmission and fuel. example: ECMR rentalCompany: type: object properties: code: type: string description: Code of the rental company. example: LOC name: type: string description: Commercial name of the rental company. example: Localiza logo: type: string nullable: true description: >- URL of the rental company's logo. `null` when the company has no registered logo. example: https://cdn.example.com/rentals/localiza.svg required: - code - name - logo description: Rental company that holds the booking. pickUpLocation: type: object properties: name: type: string description: Name of the rental location. example: Localiza Aeroporto Guarulhos (GRU) phoneNumbers: type: array items: type: string example: '551133337777' description: >- Contact phone numbers of the location, digits only. Empty when none is registered. --- Example: `["551133337777"]` shortAddress: type: string nullable: true description: >- Readable single-line address of the location. `null` when unknown. example: Rod. Hélio Smidt, s/n, Guarulhos, SP, Brazil locality: type: string nullable: true description: >- City the location sits in. `null` when unknown. example: Guarulhos administrativeArea: type: string nullable: true description: State, as its short code. `null` when unknown. example: SP required: - name - phoneNumbers - shortAddress - locality - administrativeArea description: Where the vehicle is picked up. dropOffLocation: type: object properties: name: type: string description: Name of the rental location. example: Localiza Aeroporto Guarulhos (GRU) phoneNumbers: type: array items: type: string example: '551133337777' description: >- Contact phone numbers of the location, digits only. Empty when none is registered. --- Example: `["551133337777"]` shortAddress: type: string nullable: true description: >- Readable single-line address of the location. `null` when unknown. example: Rod. Hélio Smidt, s/n, Guarulhos, SP, Brazil locality: type: string nullable: true description: >- City the location sits in. `null` when unknown. example: Guarulhos administrativeArea: type: string nullable: true description: State, as its short code. `null` when unknown. example: SP required: - name - phoneNumbers - shortAddress - locality - administrativeArea description: Where the vehicle is dropped off. pickUpDate: type: string description: >- Pick-up date and time in the local time of the pick-up location, as `YYYY-MM-DDTHH:mm:ss` with no time zone. example: '2026-11-02T10:00:00' dropOffDate: type: string description: >- Drop-off date and time in the local time of the drop-off location, as `YYYY-MM-DDTHH:mm:ss` with no time zone. example: '2026-11-04T10:00:00' rentals: type: array items: type: object properties: description: type: string nullable: true description: >- Readable description of the rental option. `null` when not provided. example: >- Compact car, air conditioning, unlimited mileage fare: type: object properties: originalAmount: type: number description: >- Fare before discounts and fees, in cents. example: 36000 discountAmount: type: number description: Discount applied to the fare, in cents. example: 2000 feeAmount: type: number description: Fees added to the fare, in cents. example: 0 amount: type: number description: >- Total charged for the fare, in cents: `originalAmount` - `discountAmount` + `feeAmount`. example: 34000 currency: type: string description: >- Currency, as the ISO 4217 alphabetic code. example: BRL cancellationPolicies: type: object properties: refundable: type: boolean description: Whether cancelling gives any money back. example: true immediateFine: type: boolean description: >- Whether a fine applies to a cancellation made right after the booking. example: false penalties: type: array items: type: object properties: from: type: string nullable: true description: >- First day (`YYYY-MM-DD`) on which this tier applies. `null` when the supplier gave no date. example: '2026-10-31' currency: type: string description: >- Currency, as the ISO 4217 alphabetic code. example: BRL fineAmount: type: number nullable: true description: >- Fine charged for cancelling from `from` onward, in cents. `null` when the amount is not available. example: 12000 required: - from - currency - fineAmount description: >- One tier of the cancellation penalty schedule of a rental. description: >- Penalty tiers, each in effect from its own date. Empty when no scheduled penalty applies. required: - refundable - immediateFine - penalties description: Cancellation rules of the fare. required: - originalAmount - discountAmount - feeAmount - amount - currency - cancellationPolicies description: Fare of the rental. passengersId: type: array items: type: string example: 6710a3f2c9e77b0012a4d5e1 description: >- IDs of the passengers travelling on this rental — the trip's `passengers[]`. Empty when none was assigned. --- Example: `["6710a3f2c9e77b0012a4d5e1"]` locators: type: array items: type: object properties: type: type: string description: >- Kind of reference, such as `PNR` for an airline's booking code. example: PNR code: type: string description: >- The reference itself, as the supplier issued it. example: ABC123 required: - type - code description: >- A reference that identifies the booking with the supplier, such as an airline's booking code. description: >- Booking references of the rental with the rental company. Empty until the reservation is confirmed. required: - description - fare - passengersId - locators description: A booked rental. description: Rentals booked under this record. locators: type: array items: type: object properties: type: type: string description: >- Kind of reference, such as `PNR` for an airline's booking code. example: PNR code: type: string description: >- The reference itself, as the supplier issued it. example: ABC123 required: - type - code description: >- A reference that identifies the booking with the supplier, such as an airline's booking code. description: >- Booking references of the reservation as a whole. Empty until the reservation is confirmed. required: - groupName - class - name - sipp - rentalCompany - pickUpLocation - dropOffLocation - pickUpDate - dropOffDate - rentals - locators description: >- The booked vehicle rental: the vehicle, the rental company, the pick-up and drop-off places and dates, fares, passengers (by ID) and reservation locators. This is the shape of `productSnapshot` when the trip's `vertical` is `VEHICLE`. Amounts are integers in cents. title: Vehicle trip description: >- The booked product: the itinerary, stay, ticket or rental as recorded by the travel provider — journeys and flights, the hotel and its rooms, the route and boarding information, the rental — with its fares, policies and booking locators. It does not repeat the trip's own fields (`state`, `status`, the amounts, the dates) and carries no identifier of the travel provider; passengers are referenced by their `id` in `passengers[]`. Its shape depends on `vertical`: a flight (`AIR`), a hotel stay (`HOTEL`), a bus ticket (`BUS`) or a vehicle rental (`VEHICLE`) — see the four schemas below. Omitted until the record is first fetched. cancellation: type: object properties: quoteId: type: string description: ID of the confirmed cancellation quote. cancelType: type: string enum: - CREDIT - REFUND - MANUAL_CANCEL - VOID description: >- Kind of cancellation: `VOID` for a trip not issued yet, `REFUND` or `CREDIT` for an issued one, `MANUAL_CANCEL` when the amounts are settled outside the system. originalAmount: type: number nullable: true description: >- What the trip cost, in cents. Omitted when it couldn't be recorded; `null` for `MANUAL_CANCEL`. remainingAmount: type: number nullable: true description: >- What is given back after the fine, in cents. Omitted when it couldn't be recorded; `null` for `MANUAL_CANCEL`. fineAmount: type: number nullable: true description: >- Cancellation fine, in cents. Omitted when it couldn't be recorded; `null` for `MANUAL_CANCEL`. currency: type: string description: >- Currency of the amounts, as the numeric ISO 4217 code (`986` is BRL). status: type: string description: Status of the quote when it was confirmed. expiresAt: type: string description: When the quote would have expired. format: date-time confirmedAt: type: string description: When the cancellation was confirmed. format: date-time confirmedBy: type: string description: >- ID of the user who confirmed the cancellation. Omitted when a service did. required: - quoteId - cancelType description: >- The confirmed cancellation. Omitted until one is confirmed. createdAt: type: string description: When the trip was created. example: '2026-10-01T13:45:12.000Z' format: date-time updatedAt: type: string description: When the trip last changed. example: '2026-10-01T13:46:03.000Z' format: date-time required: - id - realmId - organizationId - customFields - vertical - state - status - passengers description: >- A trip: ONE booked product — a flight, a hotel stay, a bus ticket or a vehicle rental — for the organization's passengers, with its lifecycle. Booking several products means creating several trips. examples: air-trip: summary: Air trip value: id: 6711b4c0d8e1a30012b7c9f2 realmId: f495ff0c-ab54-4f99-8e92-ca8682e4de9b organizationId: c4bd3f21-dfbd-44e8-8055-68ba15bed410 createdBy: e3553bc1-5e20-4e17-b22a-a796fda0aa99 customFields: cost-center: CC-1020 vertical: AIR state: RESERVED status: RESERVED reservationExpiresAt: '2026-10-02T13:45:12.000Z' originalAmount: 95000 discountAmount: 3010 feeAmount: 0 totalAmount: 91990 currency: '986' passengers: - id: 6710a3f2c9e77b0012a4d5e1 userId: e3553bc1-5e20-4e17-b22a-a796fda0aa99 lead: true name: Mariana Costa gender: FEMALE birthDate: '1990-04-17' productSnapshot: journeys: - id: jour_V1StGXR8Z5jdHi6BmyT2k direction: DEPARTURE origin: iata: GRU name: São Paulo/Guarulhos International Airport shortAddress: Guarulhos, SP, Brazil locality: Guarulhos administrativeArea: SP phoneNumbers: - '551133334444' destination: iata: SDU name: Rio de Janeiro/Santos Dumont Airport shortAddress: Rio de Janeiro, RJ, Brazil locality: Rio de Janeiro administrativeArea: RJ phoneNumbers: - '552133339999' departureDate: '2026-11-02T08:30:00' arrivalDate: '2026-11-02T09:35:00' duration: '01:05' segments: - airline: code: LA name: LATAM Airlines logo: https://cdn.example.com/airlines/LA.png operation: code: LA name: LATAM Airlines logo: https://cdn.example.com/airlines/LA.png origin: iata: GRU name: São Paulo/Guarulhos International Airport shortAddress: Guarulhos, SP, Brazil locality: Guarulhos administrativeArea: SP phoneNumbers: - '551133334444' destination: iata: SDU name: Rio de Janeiro/Santos Dumont Airport shortAddress: Rio de Janeiro, RJ, Brazil locality: Rio de Janeiro administrativeArea: RJ phoneNumbers: - '552133339999' flightNumber: '3101' departureDate: '2026-11-02T08:30:00' arrivalDate: '2026-11-02T09:35:00' flightType: REGULAR duration: '01:05' equipment: 32Q cabin: ECONOMY class: 'Y' fareBasis: YOW flightInfo: null tickets: - passengerId: 6710a3f2c9e77b0012a4d5e1 fareDescription: GRU to SDU, LATAM Airlines, Economy ticketNumber: null fares: - journeyId: jour_V1StGXR8Z5jdHi6BmyT2k currency: BRL originalAmount: 95000 discountAmount: 3010 feeAmount: 0 amount: 91990 cancellationPolicies: refundable: true immediateFine: false penalties: - from: '2026-10-25' currency: BRL fineAmount: 15000 changePolicies: canChange: true immediateFine: false penalties: - from: '2026-10-25' currency: BRL fineAmount: 8000 segments: - flightNumber: '3101' cabin: ECONOMY class: 'Y' fareBasis: YOW baggages: - quantity: 1 weight: 23 type: CHECKED locators: - type: PNR code: ABC123 flightInfoUpdatedAt: null createdAt: '2026-10-01T13:45:12.000Z' updatedAt: '2026-10-01T13:46:03.000Z' hotel-trip: summary: Hotel trip value: id: 6711b4c0d8e1a30012b7c9f2 realmId: f495ff0c-ab54-4f99-8e92-ca8682e4de9b organizationId: c4bd3f21-dfbd-44e8-8055-68ba15bed410 createdBy: e3553bc1-5e20-4e17-b22a-a796fda0aa99 customFields: cost-center: CC-1020 vertical: HOTEL state: RESERVED status: RESERVED reservationExpiresAt: '2026-10-02T13:45:12.000Z' originalAmount: 95000 discountAmount: 3010 feeAmount: 0 totalAmount: 91990 currency: '986' passengers: - id: 6710a3f2c9e77b0012a4d5e1 userId: e3553bc1-5e20-4e17-b22a-a796fda0aa99 lead: true name: Mariana Costa gender: FEMALE birthDate: '1990-04-17' productSnapshot: hotel: name: Hotel Paulista Plaza chain: brandName: Ibis chainName: Accor logo: https://cdn.example.com/hotels/ibis.svg shortAddress: Av. Paulista, 1500, São Paulo, SP, Brazil phoneNumbers: - '551133335555' locality: São Paulo administrativeArea: SP checkInTime: '14:00' checkOutTime: '12:00' checkIn: '2026-11-02' checkOut: '2026-11-04' rooms: - name: Standard Room, 1 Queen Bed fare: currency: BRL originalAmount: 120000 discountAmount: 8000 feeAmount: 0 amount: 112000 boardType: BREAKFAST cancellationPolicies: refundable: true immediateFine: false penalties: - from: '2026-10-25' currency: BRL fineAmount: 15000 passengersId: - 6710a3f2c9e77b0012a4d5e1 locators: - type: PNR code: ABC123 createdAt: '2026-10-01T13:45:12.000Z' updatedAt: '2026-10-01T13:46:03.000Z' bus-trip: summary: Bus trip value: id: 6711b4c0d8e1a30012b7c9f2 realmId: f495ff0c-ab54-4f99-8e92-ca8682e4de9b organizationId: c4bd3f21-dfbd-44e8-8055-68ba15bed410 createdBy: e3553bc1-5e20-4e17-b22a-a796fda0aa99 customFields: cost-center: CC-1020 vertical: BUS state: RESERVED status: RESERVED reservationExpiresAt: '2026-10-02T13:45:12.000Z' originalAmount: 95000 discountAmount: 3010 feeAmount: 0 totalAmount: 91990 currency: '986' passengers: - id: 6710a3f2c9e77b0012a4d5e1 userId: e3553bc1-5e20-4e17-b22a-a796fda0aa99 lead: true name: Mariana Costa gender: FEMALE birthDate: '1990-04-17' productSnapshot: type: DIRECT origin: locality: São Paulo administrativeArea: SP name: Terminal Rodoviário Tietê shortAddress: Av. Cruzeiro do Sul, 1800, São Paulo, SP, Brazil phoneNumbers: - '551133336666' destination: locality: Rio de Janeiro administrativeArea: RJ name: Rodoviária Novo Rio shortAddress: Av. Francisco Bicalho, 1, Rio de Janeiro, RJ, Brazil phoneNumbers: - '552133338888' departureDate: '2026-11-02T08:30:00' arrivalDate: '2026-11-02T14:45:00' company: name: Expresso Brasileiro logo: https://cdn.example.com/bus/expresso-brasileiro.png passengerId: 6710a3f2c9e77b0012a4d5e1 segments: - seatNumber: 12 serviceClass: EXECUTIVE origin: locality: São Paulo administrativeArea: SP name: Terminal Rodoviário Tietê shortAddress: Av. Cruzeiro do Sul, 1800, São Paulo, SP, Brazil phoneNumbers: - '551133336666' destination: locality: Rio de Janeiro administrativeArea: RJ name: Rodoviária Novo Rio shortAddress: >- Av. Francisco Bicalho, 1, Rio de Janeiro, RJ, Brazil phoneNumbers: - '552133338888' departureDate: '2026-11-02T08:30:00' arrivalDate: '2026-11-02T14:45:00' duration: '06:15' fare: originalAmount: 18000 discountAmount: 1000 feeAmount: 500 amount: 17500 currency: BRL cancellationPolicies: refundable: true immediateFine: false penalties: - from: '2026-10-25' currency: BRL fineAmount: 15000 company: name: Expresso Brasileiro logo: >- https://cdn.example.com/bus/expresso-brasileiro.png routeDirection: DEPARTURE boardingInfo: null createdAt: '2026-10-01T13:45:12.000Z' updatedAt: '2026-10-01T13:46:03.000Z' vehicle-trip: summary: Vehicle trip value: id: 6711b4c0d8e1a30012b7c9f2 realmId: f495ff0c-ab54-4f99-8e92-ca8682e4de9b organizationId: c4bd3f21-dfbd-44e8-8055-68ba15bed410 createdBy: e3553bc1-5e20-4e17-b22a-a796fda0aa99 customFields: cost-center: CC-1020 vertical: VEHICLE state: RESERVED status: RESERVED reservationExpiresAt: '2026-10-02T13:45:12.000Z' originalAmount: 95000 discountAmount: 3010 feeAmount: 0 totalAmount: 91990 currency: '986' passengers: - id: 6710a3f2c9e77b0012a4d5e1 userId: e3553bc1-5e20-4e17-b22a-a796fda0aa99 lead: true name: Mariana Costa gender: FEMALE birthDate: '1990-04-17' productSnapshot: groupName: ECONOMY class: INTERMEDIATE name: Fiat Mobi sipp: ECMR rentalCompany: code: LOC name: Localiza logo: https://cdn.example.com/rentals/localiza.svg pickUpLocation: name: Localiza Aeroporto Guarulhos (GRU) phoneNumbers: - '551133337777' shortAddress: Rod. Hélio Smidt, s/n, Guarulhos, SP, Brazil locality: Guarulhos administrativeArea: SP dropOffLocation: name: Localiza Aeroporto Guarulhos (GRU) phoneNumbers: - '551133337777' shortAddress: Rod. Hélio Smidt, s/n, Guarulhos, SP, Brazil locality: Guarulhos administrativeArea: SP pickUpDate: '2026-11-02T10:00:00' dropOffDate: '2026-11-04T10:00:00' rentals: - description: Compact car, air conditioning, unlimited mileage fare: originalAmount: 36000 discountAmount: 2000 feeAmount: 0 amount: 34000 currency: BRL cancellationPolicies: refundable: true immediateFine: false penalties: - from: '2026-10-31' currency: BRL fineAmount: 12000 passengersId: - 6710a3f2c9e77b0012a4d5e1 locators: - type: PNR code: ABC123 locators: - type: PNR code: ABC123 createdAt: '2026-10-01T13:45:12.000Z' updatedAt: '2026-10-01T13:46:03.000Z' '404': description: >- `TRIP_NOT_FOUND` — No trip with this ID is visible to you in the organization: it doesn't exist, belongs to another organization, or you are neither an organization admin nor a passenger on it. content: application/json: schema: type: object properties: traceId: type: string description: >- Identifier of the request that failed. Quote it when contacting support. example: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: type: string enum: - TRIP_NOT_FOUND description: >- Stable, machine-readable error code. Branch on this, never on `message`. origin: type: string enum: - TRAVEL description: Service that produced the error. message: type: string description: >- Human-readable explanation. Its wording may change without notice. required: - traceId - code - origin - message example: traceId: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: TRIP_NOT_FOUND origin: TRAVEL message: Trip not found '422': description: >- `BAD_REQUEST` — A path parameter is not a valid ID; `fields` lists each one. content: application/json: schema: type: object properties: traceId: type: string description: >- Identifier of the request that failed. Quote it when contacting support. example: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: type: string enum: - BAD_REQUEST description: >- Stable, machine-readable error code. Branch on this, never on `message`. origin: type: string enum: - TRAVEL description: Service that produced the error. message: type: string description: >- Human-readable explanation. Its wording may change without notice. fields: type: array description: >- One entry per invalid request field (validation errors only). items: type: object properties: field: type: string description: >- Path of the invalid field, e.g. `label` or `values[0].value`. example: label message: type: string description: Why the field was rejected. example: label is required code: type: string description: >- `_` — e.g. `LABEL_REQUIRED`, `TYPE_ONE_OF`, `VALUES_VALUE_TYPE_ERROR`. example: LABEL_REQUIRED values: type: array items: type: string description: >- The accepted values, when the field is an enumeration. required: - field - message - code required: - traceId - code - origin - message example: traceId: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: BAD_REQUEST origin: TRAVEL message: >- Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields. fields: - field: organizationId message: Invalid UUID code: ORGANIZATIONID_UUID ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.