Documentation
    Preparing search index...

    Function seatMapByPayload

    • Parameters

      Returns Omit<
          {
              payloadAttributes?: {
                  correlationID?: string;
                  echoTokenText?: string;
                  timeStamp?: string;
                  transactionID?: string;
              };
              requestType: string;
          },
          "requestType",
      > & {
          request: {
              currency?: string;
              customAttributes?: { key: string; value: string }[];
              dataBin?: string;
              fareComponents?: {
                  brand?: { code: string };
                  fareBasis: { fareBasisCode: string };
                  fareComponentId: string;
                  fareDetail?: {
                      fareIndicator?: number;
                      fareRule?: string;
                      fareTariff?: string;
                      fareType?: string;
                      fareTypeBitmap?: string;
                      privateTariffIndicator?: boolean;
                  };
                  governingCarrier?: string;
                  price?: { amount: number };
                  vendorCode?: string;
              }[];
              originDest: {
                  paxJourney: {
                      paxSegments: {
                          arrival: {
                              aircraftScheduledDate: { date: string };
                              locationCode: string;
                          };
                          cabinType?: { cabinTypeCode?: string; cabinTypeName?: string };
                          departure: {
                              aircraftScheduledDate: { date: string };
                              locationCode: string;
                          };
                          marketingCarrierInfo: {
                              bookingCode?: string;
                              carrierCode: string;
                              carrierFlightNumber: string;
                          };
                          operatingCarrierInfo?: {
                              bookingCode?: string;
                              carrierCode: string;
                              carrierFlightNumber: string;
                          };
                          paxSegmentId: string;
                      }[];
                  };
              };
              paxes: {
                  accompaniedByInfant?: boolean;
                  birthday?: string;
                  customAttributes?: { key: string; value: string }[];
                  fareComponentsAndSegmentId?: {
                      fareComponentRefId: string;
                      segmentRefId: string;
                  }[];
                  givenName?: string;
                  loyaltyProgramAccount?: {
                      accountNumber: string;
                      airline: string;
                      partnerProgram?: string;
                      tierPriority?: string;
                  }[];
                  paxID: string;
                  ptc: string;
                  surname?: string;
              }[];
              paxSegmentRefIds: string[];
          };
          requestMode?: "BOOKING"
          | "CHECKIN";
      } & { requestType: "payload" }

      seatMap

      • request: {
            currency?: string;
            customAttributes?: { key: string; value: string }[];
            dataBin?: string;
            fareComponents?: {
                brand?: { code: string };
                fareBasis: { fareBasisCode: string };
                fareComponentId: string;
                fareDetail?: {
                    fareIndicator?: number;
                    fareRule?: string;
                    fareTariff?: string;
                    fareType?: string;
                    fareTypeBitmap?: string;
                    privateTariffIndicator?: boolean;
                };
                governingCarrier?: string;
                price?: { amount: number };
                vendorCode?: string;
            }[];
            originDest: {
                paxJourney: {
                    paxSegments: {
                        arrival: {
                            aircraftScheduledDate: { date: string };
                            locationCode: string;
                        };
                        cabinType?: { cabinTypeCode?: string; cabinTypeName?: string };
                        departure: {
                            aircraftScheduledDate: { date: string };
                            locationCode: string;
                        };
                        marketingCarrierInfo: {
                            bookingCode?: string;
                            carrierCode: string;
                            carrierFlightNumber: string;
                        };
                        operatingCarrierInfo?: {
                            bookingCode?: string;
                            carrierCode: string;
                            carrierFlightNumber: string;
                        };
                        paxSegmentId: string;
                    }[];
                };
            };
            paxes: {
                accompaniedByInfant?: boolean;
                birthday?: string;
                customAttributes?: { key: string; value: string }[];
                fareComponentsAndSegmentId?: {
                    fareComponentRefId: string;
                    segmentRefId: string;
                }[];
                givenName?: string;
                loyaltyProgramAccount?: {
                    accountNumber: string;
                    airline: string;
                    partnerProgram?: string;
                    tierPriority?: string;
                }[];
                paxID: string;
                ptc: string;
                surname?: string;
            }[];
            paxSegmentRefIds: string[];
        }

        Contains itinerary elements required for the payload request type.

        • Optionalcurrency?: string

          Requested search processing and results currency information.

        • OptionalcustomAttributes?: { key: string; value: string }[]

          Lists any custom input attributes.

        • OptionaldataBin?: string
        • OptionalfareComponents?: {
              brand?: { code: string };
              fareBasis: { fareBasisCode: string };
              fareComponentId: string;
              fareDetail?: {
                  fareIndicator?: number;
                  fareRule?: string;
                  fareTariff?: string;
                  fareType?: string;
                  fareTypeBitmap?: string;
                  privateTariffIndicator?: boolean;
              };
              governingCarrier?: string;
              price?: { amount: number };
              vendorCode?: string;
          }[]

          Lists fare definitions used for the trip.

        • originDest: {
              paxJourney: {
                  paxSegments: {
                      arrival: {
                          aircraftScheduledDate: { date: string };
                          locationCode: string;
                      };
                      cabinType?: { cabinTypeCode?: string; cabinTypeName?: string };
                      departure: {
                          aircraftScheduledDate: { date: string };
                          locationCode: string;
                      };
                      marketingCarrierInfo: {
                          bookingCode?: string;
                          carrierCode: string;
                          carrierFlightNumber: string;
                      };
                      operatingCarrierInfo?: {
                          bookingCode?: string;
                          carrierCode: string;
                          carrierFlightNumber: string;
                      };
                      paxSegmentId: string;
                  }[];
              };
          }

          Contains the origin and destination airport/city pair.

          • paxJourney: {
                paxSegments: {
                    arrival: {
                        aircraftScheduledDate: { date: string };
                        locationCode: string;
                    };
                    cabinType?: { cabinTypeCode?: string; cabinTypeName?: string };
                    departure: {
                        aircraftScheduledDate: { date: string };
                        locationCode: string;
                    };
                    marketingCarrierInfo: {
                        bookingCode?: string;
                        carrierCode: string;
                        carrierFlightNumber: string;
                    };
                    operatingCarrierInfo?: {
                        bookingCode?: string;
                        carrierCode: string;
                        carrierFlightNumber: string;
                    };
                    paxSegmentId: string;
                }[];
            }

            The origin and destination airport/city pair for the flight.

            • paxSegments: {
                  arrival: {
                      aircraftScheduledDate: { date: string };
                      locationCode: string;
                  };
                  cabinType?: { cabinTypeCode?: string; cabinTypeName?: string };
                  departure: {
                      aircraftScheduledDate: { date: string };
                      locationCode: string;
                  };
                  marketingCarrierInfo: {
                      bookingCode?: string;
                      carrierCode: string;
                      carrierFlightNumber: string;
                  };
                  operatingCarrierInfo?: {
                      bookingCode?: string;
                      carrierCode: string;
                      carrierFlightNumber: string;
                  };
                  paxSegmentId: string;
              }[]

              Lists any segment data definitions.

        • paxes: {
              accompaniedByInfant?: boolean;
              birthday?: string;
              customAttributes?: { key: string; value: string }[];
              fareComponentsAndSegmentId?: {
                  fareComponentRefId: string;
                  segmentRefId: string;
              }[];
              givenName?: string;
              loyaltyProgramAccount?: {
                  accountNumber: string;
                  airline: string;
                  partnerProgram?: string;
                  tierPriority?: string;
              }[];
              paxID: string;
              ptc: string;
              surname?: string;
          }[]

          Lists passenger definitions for each seat map to be returned.

        • paxSegmentRefIds: string[]

          Lists passenger segment IDs for a requested seat map.

      • OptionalrequestMode?: "BOOKING" | "CHECKIN"

        Identifies whether the request should be used for booking or for check-in.

      • requestType: "payload"

        discriminator enum property added by openapi-typescript

    Settings

    Member Visibility