JSON API - GETRES

Owned by Vincent Josset
Feb 20, 2023
5 min read

Returns the details of the requested reservation number.

Input

  • transtype - "GETRES"

  • login - API user's username

  • password - API user's password

  • resnumber - The reservation number for the reservation whose details you want to pull

Output

  • Reservation

    • Header - General information about the reservation

      • ResNumber

      • ProductCode

      • BrandID

      • DepartureDate

      • ReturnDate

      • BookDate

      • BookedBy - The user ID of the user who created this reservation

      • ResStatus - The status of the reservation. Valid ResStatus values:

        • A - Active: A reservation that has received payment, has taken inventory and made PNRs (where applicable)

        • Q - Quote: A reservation that has not received payment, but has taken inventory and has made PNRs (where applicable)

        • X - Cancelled: A reservation that has been cancelled

        • O - Option: A saved itinerary. This reservation has not received payment, has not taken inventory and has not made any PNRs

      • DepositDate - The date that deposit is due

      • DepositAmount - The minimum deposit amount due on or before deposit date

      • FinalDate - The date that the final payment is due

      • QuoteCurrency - The currency of the prices on this reservation

      • Price - The total price of the reservation, excluding taxes and GST (PriceTax and PriceGST)

      • PriceTax - The total taxes on the reservation

      • PriceGST

      • Commission - The total amount of commission (if any) to be paid to the travel agent on this reservation

      • Received - The total amount received on this reservation

      • LeadName - The name of the lead passenger on this reservation

      • ContactID - The contact ID for the main contact on this reservation. For agency bookings, the main contact is the travel agent. For direct bookings, the main contact is the lead passenger.

      • CustomerID - The Customer ID (usually IATA number) of the agency this reservation belongs to. For direct bookings, the customer ID is blank.

      • CustomerName - The name of the agency this reservation belongs to

    • Contact - The contact record for the main contact on this reservation

      • ContactID - The unique ID for this contact

      • LastName

      • FirstName

      • Gender - string - "M" for Male, or "F" for Female

      • PaxType - string - "A" for Adult, or "C" for Child

      • Email

      • Phone

      • MobilePhone

      • Fax

      • Address

        • Address1

        • Address2

        • City

        • State

        • Zip

        • Country

    • Passengers - The array of passengers on this reservation

      • LastName

      • FirstName

      • Gender - string - "M" for Male, or "F" for Female

      • PaxType - string - "A" for Adult, or "C" for Child

      • Email

      • Phone

      • MobilePhone

      • Fax

      • HotelRequest - String - Free text field for hotel-related requests (smoking room, lower floor, disabled access etc.)

      • AirRequest - String - Free text field for air-related requests (Vegetarian meals, aisle/window seat etc.)

      • GeneralRequest - String - Free text field for all other passenger requests

      • Address

        • Address1

        • Address2

        • City

        • State

        • Zip

        • Country

      • BirthDate

    • Services - The array of services on this reservation

      • ServiceSeq - Unique integer for this service on this reservation. In combination with ResNumber (e.g. "123456-1" for reservation #123456, ServiceSeq #1), represents a globally unique reservation service.

      • ConfInfo - Confirmation number from vendor/supplier

      • ProductCode - The product code from which this service was booked

      • Seq - The sequence/item number for this service in the product

      • ISeq - The inclusion number for this service in the product

      • ItemRole - Indicates the role of this service in the product

        • Item Roles:

          • R - "Required" - Required and included in package price

          • S - "Supplement" - Required but not included in package price

          • O - "Optional" - Not required, not included in package price

      • RequestedMask - The original requested mask at time of booking for this service

      • IsRemark - Indicates whether this item is a remark rather than an actual service

      • ServiceType

      • ServiceTypeName

      • IsUnavailable

      • UnavailableReason

      • ServiceDate

      • ServiceTime

      • DayNumber

      • ServiceDuration

      • SupplierID

      • ServiceID

      • ExtSvcRef - string - The External Service Reference that was passed in the BOOK command for this service

      • Description - The description of this service. For example, hotel room category)

      • SupplierName - The name of the supplier for this service. In case of a hotel, this is the hotel name.

      • VoucherNotes

      • ItineraryDescription

      • Destination - The city code indicating where this service occurs. For transfers, this is the city code for pickup.

      • ToDestination - For transfers, the city code for dropoff

      • SupplierImage

      • SupplierThumbnail

      • SupplierDetail

      • VerboseDuration - The duration of the service in a user-friendly format (i.e. "6 Nights" or "3 Days")

      • VerboseQty - The qty of the service in a user-friendly format (i.e. "2 Double Rooms" or "1 Deluxe Cabin")

      • TotalPrice - The total price of the service (excluding Tax and GST)

      • TotalPriceTax - The total tax of the service

      • TotalPriceGST - The total GST/VAT of the service

      • TotalCommission - The total commission (to the agency, where applicable)

      • TotalQty

      • SupplierRating - The supplier's star rating. E.g. "4*", "4.5*". May be blank.

      • ConfStatus - The confirmation status for this service. May be "BK" (confirmed from inventory/block), "OR" (on request), "CF" (confirmed over allotment), or blank (no confirmation needed).

      • PriceItems - Array of PriceItems for this priced service

        • Qty - The number of units returned

        • Unit - The unit for the qty (i.e. "Room", "Cabin", "Car")

        • Mask - The mask that was found (may not match the requested mask, for example for hotel rooms that don't have child rates, a RequestedMask of "AAC5" may return a room with mask "AAA")

        • RequestedMask - The original requested mask

        • Price - The price per unit (excluding Tax and GST/VAT)

        • PriceTax - The tax per unit

        • PriceGST - The GST/VAT per unit

        • Commission - The commission per unit (to the agency, where applicable)

        • CommissionPercentage - The commission percentage

        • VerboseQty - The qty of the service in a user-friendly format (i.e. "2 Double Rooms" or "1 Deluxe Cabin")

      • AIR SERVICES ONLY

      • flights - Array of flight objects

        • fromairportcode - String - The airport code for the flight's departure

        • fromairportname - String - The airport name for the flight's departure

        • toairportcode - String - The airport code for the flight's arrival

        • toairportname - String - The airport name for the flight's arrival

        • airlinecode - String - The two-letter airline code for this flight

        • airlinename - String - The name of the airline operating this flight

        • flightnumber - String

        • departuredate - Date - The local departure date of this flight

        • departuretime - String - The local departure time of this flight

        • arrivaldate - Date - The local arrival date of this flight

        • arrivaltime - String - The local arrival time of this flight

        • gdspnr - String - The GDS (Amadeus, Sabre etc.) Record Locator for this flight

        • carrierpnr - String - The airline's Record Locator for this flight***** elapsedtime - String - The duration of this flight

        • numstop - Integer - The number of stops for this flight

        • operatedby - String - The airline code for the operating airline for this flight

        • class - String - The class of service for this flight

        • equipment - String The plane code for this flight

        • status - String - The confirmation status of this flight in the GDS

        • bookedseats - String - The seats that are booked for this flight

  • Payments

    • Array of payment objects representing payments received for this reservation

    • TransactionDate

    • TransactionNumber

    • ReferenceNumber

    • Amount

    • Currency

    • Description

  • References

    • Array of reference codes (key-value pairs) tied to this reservation

    • KeyID - string

    • Key - string

    • Value - string

  • PromotionsApplied - The array of promotion/coupon codes applied to this reservation

    • promotionid - String - The promotion/coupon code for this applied promotion

    • description - String - The description/title of this promotion

    • discountamount - Number - The total discount amount for this promotion

    • quotecurrency - String - The currency code for the discount amount