--- title: "Status" method: GET path: "/reservations" tags: ["Reservations"] --- # Status `GET /reservations` ## Request - Base URL: `https://api-dev.despegar.com/v3` - URL: `https://api-dev.despegar.com/v3/reservations` - Auth: API key in header `x-apikey` ## Query parameters - `product_id` integer - `product_type` 'HOTEL' | 'FLIGHT' | 'TICKET' | 'TOUR' - `reservation_id` integer - `flow_id` string - `partner_id` string - `limit` integer - `page` integer - `by_api_key` boolean - `external_transaction_id` integer - `from_purchase_date` string, date - `to_purchase_date` string, date ## Response `200` OK - object - `items` object[]: List of reservations matching the query. The fields present in each item depend on the `product_type` (FLIGHT, HOTEL, TICKET). - `id` string: Unique reservation identifier. - `product` object: Product details. The fields present depend on the `product_type`. - `product_id` string: Unique product identifier within the reservation. - `product_type` 'FLIGHT' | 'HOTEL' | 'TICKET' | 'TOUR': Type of the reserved product. Determines which fields are present. - `transaction_id` string: Internal transaction identifier associated with the reservation. - `status` 'IN_PROCESS' | 'ISSUED' | 'CANCELLED': Current status of the reservation. - `purchase_date_time` string, date-time: Date and time when the reservation was created. Format: ISO 8601 (UTC). - `partner_id` string: Identifier of the partner who made the reservation. - `pnr` string: Booking reference code (PNR) assigned by the provider. - `external_reservation_id` string: Reservation identifier in the partner's system. - `reservation_id` string: Internal reservation identifier. - `sale_price` object: Pricing breakdown of the reservation. - `currency` string: Currency code (ISO 4217). E.g.: `BRL`, `USD`, `MXN`. - `price` number: Total sale price in the specified currency. - `conversion_rate` number: Exchange rate used to convert from the base currency to the sale currency. - `charges` object[]: Breakdown of charge categories that compose the total price. - `code` string: Charge category code. E.g.: `FARE`, `FEE`, `INTERESTS`, `DISCOUNT`. - `charges` object[]: Sub-charges within the category. - `code` string: Sub-charge code. - `individual_charges` object[]: Individual charge breakdown. Only present for some sub-charges. - … - `purchase_customer` object: Contact information of the purchasing customer. - `full_name` string: Full name of the purchasing customer. Only present for FLIGHT reservations. - `email` string: Email address of the purchasing customer. - `phone_number` string: Primary phone number of the purchasing customer. - `phone_type` string: Type of the primary phone. E.g.: `HOME`, `MOBILE`, `FAX`. - `phones` object[]: List of phone numbers for the purchasing customer. - `type` string: Phone type. E.g.: `HOME`, `MOBILE`, `FAX`. - `number` string: Phone number including country and area code. - `departure_date_time` string, date-time: Scheduled departure date and time (UTC). Only present for FLIGHT reservations. - `itinerary_type` 'ONE_WAY' | 'ROUND_TRIP' | 'MULTI_DESTINATION': Type of flight itinerary. Only present for FLIGHT reservations. - `passengers` object[]: List of passengers. Only present for FLIGHT and TICKET reservations. - `gender` 'MALE' | 'FEMALE': Passenger gender. - `type` 'ADULT' | 'CHILD' | 'INFANT': Passenger type. - `birth_date` string, date-time: Passenger date of birth. - `first_name` string: Passenger first name. - `last_name` string: Passenger last name. - `nationality` string: Passenger nationality as ISO country code. E.g.: `BR`, `AR`, `MX`. - `identification_type` 'LOCAL' | 'PASSPORT': Type of identification document. - `identification_code` string: Identification document number. - `passenger_index` string: Zero-based index of the passenger within the reservation. - `tickets` object[]: List of tickets associated with the passenger. - `type` string: Ticket type. E.g.: `ETICKET`. - `number` string: Ticket number. - `active` boolean: Indicates whether the ticket is currently active. - `routes` object[]: List of route legs. Only present for FLIGHT reservations. - `departure_location` object - `city_code` string - `country_code` string - `city_id` string - `arrival_location` object - `city_code` string - `country_code` string - `city_id` string - `departure_date_time` string: Local departure date and time. - `arrival_date_time` string: Local arrival date and time. - `gmt_departure_date_time` string: Departure date and time in UTC. - `gmt_arrival_date_time` string: Arrival date and time in UTC. - `departure_date_time_zone` string: Timezone of the departure location. E.g.: `America/Mexico_City`. - `arrival_date_time_zone` string: Timezone of the arrival location. E.g.: `Europe/Madrid`. - `web_check_in_code` string: Code used for web check-in. Only present when available. - `included_baggage` object[]: Baggage allowance included in the fare per passenger type. - `passenger_type` string - `checked_bags` object - `quantity` integer: Number of checked bags included. - `carry_on` boolean: Indicates if carry-on baggage is included. - `personal_item` boolean: Indicates if a personal item is included. - `segments` object[]: List of flight segments within the route leg. - `segment_index` integer - `flight_number` integer - `flight_class` string: Cabin class. E.g.: `ECONOMY`, `BUSINESS`. - `operating_carrier_code` string - `operating_carrier_description` string - `marketing_carrier_code` string - `marketing_carrier_description` string - `duration` integer: Flight duration in minutes. - `stopovers` object[]: List of stopovers. Empty if non-stop. - `departure_location` object - `airport` string - `city_code` string - `country_code` string - `gmt_date_time` string - `timezone` string - `local_date` string - `arrival_location` object - `airport` string - `city_code` string - `country_code` string - `gmt_date_time` string - `timezone` string - `local_date` string - `check_in_date_time` string, date-time: Check-in date and time. Only present for HOTEL reservations. - `check_out_date_time` string, date-time: Check-out date and time. Only present for HOTEL reservations. - `hotel_id` string: Internal identifier of the hotel. Only present for HOTEL reservations. - `hotel_name` string: Name of the hotel. Only present for HOTEL reservations. - `rooms` object[]: List of rooms included in the reservation. Only present for HOTEL reservations. - `code` string: Room identifier code. - `meal_plan_code` string: Meal plan code. E.g.: `B` (Breakfast), `AI` (All Inclusive). - `meal_plan_description` string: Full description of the meal plan. - `description` string: Room type description. - `bed_type_description` string: Description of the bed configuration. - `holder_first_name` string: First name of the room holder. - `holder_last_name` string: Last name of the room holder. - `adults` integer: Number of adults in the room. - `minor_ages` integer[]: Ages of minors in the room. Empty if no minors. - `use_date` string, date-time: Date on which the activity/ticket is valid for use. Only present for TICKET reservations. - `use_expiration_date` string, date-time: Expiration date of the ticket. Only present for TICKET reservations. - `use_type` string: Indicates when the ticket can be used. E.g.: `FIXED`. Only present for TICKET reservations. - `ticket_type` string: Type or brand of the ticket. E.g.: `DISNEY`. Only present for TICKET reservations. - `duration` integer: Duration of the activity in days. Only present for TICKET reservations. - `highlights` string[]: List of highlights or main attractions of the activity. Only present for TICKET reservations. - `all_travelers_required` boolean: Indicates if all travelers must be present to use the ticket. Only present for TICKET reservations. - `cancellation_policy` object: Cancellation policy for the reservation. Only present for TICKET reservations. - `cancellable` boolean: Indicates if the reservation can be cancelled. - `conditions` string[]: List of cancellation conditions. - `descriptions` string[]: Human-readable cancellation deadline descriptions. - `ranges` object[]: Cancellation fee ranges by date. - `from` string, date-time: Start date of this cancellation fee range. - `percentage` number: Cancellation fee as a percentage of the total price. - `rounded_percentage` number: Rounded cancellation fee percentage. - `flows` object[]: List of flows associated with the reservation (e.g. payment, cancellation). - `flow_id` string - `flow_type` string - `status` string - `created_date` string - `finalized_date` string - `postsales` object[]: List of post-sale actions associated with the reservation. - `notifications` object[]: List of notifications sent for this reservation. - `invoices` object[]: List of invoices associated with the reservation. - `download_voucher_url` string: Relative URL to download the reservation voucher. Not always present. ## Other responses - `400`: Invalid request - `401`: Unauthorized - `500`: Internal server error --- [API](https://skmtc.dev/despegar/apis/aftersale.md) - [All operations](https://skmtc.dev/despegar/apis/aftersale/llms.txt) - [OpenAPI document](https://skmtc.dev/despegar/apis/aftersale/revisions/686d705e3aa8?raw)