Function orderChangeGDS

Parameters

• req: any
• res: any
• next: any
• orderRetrieveRS: {
      accountingItems?: {
          airlineCode?: string;
          cardNumber?: string;
          cardTypeCode?: string;
          commission?: {
              commissionAmount?: string;
              commissionPercentage?: string;
              currencyCode?: string;
          };
          creationType?: "Refund"
          | "Exchange"
          | "First Issuance";
          currencyCode?: string;
          fareAmount?: string;
          fareApplicationType?:
              | "Single Traveler"
              | "All Travelers"
              | "Each Traveler";
          formOfPaymentType?: | "Unknown"
          | "Cash"
          | "Check"
          | "Check or Cash"
          | "Payment Card"
          | "Masked Payment Card";
          tariffBasisType?: "Domestic"
          | "Foreign"
          | "International";
          taxAmount?: string;
          ticketNumber?: string;
          travelerIndices?: number[];
      }[];
      agencyCustomerNumber?: string;
      allSegments?: (
          { id: string } & {
              address?: {
                  city?: string;
                  countryCode?: string;
                  postalCode?: string;
                  stateProvince?: string;
                  street?: string;
              } & { freeText?: string; name?: string };
              date?: string;
              endAddress?: {
                  city?: string;
                  countryCode?: string;
                  postalCode?: string;
                  stateProvince?: string;
                  street?: string;
              } & { freeText?: string; name?: string };
              endDate?: string;
              endLocationCode?: string;
              endTime?: string;
              locationCode?: string;
              startAddress?: {
                  city?: string;
                  countryCode?: string;
                  postalCode?: string;
                  stateProvince?: string;
                  street?: string;
              } & { freeText?: string; name?: string };
              startDate?: string;
              startLocationCode?: string;
              startTime?: string;
              text?: string;
              time?: string;
              type: string;
              vendorCode?: string;
          }
      )[];
      bookingId?: string;
      cars?: (
          { itemId: string } & {
              carStatusCode?: string;
              carStatusName?:
                  | "Unknown"
                  | "Confirmed"
                  | "On Request"
                  | "Pending"
                  | "Cancelled"
                  | "Unconfirmed"
                  | "Waitlisted"
                  | "Infant/No Seat"
                  | "Priority Waitlist"
                  | "Quote"
                  | "Space Available"
                  | "Pending Quote"
                  | "No Seat"
                  | "Standby";
              collectionAddress?: {
                  city?: string;
                  countryCode?: string;
                  postalCode?: string;
                  stateProvince?: string;
                  street?: string;
              };
              collectionSite?: { id?: string; name?: string; phone?: string };
              confirmationId?: string;
              deliveryAddress?: {
                  city?: string;
                  countryCode?: string;
                  postalCode?: string;
                  stateProvince?: string;
                  street?: string;
              };
              deliverySite?: { id?: string; name?: string; phone?: string };
              distanceAllowance?: string;
              dropOffAddress?: {
                  city?: string;
                  countryCode?: string;
                  postalCode?: string;
                  stateProvince?: string;
                  street?: string;
              } & { freeText?: string; name?: string };
              dropOffContactInfo?: { emails?: string[] } & {
                  emergencyPhones?: string[];
                  faxes?: string[];
                  phones?: string[];
              };
              dropOffDate: string;
              dropOffLocationCode?: string;
              dropOffTime: string;
              guaranteePaymentNote?: string;
              isRefundable: boolean;
              numberOfVehicles?: number;
              payment?: {
                  currencyCode: string;
                  fees?: string;
                  subtotal?: string;
                  taxes?: string;
                  total: string;
              };
              pickUpAddress: {
                  city?: string;
                  countryCode?: string;
                  postalCode?: string;
                  stateProvince?: string;
                  street?: string;
              } & { freeText?: string; name?: string };
              pickUpContactInfo?: { emails?: string[] } & {
                  emergencyPhones?: string[];
                  faxes?: string[];
                  phones?: string[];
              };
              pickUpDate: string;
              pickUpLocationCode?: string;
              pickUpTime: string;
              rateCode?: string;
              refundPenalties?: {
                  applicableFromDate?: string;
                  applicableToDate?: string;
                  penalty: { amount: string; currencyCode: string };
              }[];
              specialInstructions?: string;
              travelerIndex?: number;
              vehicleTypeCode?: string;
              vehicleTypeName?: | "Two/Three Door"
              | "Two/Four Door"
              | "Four/Five Door"
              | "Wagon/Estate"
              | "Passenger Van"
              | "Limousine/Sedan"
              | "Sport"
              | "Convertible"
              | "SUV"
              | "Open Air All Terrain"
              | "Special"
              | "Pick up single/extended cab 2 door"
              | "Pick up double cab 4 door"
              | "Special Offer Car"
              | "Coupe"
              | "Monospace"
              | "Recreational Vehicle"
              | "Motor Home"
              | "Two Wheel Vehicle"
              | "Roadster"
              | "Crossover"
              | "Commercial Van/Truck";
              vendorCode: string;
              vendorName: string;
          }
      )[];
      contactInfo?: { emails?: string[] } & {
          emergencyPhones?: string[];
          faxes?: string[];
          phones?: string[];
      };
      creationDetails?: {
          agencyIataNumber?: string;
          creationDate?: string;
          creationTime?: string;
          creationUserSine?: string;
          primeHostId?: string;
          purchaseDeadlineDate?: string;
          purchaseDeadlineTime?: string;
          userHomePcc?: string;
          userWorkPcc?: string;
      };
      cruises?: (
          { itemId: string } & {
              arrivalDate: string;
              arrivalTime?: string;
              cabinNumber?: string;
              confirmationId?: string;
              cruiseStatusCode?: string;
              cruiseStatusName?:
                  | "Unknown"
                  | "Confirmed"
                  | "On Request"
                  | "Pending"
                  | "Cancelled"
                  | "Unconfirmed"
                  | "Waitlisted"
                  | "Infant/No Seat"
                  | "Priority Waitlist"
                  | "Quote"
                  | "Space Available"
                  | "Pending Quote"
                  | "No Seat"
                  | "Standby";
              departureDate: string;
              departureTime?: string;
              fromPortCode: string;
              numberOfGuests?: number;
              shipCode?: string;
              shipName?: string;
              toPortCode?: string;
              vendorCode: string;
          }
      )[];
      endDate?: string;
      fareOffers?: {
          cabinBaggageAllowance?: {
              baggagePieces?: {
                  fee?: { amount: string; currencyCode: string };
                  isCheckInOnly?: boolean;
                  maximumSizeInCentimeters?: number;
                  maximumSizeInInches?: number;
                  maximumWeightInKilograms?: number;
                  maximumWeightInPounds?: number;
                  numberOfPieces: number;
                  specialItemDescription?: string;
              }[];
              maximumPieces?: number;
              totalWeightInKilograms?: number;
              totalWeightInPounds?: number;
          };
          cabinBaggageCharges?: {
              fee?: { amount: string; currencyCode: string };
              isCheckInOnly?: boolean;
              maximumSizeInCentimeters?: number;
              maximumSizeInInches?: number;
              maximumWeightInKilograms?: number;
              maximumWeightInPounds?: number;
              numberOfPieces: number;
              specialItemDescription?: string;
          }[];
          checkedBaggageAllowance?: {
              baggagePieces?: {
                  fee?: { amount: string; currencyCode: string };
                  isCheckInOnly?: boolean;
                  maximumSizeInCentimeters?: number;
                  maximumSizeInInches?: number;
                  maximumWeightInKilograms?: number;
                  maximumWeightInPounds?: number;
                  numberOfPieces: number;
                  specialItemDescription?: string;
              }[];
              maximumPieces?: number;
              totalWeightInKilograms?: number;
              totalWeightInPounds?: number;
          };
          checkedBaggageCharges?: {
              fee?: { amount: string; currencyCode: string };
              isCheckInOnly?: boolean;
              maximumSizeInCentimeters?: number;
              maximumSizeInInches?: number;
              maximumWeightInKilograms?: number;
              maximumWeightInPounds?: number;
              numberOfPieces: number;
              specialItemDescription?: string;
          }[];
          flights?: { itemId: string }[];
          travelerIndices?: number[];
      }[];
      fareRules?: {
          destinationAirportCode?: string;
          exchangePenalties?: {
              applicability: "BEFORE_DEPARTURE"
              | "AFTER_DEPARTURE";
              conditionsApply: boolean;
              penalty: { amount: string; currencyCode: string };
          }[];
          isChangeable?: boolean;
          isRefundable?: boolean;
          originAirportCode?: string;
          owningAirlineCode: string;
          passengerCode?: string;
          refundPenalties?: {
              applicability: "BEFORE_DEPARTURE"
              | "AFTER_DEPARTURE";
              conditionsApply: boolean;
              penalty: { amount: string; currencyCode: string };
          }[];
      }[];
      fares?: {
          airlineCode?: string;
          commission?: {
              commissionAmount?: string;
              commissionPercentage?: string;
              currencyCode?: string;
          };
          creationDetails?: {
              agencyIataNumber?: string;
              creationDate?: string;
              creationTime?: string;
              creationUserSine?: string;
              primeHostId?: string;
              purchaseDeadlineDate?: string;
              purchaseDeadlineTime?: string;
              userHomePcc?: string;
              userWorkPcc?: string;
          };
          fareCalculationLine?: string;
          fareConstruction?: {
              baseRate?: { amount: string; currencyCode: string };
              brandAttributes?: { description?: string; itemId?: string }[];
              brandFareCode?: string;
              brandFareName?: string;
              brandProgramCode?: string;
              brandProgramName?: string;
              checkedBaggageAllowance?: {
                  baggagePieces?: {
                      fee?: { amount: string; currencyCode: string };
                      isCheckInOnly?: boolean;
                      maximumSizeInCentimeters?: number;
                      maximumSizeInInches?: number;
                      maximumWeightInKilograms?: number;
                      maximumWeightInPounds?: number;
                      numberOfPieces: number;
                      specialItemDescription?: string;
                  }[];
                  maximumPieces?: number;
                  totalWeightInKilograms?: number;
                  totalWeightInPounds?: number;
              };
              fareBasisCode?: string;
              flightIndices?: number[];
              flights?: { itemId: string }[];
              isCurrentItinerary?: boolean;
          }[];
          hasValidPricing: boolean;
          isNegotiatedFare?: boolean;
          pricedTravelerType?: string;
          pricingStatusCode?: "A"
          | "H";
          pricingStatusName?: "Active" | "History";
          pricingTypeCode?: "S" | "A" | "M";
          pricingTypeName?: "Unknown" | "System" | "Amended" | "Manual";
          recordId?: string;
          recordTypeCode?: string;
          recordTypeName?: string;
          requestedTravelerType?: string;
          taxBreakdown?: {
              taxAmount?: { amount: string; currencyCode: string };
              taxCode?: string;
          }[];
          totals?: {
              currencyCode: string;
              fees?: string;
              subtotal?: string;
              taxes?: string;
              total: string;
          };
          tourCode?: string;
          travelerIndices?: number[];
      }[];
      flights?: (
          { itemId: string } & {
              aircraftTypeCode?: string;
              aircraftTypeName?: string;
              airlineCode: string;
              airlineName?: string;
              arrivalDate: string;
              arrivalGate?: string;
              arrivalTerminalName?: string;
              arrivalTime: string;
              bookingClass?: string;
              cabinTypeCode?: string;
              cabinTypeName?: string;
              confirmationId?: string;
              departureDate: string;
              departureGate?: string;
              departureTerminalName?: string;
              departureTime: string;
              distanceInMiles?: number;
              durationInMinutes?: number;
              flightNumber: number;
              flightStatusCode?: string;
              flightStatusName?:
                  | "Unknown"
                  | "Confirmed"
                  | "On Request"
                  | "Pending"
                  | "Cancelled"
                  | "Unconfirmed"
                  | "Waitlisted"
                  | "Infant/No Seat"
                  | "Priority Waitlist"
                  | "Quote"
                  | "Space Available"
                  | "Pending Quote"
                  | "No Seat"
                  | "Standby";
              fromAirportCode: string;
              hiddenStopAircraftTypeCode?: string;
              hiddenStopAircraftTypeName?: string;
              hiddenStopAirportCode?: string;
              hiddenStopArrivalDate?: string;
              hiddenStopArrivalTime?: string;
              hiddenStopDepartureDate?: string;
              hiddenStopDepartureTime?: string;
              hiddenStops?: {
                  aircraftTypeCode?: string;
                  aircraftTypeName?: string;
                  airportCode?: string;
                  arrivalDate?: string;
                  arrivalTime?: string;
                  departureDate?: string;
                  departureTime?: string;
                  durationInMinutes?: number;
              }[];
              identityDocuments?: {
                  itemId?: string;
                  status?: | "Unknown"
                  | "Confirmed"
                  | "On Request"
                  | "Pending"
                  | "Cancelled"
                  | "Unconfirmed"
                  | "Waitlisted"
                  | "Infant/No Seat"
                  | "Priority Waitlist"
                  | "Quote"
                  | "Space Available"
                  | "Pending Quote"
                  | "No Seat"
                  | "Standby";
              }[];
              isPast?: boolean;
              meals?: {
                  code: string;
                  description: | "Meal"
                  | "Alcoholic beverages for purchase"
                  | "Breakfast"
                  | "Cold meal"
                  | "Complimentary alcoholic beverages"
                  | "Continental breakfast"
                  | "Dinner"
                  | "Food for purchase"
                  | "Food and beverage for purchase"
                  | "Hot meal"
                  | "Lunch"
                  | "No meal service"
                  | "Refreshment"
                  | "Refreshment for purchase"
                  | "Snack";
              }[];
              numberOfSeats?: number;
              operatingAirlineCode?: string;
              operatingAirlineName?: string;
              operatingFlightNumber?: number;
              seats?: {
                  characteristics?: string[];
                  number: string;
                  statusCode?: string;
                  statusName?: | "Unknown"
                  | "Confirmed"
                  | "On Request"
                  | "Pending"
                  | "Cancelled"
                  | "Unconfirmed"
                  | "Waitlisted"
                  | "Infant/No Seat"
                  | "Priority Waitlist"
                  | "Quote"
                  | "Space Available"
                  | "Pending Quote"
                  | "No Seat"
                  | "Standby";
              }[];
              sourceType?: "NDC"
              | "LCC"
              | "ATPCO";
              toAirportCode: string;
              travelerIndices?: number[];
              updatedArrivalDate?: string;
              updatedArrivalTime?: string;
              updatedDepartureDate?: string;
              updatedDepartureTime?: string;
          }
      )[];
      flightTickets?: {
          agencyIataNumber?: string;
          airlineCode: string;
          allCoupons?: (
              {
                  couponStatus: | "Airport Control"
                  | "Lifted"
                  | "Checked In"
                  | "Exchanged"
                  | "Flown"
                  | "Not Flown"
                  | "Refunded"
                  | "Voided"
                  | "Printed"
                  | "Okay"
                  | "Reactivated"
                  | "Irregular Operations"
                  | "Print Exchange"
                  | "Paper Ticket"
                  | "Suspended"
                  | "Locked";
                  couponStatusCode: | "AL"
                  | "PE"
                  | "XX"
                  | "S"
                  | "P"
                  | "B"
                  | "E"
                  | "BD"
                  | "CK"
                  | "I"
                  | "RF"
                  | "V"
                  | "PR"
                  | "IO"
                  | "T";
              } & { itemId?: string }
          )[];
          commission?: {
              commissionAmount?: string;
              commissionPercentage?: string;
              currencyCode?: string;
          };
          date: string;
          flightCoupons: (
              { itemId: string } & {
                  couponStatus:
                      | "Airport Control"
                      | "Lifted"
                      | "Checked In"
                      | "Exchanged"
                      | "Flown"
                      | "Not Flown"
                      | "Refunded"
                      | "Voided"
                      | "Printed"
                      | "Okay"
                      | "Reactivated"
                      | "Irregular Operations"
                      | "Print Exchange"
                      | "Paper Ticket"
                      | "Suspended"
                      | "Locked";
                  couponStatusCode: | "AL"
                  | "PE"
                  | "XX"
                  | "S"
                  | "P"
                  | "B"
                  | "E"
                  | "BD"
                  | "CK"
                  | "I"
                  | "RF"
                  | "V"
                  | "PR"
                  | "IO"
                  | "T";
              }
          )[];
          number: string;
          payment: {
              currencyCode: string;
              fees?: string;
              subtotal?: string;
              taxes?: string;
              total: string;
          };
          ticketingPcc?: string;
          ticketStatusCode?: string;
          ticketStatusName?: "Voided"
          | "Issued"
          | "Refunded/Exchanged";
          travelerIndex: number;
      }[];
      futureTicketingPolicy?: {
          comment?: string;
          queueNumber?: string;
          ticketingDate?: string;
          ticketingPcc?: string;
          ticketingTime?: string;
      };
      hotels?: (
          { itemId: string } & {
              address: {
                  city?: string;
                  countryCode?: string;
                  postalCode?: string;
                  stateProvince?: string;
                  street?: string;
              } & { freeText?: string; name?: string } & { cityCode?: string };
              associatedFlightDetails?: {
                  arrivalAirlineCode?: string;
                  arrivalFlightNumber?: number;
                  arrivalTime?: string;
                  departureAirlineCode?: string;
                  departureFlightNumber?: number;
                  departureTime?: string;
              };
              chainCode?: string;
              chainName?: string;
              checkInDate: string;
              checkInTime: string;
              checkOutDate: string;
              checkOutTime: string;
              confirmationId?: string;
              contactInfo?: { emails?: string[] } & {
                  emergencyPhones?: string[];
                  faxes?: string[];
                  phones?: string[];
              };
              corporateDiscountCode?: number;
              guaranteePaymentNote?: string;
              guaranteeTypeCode?: number;
              guaranteeTypeName?: | "Credit card"
              | "Travel agency name/address"
              | "Travel agency IATA number"
              | "Company name/address"
              | "Corporate ID/CD number"
              | "Virtual card";
              hotelName: string;
              hotelStatusCode?: string;
              hotelStatusName?: | "Unknown"
              | "Confirmed"
              | "On Request"
              | "Pending"
              | "Cancelled"
              | "Unconfirmed"
              | "Waitlisted"
              | "Infant/No Seat"
              | "Priority Waitlist"
              | "Quote"
              | "Space Available"
              | "Pending Quote"
              | "No Seat"
              | "Standby";
              isRefundable: boolean;
              leadTravelerIndex?: number;
              numberOfGuests?: number;
              payment?: {
                  currencyCode: string;
                  fees?: string;
                  subtotal?: string;
                  taxes?: string;
                  total: string;
              };
              paymentPolicy?: "DEPOSIT"
              | "GUARANTEE"
              | "LATE";
              propertyId?: string;
              refundPenalties?: {
                  applicableFromDate?: string;
                  applicableToDate?: string;
                  penalty: { amount: string; currencyCode: string };
              }[];
              refundPenaltyPolicyCode?: string;
              room?: {
                  agencyCommission?: {
                      commissionAmount?: string;
                      commissionPercentage?: string;
                      currencyCode?: string;
                  };
                  description?: string;
                  productCode?: string;
                  quantity: number;
                  roomRate?: { amount: string; currencyCode: string };
                  roomType: string;
                  roomTypeCode?: string;
                  travelerIndices?: number[];
              };
              sabrePropertyId?: string;
              sourceTypeCode?: number;
              sourceTypeName?: | "Unknown"
              | "Legacy"
              | "Sabre GDS"
              | "Expedia Associate Network"
              | "HotelBeds.com"
              | "Booking.com"
              | "CMNet";
              specialInstructions?: string;
          }
      )[];
      isCancelable?: boolean;
      isTicketed?: boolean;
      journeys?: {
          departureDate: string;
          departureTime: string;
          firstAirportCode: string;
          lastAirportCode: string;
          numberOfFlights: number;
      }[];
      nonElectronicTickets?: {
          date?: string;
          ticketingPcc?: string;
          ticketingUserCode?: string;
          ticketNumber?: string;
          ticketStatus?: "Unknown"
          | "Active"
          | "Inactive";
          time?: string;
          travelerIndex?: number;
      }[];
      otherServices?: {
          airlineCode?: string;
          chainCode?: string;
          serviceMessage?: string;
          travelerIndex?: number;
          vendorCode?: string;
      }[];
      payments?: {
          carTotals?: {
              currencyCode: string;
              fees?: string;
              subtotal?: string;
              taxes?: string;
              total: string;
          }[];
          flightCurrentTotals?: {
              currencyCode: string;
              fees?: string;
              subtotal?: string;
              taxes?: string;
              total: string;
          }[];
          flightTotals?: {
              currencyCode: string;
              fees?: string;
              subtotal?: string;
              taxes?: string;
              total: string;
          }[];
          formsOfPayment?: (
              {
                  airlinePlanCode?: string;
                  cardNumber?: string;
                  cardSecurityCode?: string;
                  cardTypeCode?: string;
                  expiryDate?: string;
                  extendedPayment?: number;
                  installmentAmount?: string;
                  miscellaneousCreditCode?: string;
                  numberOfInstallments?: number;
              } & {
                  agencyAddress?: {
                      city?: string;
                      countryCode?: string;
                      postalCode?: string;
                      stateProvince?: string;
                      street?: string;
                  } & { freeText?: string; name?: string };
                  agencyIataNumber?: string;
                  authentications?: {
                      amount?: string;
                      cardNumberCollectionCode?: string;
                      channelCode?: string;
                      currencyCode?: string;
                      electronicCommerceIndicator?: string;
                      exemptionTypeCode?: string;
                      issueCode?: string;
                      mandateTypeCode?: string;
                      merchantName?: string;
                      originalPaymentReference?: string;
                      resultCode?: string;
                      secureAuthenticationValue?: string;
                      secureTransactionId?: string;
                      tokenAuthenticationValue?: string;
                      updatedDateTime?: string;
                      verificationResultCode?: string;
                      version?: string;
                  }[];
                  cardHolder?: {
                      address?: {
                          city?: string;
                          countryCode?: string;
                          postalCode?: string;
                          stateProvince?: string;
                          street?: string;
                      };
                      email?: string;
                      givenName: string;
                      phone?: string;
                      surname: string;
                  };
                  companyAddress?: {
                      city?: string;
                      countryCode?: string;
                      postalCode?: string;
                      stateProvince?: string;
                      street?: string;
                  } & { freeText?: string; name?: string };
                  corporateId?: string;
                  docketDescription?: string;
                  docketIssuingAgentInitials?: string;
                  docketNumber?: string;
                  docketPrefix?: string;
                  governmentTravelRequestDescription?: string;
                  invoiceDescription?: string;
                  isAgencyPaymentCard?: boolean;
                  manualApproval?: {
                      airlineCode: string;
                      amount: string;
                      code: string;
                      currencyCode: string;
                      expiryDateTime: string;
                      requestDateTime: string;
                  };
                  netBalance?: string;
                  tripType?: | "All"
                  | "Unknown"
                  | "Corporate/Business"
                  | "Leisure"
                  | "Emergency"
                  | "Family"
                  | "Group";
                  tripTypes?: (
                      | "All"
                      | "Unknown"
                      | "Corporate/Business"
                      | "Leisure"
                      | "Emergency"
                      | "Family"
                      | "Group"
                  )[];
                  type: | "INVOICE"
                  | "CORPORATE"
                  | "PAYMENTCARD"
                  | "CASH"
                  | "CHECK"
                  | "MISCELLANEOUS"
                  | "INSTALLMENTS"
                  | "VIRTUAL_CARD"
                  | "AGENCY_NAME"
                  | "AGENCY_IATA"
                  | "COMPANY_NAME"
                  | "VOUCHER"
                  | "DOCKET"
                  | "GOVERNMENT_TRAVEL_REQUEST";
                  useType?: | "All"
                  | "Other"
                  | "Tour"
                  | "Unknown"
                  | "Ancillary"
                  | "Hotel"
                  | "Car"
                  | "Cruise"
                  | "Airline"
                  | "Bus/Ground Transportation"
                  | "Insurance"
                  | "Low-Cost Carrier"
                  | "Rail"
                  | "Specialty Service"
                  | "Interface Record";
                  useTypes?: (
                      | "All"
                      | "Other"
                      | "Tour"
                      | "Unknown"
                      | "Ancillary"
                      | "Hotel"
                      | "Car"
                      | "Cruise"
                      | "Airline"
                      | "Bus/Ground Transportation"
                      | "Insurance"
                      | "Low-Cost Carrier"
                      | "Rail"
                      | "Specialty Service"
                      | "Interface Record"
                  )[];
                  virtualCard?: {
                      agencyEmail?: string;
                      customerAccountCode?: string;
                      hotelFax?: string;
                      hotelName?: string;
                      rateAmount?: { amount: string; currencyCode: string };
                      roomDescription?: string;
                      roomType?: string;
                      virtualCardCharges?: string[];
                  };
                  voucher?: { billingNumber?: string; type?: string };
              }
          )[];
          hotelTotals?: {
              currencyCode: string;
              fees?: string;
              subtotal?: string;
              taxes?: string;
              total: string;
          }[];
          trainTotals?: {
              currencyCode: string;
              fees?: string;
              subtotal?: string;
              taxes?: string;
              total: string;
          }[];
      };
      remarks?: {
          alphaCode?: string;
          text?: string;
          type?: | "INVOICE"
          | "ITINERARY"
          | "GENERAL"
          | "HISTORICAL"
          | "CLIENT_ADDRESS"
          | "ALPHA_CODED"
          | "DELIVERY_ADDRESS"
          | "HIDDEN"
          | "CORPORATE"
          | "FORM_OF_PAYMENT"
          | "PRINT_ON_TICKET"
          | "FILLER_STRIP"
          | "INTERFACE"
          | "QUEUE_PLACE";
      }[];
      retentionEndDate?: string;
      retentionLabel?: string;
      specialServices?: {
          code?: string;
          flights?: { itemId: string }[];
          message?: string;
          name?: string;
          statusCode?: string;
          statusName?:
              | "Unknown"
              | "Confirmed"
              | "On Request"
              | "Pending"
              | "Cancelled"
              | "Unconfirmed"
              | "Waitlisted"
              | "Infant/No Seat"
              | "Priority Waitlist"
              | "Quote"
              | "Space Available"
              | "Pending Quote"
              | "No Seat"
              | "Standby";
          travelerIndices?: number[];
      }[];
      startDate?: string;
      trains?: (
          { itemId: string } & {
              arrivalDate: string;
              arrivalTime: string;
              confirmationId?: string;
              departureDate: string;
              departureTime: string;
              fromStationCode: string;
              fromStationName?: string;
              isRefundable?: boolean;
              operatingVendorCode?: string;
              operatingVendorName?: string;
              payment?: {
                  currencyCode: string;
                  fees?: string;
                  subtotal?: string;
                  taxes?: string;
                  total: string;
              };
              toStationCode: string;
              toStationName?: string;
              trainName?: string;
              trainNumber: string;
              trainStatusCode?: string;
              trainStatusName?: | "Unknown"
              | "Confirmed"
              | "On Request"
              | "Pending"
              | "Cancelled"
              | "Unconfirmed"
              | "Waitlisted"
              | "Infant/No Seat"
              | "Priority Waitlist"
              | "Quote"
              | "Space Available"
              | "Pending Quote"
              | "No Seat"
              | "Standby";
              vendorCode: string;
              vendorName?: string;
          }
      )[];
      travelers?: {
          address?: {
              city?: string;
              countryCode?: string;
              postalCode?: string;
              stateProvince?: string;
              street?: string;
          } & { freeText?: string; name?: string };
          ancillaries?: {
              airlineCode?: string;
              commercialName?: string;
              electronicMiscellaneousDocumentNumber?: string;
              flightApplicabilityType?: "Unknown" | "Single" | "Multiple";
              flights?: { itemId: string }[];
              isCommissionable?: boolean;
              isRefundable?: boolean;
              itemId?: string;
              numberOfItems?: number;
              reasonForIssuanceCode?: string;
              reasonForIssuanceName?:
                  | "UNKNOWN"
                  | "AIR_TRANSPORTATION"
                  | "SURFACE_TRANSPORTATION_NON_AIR_SERVICES"
                  | "BAGGAGE"
                  | "FINANCIAL_IMPACT"
                  | "AIRPORT_SERVICES"
                  | "MERCHANDISE"
                  | "INFLIGHT_SERVICES"
                  | "INDIVIDUAL_AIRLINE_USE";
              source?: "ATPCO"
              | "MERCHANDISING_MANAGER";
              statusCode?: string;
              statusName?:
                  | "Confirmed"
                  | "Confirmed with EMD issued"
                  | "On Request"
                  | "Pending"
                  | "Cancelled"
                  | "Unconfirmed"
                  | "Confirmed with pending payment"
                  | "Schedule change";
              subcode?: string;
              totals?: {
                  currencyCode: string;
                  fees?: string;
                  subtotal?: string;
                  taxes?: string;
                  total: string;
              };
              vendorCode?: string;
          }[];
          birthDate?: string;
          emails?: string[];
          formOfPaymentIndices?: number[];
          gender?: | "FEMALE"
          | "MALE"
          | "INFANT_FEMALE"
          | "INFANT_MALE"
          | "UNDISCLOSED"
          | "UNDEFINED";
          givenName: string;
          identityDocuments?: {
              birthDate?: string;
              documentNumber?: string;
              documentSubType?: "RUC"
              | "CUIT/CUIL"
              | "NIT";
              documentType:
                  | "MILITARY"
                  | "PASSPORT"
                  | "VISA"
                  | "SECURE_FLIGHT_PASSENGER_DATA"
                  | "RESIDENCE_ADDRESS"
                  | "DESTINATION_ADDRESS"
                  | "KNOWN_TRAVELER_NUMBER"
                  | "REDRESS_NUMBER"
                  | "ALIEN_RESIDENT"
                  | "PERMANENT_RESIDENT"
                  | "FACILITATION_DOCUMENT"
                  | "NATIONAL_ID_CARD"
                  | "NEXUS_CARD"
                  | "NATURALIZATION_CERTIFICATE"
                  | "REFUGEE_REENTRY_PERMIT"
                  | "BORDER_CROSSING_CARD"
                  | "FISCAL_ID";
              expiryDate?: string;
              flightIndices?: number[];
              gender?: | "FEMALE"
              | "MALE"
              | "INFANT_FEMALE"
              | "INFANT_MALE"
              | "UNDISCLOSED"
              | "UNDEFINED";
              givenName?: string;
              hostCountryCode?: string;
              isLapChildDocument?: boolean;
              isPrimaryDocumentHolder?: boolean;
              issueDate?: string;
              issuingCountryCode?: string;
              itemId?: string;
              middleName?: string;
              placeOfBirth?: string;
              placeOfIssue?: string;
              residenceCountryCode?: string;
              residenceDestinationAddress?: {
                  city?: string;
                  countryCode?: string;
                  postalCode?: string;
                  stateProvince?: string;
                  street?: string;
              };
              surname?: string;
          }[];
          isGrouped?: boolean;
          loyaltyPrograms?: {
              programNumber: string;
              programType?: | "FREQUENT_FLYER"
              | "FREQUENT_RENTER"
              | "LOYALTY_ID"
              | "CORPORATE_LOYALTY_ID";
              receiverCode?: string;
              supplierCode?: string;
              tierLevel?: number;
          }[];
          middleName?: string;
          nameAssociationId?: string;
          nameReferenceCode?: string;
          passengerCode?: string;
          phones?: { label?: string; number: string }[];
          remarks?: {
              alphaCode?: string;
              text?: string;
              type?:
                  | "INVOICE"
                  | "ITINERARY"
                  | "GENERAL"
                  | "HISTORICAL"
                  | "CLIENT_ADDRESS"
                  | "ALPHA_CODED"
                  | "DELIVERY_ADDRESS"
                  | "HIDDEN"
                  | "CORPORATE"
                  | "FORM_OF_PAYMENT"
                  | "PRINT_ON_TICKET"
                  | "FILLER_STRIP"
                  | "INTERFACE"
                  | "QUEUE_PLACE";
          }[];
          surname: string;
          type?: | "ADULT"
          | "AGENT"
          | "AIRLINE"
          | "CHILD"
          | "EDUCATION"
          | "GOVERNMENT"
          | "GROUP"
          | "INFANT"
          | "MILITARY"
          | "SENIOR"
          | "SPECIAL"
          | "YOUTH";
      }[];
      travelersGroup?: {
          itemId?: string;
          name?: string;
          numberOfTravelers?: number;
          numberOfTravelersRemaining?: number;
      };
  } & {
      bookingSignature?: string;
      errors?: {
          category: string;
          description?: string;
          fieldName?: string;
          fieldPath?: string;
          fieldValue?: string;
          type: string;
      }[];
      request?: {
          bookingSource?: "SABRE"
          | "SABRE_ORDER";
          confirmationId: string;
          extraFeatures?: { returnEmptySeatObjects: boolean } & {
              returnFiscalId: boolean;
              returnFrequentRenter: boolean;
              returnWalletFormsOfPayment: boolean;
          } & Record<string, never>;
          givenName?: string;
          middleName?: string;
          returnOnly?: (
              | "FLIGHTS"
              | "FLIGHT_PENALTY"
              | "BAGGAGE_POLICY"
              | "JOURNEYS"
              | "HOTELS"
              | "HOTEL_ADDRESS"
              | "CARS"
              | "CAR_RENTAL_ADDRESS"
              | "CAR_RENTAL_PENALTY"
              | "TRAINS"
              | "CRUISES"
              | "ALL_SEGMENTS"
              | "TRAVELERS"
              | "TICKETS"
              | "PAYMENTS"
              | "PENALTIES"
              | "REMARKS"
              | "IS_CANCELABLE"
              | "IS_TICKETED"
              | "CONTACT_INFO"
              | "OTHER_SERVICES"
              | "SPECIAL_SERVICES"
              | "FARES"
              | "CREATION_DETAILS"
              | "ANCILLARIES"
              | "FORMS_OF_PAYMENT"
              | "RETENTION_DATE"
              | "ACCOUNTING_ITEMS"
              | "NON_ELECTRONIC_TICKETS"
          )[];
          surname?: string;
          targetPcc?: string;
          unmaskPaymentCardNumbers?: boolean;
      };
      timestamp?: string;
  }

  • OptionalaccountingItems?: {
        airlineCode?: string;
        cardNumber?: string;
        cardTypeCode?: string;
        commission?: {
            commissionAmount?: string;
            commissionPercentage?: string;
            currencyCode?: string;
        };
        creationType?: "Refund"
        | "Exchange"
        | "First Issuance";
        currencyCode?: string;
        fareAmount?: string;
        fareApplicationType?: "Single Traveler" | "All Travelers" | "Each Traveler";
        formOfPaymentType?:
            | "Unknown"
            | "Cash"
            | "Check"
            | "Check or Cash"
            | "Payment Card"
            | "Masked Payment Card";
        tariffBasisType?: "Domestic"
        | "Foreign"
        | "International";
        taxAmount?: string;
        ticketNumber?: string;
        travelerIndices?: number[];
    }[]

    Description

    Lists accounting items from the booking.

  • OptionalagencyCustomerNumber?: string

    Description

    The customer identifier used by their travel agency, also known as the customer number or the DK number. Can be a six, seven, or 10-character string.

    Example

    1234567
    Copy

  • OptionalallSegments?: (
        { id: string } & {
            address?: {
                city?: string;
                countryCode?: string;
                postalCode?: string;
                stateProvince?: string;
                street?: string;
            } & { freeText?: string; name?: string };
            date?: string;
            endAddress?: {
                city?: string;
                countryCode?: string;
                postalCode?: string;
                stateProvince?: string;
                street?: string;
            } & { freeText?: string; name?: string };
            endDate?: string;
            endLocationCode?: string;
            endTime?: string;
            locationCode?: string;
            startAddress?: {
                city?: string;
                countryCode?: string;
                postalCode?: string;
                stateProvince?: string;
                street?: string;
            } & { freeText?: string; name?: string };
            startDate?: string;
            startLocationCode?: string;
            startTime?: string;
            text?: string;
            time?: string;
            type: string;
            vendorCode?: string;
        }
    )[]

    Description

    Lists all segments of the booking which overlaps with contextual booking elements such as flights, hotels, cars, trains and so on. This list also contains non-product related segments which exist in an underlying booking system.

  • OptionalbookingId?: string

    Description

    The booking reference ID as shown in the source supplier/vendor system. For SABRE, this is the PNR Locator or NDC orderId value, depending on content type.

    Example

    1SXXX1A2B3C4D
    Copy

  • Optionalcars?: (
        { itemId: string } & {
            carStatusCode?: string;
            carStatusName?:
                | "Unknown"
                | "Confirmed"
                | "On Request"
                | "Pending"
                | "Cancelled"
                | "Unconfirmed"
                | "Waitlisted"
                | "Infant/No Seat"
                | "Priority Waitlist"
                | "Quote"
                | "Space Available"
                | "Pending Quote"
                | "No Seat"
                | "Standby";
            collectionAddress?: {
                city?: string;
                countryCode?: string;
                postalCode?: string;
                stateProvince?: string;
                street?: string;
            };
            collectionSite?: { id?: string; name?: string; phone?: string };
            confirmationId?: string;
            deliveryAddress?: {
                city?: string;
                countryCode?: string;
                postalCode?: string;
                stateProvince?: string;
                street?: string;
            };
            deliverySite?: { id?: string; name?: string; phone?: string };
            distanceAllowance?: string;
            dropOffAddress?: {
                city?: string;
                countryCode?: string;
                postalCode?: string;
                stateProvince?: string;
                street?: string;
            } & { freeText?: string; name?: string };
            dropOffContactInfo?: { emails?: string[] } & {
                emergencyPhones?: string[];
                faxes?: string[];
                phones?: string[];
            };
            dropOffDate: string;
            dropOffLocationCode?: string;
            dropOffTime: string;
            guaranteePaymentNote?: string;
            isRefundable: boolean;
            numberOfVehicles?: number;
            payment?: {
                currencyCode: string;
                fees?: string;
                subtotal?: string;
                taxes?: string;
                total: string;
            };
            pickUpAddress: {
                city?: string;
                countryCode?: string;
                postalCode?: string;
                stateProvince?: string;
                street?: string;
            } & { freeText?: string; name?: string };
            pickUpContactInfo?: { emails?: string[] } & {
                emergencyPhones?: string[];
                faxes?: string[];
                phones?: string[];
            };
            pickUpDate: string;
            pickUpLocationCode?: string;
            pickUpTime: string;
            rateCode?: string;
            refundPenalties?: {
                applicableFromDate?: string;
                applicableToDate?: string;
                penalty: { amount: string; currencyCode: string };
            }[];
            specialInstructions?: string;
            travelerIndex?: number;
            vehicleTypeCode?: string;
            vehicleTypeName?: | "Two/Three Door"
            | "Two/Four Door"
            | "Four/Five Door"
            | "Wagon/Estate"
            | "Passenger Van"
            | "Limousine/Sedan"
            | "Sport"
            | "Convertible"
            | "SUV"
            | "Open Air All Terrain"
            | "Special"
            | "Pick up single/extended cab 2 door"
            | "Pick up double cab 4 door"
            | "Special Offer Car"
            | "Coupe"
            | "Monospace"
            | "Recreational Vehicle"
            | "Motor Home"
            | "Two Wheel Vehicle"
            | "Roadster"
            | "Crossover"
            | "Commercial Van/Truck";
            vendorCode: string;
            vendorName: string;
        }
    )[]

    Description

    Lists all car rentals associated with the booking.

  • OptionalcontactInfo?: { emails?: string[] } & {
        emergencyPhones?: string[];
        faxes?: string[];
        phones?: string[];
    }

  • OptionalcreationDetails?: {
        agencyIataNumber?: string;
        creationDate?: string;
        creationTime?: string;
        creationUserSine?: string;
        primeHostId?: string;
        purchaseDeadlineDate?: string;
        purchaseDeadlineTime?: string;
        userHomePcc?: string;
        userWorkPcc?: string;
    }

    • OptionalagencyIataNumber?: string

      Description

      A unique identifier accredited by the International Air Transport Association (IATA).

      Example

      99119911
      Copy

    • OptionalcreationDate?: string

      Format: date

      Description

      The date in YYYY-MM-DD format when the booking was created.

      Example

      2024-01-09
      Copy

    • OptionalcreationTime?: string

      Description

      The time in HH:MM format when the booking was created. Not supported for NDC bookings.

      Example

      15:00
      Copy

    • OptionalcreationUserSine?: string

      Description

      The sine of the Employee Profile Record that created the booking. Not supported for NDC bookings.

      Example

      A12
      Copy

    • OptionalprimeHostId?: string

      Description

      The identification code for the prime host (global distribution system) associated with the reservation.

      Example

      1S
      Copy

    • OptionalpurchaseDeadlineDate?: string

      Format: date

      Description

      The date in the YYYY-MM-DD format by which the stored fare must be ticketed.

      Example

      2024-01-09
      Copy

    • OptionalpurchaseDeadlineTime?: string

      Description

      The time in the HH:MM format by which the stored fare must be ticketed.

      Example

      15:00
      Copy

    • OptionaluserHomePcc?: string

      Description

      The pseudo city code of the agent who created the booking.

      Example

      CD34
      Copy

    • OptionaluserWorkPcc?: string

      Description

      The pseudo city code where the booking was created.

      Example

      AB12
      Copy

  • Optionalcruises?: (
        { itemId: string } & {
            arrivalDate: string;
            arrivalTime?: string;
            cabinNumber?: string;
            confirmationId?: string;
            cruiseStatusCode?: string;
            cruiseStatusName?:
                | "Unknown"
                | "Confirmed"
                | "On Request"
                | "Pending"
                | "Cancelled"
                | "Unconfirmed"
                | "Waitlisted"
                | "Infant/No Seat"
                | "Priority Waitlist"
                | "Quote"
                | "Space Available"
                | "Pending Quote"
                | "No Seat"
                | "Standby";
            departureDate: string;
            departureTime?: string;
            fromPortCode: string;
            numberOfGuests?: number;
            shipCode?: string;
            shipName?: string;
            toPortCode?: string;
            vendorCode: string;
        }
    )[]

    Description

    Lists all cruises associated with the booking.

  • OptionalendDate?: string

    Format: date

    Description

    The end date of the booking in ISO 8601 format.

    Example

    2024-07-19
    Copy

  • OptionalfareOffers?: {
        cabinBaggageAllowance?: {
            baggagePieces?: {
                fee?: { amount: string; currencyCode: string };
                isCheckInOnly?: boolean;
                maximumSizeInCentimeters?: number;
                maximumSizeInInches?: number;
                maximumWeightInKilograms?: number;
                maximumWeightInPounds?: number;
                numberOfPieces: number;
                specialItemDescription?: string;
            }[];
            maximumPieces?: number;
            totalWeightInKilograms?: number;
            totalWeightInPounds?: number;
        };
        cabinBaggageCharges?: {
            fee?: { amount: string; currencyCode: string };
            isCheckInOnly?: boolean;
            maximumSizeInCentimeters?: number;
            maximumSizeInInches?: number;
            maximumWeightInKilograms?: number;
            maximumWeightInPounds?: number;
            numberOfPieces: number;
            specialItemDescription?: string;
        }[];
        checkedBaggageAllowance?: {
            baggagePieces?: {
                fee?: { amount: string; currencyCode: string };
                isCheckInOnly?: boolean;
                maximumSizeInCentimeters?: number;
                maximumSizeInInches?: number;
                maximumWeightInKilograms?: number;
                maximumWeightInPounds?: number;
                numberOfPieces: number;
                specialItemDescription?: string;
            }[];
            maximumPieces?: number;
            totalWeightInKilograms?: number;
            totalWeightInPounds?: number;
        };
        checkedBaggageCharges?: {
            fee?: { amount: string; currencyCode: string };
            isCheckInOnly?: boolean;
            maximumSizeInCentimeters?: number;
            maximumSizeInInches?: number;
            maximumWeightInKilograms?: number;
            maximumWeightInPounds?: number;
            numberOfPieces: number;
            specialItemDescription?: string;
        }[];
        flights?: { itemId: string }[];
        travelerIndices?: number[];
    }[]

    Description

    Lists ancillary offers for selected flights identified by itemId flight references.

  • OptionalfareRules?: {
        destinationAirportCode?: string;
        exchangePenalties?: {
            applicability: "BEFORE_DEPARTURE" | "AFTER_DEPARTURE";
            conditionsApply: boolean;
            penalty: { amount: string; currencyCode: string };
        }[];
        isChangeable?: boolean;
        isRefundable?: boolean;
        originAirportCode?: string;
        owningAirlineCode: string;
        passengerCode?: string;
        refundPenalties?: {
            applicability: "BEFORE_DEPARTURE"
            | "AFTER_DEPARTURE";
            conditionsApply: boolean;
            penalty: { amount: string; currencyCode: string };
        }[];
    }[]

    Description

    Lists most restrictive fare rule information displayed at the time of purchase. This service applies data from either Tickets or Price Quotes.

  • Optionalfares?: {
        airlineCode?: string;
        commission?: {
            commissionAmount?: string;
            commissionPercentage?: string;
            currencyCode?: string;
        };
        creationDetails?: {
            agencyIataNumber?: string;
            creationDate?: string;
            creationTime?: string;
            creationUserSine?: string;
            primeHostId?: string;
            purchaseDeadlineDate?: string;
            purchaseDeadlineTime?: string;
            userHomePcc?: string;
            userWorkPcc?: string;
        };
        fareCalculationLine?: string;
        fareConstruction?: {
            baseRate?: { amount: string; currencyCode: string };
            brandAttributes?: { description?: string; itemId?: string }[];
            brandFareCode?: string;
            brandFareName?: string;
            brandProgramCode?: string;
            brandProgramName?: string;
            checkedBaggageAllowance?: {
                baggagePieces?: {
                    fee?: { amount: string; currencyCode: string };
                    isCheckInOnly?: boolean;
                    maximumSizeInCentimeters?: number;
                    maximumSizeInInches?: number;
                    maximumWeightInKilograms?: number;
                    maximumWeightInPounds?: number;
                    numberOfPieces: number;
                    specialItemDescription?: string;
                }[];
                maximumPieces?: number;
                totalWeightInKilograms?: number;
                totalWeightInPounds?: number;
            };
            fareBasisCode?: string;
            flightIndices?: number[];
            flights?: { itemId: string }[];
            isCurrentItinerary?: boolean;
        }[];
        hasValidPricing: boolean;
        isNegotiatedFare?: boolean;
        pricedTravelerType?: string;
        pricingStatusCode?: "A"
        | "H";
        pricingStatusName?: "Active" | "History";
        pricingTypeCode?: "S" | "A" | "M";
        pricingTypeName?: "Unknown" | "System" | "Amended" | "Manual";
        recordId?: string;
        recordTypeCode?: string;
        recordTypeName?: string;
        requestedTravelerType?: string;
        taxBreakdown?: {
            taxAmount?: { amount: string; currencyCode: string };
            taxCode?: string;
        }[];
        totals?: {
            currencyCode: string;
            fees?: string;
            subtotal?: string;
            taxes?: string;
            total: string;
        };
        tourCode?: string;
        travelerIndices?: number[];
    }[]

    Description

    Lists the details for saved fares. This service applies data either from a Price Quote or an Order Item.

  • Optionalflights?: (
        { itemId: string } & {
            aircraftTypeCode?: string;
            aircraftTypeName?: string;
            airlineCode: string;
            airlineName?: string;
            arrivalDate: string;
            arrivalGate?: string;
            arrivalTerminalName?: string;
            arrivalTime: string;
            bookingClass?: string;
            cabinTypeCode?: string;
            cabinTypeName?: string;
            confirmationId?: string;
            departureDate: string;
            departureGate?: string;
            departureTerminalName?: string;
            departureTime: string;
            distanceInMiles?: number;
            durationInMinutes?: number;
            flightNumber: number;
            flightStatusCode?: string;
            flightStatusName?:
                | "Unknown"
                | "Confirmed"
                | "On Request"
                | "Pending"
                | "Cancelled"
                | "Unconfirmed"
                | "Waitlisted"
                | "Infant/No Seat"
                | "Priority Waitlist"
                | "Quote"
                | "Space Available"
                | "Pending Quote"
                | "No Seat"
                | "Standby";
            fromAirportCode: string;
            hiddenStopAircraftTypeCode?: string;
            hiddenStopAircraftTypeName?: string;
            hiddenStopAirportCode?: string;
            hiddenStopArrivalDate?: string;
            hiddenStopArrivalTime?: string;
            hiddenStopDepartureDate?: string;
            hiddenStopDepartureTime?: string;
            hiddenStops?: {
                aircraftTypeCode?: string;
                aircraftTypeName?: string;
                airportCode?: string;
                arrivalDate?: string;
                arrivalTime?: string;
                departureDate?: string;
                departureTime?: string;
                durationInMinutes?: number;
            }[];
            identityDocuments?: {
                itemId?: string;
                status?: | "Unknown"
                | "Confirmed"
                | "On Request"
                | "Pending"
                | "Cancelled"
                | "Unconfirmed"
                | "Waitlisted"
                | "Infant/No Seat"
                | "Priority Waitlist"
                | "Quote"
                | "Space Available"
                | "Pending Quote"
                | "No Seat"
                | "Standby";
            }[];
            isPast?: boolean;
            meals?: {
                code: string;
                description: | "Meal"
                | "Alcoholic beverages for purchase"
                | "Breakfast"
                | "Cold meal"
                | "Complimentary alcoholic beverages"
                | "Continental breakfast"
                | "Dinner"
                | "Food for purchase"
                | "Food and beverage for purchase"
                | "Hot meal"
                | "Lunch"
                | "No meal service"
                | "Refreshment"
                | "Refreshment for purchase"
                | "Snack";
            }[];
            numberOfSeats?: number;
            operatingAirlineCode?: string;
            operatingAirlineName?: string;
            operatingFlightNumber?: number;
            seats?: {
                characteristics?: string[];
                number: string;
                statusCode?: string;
                statusName?: | "Unknown"
                | "Confirmed"
                | "On Request"
                | "Pending"
                | "Cancelled"
                | "Unconfirmed"
                | "Waitlisted"
                | "Infant/No Seat"
                | "Priority Waitlist"
                | "Quote"
                | "Space Available"
                | "Pending Quote"
                | "No Seat"
                | "Standby";
            }[];
            sourceType?: "NDC"
            | "LCC"
            | "ATPCO";
            toAirportCode: string;
            travelerIndices?: number[];
            updatedArrivalDate?: string;
            updatedArrivalTime?: string;
            updatedDepartureDate?: string;
            updatedDepartureTime?: string;
        }
    )[]

    Description

    Lists all flights associated with the booking in chronological order.

  • OptionalflightTickets?: {
        agencyIataNumber?: string;
        airlineCode: string;
        allCoupons?: (
            {
                couponStatus: | "Airport Control"
                | "Lifted"
                | "Checked In"
                | "Exchanged"
                | "Flown"
                | "Not Flown"
                | "Refunded"
                | "Voided"
                | "Printed"
                | "Okay"
                | "Reactivated"
                | "Irregular Operations"
                | "Print Exchange"
                | "Paper Ticket"
                | "Suspended"
                | "Locked";
                couponStatusCode: | "AL"
                | "PE"
                | "XX"
                | "S"
                | "P"
                | "B"
                | "E"
                | "BD"
                | "CK"
                | "I"
                | "RF"
                | "V"
                | "PR"
                | "IO"
                | "T";
            } & { itemId?: string }
        )[];
        commission?: {
            commissionAmount?: string;
            commissionPercentage?: string;
            currencyCode?: string;
        };
        date: string;
        flightCoupons: (
            { itemId: string } & {
                couponStatus:
                    | "Airport Control"
                    | "Lifted"
                    | "Checked In"
                    | "Exchanged"
                    | "Flown"
                    | "Not Flown"
                    | "Refunded"
                    | "Voided"
                    | "Printed"
                    | "Okay"
                    | "Reactivated"
                    | "Irregular Operations"
                    | "Print Exchange"
                    | "Paper Ticket"
                    | "Suspended"
                    | "Locked";
                couponStatusCode: | "AL"
                | "PE"
                | "XX"
                | "S"
                | "P"
                | "B"
                | "E"
                | "BD"
                | "CK"
                | "I"
                | "RF"
                | "V"
                | "PR"
                | "IO"
                | "T";
            }
        )[];
        number: string;
        payment: {
            currencyCode: string;
            fees?: string;
            subtotal?: string;
            taxes?: string;
            total: string;
        };
        ticketingPcc?: string;
        ticketStatusCode?: string;
        ticketStatusName?: "Voided"
        | "Issued"
        | "Refunded/Exchanged";
        travelerIndex: number;
    }[]

    Description

    Lists all electronic flight tickets issued for the travelers.

  • OptionalfutureTicketingPolicy?: {
        comment?: string;
        queueNumber?: string;
        ticketingDate?: string;
        ticketingPcc?: string;
        ticketingTime?: string;
    }

    • Optionalcomment?: string

      Description

      Free text comment.

      Example

      TICKET BEFORE TUES
      Copy

    • OptionalqueueNumber?: string

      Description

      Used to specify a queue number.

      Example

      55
      Copy

    • OptionalticketingDate?: string

      Format: date

      Description

      The ticketing date.

      Example

      2024-07-09
      Copy

    • OptionalticketingPcc?: string

      Description

      Used to specify a pseudocity code.

      Example

      G7RE
      Copy

    • OptionalticketingTime?: string

      Description

      The ticketing time in HH:MM format.

      Example

      11:00
      Copy

  • Optionalhotels?: (
        { itemId: string } & {
            address: {
                city?: string;
                countryCode?: string;
                postalCode?: string;
                stateProvince?: string;
                street?: string;
            } & { freeText?: string; name?: string } & { cityCode?: string };
            associatedFlightDetails?: {
                arrivalAirlineCode?: string;
                arrivalFlightNumber?: number;
                arrivalTime?: string;
                departureAirlineCode?: string;
                departureFlightNumber?: number;
                departureTime?: string;
            };
            chainCode?: string;
            chainName?: string;
            checkInDate: string;
            checkInTime: string;
            checkOutDate: string;
            checkOutTime: string;
            confirmationId?: string;
            contactInfo?: { emails?: string[] } & {
                emergencyPhones?: string[];
                faxes?: string[];
                phones?: string[];
            };
            corporateDiscountCode?: number;
            guaranteePaymentNote?: string;
            guaranteeTypeCode?: number;
            guaranteeTypeName?: | "Credit card"
            | "Travel agency name/address"
            | "Travel agency IATA number"
            | "Company name/address"
            | "Corporate ID/CD number"
            | "Virtual card";
            hotelName: string;
            hotelStatusCode?: string;
            hotelStatusName?: | "Unknown"
            | "Confirmed"
            | "On Request"
            | "Pending"
            | "Cancelled"
            | "Unconfirmed"
            | "Waitlisted"
            | "Infant/No Seat"
            | "Priority Waitlist"
            | "Quote"
            | "Space Available"
            | "Pending Quote"
            | "No Seat"
            | "Standby";
            isRefundable: boolean;
            leadTravelerIndex?: number;
            numberOfGuests?: number;
            payment?: {
                currencyCode: string;
                fees?: string;
                subtotal?: string;
                taxes?: string;
                total: string;
            };
            paymentPolicy?: "DEPOSIT"
            | "GUARANTEE"
            | "LATE";
            propertyId?: string;
            refundPenalties?: {
                applicableFromDate?: string;
                applicableToDate?: string;
                penalty: { amount: string; currencyCode: string };
            }[];
            refundPenaltyPolicyCode?: string;
            room?: {
                agencyCommission?: {
                    commissionAmount?: string;
                    commissionPercentage?: string;
                    currencyCode?: string;
                };
                description?: string;
                productCode?: string;
                quantity: number;
                roomRate?: { amount: string; currencyCode: string };
                roomType: string;
                roomTypeCode?: string;
                travelerIndices?: number[];
            };
            sabrePropertyId?: string;
            sourceTypeCode?: number;
            sourceTypeName?: | "Unknown"
            | "Legacy"
            | "Sabre GDS"
            | "Expedia Associate Network"
            | "HotelBeds.com"
            | "Booking.com"
            | "CMNet";
            specialInstructions?: string;
        }
    )[]

    Description

    Lists all hotel reservations associated with the booking.

  • OptionalisCancelable?: boolean

    Description

    If true, the booking is cancelable in full or in segments. Refer to the refundPenalties array for more information.

    Example

    false
    Copy

  • OptionalisTicketed?: boolean

    Description

    If true, at least one ticket was issued for the booking.

    Example

    false
    Copy

  • Optionaljourneys?: {
        departureDate: string;
        departureTime: string;
        firstAirportCode: string;
        lastAirportCode: string;
        numberOfFlights: number;
    }[]

    Description

    Lists all the journeys associated with the booking. * For one-way, this is a single element list. * For round-trip, the list contains two journeys. * For multi-destinations, the list contains more than two journeys.

  • OptionalnonElectronicTickets?: {
        date?: string;
        ticketingPcc?: string;
        ticketingUserCode?: string;
        ticketNumber?: string;
        ticketStatus?: "Unknown" | "Active" | "Inactive";
        time?: string;
        travelerIndex?: number;
    }[]

    Description

    Lists nonelectronic tickets from the booking.

  • OptionalotherServices?: {
        airlineCode?: string;
        chainCode?: string;
        serviceMessage?: string;
        travelerIndex?: number;
        vendorCode?: string;
    }[]

    Description

    Lists Other Service Information (OSI) to/from a specific vendor.

  • Optionalpayments?: {
        carTotals?: {
            currencyCode: string;
            fees?: string;
            subtotal?: string;
            taxes?: string;
            total: string;
        }[];
        flightCurrentTotals?: {
            currencyCode: string;
            fees?: string;
            subtotal?: string;
            taxes?: string;
            total: string;
        }[];
        flightTotals?: {
            currencyCode: string;
            fees?: string;
            subtotal?: string;
            taxes?: string;
            total: string;
        }[];
        formsOfPayment?: (
            {
                airlinePlanCode?: string;
                cardNumber?: string;
                cardSecurityCode?: string;
                cardTypeCode?: string;
                expiryDate?: string;
                extendedPayment?: number;
                installmentAmount?: string;
                miscellaneousCreditCode?: string;
                numberOfInstallments?: number;
            } & {
                agencyAddress?: {
                    city?: string;
                    countryCode?: string;
                    postalCode?: string;
                    stateProvince?: string;
                    street?: string;
                } & { freeText?: string; name?: string };
                agencyIataNumber?: string;
                authentications?: {
                    amount?: string;
                    cardNumberCollectionCode?: string;
                    channelCode?: string;
                    currencyCode?: string;
                    electronicCommerceIndicator?: string;
                    exemptionTypeCode?: string;
                    issueCode?: string;
                    mandateTypeCode?: string;
                    merchantName?: string;
                    originalPaymentReference?: string;
                    resultCode?: string;
                    secureAuthenticationValue?: string;
                    secureTransactionId?: string;
                    tokenAuthenticationValue?: string;
                    updatedDateTime?: string;
                    verificationResultCode?: string;
                    version?: string;
                }[];
                cardHolder?: {
                    address?: {
                        city?: string;
                        countryCode?: string;
                        postalCode?: string;
                        stateProvince?: string;
                        street?: string;
                    };
                    email?: string;
                    givenName: string;
                    phone?: string;
                    surname: string;
                };
                companyAddress?: {
                    city?: string;
                    countryCode?: string;
                    postalCode?: string;
                    stateProvince?: string;
                    street?: string;
                } & { freeText?: string; name?: string };
                corporateId?: string;
                docketDescription?: string;
                docketIssuingAgentInitials?: string;
                docketNumber?: string;
                docketPrefix?: string;
                governmentTravelRequestDescription?: string;
                invoiceDescription?: string;
                isAgencyPaymentCard?: boolean;
                manualApproval?: {
                    airlineCode: string;
                    amount: string;
                    code: string;
                    currencyCode: string;
                    expiryDateTime: string;
                    requestDateTime: string;
                };
                netBalance?: string;
                tripType?: | "All"
                | "Unknown"
                | "Corporate/Business"
                | "Leisure"
                | "Emergency"
                | "Family"
                | "Group";
                tripTypes?: (
                    | "All"
                    | "Unknown"
                    | "Corporate/Business"
                    | "Leisure"
                    | "Emergency"
                    | "Family"
                    | "Group"
                )[];
                type: | "INVOICE"
                | "CORPORATE"
                | "PAYMENTCARD"
                | "CASH"
                | "CHECK"
                | "MISCELLANEOUS"
                | "INSTALLMENTS"
                | "VIRTUAL_CARD"
                | "AGENCY_NAME"
                | "AGENCY_IATA"
                | "COMPANY_NAME"
                | "VOUCHER"
                | "DOCKET"
                | "GOVERNMENT_TRAVEL_REQUEST";
                useType?: | "All"
                | "Other"
                | "Tour"
                | "Unknown"
                | "Ancillary"
                | "Hotel"
                | "Car"
                | "Cruise"
                | "Airline"
                | "Bus/Ground Transportation"
                | "Insurance"
                | "Low-Cost Carrier"
                | "Rail"
                | "Specialty Service"
                | "Interface Record";
                useTypes?: (
                    | "All"
                    | "Other"
                    | "Tour"
                    | "Unknown"
                    | "Ancillary"
                    | "Hotel"
                    | "Car"
                    | "Cruise"
                    | "Airline"
                    | "Bus/Ground Transportation"
                    | "Insurance"
                    | "Low-Cost Carrier"
                    | "Rail"
                    | "Specialty Service"
                    | "Interface Record"
                )[];
                virtualCard?: {
                    agencyEmail?: string;
                    customerAccountCode?: string;
                    hotelFax?: string;
                    hotelName?: string;
                    rateAmount?: { amount: string; currencyCode: string };
                    roomDescription?: string;
                    roomType?: string;
                    virtualCardCharges?: string[];
                };
                voucher?: { billingNumber?: string; type?: string };
            }
        )[];
        hotelTotals?: {
            currencyCode: string;
            fees?: string;
            subtotal?: string;
            taxes?: string;
            total: string;
        }[];
        trainTotals?: {
            currencyCode: string;
            fees?: string;
            subtotal?: string;
            taxes?: string;
            total: string;
        }[];
    }

    • OptionalcarTotals?: {
          currencyCode: string;
          fees?: string;
          subtotal?: string;
          taxes?: string;
          total: string;
      }[]

      Description

      Lists all car rental payments, per each currency used.

    • OptionalflightCurrentTotals?: {
          currencyCode: string;
          fees?: string;
          subtotal?: string;
          taxes?: string;
          total: string;
      }[]

      Description

      Lists all flight payments, per each currency used, and is applicable only for ticketed bookings. It sums up all payments with the exclusion of Refunded/Voided tickets, obtained directly from the ticket data.

    • OptionalflightTotals?: {
          currencyCode: string;
          fees?: string;
          subtotal?: string;
          taxes?: string;
          total: string;
      }[]

      Description

      Lists all flight payments, per each currency used. For ticketed bookings it sums all payments irrespective of the document status. For non-ticketed bookings it sums payments from all price quotes stored in the booking.

    • OptionalformsOfPayment?: (
          {
              airlinePlanCode?: string;
              cardNumber?: string;
              cardSecurityCode?: string;
              cardTypeCode?: string;
              expiryDate?: string;
              extendedPayment?: number;
              installmentAmount?: string;
              miscellaneousCreditCode?: string;
              numberOfInstallments?: number;
          } & {
              agencyAddress?: {
                  city?: string;
                  countryCode?: string;
                  postalCode?: string;
                  stateProvince?: string;
                  street?: string;
              } & { freeText?: string; name?: string };
              agencyIataNumber?: string;
              authentications?: {
                  amount?: string;
                  cardNumberCollectionCode?: string;
                  channelCode?: string;
                  currencyCode?: string;
                  electronicCommerceIndicator?: string;
                  exemptionTypeCode?: string;
                  issueCode?: string;
                  mandateTypeCode?: string;
                  merchantName?: string;
                  originalPaymentReference?: string;
                  resultCode?: string;
                  secureAuthenticationValue?: string;
                  secureTransactionId?: string;
                  tokenAuthenticationValue?: string;
                  updatedDateTime?: string;
                  verificationResultCode?: string;
                  version?: string;
              }[];
              cardHolder?: {
                  address?: {
                      city?: string;
                      countryCode?: string;
                      postalCode?: string;
                      stateProvince?: string;
                      street?: string;
                  };
                  email?: string;
                  givenName: string;
                  phone?: string;
                  surname: string;
              };
              companyAddress?: {
                  city?: string;
                  countryCode?: string;
                  postalCode?: string;
                  stateProvince?: string;
                  street?: string;
              } & { freeText?: string; name?: string };
              corporateId?: string;
              docketDescription?: string;
              docketIssuingAgentInitials?: string;
              docketNumber?: string;
              docketPrefix?: string;
              governmentTravelRequestDescription?: string;
              invoiceDescription?: string;
              isAgencyPaymentCard?: boolean;
              manualApproval?: {
                  airlineCode: string;
                  amount: string;
                  code: string;
                  currencyCode: string;
                  expiryDateTime: string;
                  requestDateTime: string;
              };
              netBalance?: string;
              tripType?: | "All"
              | "Unknown"
              | "Corporate/Business"
              | "Leisure"
              | "Emergency"
              | "Family"
              | "Group";
              tripTypes?: (
                  | "All"
                  | "Unknown"
                  | "Corporate/Business"
                  | "Leisure"
                  | "Emergency"
                  | "Family"
                  | "Group"
              )[];
              type: | "INVOICE"
              | "CORPORATE"
              | "PAYMENTCARD"
              | "CASH"
              | "CHECK"
              | "MISCELLANEOUS"
              | "INSTALLMENTS"
              | "VIRTUAL_CARD"
              | "AGENCY_NAME"
              | "AGENCY_IATA"
              | "COMPANY_NAME"
              | "VOUCHER"
              | "DOCKET"
              | "GOVERNMENT_TRAVEL_REQUEST";
              useType?: | "All"
              | "Other"
              | "Tour"
              | "Unknown"
              | "Ancillary"
              | "Hotel"
              | "Car"
              | "Cruise"
              | "Airline"
              | "Bus/Ground Transportation"
              | "Insurance"
              | "Low-Cost Carrier"
              | "Rail"
              | "Specialty Service"
              | "Interface Record";
              useTypes?: (
                  | "All"
                  | "Other"
                  | "Tour"
                  | "Unknown"
                  | "Ancillary"
                  | "Hotel"
                  | "Car"
                  | "Cruise"
                  | "Airline"
                  | "Bus/Ground Transportation"
                  | "Insurance"
                  | "Low-Cost Carrier"
                  | "Rail"
                  | "Specialty Service"
                  | "Interface Record"
              )[];
              virtualCard?: {
                  agencyEmail?: string;
                  customerAccountCode?: string;
                  hotelFax?: string;
                  hotelName?: string;
                  rateAmount?: { amount: string; currencyCode: string };
                  roomDescription?: string;
                  roomType?: string;
                  virtualCardCharges?: string[];
              };
              voucher?: { billingNumber?: string; type?: string };
          }
      )[]

      Description

      Lists all the payment methods that are stored in the booking.

    • OptionalhotelTotals?: {
          currencyCode: string;
          fees?: string;
          subtotal?: string;
          taxes?: string;
          total: string;
      }[]

      Description

      Lists all hotel payments, per each currency used.

    • OptionaltrainTotals?: {
          currencyCode: string;
          fees?: string;
          subtotal?: string;
          taxes?: string;
          total: string;
      }[]

      Description

      Lists all train payments, per each currency used.

  • Optionalremarks?: {
        alphaCode?: string;
        text?: string;
        type?:
            | "INVOICE"
            | "ITINERARY"
            | "GENERAL"
            | "HISTORICAL"
            | "CLIENT_ADDRESS"
            | "ALPHA_CODED"
            | "DELIVERY_ADDRESS"
            | "HIDDEN"
            | "CORPORATE"
            | "FORM_OF_PAYMENT"
            | "PRINT_ON_TICKET"
            | "FILLER_STRIP"
            | "INTERFACE"
            | "QUEUE_PLACE";
    }[]

    Description

    Contains list of remarks added to the PNR.

  • OptionalretentionEndDate?: string

    Format: date

    Description

    The retention date of the booking. Used optionally to keep the booking active past the date of the last itinerary item (flight, hotel, car, etc.). After this date, the booking is set for purging.

    Example

    2024-01-30
    Copy

  • OptionalretentionLabel?: string

    Description

    The label associated with the retention date.

    Example

    RETENTION DATE
    Copy

  • OptionalspecialServices?: {
        code?: string;
        flights?: { itemId: string }[];
        message?: string;
        name?: string;
        statusCode?: string;
        statusName?:
            | "Unknown"
            | "Confirmed"
            | "On Request"
            | "Pending"
            | "Cancelled"
            | "Unconfirmed"
            | "Waitlisted"
            | "Infant/No Seat"
            | "Priority Waitlist"
            | "Quote"
            | "Space Available"
            | "Pending Quote"
            | "No Seat"
            | "Standby";
        travelerIndices?: number[];
    }[]

    Description

    Lists all special services associated with a traveler.

  • OptionalstartDate?: string

    Format: date

    Description

    The start date of the booking in ISO 8601 format.

    Example

    2024-07-09
    Copy

  • Optionaltrains?: (
        { itemId: string } & {
            arrivalDate: string;
            arrivalTime: string;
            confirmationId?: string;
            departureDate: string;
            departureTime: string;
            fromStationCode: string;
            fromStationName?: string;
            isRefundable?: boolean;
            operatingVendorCode?: string;
            operatingVendorName?: string;
            payment?: {
                currencyCode: string;
                fees?: string;
                subtotal?: string;
                taxes?: string;
                total: string;
            };
            toStationCode: string;
            toStationName?: string;
            trainName?: string;
            trainNumber: string;
            trainStatusCode?: string;
            trainStatusName?: | "Unknown"
            | "Confirmed"
            | "On Request"
            | "Pending"
            | "Cancelled"
            | "Unconfirmed"
            | "Waitlisted"
            | "Infant/No Seat"
            | "Priority Waitlist"
            | "Quote"
            | "Space Available"
            | "Pending Quote"
            | "No Seat"
            | "Standby";
            vendorCode: string;
            vendorName?: string;
        }
    )[]

    Description

    Lists all trains associated with the booking.

  • Optionaltravelers?: {
        address?: {
            city?: string;
            countryCode?: string;
            postalCode?: string;
            stateProvince?: string;
            street?: string;
        } & { freeText?: string; name?: string };
        ancillaries?: {
            airlineCode?: string;
            commercialName?: string;
            electronicMiscellaneousDocumentNumber?: string;
            flightApplicabilityType?: "Unknown" | "Single" | "Multiple";
            flights?: { itemId: string }[];
            isCommissionable?: boolean;
            isRefundable?: boolean;
            itemId?: string;
            numberOfItems?: number;
            reasonForIssuanceCode?: string;
            reasonForIssuanceName?:
                | "UNKNOWN"
                | "AIR_TRANSPORTATION"
                | "SURFACE_TRANSPORTATION_NON_AIR_SERVICES"
                | "BAGGAGE"
                | "FINANCIAL_IMPACT"
                | "AIRPORT_SERVICES"
                | "MERCHANDISE"
                | "INFLIGHT_SERVICES"
                | "INDIVIDUAL_AIRLINE_USE";
            source?: "ATPCO"
            | "MERCHANDISING_MANAGER";
            statusCode?: string;
            statusName?:
                | "Confirmed"
                | "Confirmed with EMD issued"
                | "On Request"
                | "Pending"
                | "Cancelled"
                | "Unconfirmed"
                | "Confirmed with pending payment"
                | "Schedule change";
            subcode?: string;
            totals?: {
                currencyCode: string;
                fees?: string;
                subtotal?: string;
                taxes?: string;
                total: string;
            };
            vendorCode?: string;
        }[];
        birthDate?: string;
        emails?: string[];
        formOfPaymentIndices?: number[];
        gender?: | "FEMALE"
        | "MALE"
        | "INFANT_FEMALE"
        | "INFANT_MALE"
        | "UNDISCLOSED"
        | "UNDEFINED";
        givenName: string;
        identityDocuments?: {
            birthDate?: string;
            documentNumber?: string;
            documentSubType?: "RUC"
            | "CUIT/CUIL"
            | "NIT";
            documentType:
                | "MILITARY"
                | "PASSPORT"
                | "VISA"
                | "SECURE_FLIGHT_PASSENGER_DATA"
                | "RESIDENCE_ADDRESS"
                | "DESTINATION_ADDRESS"
                | "KNOWN_TRAVELER_NUMBER"
                | "REDRESS_NUMBER"
                | "ALIEN_RESIDENT"
                | "PERMANENT_RESIDENT"
                | "FACILITATION_DOCUMENT"
                | "NATIONAL_ID_CARD"
                | "NEXUS_CARD"
                | "NATURALIZATION_CERTIFICATE"
                | "REFUGEE_REENTRY_PERMIT"
                | "BORDER_CROSSING_CARD"
                | "FISCAL_ID";
            expiryDate?: string;
            flightIndices?: number[];
            gender?: | "FEMALE"
            | "MALE"
            | "INFANT_FEMALE"
            | "INFANT_MALE"
            | "UNDISCLOSED"
            | "UNDEFINED";
            givenName?: string;
            hostCountryCode?: string;
            isLapChildDocument?: boolean;
            isPrimaryDocumentHolder?: boolean;
            issueDate?: string;
            issuingCountryCode?: string;
            itemId?: string;
            middleName?: string;
            placeOfBirth?: string;
            placeOfIssue?: string;
            residenceCountryCode?: string;
            residenceDestinationAddress?: {
                city?: string;
                countryCode?: string;
                postalCode?: string;
                stateProvince?: string;
                street?: string;
            };
            surname?: string;
        }[];
        isGrouped?: boolean;
        loyaltyPrograms?: {
            programNumber: string;
            programType?: | "FREQUENT_FLYER"
            | "FREQUENT_RENTER"
            | "LOYALTY_ID"
            | "CORPORATE_LOYALTY_ID";
            receiverCode?: string;
            supplierCode?: string;
            tierLevel?: number;
        }[];
        middleName?: string;
        nameAssociationId?: string;
        nameReferenceCode?: string;
        passengerCode?: string;
        phones?: { label?: string; number: string }[];
        remarks?: {
            alphaCode?: string;
            text?: string;
            type?:
                | "INVOICE"
                | "ITINERARY"
                | "GENERAL"
                | "HISTORICAL"
                | "CLIENT_ADDRESS"
                | "ALPHA_CODED"
                | "DELIVERY_ADDRESS"
                | "HIDDEN"
                | "CORPORATE"
                | "FORM_OF_PAYMENT"
                | "PRINT_ON_TICKET"
                | "FILLER_STRIP"
                | "INTERFACE"
                | "QUEUE_PLACE";
        }[];
        surname: string;
        type?: | "ADULT"
        | "AGENT"
        | "AIRLINE"
        | "CHILD"
        | "EDUCATION"
        | "GOVERNMENT"
        | "GROUP"
        | "INFANT"
        | "MILITARY"
        | "SENIOR"
        | "SPECIAL"
        | "YOUTH";
    }[]

    Description

    Lists the traveler(s) associated with the booking.

  • OptionaltravelersGroup?: {
        itemId?: string;
        name?: string;
        numberOfTravelers?: number;
        numberOfTravelersRemaining?: number;
    }

    • OptionalitemId?: string

      Description

      Contains the ID of the group.

      Example

      3
      Copy

    • Optionalname?: string

      Description

      The name of the group.

      Example

      GROUP ONE
      Copy

    • OptionalnumberOfTravelers?: number

      Format: int32

      Description

      The total number of travelers within the group. Lap infants are not taken into consideration.

      Example

      1
      Copy

    • OptionalnumberOfTravelersRemaining?: number

      Format: int32

      Description

      The number of remaining travelers within the group whose names are not provided. Lap infants are not taken into consideration.

      Example

      1
      Copy

  • OptionalbookingSignature?: string

    Description

    The unique ID of the Get Booking response. It is used to verify the state of the booking during the modification operation. Available only if obtaining the booking state does not result in any errors.

    Example

    76c2817b178cc264fa44cf85df1da5fb9e1b963006b2339aa5edc09129415bba5fcf5bf91a5f
    Copy

  • Optionalerrors?: {
        category: string;
        description?: string;
        fieldName?: string;
        fieldPath?: string;
        fieldValue?: string;
        type: string;
    }[]

    Description

    Lists detailed error information. This array is not displayed in successful responses.

  • Optionalrequest?: {
        bookingSource?: "SABRE" | "SABRE_ORDER";
        confirmationId: string;
        extraFeatures?: { returnEmptySeatObjects: boolean } & {
            returnFiscalId: boolean;
            returnFrequentRenter: boolean;
            returnWalletFormsOfPayment: boolean;
        } & Record<string, never>;
        givenName?: string;
        middleName?: string;
        returnOnly?: (
            | "FLIGHTS"
            | "FLIGHT_PENALTY"
            | "BAGGAGE_POLICY"
            | "JOURNEYS"
            | "HOTELS"
            | "HOTEL_ADDRESS"
            | "CARS"
            | "CAR_RENTAL_ADDRESS"
            | "CAR_RENTAL_PENALTY"
            | "TRAINS"
            | "CRUISES"
            | "ALL_SEGMENTS"
            | "TRAVELERS"
            | "TICKETS"
            | "PAYMENTS"
            | "PENALTIES"
            | "REMARKS"
            | "IS_CANCELABLE"
            | "IS_TICKETED"
            | "CONTACT_INFO"
            | "OTHER_SERVICES"
            | "SPECIAL_SERVICES"
            | "FARES"
            | "CREATION_DETAILS"
            | "ANCILLARIES"
            | "FORMS_OF_PAYMENT"
            | "RETENTION_DATE"
            | "ACCOUNTING_ITEMS"
            | "NON_ELECTRONIC_TICKETS"
        )[];
        surname?: string;
        targetPcc?: string;
        unmaskPaymentCardNumbers?: boolean;
    }

    • OptionalbookingSource?: "SABRE" | "SABRE_ORDER"

    • confirmationId: string

      Description

      The booking reference ID as shown in the source supplier/vendor system. For SABRE, this is the PNR Locator value.

      Example

      GLEBNY
      Copy

    • OptionalextraFeatures?: { returnEmptySeatObjects: boolean } & {
          returnFiscalId: boolean;
          returnFrequentRenter: boolean;
          returnWalletFormsOfPayment: boolean;
      } & Record<string, never>

    • OptionalgivenName?: string

      Description

      The traveler's first name.

      Example

      John
      Copy

    • OptionalmiddleName?: string

      Description

      The middle name or the initial of the middle name of the traveler.

      Example

      W
      Copy

    • OptionalreturnOnly?: (
          | "FLIGHTS"
          | "FLIGHT_PENALTY"
          | "BAGGAGE_POLICY"
          | "JOURNEYS"
          | "HOTELS"
          | "HOTEL_ADDRESS"
          | "CARS"
          | "CAR_RENTAL_ADDRESS"
          | "CAR_RENTAL_PENALTY"
          | "TRAINS"
          | "CRUISES"
          | "ALL_SEGMENTS"
          | "TRAVELERS"
          | "TICKETS"
          | "PAYMENTS"
          | "PENALTIES"
          | "REMARKS"
          | "IS_CANCELABLE"
          | "IS_TICKETED"
          | "CONTACT_INFO"
          | "OTHER_SERVICES"
          | "SPECIAL_SERVICES"
          | "FARES"
          | "CREATION_DETAILS"
          | "ANCILLARIES"
          | "FORMS_OF_PAYMENT"
          | "RETENTION_DATE"
          | "ACCOUNTING_ITEMS"
          | "NON_ELECTRONIC_TICKETS"
      )[]

      Description

      Lists the response sections which are returned by the service. If this list is empty or not provided, then the full structure is returned. By using this option, the application may exclude or simplify calls of downline APIs, which usually results in a significant performance boost.

    • Optionalsurname?: string

      Description

      The traveler's last name.

      Example

      Smith
      Copy

    • OptionaltargetPcc?: string

      Description

      The pseudo city code of the target destination in which the booking retrieval is requested.

      Example

      G7HE
      Copy

    • OptionalunmaskPaymentCardNumbers?: boolean

      Description

      If true, the application unmasks payment card information stored in the booking. To display this data, the Employee Profile Record (EPR) needs to include the CCVIEW keyword.

      Example

      false
      Copy

  • Optionaltimestamp?: string

    Format: date-time

    Description

    Provides the exact point in time when the response was generated. The timestamp is expressed in UTC and presented in the YYYY-MM-DDTHH:MM:SSZ format.

    Example

    2024-10-28T11:11:21Z
    Copy