Documentation
    Preparing search index...
    • Parameters

      • orderData: {
            diagnostics?: {
                body?: string;
                customId?: string;
                headers?: { [key: string]: string };
                name?:
                    | "ORDER_VIEW_REQUEST"
                    | "ORDER_VIEW_RESPONSE"
                    | "OFFER_STORE_ID_REQUEST"
                    | "OFFER_STORE_ID_RESPONSE"
                    | "OFFER_STORE_PUT_REQUEST"
                    | "OFFER_STORE_PUT_RESPONSE"
                    | "NDCC_ORDER_RESHOP_REQUEST"
                    | "NDCC_ORDER_RESHOP_RESPONSE"
                    | "ESSM_RESPONSE"
                    | "ESSM_TJR_REQUEST"
                    | "ESSM_TJR_RESPONSE"
                    | "ESSM_JWT_REQUEST"
                    | "ESSM_JWT_RESPONSE"
                    | "SPR_REQUEST"
                    | "SPR_RESPONSE";
            }[];
            errors?: { code?: string; message?: string; service?: string }[];
            payloadAttributes?: {
                baseline?: string;
                echoToken?: string;
                host?: string;
                timeStamp?: string;
                trxId?: string;
                version?: string;
            };
            response: {
                reshopOffers?: {
                    offerExpirationDateTime?: string;
                    offerId: string;
                    offerItems?: {
                        differentialAmountDue?: {
                            amount: { amount: string; curCode?: string };
                            taxSummary?: { totalTaxAmount?: { amount: string; curCode?: string } };
                        };
                        mandatoryInd?: boolean;
                        newOfferItemDifferential?: {
                            amount: { amount: string; curCode?: string };
                            taxSummary?: { totalTaxAmount?: { amount: string; curCode?: string } };
                        };
                        offerItemId?: string;
                        originalOrderItemDifferential?: {
                            amount: { amount: string; curCode?: string };
                            taxSummary?: { totalTaxAmount?: { amount: string; curCode?: string } };
                        };
                        penaltyDifferential?: {
                            amount: { amount: string; curCode?: string };
                            taxSummary?: { totalTaxAmount?: { amount: string; curCode?: string } };
                        };
                    }[];
                    offerType?: "VOID"
                    | "REFUND";
                    ownerCode: string;
                }[];
                warnings?: { code?: string; message?: string; service?: string }[];
            };
        }
        • Optionaldiagnostics?: {
              body?: string;
              customId?: string;
              headers?: { [key: string]: string };
              name?:
                  | "ORDER_VIEW_REQUEST"
                  | "ORDER_VIEW_RESPONSE"
                  | "OFFER_STORE_ID_REQUEST"
                  | "OFFER_STORE_ID_RESPONSE"
                  | "OFFER_STORE_PUT_REQUEST"
                  | "OFFER_STORE_PUT_RESPONSE"
                  | "NDCC_ORDER_RESHOP_REQUEST"
                  | "NDCC_ORDER_RESHOP_RESPONSE"
                  | "ESSM_RESPONSE"
                  | "ESSM_TJR_REQUEST"
                  | "ESSM_TJR_RESPONSE"
                  | "ESSM_JWT_REQUEST"
                  | "ESSM_JWT_RESPONSE"
                  | "SPR_REQUEST"
                  | "SPR_RESPONSE";
          }[]

          Lists any applicable diagnostic information to help debug and troubleshoot possible processing errors.

        • Optionalerrors?: { code?: string; message?: string; service?: string }[]

          Errors returned during request processing.

        • OptionalpayloadAttributes?: {
              baseline?: string;
              echoToken?: string;
              host?: string;
              timeStamp?: string;
              trxId?: string;
              version?: string;
          }

          Standard payload parameters.

          • Optional Readonlybaseline?: string

            Application baseline.

            PRICINGORCHESTRATOR.2019.12.AE
            
          • OptionalechoToken?: string

            A reference for additional message identification, assigned by the requesting host system. When a request message includes an echo token the corresponding response message MUST include an echo token with an identical value.

            7c6d6c52-a277-4539-a7f1-da225470d053
            
          • Optional Readonlyhost?: string

            The hostname and port of the machine.

            LTXL0651:2470
            
          • OptionaltimeStamp?: string

            Format: date-time

            The date and time the request was processed.

            2024-10-03T12:48:52.968Z
            
          • OptionaltrxId?: string

            A unique ID assigned to the transaction.

            b213e940-c89c-4dbb-96b1-d16a6c0249fb
            
          • Optional Readonlyversion?: string

            The version of the API.

            1.0.0
            
        • response: {
              reshopOffers?: {
                  offerExpirationDateTime?: string;
                  offerId: string;
                  offerItems?: {
                      differentialAmountDue?: {
                          amount: { amount: string; curCode?: string };
                          taxSummary?: { totalTaxAmount?: { amount: string; curCode?: string } };
                      };
                      mandatoryInd?: boolean;
                      newOfferItemDifferential?: {
                          amount: { amount: string; curCode?: string };
                          taxSummary?: { totalTaxAmount?: { amount: string; curCode?: string } };
                      };
                      offerItemId?: string;
                      originalOrderItemDifferential?: {
                          amount: { amount: string; curCode?: string };
                          taxSummary?: { totalTaxAmount?: { amount: string; curCode?: string } };
                      };
                      penaltyDifferential?: {
                          amount: { amount: string; curCode?: string };
                          taxSummary?: { totalTaxAmount?: { amount: string; curCode?: string } };
                      };
                  }[];
                  offerType?: "VOID"
                  | "REFUND";
                  ownerCode: string;
              }[];
              warnings?: { code?: string; message?: string; service?: string }[];
          }

          Main response body.

          • OptionalreshopOffers?: {
                offerExpirationDateTime?: string;
                offerId: string;
                offerItems?: {
                    differentialAmountDue?: {
                        amount: { amount: string; curCode?: string };
                        taxSummary?: { totalTaxAmount?: { amount: string; curCode?: string } };
                    };
                    mandatoryInd?: boolean;
                    newOfferItemDifferential?: {
                        amount: { amount: string; curCode?: string };
                        taxSummary?: { totalTaxAmount?: { amount: string; curCode?: string } };
                    };
                    offerItemId?: string;
                    originalOrderItemDifferential?: {
                        amount: { amount: string; curCode?: string };
                        taxSummary?: { totalTaxAmount?: { amount: string; curCode?: string } };
                    };
                    penaltyDifferential?: {
                        amount: { amount: string; curCode?: string };
                        taxSummary?: { totalTaxAmount?: { amount: string; curCode?: string } };
                    };
                }[];
                offerType?: "VOID"
                | "REFUND";
                ownerCode: string;
            }[]

            Lists carrier offers based on the order to be canceled.

          • Optionalwarnings?: { code?: string; message?: string; service?: string }[]

            Lists any warnings returned during request processing.

      Returns any

      // The response to be sent back to the client

      This function formats the response from the Sabre API for order cancellation, to a Metis Format (That follow an AirFrance format)