Documentation
    Preparing search index...
    interface components {
        headers: never;
        parameters: never;
        pathItems: never;
        requestBodies: never;
        responses: never;
        schemas: {
            AdvanceStay: {
                advancePurchase?: { context?: string; value?: string };
                maximumStay?: {
                    dayOfWeek?: number;
                    dayQuantity?: { context?: string; value?: string };
                };
                minimumStay?: {
                    dayOfWeek?: number;
                    dayQuantity?: { context?: string; value?: string };
                };
            };
            ArnkInd: boolean;
            Baggage: {
                applicablePartyText?: string;
                details?: {
                    constrains?: { max?: number; min?: number; unit?: string }[];
                    desc?: string[];
                    quantity?: number;
                }[];
                segments?: string[];
                totalQty?: number;
                type?: string;
            }[];
            CabinType: { cabinTypeCode: string; cabinTypeName: string };
            CarrierCode: string;
            CorporateFare: { account: string };
            CurrencyType: { amount: string; curCode: string; taxable?: boolean };
            DateTimeType: string;
            FareRules: {
                advanceStay?: {
                    advancePurchase?: { context?: string; value?: string };
                    maximumStay?: {
                        dayOfWeek?: number;
                        dayQuantity?: { context?: string; value?: string };
                    };
                    minimumStay?: {
                        dayOfWeek?: number;
                        dayQuantity?: { context?: string; value?: string };
                    };
                };
                corporateFare?: { account: string };
                penalty?: {
                    applicableFeeRemarks?: { displayInd?: boolean; value?: string }[];
                    cancelFeeInd?: boolean;
                    changeFeeInd?: boolean;
                    details?: {
                        amounts?: {
                            amountApplication?: string;
                            applicableFeeRemarks?: { displayInd?: boolean; value?: string }[];
                            currencyAmountValue?: {
                                amount: string;
                                curCode: string;
                                taxable?: boolean;
                            };
                            percentageAmount?: string;
                        }[];
                        application?: string;
                        penaltyType?: string;
                    }[];
                    refundableInd?: boolean;
                    reuseInd?: boolean;
                    upgradeFeeInd?: boolean;
                };
                ticketing?: {
                    endorsements?: string[];
                    instantPurchase?: string;
                    remarks?: { displayInd?: boolean; value?: string }[];
                    ticketlessInd?: boolean;
                };
            };
            MinMaxStay: {
                dayOfWeek?: number;
                dayQuantity?: { context?: string; value?: string };
            };
            OfferPriceRQ: {
                diags?: string[];
                params?: {
                    formOfPayment?: {
                        binNumber?: string;
                        cardType?: string;
                        id: string;
                        subCode: string;
                    }[];
                };
                passengers?: {
                    frequentFlyer?: {
                        accountNumber?: string;
                        airline?: string;
                        programCode?: string;
                        programName?: string;
                        providerName?: string;
                        signInID?: string;
                        tierCode?: string;
                        tierName?: string;
                        tierPriority?: string;
                    }[];
                    id: string;
                    type?: string;
                }[];
                query: {
                    formOfPayment: string;
                    offerItemId: string[];
                    passengerId?: string[];
                }[];
            };
            OfferPriceRS: {
                id?: string;
                messages?: {
                    code: number;
                    message: string;
                    service: string;
                    system?: string;
                    type: string;
                }[];
                payloadAttributes?: { host?: string; timeStamp?: string; trxID?: string } & {
                    [key: string]: string;
                };
                response?: {
                    offers: {
                        commission?: { amount?: string; percentage?: string };
                        id: string;
                        offerExpirationDateTime: string;
                        offerItems: {
                            id: string;
                            mandatoryInd?: boolean;
                            passengers: {
                                baggage?: {
                                    applicablePartyText?: ...;
                                    details?: ...;
                                    segments?: ...;
                                    totalQty?: ...;
                                    type?: ...;
                                }[];
                                fareComponents?: {
                                    brand?: ...;
                                    fareBasis: ...;
                                    fareRules?: ...;
                                    price: ...;
                                    segments: ...;
                                }[];
                                fees?: {
                                    airline?: ...;
                                    arrivalCity?: ...;
                                    boardCity?: ...;
                                    cardInfo?: ...;
                                    fareAmount: ...;
                                    localAmount?: ...;
                                    maxChargeAmount?: ...;
                                    nature?: ...;
                                    noChargeInd: ...;
                                    percentageAmount?: ...;
                                    surchargeType?: ...;
                                }[];
                                id: string;
                                price?: {
                                    baseAmount?: { amount: ...; curCode: ...; taxable?: ... };
                                    originalAmount?: { amount: ...; curCode: ...; taxable?: ... };
                                    taxes?: { breakdown?: ...; total: ... };
                                    totalAmount?: { amount: ...; curCode: ...; taxable?: ... };
                                };
                                ptc: string;
                                requestedPtc: string;
                                services?: {
                                    name: ...;
                                    reasonForIssuanceSubCode?: ...;
                                    segments?: ...;
                                    serviceCode?: ...;
                                }[];
                            }[];
                        }[];
                        paymentTimeLimitDateTime?: string;
                        price?: {
                            baseAmount?: { amount: string; curCode: string; taxable?: boolean };
                            originalAmount?: {
                                amount: string;
                                curCode: string;
                                taxable?: boolean;
                            };
                            taxes?: {
                                breakdown?: {
                                    amount: { amount: string; curCode: string; taxable?: boolean };
                                    description: string;
                                    nation?: string;
                                    taxCode: string;
                                }[];
                                total: { amount: string; curCode: string; taxable?: boolean };
                            };
                            totalAmount?: { amount: string; curCode: string; taxable?: boolean };
                        };
                        purchaseTimeLimitDateTime?: string;
                        source: string;
                        totalPrice: {
                            baseAmount?: { amount: string; curCode: string; taxable?: boolean };
                            equivAmount?: { amount: string; curCode: string; taxable?: boolean };
                            totalAmount: { amount: string; curCode: string; taxable?: boolean };
                            totalTaxes?: { amount: string; curCode: string; taxable?: boolean };
                        };
                        ttl: number;
                    }[];
                    promotions?: {
                        remarks?: string[];
                        rules?: {
                            discount?: {
                                accountCodes?: string;
                                amount?: string;
                                curCode?: string;
                                percent?: string;
                            };
                            id?: string;
                            type?: string;
                        }[];
                        tag?: string;
                        tourCode?: string;
                    }[];
                };
                version: string;
            };
            PayloadAttributes: { host?: string; timeStamp?: string; trxID?: string } & {
                [key: string]: string;
            };
            Penalty: {
                applicableFeeRemarks?: { displayInd?: boolean; value?: string }[];
                cancelFeeInd?: boolean;
                changeFeeInd?: boolean;
                details?: {
                    amounts?: {
                        amountApplication?: string;
                        applicableFeeRemarks?: { displayInd?: boolean; value?: string }[];
                        currencyAmountValue?: {
                            amount: string;
                            curCode: string;
                            taxable?: boolean;
                        };
                        percentageAmount?: string;
                    }[];
                    application?: string;
                    penaltyType?: string;
                }[];
                refundableInd?: boolean;
                reuseInd?: boolean;
                upgradeFeeInd?: boolean;
            };
            PenaltyDetail: {
                amounts?: {
                    amountApplication?: string;
                    applicableFeeRemarks?: { displayInd?: boolean; value?: string }[];
                    currencyAmountValue?: {
                        amount: string;
                        curCode: string;
                        taxable?: boolean;
                    };
                    percentageAmount?: string;
                }[];
                application?: string;
                penaltyType?: string;
            };
            Price: {
                baseAmount?: { amount: string; curCode: string; taxable?: boolean };
                originalAmount?: { amount: string; curCode: string; taxable?: boolean };
                taxes?: {
                    breakdown?: {
                        amount: { amount: string; curCode: string; taxable?: boolean };
                        description: string;
                        nation?: string;
                        taxCode: string;
                    }[];
                    total: { amount: string; curCode: string; taxable?: boolean };
                };
                totalAmount?: { amount: string; curCode: string; taxable?: boolean };
            };
            PromotionType: {
                remarks?: string[];
                rules?: {
                    discount?: {
                        accountCodes?: string;
                        amount?: string;
                        curCode?: string;
                        percent?: string;
                    };
                    id?: string;
                    type?: string;
                }[];
                tag?: string;
                tourCode?: string;
            };
            RBD: string;
            Remark: { displayInd?: boolean; value?: string };
            Services: {
                name: string;
                reasonForIssuanceSubCode?: string;
                segments?: string[];
                serviceCode?: string;
            }[];
            Source: string;
            Ticketing: {
                endorsements?: string[];
                instantPurchase?: string;
                remarks?: { displayInd?: boolean; value?: string }[];
                ticketlessInd?: boolean;
            };
            ValueWithContext: { context?: string; value?: string };
        };
    }
    Index

    Properties

    headers: never
    parameters: never
    pathItems: never
    requestBodies: never
    responses: never
    schemas: {
        AdvanceStay: {
            advancePurchase?: { context?: string; value?: string };
            maximumStay?: {
                dayOfWeek?: number;
                dayQuantity?: { context?: string; value?: string };
            };
            minimumStay?: {
                dayOfWeek?: number;
                dayQuantity?: { context?: string; value?: string };
            };
        };
        ArnkInd: boolean;
        Baggage: {
            applicablePartyText?: string;
            details?: {
                constrains?: { max?: number; min?: number; unit?: string }[];
                desc?: string[];
                quantity?: number;
            }[];
            segments?: string[];
            totalQty?: number;
            type?: string;
        }[];
        CabinType: { cabinTypeCode: string; cabinTypeName: string };
        CarrierCode: string;
        CorporateFare: { account: string };
        CurrencyType: { amount: string; curCode: string; taxable?: boolean };
        DateTimeType: string;
        FareRules: {
            advanceStay?: {
                advancePurchase?: { context?: string; value?: string };
                maximumStay?: {
                    dayOfWeek?: number;
                    dayQuantity?: { context?: string; value?: string };
                };
                minimumStay?: {
                    dayOfWeek?: number;
                    dayQuantity?: { context?: string; value?: string };
                };
            };
            corporateFare?: { account: string };
            penalty?: {
                applicableFeeRemarks?: { displayInd?: boolean; value?: string }[];
                cancelFeeInd?: boolean;
                changeFeeInd?: boolean;
                details?: {
                    amounts?: {
                        amountApplication?: string;
                        applicableFeeRemarks?: { displayInd?: boolean; value?: string }[];
                        currencyAmountValue?: {
                            amount: string;
                            curCode: string;
                            taxable?: boolean;
                        };
                        percentageAmount?: string;
                    }[];
                    application?: string;
                    penaltyType?: string;
                }[];
                refundableInd?: boolean;
                reuseInd?: boolean;
                upgradeFeeInd?: boolean;
            };
            ticketing?: {
                endorsements?: string[];
                instantPurchase?: string;
                remarks?: { displayInd?: boolean; value?: string }[];
                ticketlessInd?: boolean;
            };
        };
        MinMaxStay: {
            dayOfWeek?: number;
            dayQuantity?: { context?: string; value?: string };
        };
        OfferPriceRQ: {
            diags?: string[];
            params?: {
                formOfPayment?: {
                    binNumber?: string;
                    cardType?: string;
                    id: string;
                    subCode: string;
                }[];
            };
            passengers?: {
                frequentFlyer?: {
                    accountNumber?: string;
                    airline?: string;
                    programCode?: string;
                    programName?: string;
                    providerName?: string;
                    signInID?: string;
                    tierCode?: string;
                    tierName?: string;
                    tierPriority?: string;
                }[];
                id: string;
                type?: string;
            }[];
            query: {
                formOfPayment: string;
                offerItemId: string[];
                passengerId?: string[];
            }[];
        };
        OfferPriceRS: {
            id?: string;
            messages?: {
                code: number;
                message: string;
                service: string;
                system?: string;
                type: string;
            }[];
            payloadAttributes?: { host?: string; timeStamp?: string; trxID?: string } & {
                [key: string]: string;
            };
            response?: {
                offers: {
                    commission?: { amount?: string; percentage?: string };
                    id: string;
                    offerExpirationDateTime: string;
                    offerItems: {
                        id: string;
                        mandatoryInd?: boolean;
                        passengers: {
                            baggage?: {
                                applicablePartyText?: ...;
                                details?: ...;
                                segments?: ...;
                                totalQty?: ...;
                                type?: ...;
                            }[];
                            fareComponents?: {
                                brand?: ...;
                                fareBasis: ...;
                                fareRules?: ...;
                                price: ...;
                                segments: ...;
                            }[];
                            fees?: {
                                airline?: ...;
                                arrivalCity?: ...;
                                boardCity?: ...;
                                cardInfo?: ...;
                                fareAmount: ...;
                                localAmount?: ...;
                                maxChargeAmount?: ...;
                                nature?: ...;
                                noChargeInd: ...;
                                percentageAmount?: ...;
                                surchargeType?: ...;
                            }[];
                            id: string;
                            price?: {
                                baseAmount?: { amount: ...; curCode: ...; taxable?: ... };
                                originalAmount?: { amount: ...; curCode: ...; taxable?: ... };
                                taxes?: { breakdown?: ...; total: ... };
                                totalAmount?: { amount: ...; curCode: ...; taxable?: ... };
                            };
                            ptc: string;
                            requestedPtc: string;
                            services?: {
                                name: ...;
                                reasonForIssuanceSubCode?: ...;
                                segments?: ...;
                                serviceCode?: ...;
                            }[];
                        }[];
                    }[];
                    paymentTimeLimitDateTime?: string;
                    price?: {
                        baseAmount?: { amount: string; curCode: string; taxable?: boolean };
                        originalAmount?: { amount: string; curCode: string; taxable?: boolean };
                        taxes?: {
                            breakdown?: {
                                amount: { amount: string; curCode: string; taxable?: boolean };
                                description: string;
                                nation?: string;
                                taxCode: string;
                            }[];
                            total: { amount: string; curCode: string; taxable?: boolean };
                        };
                        totalAmount?: { amount: string; curCode: string; taxable?: boolean };
                    };
                    purchaseTimeLimitDateTime?: string;
                    source: string;
                    totalPrice: {
                        baseAmount?: { amount: string; curCode: string; taxable?: boolean };
                        equivAmount?: { amount: string; curCode: string; taxable?: boolean };
                        totalAmount: { amount: string; curCode: string; taxable?: boolean };
                        totalTaxes?: { amount: string; curCode: string; taxable?: boolean };
                    };
                    ttl: number;
                }[];
                promotions?: {
                    remarks?: string[];
                    rules?: {
                        discount?: {
                            accountCodes?: string;
                            amount?: string;
                            curCode?: string;
                            percent?: string;
                        };
                        id?: string;
                        type?: string;
                    }[];
                    tag?: string;
                    tourCode?: string;
                }[];
            };
            version: string;
        };
        PayloadAttributes: { host?: string; timeStamp?: string; trxID?: string } & {
            [key: string]: string;
        };
        Penalty: {
            applicableFeeRemarks?: { displayInd?: boolean; value?: string }[];
            cancelFeeInd?: boolean;
            changeFeeInd?: boolean;
            details?: {
                amounts?: {
                    amountApplication?: string;
                    applicableFeeRemarks?: { displayInd?: boolean; value?: string }[];
                    currencyAmountValue?: {
                        amount: string;
                        curCode: string;
                        taxable?: boolean;
                    };
                    percentageAmount?: string;
                }[];
                application?: string;
                penaltyType?: string;
            }[];
            refundableInd?: boolean;
            reuseInd?: boolean;
            upgradeFeeInd?: boolean;
        };
        PenaltyDetail: {
            amounts?: {
                amountApplication?: string;
                applicableFeeRemarks?: { displayInd?: boolean; value?: string }[];
                currencyAmountValue?: {
                    amount: string;
                    curCode: string;
                    taxable?: boolean;
                };
                percentageAmount?: string;
            }[];
            application?: string;
            penaltyType?: string;
        };
        Price: {
            baseAmount?: { amount: string; curCode: string; taxable?: boolean };
            originalAmount?: { amount: string; curCode: string; taxable?: boolean };
            taxes?: {
                breakdown?: {
                    amount: { amount: string; curCode: string; taxable?: boolean };
                    description: string;
                    nation?: string;
                    taxCode: string;
                }[];
                total: { amount: string; curCode: string; taxable?: boolean };
            };
            totalAmount?: { amount: string; curCode: string; taxable?: boolean };
        };
        PromotionType: {
            remarks?: string[];
            rules?: {
                discount?: {
                    accountCodes?: string;
                    amount?: string;
                    curCode?: string;
                    percent?: string;
                };
                id?: string;
                type?: string;
            }[];
            tag?: string;
            tourCode?: string;
        };
        RBD: string;
        Remark: { displayInd?: boolean; value?: string };
        Services: {
            name: string;
            reasonForIssuanceSubCode?: string;
            segments?: string[];
            serviceCode?: string;
        }[];
        Source: string;
        Ticketing: {
            endorsements?: string[];
            instantPurchase?: string;
            remarks?: { displayInd?: boolean; value?: string }[];
            ticketlessInd?: boolean;
        };
        ValueWithContext: { context?: string; value?: string };
    }

    Type Declaration

    • AdvanceStay: {
          advancePurchase?: { context?: string; value?: string };
          maximumStay?: {
              dayOfWeek?: number;
              dayQuantity?: { context?: string; value?: string };
          };
          minimumStay?: {
              dayOfWeek?: number;
              dayQuantity?: { context?: string; value?: string };
          };
      }

      Contains advance ticketing, advance purchase, and minimum and maximum stay information.

      • OptionaladvancePurchase?: { context?: string; value?: string }
        • Optionalcontext?: string

          Context of the restriction, such as EARLIEST or LATEST.

          EARLIEST
          
        • Optionalvalue?: string

          Purchase restriction value in ISO 8601 format. For example, P3D would be a Period of 3 Days.

          P3D
          
      • OptionalmaximumStay?: { dayOfWeek?: number; dayQuantity?: { context?: string; value?: string } }
        • OptionaldayOfWeek?: number

          A number associated to the day of a week. Can be 1 for Monday, 2 for Tuesday, 3 for Wednesday, 4 for Thursday, 5 for Friday, 6 for Saturday, or 7 for Sunday.

          1
          
        • OptionaldayQuantity?: { context?: string; value?: string }
          • Optionalcontext?: string

            Context of the restriction, such as EARLIEST or LATEST.

            EARLIEST
            
          • Optionalvalue?: string

            Purchase restriction value in ISO 8601 format. For example, P3D would be a Period of 3 Days.

            P3D
            
      • OptionalminimumStay?: { dayOfWeek?: number; dayQuantity?: { context?: string; value?: string } }
        • OptionaldayOfWeek?: number

          A number associated to the day of a week. Can be 1 for Monday, 2 for Tuesday, 3 for Wednesday, 4 for Thursday, 5 for Friday, 6 for Saturday, or 7 for Sunday.

          1
          
        • OptionaldayQuantity?: { context?: string; value?: string }
          • Optionalcontext?: string

            Context of the restriction, such as EARLIEST or LATEST.

            EARLIEST
            
          • Optionalvalue?: string

            Purchase restriction value in ISO 8601 format. For example, P3D would be a Period of 3 Days.

            P3D
            
    • ArnkInd: boolean

      When true, indicates an ARNK (ARrival uNKown) condition, i.e. a gap between current segment departure and previous segment arrival location, implying an unknown passenger movement.

      false
      
    • Baggage: {
          applicablePartyText?: string;
          details?: {
              constrains?: { max?: number; min?: number; unit?: string }[];
              desc?: string[];
              quantity?: number;
          }[];
          segments?: string[];
          totalQty?: number;
          type?: string;
      }[]

      Contains a list of baggage details.

    • CabinType: { cabinTypeCode: string; cabinTypeName: string }

      Contains details of the cabin class.

      • cabinTypeCode: string

        The cabin code.

        Y
        
      • cabinTypeName: string

        The full cabin name.

        ECONOMY
        
    • CarrierCode: string

      The carrier designator code.

      LO
      
    • CorporateFare: { account: string }

      Contains the company profile index associated with the special fares.

      • account: string

        Corporate account name or ID used for pricing special fares.

        GRI90
        
    • CurrencyType: { amount: string; curCode: string; taxable?: boolean }

      Contains currency information.

      • amount: string

        The monetary amount.

        402.53
        
      • curCode: string

        The three-letter ISO 4217 currency code.

        USD
        
      • Optionaltaxable?: boolean

        If true, the given amount is subject to taxation.

        false
        
    • DateTimeType: string

      The date and time.

      2019-05-10T05:38:16Z
      
    • FareRules: {
          advanceStay?: {
              advancePurchase?: { context?: string; value?: string };
              maximumStay?: {
                  dayOfWeek?: number;
                  dayQuantity?: { context?: string; value?: string };
              };
              minimumStay?: {
                  dayOfWeek?: number;
                  dayQuantity?: { context?: string; value?: string };
              };
          };
          corporateFare?: { account: string };
          penalty?: {
              applicableFeeRemarks?: { displayInd?: boolean; value?: string }[];
              cancelFeeInd?: boolean;
              changeFeeInd?: boolean;
              details?: {
                  amounts?: {
                      amountApplication?: string;
                      applicableFeeRemarks?: { displayInd?: boolean; value?: string }[];
                      currencyAmountValue?: {
                          amount: string;
                          curCode: string;
                          taxable?: boolean;
                      };
                      percentageAmount?: string;
                  }[];
                  application?: string;
                  penaltyType?: string;
              }[];
              refundableInd?: boolean;
              reuseInd?: boolean;
              upgradeFeeInd?: boolean;
          };
          ticketing?: {
              endorsements?: string[];
              instantPurchase?: string;
              remarks?: { displayInd?: boolean; value?: string }[];
              ticketlessInd?: boolean;
          };
      }

      Contains information about rules that govern eligibility and refundability of fares.

      • OptionaladvanceStay?: {
            advancePurchase?: { context?: string; value?: string };
            maximumStay?: {
                dayOfWeek?: number;
                dayQuantity?: { context?: string; value?: string };
            };
            minimumStay?: {
                dayOfWeek?: number;
                dayQuantity?: { context?: string; value?: string };
            };
        }
        • OptionaladvancePurchase?: { context?: string; value?: string }
          • Optionalcontext?: string

            Context of the restriction, such as EARLIEST or LATEST.

            EARLIEST
            
          • Optionalvalue?: string

            Purchase restriction value in ISO 8601 format. For example, P3D would be a Period of 3 Days.

            P3D
            
        • OptionalmaximumStay?: { dayOfWeek?: number; dayQuantity?: { context?: string; value?: string } }
          • OptionaldayOfWeek?: number

            A number associated to the day of a week. Can be 1 for Monday, 2 for Tuesday, 3 for Wednesday, 4 for Thursday, 5 for Friday, 6 for Saturday, or 7 for Sunday.

            1
            
          • OptionaldayQuantity?: { context?: string; value?: string }
            • Optionalcontext?: string

              Context of the restriction, such as EARLIEST or LATEST.

              EARLIEST
              
            • Optionalvalue?: string

              Purchase restriction value in ISO 8601 format. For example, P3D would be a Period of 3 Days.

              P3D
              
        • OptionalminimumStay?: { dayOfWeek?: number; dayQuantity?: { context?: string; value?: string } }
          • OptionaldayOfWeek?: number

            A number associated to the day of a week. Can be 1 for Monday, 2 for Tuesday, 3 for Wednesday, 4 for Thursday, 5 for Friday, 6 for Saturday, or 7 for Sunday.

            1
            
          • OptionaldayQuantity?: { context?: string; value?: string }
            • Optionalcontext?: string

              Context of the restriction, such as EARLIEST or LATEST.

              EARLIEST
              
            • Optionalvalue?: string

              Purchase restriction value in ISO 8601 format. For example, P3D would be a Period of 3 Days.

              P3D
              
      • OptionalcorporateFare?: { account: string }
        • account: string

          Corporate account name or ID used for pricing special fares.

          GRI90
          
      • Optionalpenalty?: {
            applicableFeeRemarks?: { displayInd?: boolean; value?: string }[];
            cancelFeeInd?: boolean;
            changeFeeInd?: boolean;
            details?: {
                amounts?: {
                    amountApplication?: string;
                    applicableFeeRemarks?: { displayInd?: boolean; value?: string }[];
                    currencyAmountValue?: {
                        amount: string;
                        curCode: string;
                        taxable?: boolean;
                    };
                    percentageAmount?: string;
                }[];
                application?: string;
                penaltyType?: string;
            }[];
            refundableInd?: boolean;
            reuseInd?: boolean;
            upgradeFeeInd?: boolean;
        }
        • OptionalapplicableFeeRemarks?: { displayInd?: boolean; value?: string }[]

          Lists all applicable fee remarks.

        • OptionalcancelFeeInd?: boolean

          If true, cancellation fee(s) may apply.

          true
          
        • OptionalchangeFeeInd?: boolean

          If true, itinerary change fee(s) may apply.

          true
          
        • Optionaldetails?: {
              amounts?: {
                  amountApplication?: string;
                  applicableFeeRemarks?: { displayInd?: boolean; value?: string }[];
                  currencyAmountValue?: {
                      amount: string;
                      curCode: string;
                      taxable?: boolean;
                  };
                  percentageAmount?: string;
              }[];
              application?: string;
              penaltyType?: string;
          }[]

          Lists detailed information related to penalty conditions and the penalty amount.

        • OptionalrefundableInd?: boolean

          If true, this is a refundable ticket or fare.

          false
          
        • OptionalreuseInd?: boolean

          If true, this is a reusable ticket or fee.

          false
          
        • OptionalupgradeFeeInd?: boolean

          If true, upgrade fee(s) may apply.

          true
          
      • Optionalticketing?: {
            endorsements?: string[];
            instantPurchase?: string;
            remarks?: { displayInd?: boolean; value?: string }[];
            ticketlessInd?: boolean;
        }
        • Optionalendorsements?: string[]

          Lists all provided remarks to ensure common understanding between the passenger and an airline. Sometimes, fares are restricted to time of travel, period of validity, voluntary rerouting, or any other applicable restricting conditions that are not otherwise clearly evident from other entries.

        • OptionalinstantPurchase?: string

          Identifies an instant purchase, mapped to the IATA PADIS codeset IPT.

          CC
          
        • Optionalremarks?: { displayInd?: boolean; value?: string }[]

          Lists all fare remarks.

        • OptionalticketlessInd?: boolean

          If true, the fare can be purchased without issuing a ticket.

          false
          
    • MinMaxStay: { dayOfWeek?: number; dayQuantity?: { context?: string; value?: string } }

      Contains minimum or maximum stay requirements.

      • OptionaldayOfWeek?: number

        A number associated to the day of a week. Can be 1 for Monday, 2 for Tuesday, 3 for Wednesday, 4 for Thursday, 5 for Friday, 6 for Saturday, or 7 for Sunday.

        1
        
      • OptionaldayQuantity?: { context?: string; value?: string }
        • Optionalcontext?: string

          Context of the restriction, such as EARLIEST or LATEST.

          EARLIEST
          
        • Optionalvalue?: string

          Purchase restriction value in ISO 8601 format. For example, P3D would be a Period of 3 Days.

          P3D
          
    • OfferPriceRQ: {
          diags?: string[];
          params?: {
              formOfPayment?: {
                  binNumber?: string;
                  cardType?: string;
                  id: string;
                  subCode: string;
              }[];
          };
          passengers?: {
              frequentFlyer?: {
                  accountNumber?: string;
                  airline?: string;
                  programCode?: string;
                  programName?: string;
                  providerName?: string;
                  signInID?: string;
                  tierCode?: string;
                  tierName?: string;
                  tierPriority?: string;
              }[];
              id: string;
              type?: string;
          }[];
          query: {
              formOfPayment: string;
              offerItemId: string[];
              passengerId?: string[];
          }[];
      }

      The Offer Price request.

      • Optionaldiags?: string[]

        Contains a list of diagnostics.

      • Optionalparams?: {
            formOfPayment?: {
                binNumber?: string;
                cardType?: string;
                id: string;
                subCode: string;
            }[];
        }

        Contains the Params schema.

        • OptionalformOfPayment?: { binNumber?: string; cardType?: string; id: string; subCode: string }[]

          Contains form of payment information.

      • Optionalpassengers?: {
            frequentFlyer?: {
                accountNumber?: string;
                airline?: string;
                programCode?: string;
                programName?: string;
                providerName?: string;
                signInID?: string;
                tierCode?: string;
                tierName?: string;
                tierPriority?: string;
            }[];
            id: string;
            type?: string;
        }[]

        Contains passenger information.

      • query: { formOfPayment: string; offerItemId: string[]; passengerId?: string[] }[]

        Contains offer items and services to be repriced.

    • OfferPriceRS: {
          id?: string;
          messages?: {
              code: number;
              message: string;
              service: string;
              system?: string;
              type: string;
          }[];
          payloadAttributes?: { host?: string; timeStamp?: string; trxID?: string } & {
              [key: string]: string;
          };
          response?: {
              offers: {
                  commission?: { amount?: string; percentage?: string };
                  id: string;
                  offerExpirationDateTime: string;
                  offerItems: {
                      id: string;
                      mandatoryInd?: boolean;
                      passengers: {
                          baggage?: {
                              applicablePartyText?: ...;
                              details?: ...;
                              segments?: ...;
                              totalQty?: ...;
                              type?: ...;
                          }[];
                          fareComponents?: {
                              brand?: ...;
                              fareBasis: ...;
                              fareRules?: ...;
                              price: ...;
                              segments: ...;
                          }[];
                          fees?: {
                              airline?: ...;
                              arrivalCity?: ...;
                              boardCity?: ...;
                              cardInfo?: ...;
                              fareAmount: ...;
                              localAmount?: ...;
                              maxChargeAmount?: ...;
                              nature?: ...;
                              noChargeInd: ...;
                              percentageAmount?: ...;
                              surchargeType?: ...;
                          }[];
                          id: string;
                          price?: {
                              baseAmount?: { amount: ...; curCode: ...; taxable?: ... };
                              originalAmount?: { amount: ...; curCode: ...; taxable?: ... };
                              taxes?: { breakdown?: ...; total: ... };
                              totalAmount?: { amount: ...; curCode: ...; taxable?: ... };
                          };
                          ptc: string;
                          requestedPtc: string;
                          services?: {
                              name: ...;
                              reasonForIssuanceSubCode?: ...;
                              segments?: ...;
                              serviceCode?: ...;
                          }[];
                      }[];
                  }[];
                  paymentTimeLimitDateTime?: string;
                  price?: {
                      baseAmount?: { amount: string; curCode: string; taxable?: boolean };
                      originalAmount?: { amount: string; curCode: string; taxable?: boolean };
                      taxes?: {
                          breakdown?: {
                              amount: { amount: string; curCode: string; taxable?: boolean };
                              description: string;
                              nation?: string;
                              taxCode: string;
                          }[];
                          total: { amount: string; curCode: string; taxable?: boolean };
                      };
                      totalAmount?: { amount: string; curCode: string; taxable?: boolean };
                  };
                  purchaseTimeLimitDateTime?: string;
                  source: string;
                  totalPrice: {
                      baseAmount?: { amount: string; curCode: string; taxable?: boolean };
                      equivAmount?: { amount: string; curCode: string; taxable?: boolean };
                      totalAmount: { amount: string; curCode: string; taxable?: boolean };
                      totalTaxes?: { amount: string; curCode: string; taxable?: boolean };
                  };
                  ttl: number;
              }[];
              promotions?: {
                  remarks?: string[];
                  rules?: {
                      discount?: {
                          accountCodes?: string;
                          amount?: string;
                          curCode?: string;
                          percent?: string;
                      };
                      id?: string;
                      type?: string;
                  }[];
                  tag?: string;
                  tourCode?: string;
              }[];
          };
          version: string;
      }

      The Offer Price response.

      • Optionalid?: string

        The ID of the unique pricing response.

        bejq23zanr1
        
      • Optionalmessages?: {
            code: number;
            message: string;
            service: string;
            system?: string;
            type: string;
        }[]

        Contains warning, error, and other messages generated by the system.

      • OptionalpayloadAttributes?: { host?: string; timeStamp?: string; trxID?: string } & {
            [key: string]: string;
        }
      • Optionalresponse?: {
            offers: {
                commission?: { amount?: string; percentage?: string };
                id: string;
                offerExpirationDateTime: string;
                offerItems: {
                    id: string;
                    mandatoryInd?: boolean;
                    passengers: {
                        baggage?: {
                            applicablePartyText?: ...;
                            details?: ...;
                            segments?: ...;
                            totalQty?: ...;
                            type?: ...;
                        }[];
                        fareComponents?: {
                            brand?: ...;
                            fareBasis: ...;
                            fareRules?: ...;
                            price: ...;
                            segments: ...;
                        }[];
                        fees?: {
                            airline?: ...;
                            arrivalCity?: ...;
                            boardCity?: ...;
                            cardInfo?: ...;
                            fareAmount: ...;
                            localAmount?: ...;
                            maxChargeAmount?: ...;
                            nature?: ...;
                            noChargeInd: ...;
                            percentageAmount?: ...;
                            surchargeType?: ...;
                        }[];
                        id: string;
                        price?: {
                            baseAmount?: { amount: ...; curCode: ...; taxable?: ... };
                            originalAmount?: { amount: ...; curCode: ...; taxable?: ... };
                            taxes?: { breakdown?: ...; total: ... };
                            totalAmount?: { amount: ...; curCode: ...; taxable?: ... };
                        };
                        ptc: string;
                        requestedPtc: string;
                        services?: {
                            name: ...;
                            reasonForIssuanceSubCode?: ...;
                            segments?: ...;
                            serviceCode?: ...;
                        }[];
                    }[];
                }[];
                paymentTimeLimitDateTime?: string;
                price?: {
                    baseAmount?: { amount: string; curCode: string; taxable?: boolean };
                    originalAmount?: { amount: string; curCode: string; taxable?: boolean };
                    taxes?: {
                        breakdown?: {
                            amount: { amount: string; curCode: string; taxable?: boolean };
                            description: string;
                            nation?: string;
                            taxCode: string;
                        }[];
                        total: { amount: string; curCode: string; taxable?: boolean };
                    };
                    totalAmount?: { amount: string; curCode: string; taxable?: boolean };
                };
                purchaseTimeLimitDateTime?: string;
                source: string;
                totalPrice: {
                    baseAmount?: { amount: string; curCode: string; taxable?: boolean };
                    equivAmount?: { amount: string; curCode: string; taxable?: boolean };
                    totalAmount: { amount: string; curCode: string; taxable?: boolean };
                    totalTaxes?: { amount: string; curCode: string; taxable?: boolean };
                };
                ttl: number;
            }[];
            promotions?: {
                remarks?: string[];
                rules?: {
                    discount?: {
                        accountCodes?: string;
                        amount?: string;
                        curCode?: string;
                        percent?: string;
                    };
                    id?: string;
                    type?: string;
                }[];
                tag?: string;
                tourCode?: string;
            }[];
        }

        Contains priced offers.

        • offers: {
              commission?: { amount?: string; percentage?: string };
              id: string;
              offerExpirationDateTime: string;
              offerItems: {
                  id: string;
                  mandatoryInd?: boolean;
                  passengers: {
                      baggage?: {
                          applicablePartyText?: ...;
                          details?: ...;
                          segments?: ...;
                          totalQty?: ...;
                          type?: ...;
                      }[];
                      fareComponents?: {
                          brand?: ...;
                          fareBasis: ...;
                          fareRules?: ...;
                          price: ...;
                          segments: ...;
                      }[];
                      fees?: {
                          airline?: ...;
                          arrivalCity?: ...;
                          boardCity?: ...;
                          cardInfo?: ...;
                          fareAmount: ...;
                          localAmount?: ...;
                          maxChargeAmount?: ...;
                          nature?: ...;
                          noChargeInd: ...;
                          percentageAmount?: ...;
                          surchargeType?: ...;
                      }[];
                      id: string;
                      price?: {
                          baseAmount?: { amount: ...; curCode: ...; taxable?: ... };
                          originalAmount?: { amount: ...; curCode: ...; taxable?: ... };
                          taxes?: { breakdown?: ...; total: ... };
                          totalAmount?: { amount: ...; curCode: ...; taxable?: ... };
                      };
                      ptc: string;
                      requestedPtc: string;
                      services?: {
                          name: ...;
                          reasonForIssuanceSubCode?: ...;
                          segments?: ...;
                          serviceCode?: ...;
                      }[];
                  }[];
              }[];
              paymentTimeLimitDateTime?: string;
              price?: {
                  baseAmount?: { amount: string; curCode: string; taxable?: boolean };
                  originalAmount?: { amount: string; curCode: string; taxable?: boolean };
                  taxes?: {
                      breakdown?: {
                          amount: { amount: string; curCode: string; taxable?: boolean };
                          description: string;
                          nation?: string;
                          taxCode: string;
                      }[];
                      total: { amount: string; curCode: string; taxable?: boolean };
                  };
                  totalAmount?: { amount: string; curCode: string; taxable?: boolean };
              };
              purchaseTimeLimitDateTime?: string;
              source: string;
              totalPrice: {
                  baseAmount?: { amount: string; curCode: string; taxable?: boolean };
                  equivAmount?: { amount: string; curCode: string; taxable?: boolean };
                  totalAmount: { amount: string; curCode: string; taxable?: boolean };
                  totalTaxes?: { amount: string; curCode: string; taxable?: boolean };
              };
              ttl: number;
          }[]

          Contains a list of priced offers.

        • Optionalpromotions?: {
              remarks?: string[];
              rules?: {
                  discount?: {
                      accountCodes?: string;
                      amount?: string;
                      curCode?: string;
                      percent?: string;
                  };
                  id?: string;
                  type?: string;
              }[];
              tag?: string;
              tourCode?: string;
          }[]

          Contains information about promotions associated with the returned offer.

      • version: string

        The version schema.

        0.0.0
        
    • PayloadAttributes: { host?: string; timeStamp?: string; trxID?: string } & {
          [key: string]: string;
      }

      Contains standard properties related to the payload.

    • Penalty: {
          applicableFeeRemarks?: { displayInd?: boolean; value?: string }[];
          cancelFeeInd?: boolean;
          changeFeeInd?: boolean;
          details?: {
              amounts?: {
                  amountApplication?: string;
                  applicableFeeRemarks?: { displayInd?: boolean; value?: string }[];
                  currencyAmountValue?: {
                      amount: string;
                      curCode: string;
                      taxable?: boolean;
                  };
                  percentageAmount?: string;
              }[];
              application?: string;
              penaltyType?: string;
          }[];
          refundableInd?: boolean;
          reuseInd?: boolean;
          upgradeFeeInd?: boolean;
      }

      Contains penalty information.

      • OptionalapplicableFeeRemarks?: { displayInd?: boolean; value?: string }[]

        Lists all applicable fee remarks.

      • OptionalcancelFeeInd?: boolean

        If true, cancellation fee(s) may apply.

        true
        
      • OptionalchangeFeeInd?: boolean

        If true, itinerary change fee(s) may apply.

        true
        
      • Optionaldetails?: {
            amounts?: {
                amountApplication?: string;
                applicableFeeRemarks?: { displayInd?: boolean; value?: string }[];
                currencyAmountValue?: {
                    amount: string;
                    curCode: string;
                    taxable?: boolean;
                };
                percentageAmount?: string;
            }[];
            application?: string;
            penaltyType?: string;
        }[]

        Lists detailed information related to penalty conditions and the penalty amount.

      • OptionalrefundableInd?: boolean

        If true, this is a refundable ticket or fare.

        false
        
      • OptionalreuseInd?: boolean

        If true, this is a reusable ticket or fee.

        false
        
      • OptionalupgradeFeeInd?: boolean

        If true, upgrade fee(s) may apply.

        true
        
    • PenaltyDetail: {
          amounts?: {
              amountApplication?: string;
              applicableFeeRemarks?: { displayInd?: boolean; value?: string }[];
              currencyAmountValue?: {
                  amount: string;
                  curCode: string;
                  taxable?: boolean;
              };
              percentageAmount?: string;
          }[];
          application?: string;
          penaltyType?: string;
      }

      Contains detailed penalty information.

      • Optionalamounts?: {
            amountApplication?: string;
            applicableFeeRemarks?: { displayInd?: boolean; value?: string }[];
            currencyAmountValue?: {
                amount: string;
                curCode: string;
                taxable?: boolean;
            };
            percentageAmount?: string;
        }[]

        Lists penalty amounts, with penalty applications and remarks.

      • Optionalapplication?: string

        Identifies a penalty application, mapped to the IATA PADIS codeset FAT.

        2
        
      • OptionalpenaltyType?: string

        A text-based description of the penalty type.

        Cancellation
        
    • Price: {
          baseAmount?: { amount: string; curCode: string; taxable?: boolean };
          originalAmount?: { amount: string; curCode: string; taxable?: boolean };
          taxes?: {
              breakdown?: {
                  amount: { amount: string; curCode: string; taxable?: boolean };
                  description: string;
                  nation?: string;
                  taxCode: string;
              }[];
              total: { amount: string; curCode: string; taxable?: boolean };
          };
          totalAmount?: { amount: string; curCode: string; taxable?: boolean };
      }

      Contains price information.

      • OptionalbaseAmount?: { amount: string; curCode: string; taxable?: boolean }
        • amount: string

          The monetary amount.

          402.53
          
        • curCode: string

          The three-letter ISO 4217 currency code.

          USD
          
        • Optionaltaxable?: boolean

          If true, the given amount is subject to taxation.

          false
          
      • OptionaloriginalAmount?: { amount: string; curCode: string; taxable?: boolean }
        • amount: string

          The monetary amount.

          402.53
          
        • curCode: string

          The three-letter ISO 4217 currency code.

          USD
          
        • Optionaltaxable?: boolean

          If true, the given amount is subject to taxation.

          false
          
      • Optionaltaxes?: {
            breakdown?: {
                amount: { amount: string; curCode: string; taxable?: boolean };
                description: string;
                nation?: string;
                taxCode: string;
            }[];
            total: { amount: string; curCode: string; taxable?: boolean };
        }

        Contains tax summary information, including the total tax amount.

        • Optionalbreakdown?: {
              amount: { amount: string; curCode: string; taxable?: boolean };
              description: string;
              nation?: string;
              taxCode: string;
          }[]

          Contains detailed information about the taxes applied.

        • total: { amount: string; curCode: string; taxable?: boolean }
          • amount: string

            The monetary amount.

            402.53
            
          • curCode: string

            The three-letter ISO 4217 currency code.

            USD
            
          • Optionaltaxable?: boolean

            If true, the given amount is subject to taxation.

            false
            
      • OptionaltotalAmount?: { amount: string; curCode: string; taxable?: boolean }
        • amount: string

          The monetary amount.

          402.53
          
        • curCode: string

          The three-letter ISO 4217 currency code.

          USD
          
        • Optionaltaxable?: boolean

          If true, the given amount is subject to taxation.

          false
          
    • PromotionType: {
          remarks?: string[];
          rules?: {
              discount?: {
                  accountCodes?: string;
                  amount?: string;
                  curCode?: string;
                  percent?: string;
              };
              id?: string;
              type?: string;
          }[];
          tag?: string;
          tourCode?: string;
      }

      Contains details of an applied promotional discount.

      • Optionalremarks?: string[]

        Lists all remarks associated with the promotion.

      • Optionalrules?: {
            discount?: {
                accountCodes?: string;
                amount?: string;
                curCode?: string;
                percent?: string;
            };
            id?: string;
            type?: string;
        }[]

        Lists all rules information associated with the promotion.

      • Optionaltag?: string

        Unique identifier of the promotion tag.

        MCTESTVALIPT2
        
      • OptionaltourCode?: string

        Unique identifier of the promotion tour code.

        MCTESTVALITC2
        
    • RBD: string

      The Reservation Booking Designator (RBD) code is used in reservation transactions to identify the booking class.

      B
      
    • Remark: { displayInd?: boolean; value?: string }

      Contains remarks associated with the fare.

      • OptionaldisplayInd?: boolean

        If true, the remark should be displayed.

        false
        
      • Optionalvalue?: string

        A text-based descriptor of the remark.

        SAMPLE REMARK TEXT
        
    • Services: {
          name: string;
          reasonForIssuanceSubCode?: string;
          segments?: string[];
          serviceCode?: string;
      }[]

      Contains a list of services, or ancillaries, included in an offer, pertaining to a given flight.

    • Source: string

      Source of the offer.

      NDC
      
    • Ticketing: {
          endorsements?: string[];
          instantPurchase?: string;
          remarks?: { displayInd?: boolean; value?: string }[];
          ticketlessInd?: boolean;
      }

      Contains ticketing information.

      • Optionalendorsements?: string[]

        Lists all provided remarks to ensure common understanding between the passenger and an airline. Sometimes, fares are restricted to time of travel, period of validity, voluntary rerouting, or any other applicable restricting conditions that are not otherwise clearly evident from other entries.

      • OptionalinstantPurchase?: string

        Identifies an instant purchase, mapped to the IATA PADIS codeset IPT.

        CC
        
      • Optionalremarks?: { displayInd?: boolean; value?: string }[]

        Lists all fare remarks.

      • OptionalticketlessInd?: boolean

        If true, the fare can be purchased without issuing a ticket.

        false
        
    • ValueWithContext: { context?: string; value?: string }

      Contains min/max stay restriction information, with EARLIEST/LATEST contexts.

      • Optionalcontext?: string

        Context of the restriction, such as EARLIEST or LATEST.

        EARLIEST
        
      • Optionalvalue?: string

        Purchase restriction value in ISO 8601 format. For example, P3D would be a Period of 3 Days.

        P3D