Documentation
    Preparing search index...
    • Create Response from OfferPriceRS for Metis Reservation Front-End

      Parameters

      • offer: {
            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?: string;
                                details?: (...)[];
                                segments?: (...)[];
                                totalQty?: number;
                                type?: string;
                            }[];
                            fareComponents?: {
                                brand?: {
                                    brandName: ...;
                                    code: ...;
                                    programCode?: ...;
                                    programID?: ...;
                                    programName?: ...;
                                };
                                fareBasis: {
                                    cabinType?: ...;
                                    fareBasisCityPair?: ...;
                                    fareBasisCode: ...;
                                    rbd: ...;
                                };
                                fareRules?: {
                                    advanceStay?: ...;
                                    corporateFare?: ...;
                                    penalty?: ...;
                                    ticketing?: ...;
                                };
                                price: {
                                    baseAmount?: ...;
                                    originalAmount?: ...;
                                    taxes?: ...;
                                    totalAmount?: ...;
                                };
                                segments: (...)[];
                            }[];
                            fees?: {
                                airline?: string;
                                arrivalCity?: string;
                                boardCity?: string;
                                cardInfo?: { binNumber?: ...; chargeAmount?: ... };
                                fareAmount: { amount: ...; curCode: ...; taxable?: ... };
                                localAmount?: { amount: ...; curCode: ...; taxable?: ... };
                                maxChargeAmount?: { amount: ...; curCode: ...; taxable?: ... };
                                nature?: string;
                                noChargeInd: string;
                                percentageAmount?: { amount: ...; curCode: ...; taxable?: ... };
                                surchargeType?: string;
                            }[];
                            id: string;
                            price?: {
                                baseAmount?: { amount: string; curCode: string; taxable?: boolean };
                                originalAmount?: {
                                    amount: string;
                                    curCode: string;
                                    taxable?: boolean;
                                };
                                taxes?: {
                                    breakdown?: (...)[];
                                    total: { amount: ...; curCode: ...; taxable?: ... };
                                };
                                totalAmount?: { amount: string; curCode: string; taxable?: boolean };
                            };
                            ptc: string;
                            requestedPtc: string;
                            services?: {
                                name: string;
                                reasonForIssuanceSubCode?: string;
                                segments?: (...)[];
                                serviceCode?: string;
                            }[];
                        }[];
                    }[];
                    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;
        }
        • 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?: string;
                              details?: (...)[];
                              segments?: (...)[];
                              totalQty?: number;
                              type?: string;
                          }[];
                          fareComponents?: {
                              brand?: {
                                  brandName: ...;
                                  code: ...;
                                  programCode?: ...;
                                  programID?: ...;
                                  programName?: ...;
                              };
                              fareBasis: {
                                  cabinType?: ...;
                                  fareBasisCityPair?: ...;
                                  fareBasisCode: ...;
                                  rbd: ...;
                              };
                              fareRules?: {
                                  advanceStay?: ...;
                                  corporateFare?: ...;
                                  penalty?: ...;
                                  ticketing?: ...;
                              };
                              price: {
                                  baseAmount?: ...;
                                  originalAmount?: ...;
                                  taxes?: ...;
                                  totalAmount?: ...;
                              };
                              segments: (...)[];
                          }[];
                          fees?: {
                              airline?: string;
                              arrivalCity?: string;
                              boardCity?: string;
                              cardInfo?: { binNumber?: ...; chargeAmount?: ... };
                              fareAmount: { amount: ...; curCode: ...; taxable?: ... };
                              localAmount?: { amount: ...; curCode: ...; taxable?: ... };
                              maxChargeAmount?: { amount: ...; curCode: ...; taxable?: ... };
                              nature?: string;
                              noChargeInd: string;
                              percentageAmount?: { amount: ...; curCode: ...; taxable?: ... };
                              surchargeType?: string;
                          }[];
                          id: string;
                          price?: {
                              baseAmount?: { amount: string; curCode: string; taxable?: boolean };
                              originalAmount?: { amount: string; curCode: string; taxable?: boolean };
                              taxes?: {
                                  breakdown?: (...)[];
                                  total: { amount: ...; curCode: ...; taxable?: ... };
                              };
                              totalAmount?: { amount: string; curCode: string; taxable?: boolean };
                          };
                          ptc: string;
                          requestedPtc: string;
                          services?: {
                              name: string;
                              reasonForIssuanceSubCode?: string;
                              segments?: (...)[];
                              serviceCode?: string;
                          }[];
                      }[];
                  }[];
                  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?: string;
                            details?: (...)[];
                            segments?: (...)[];
                            totalQty?: number;
                            type?: string;
                        }[];
                        fareComponents?: {
                            brand?: {
                                brandName: ...;
                                code: ...;
                                programCode?: ...;
                                programID?: ...;
                                programName?: ...;
                            };
                            fareBasis: {
                                cabinType?: ...;
                                fareBasisCityPair?: ...;
                                fareBasisCode: ...;
                                rbd: ...;
                            };
                            fareRules?: {
                                advanceStay?: ...;
                                corporateFare?: ...;
                                penalty?: ...;
                                ticketing?: ...;
                            };
                            price: {
                                baseAmount?: ...;
                                originalAmount?: ...;
                                taxes?: ...;
                                totalAmount?: ...;
                            };
                            segments: (...)[];
                        }[];
                        fees?: {
                            airline?: string;
                            arrivalCity?: string;
                            boardCity?: string;
                            cardInfo?: { binNumber?: ...; chargeAmount?: ... };
                            fareAmount: { amount: ...; curCode: ...; taxable?: ... };
                            localAmount?: { amount: ...; curCode: ...; taxable?: ... };
                            maxChargeAmount?: { amount: ...; curCode: ...; taxable?: ... };
                            nature?: string;
                            noChargeInd: string;
                            percentageAmount?: { amount: ...; curCode: ...; taxable?: ... };
                            surchargeType?: string;
                        }[];
                        id: string;
                        price?: {
                            baseAmount?: { amount: string; curCode: string; taxable?: boolean };
                            originalAmount?: { amount: string; curCode: string; taxable?: boolean };
                            taxes?: {
                                breakdown?: (...)[];
                                total: { amount: ...; curCode: ...; taxable?: ... };
                            };
                            totalAmount?: { amount: string; curCode: string; taxable?: boolean };
                        };
                        ptc: string;
                        requestedPtc: string;
                        services?: {
                            name: string;
                            reasonForIssuanceSubCode?: string;
                            segments?: (...)[];
                            serviceCode?: string;
                        }[];
                    }[];
                }[];
                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
          
      • dataID: string

      Returns OfferPriceRS