Interface components

interface components {
    headers: never;
    parameters: never;
    pathItems: never;
    requestBodies: never;
    responses: never;
    schemas: {
        Amount: { amount: string; curCode?: string };
        AvailableDiagnosticsEnum:
            | "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";
        Decimal: string;
        Diagnostic: {
            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";
        };
        Error: { code?: string; message?: string; service?: string };
        OfferCancelItem: {
            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 } };
            };
        };
        OfferCancelRequest: {
            diagnostics?: (
                | "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"
            )[];
            payloadAttributes?: {
                baseline?: string;
                echoToken?: string;
                host?: string;
                timeStamp?: string;
                trxId?: string;
                version?: string;
            };
            request: { orderId: string };
        };
        OfferCancelRequestBody: { orderId: string };
        OfferCancelResponse: {
            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 }[];
            };
        };
        OfferCancelResponseBody: {
            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 }[];
        };
        OfferTypeEnum: "VOID"
        | "REFUND";
        PayloadAttributes: {
            baseline?: string;
            echoToken?: string;
            host?: string;
            timeStamp?: string;
            trxId?: string;
            version?: string;
        };
        ReshopDifferentialType: {
            amount: { amount: string; curCode?: string };
            taxSummary?: { totalTaxAmount?: { amount: string; curCode?: string } };
        };
        ReshopOffer: {
            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;
        };
        TaxSummary: { totalTaxAmount?: { amount: string; curCode?: string } };
        Warning: { code?: string; message?: string; service?: string };
    };
}

Index

Properties

headers parameters pathItems requestBodies responses schemas

Properties

headers

headers: never

parameters

parameters: never

pathItems

pathItems: never

requestBodies

requestBodies: never

responses

responses: never

schemas

schemas: {
    Amount: { amount: string; curCode?: string };
    AvailableDiagnosticsEnum:
        | "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";
    Decimal: string;
    Diagnostic: {
        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";
    };
    Error: { code?: string; message?: string; service?: string };
    OfferCancelItem: {
        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 } };
        };
    };
    OfferCancelRequest: {
        diagnostics?: (
            | "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"
        )[];
        payloadAttributes?: {
            baseline?: string;
            echoToken?: string;
            host?: string;
            timeStamp?: string;
            trxId?: string;
            version?: string;
        };
        request: { orderId: string };
    };
    OfferCancelRequestBody: { orderId: string };
    OfferCancelResponse: {
        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 }[];
        };
    };
    OfferCancelResponseBody: {
        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 }[];
    };
    OfferTypeEnum: "VOID"
    | "REFUND";
    PayloadAttributes: {
        baseline?: string;
        echoToken?: string;
        host?: string;
        timeStamp?: string;
        trxId?: string;
        version?: string;
    };
    ReshopDifferentialType: {
        amount: { amount: string; curCode?: string };
        taxSummary?: { totalTaxAmount?: { amount: string; curCode?: string } };
    };
    ReshopOffer: {
        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;
    };
    TaxSummary: { totalTaxAmount?: { amount: string; curCode?: string } };
    Warning: { code?: string; message?: string; service?: string };
}

Type Declaration

Amount: { amount: string; curCode?: string }
Description
Contains monetary amount information.
- amount: string
  Description
  Amount value.
- OptionalcurCode?: string
  Description
  The ISO 4217 three-letter currency code.
  Example
```
USD
```
AvailableDiagnosticsEnum:
    | "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"
Description
Lists diagnostic information names that assist in debugging and troubleshooting possible processing errors. Each diagnostic provides information about processing in systems that this API communicates with.
Example
```
ORDER_VIEW_REQUEST
@enum {string}
```
Decimal: string
Description
Amount represented with a decimal, may be negative in some cases.
Example
```
10.99
```
Diagnostic: {
    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";
}
Description
Contains internal-use-only diagnostics to help debug and troubleshoot possible processing errors.
- Optionalbody?: string
  Description
  The part of the request/response body the diagnostic applies to.
  Example
```
ORDER_VIEW_REQUEST
```
- OptionalcustomId?: string
  Description
  Used to differentiate between multiple responses/requests to/from one service.
  Example
```
a0baa3a8-818f-4f1d-9afa-97a06b8e5fb2
```
- Optionalheaders?: { [key: string]: string }
  Description
  Contains technical details about the HTTP header used as part of service processing.
  Example
```
{
             *       "Content-Type": "application/json"
             *     }
```
- Optionalname?:
      | "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"
  Description
  Diagnostic name.
Error: { code?: string; message?: string; service?: string }
Description
Contains information related to errors detected during processing of the request.
- Optionalcode?: string
  Description
  Numbered or alphanumeric code that is used to determine the nature of an error, and why it occurred.
  Example
```
404
```
- Optionalmessage?: string
  Description
  Free text description of the provided error.
  Example
```
Invalid json request
```
- Optionalservice?: string
  Description
  Service or module in which the given error originated from.
  Example
```
NDC_CONNECTOR
```
OfferCancelItem: {
    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 } };
    };
}
Description
Contains the offer items returned by the airline. Includes information about the refunded amount, penalties, and any additional details needed to present the offer.
- OptionaldifferentialAmountDue?: {
  amount: { amount: string; curCode?: string };
  taxSummary?: { totalTaxAmount?: { amount: string; curCode?: string } };
  }
  Description
  The total differential amount due by the traveler or airline carrier. If the amount is positive, this is an indication that the amount is due from the traveler.
  - amount: { amount: string; curCode?: string }
    Description
    Monetary amount and currency code.
    - amount: string
      Description
      Amount value.
    - OptionalcurCode?: string
      Description
      The ISO 4217 three-letter currency code.
      
      Example
      USD
  - OptionaltaxSummary?: { totalTaxAmount?: { amount: string; curCode?: string } }
    Description
    Tax summary information, including total tax amount.
    - OptionaltotalTaxAmount?: { amount: string; curCode?: string }
      Description
      Total of all applicable tax amounts included in the price. If tax breakdowns are provided, this amount should match the sum of the tax breakdown amounts.
      - amount: string
        Description
        Amount value.
      - OptionalcurCode?: string
        Description
        The ISO 4217 three-letter currency code.
        
        Example
        USD
- OptionalmandatoryInd?: boolean
  Description
  If true, the offer item is mandatory and cannot be removed from the order. If not present, or false, the offer item is optional.
  Example
```
true
```
- OptionalnewOfferItemDifferential?: {
  amount: { amount: string; curCode?: string };
  taxSummary?: { totalTaxAmount?: { amount: string; curCode?: string } };
  }
  Description
  The monetary amount of the new offer item and tax information.
  - amount: { amount: string; curCode?: string }
    Description
    Monetary amount and currency code.
    - amount: string
      Description
      Amount value.
    - OptionalcurCode?: string
      Description
      The ISO 4217 three-letter currency code.
      
      Example
      USD
  - OptionaltaxSummary?: { totalTaxAmount?: { amount: string; curCode?: string } }
    Description
    Tax summary information, including total tax amount.
    - OptionaltotalTaxAmount?: { amount: string; curCode?: string }
      Description
      Total of all applicable tax amounts included in the price. If tax breakdowns are provided, this amount should match the sum of the tax breakdown amounts.
      - amount: string
        Description
        Amount value.
      - OptionalcurCode?: string
        Description
        The ISO 4217 three-letter currency code.
        
        Example
        USD
- OptionalofferItemId?: string
  Description
  The unique ID of the offer item.
  Example
```
db054547769dwhkdskemtiq340-1-1
```
- OptionaloriginalOrderItemDifferential?: {
  amount: { amount: string; curCode?: string };
  taxSummary?: { totalTaxAmount?: { amount: string; curCode?: string } };
  }
  Description
  The monetary amount of the original order item and tax information.
  - amount: { amount: string; curCode?: string }
    Description
    Monetary amount and currency code.
    - amount: string
      Description
      Amount value.
    - OptionalcurCode?: string
      Description
      The ISO 4217 three-letter currency code.
      
      Example
      USD
  - OptionaltaxSummary?: { totalTaxAmount?: { amount: string; curCode?: string } }
    Description
    Tax summary information, including total tax amount.
    - OptionaltotalTaxAmount?: { amount: string; curCode?: string }
      Description
      Total of all applicable tax amounts included in the price. If tax breakdowns are provided, this amount should match the sum of the tax breakdown amounts.
      - amount: string
        Description
        Amount value.
      - OptionalcurCode?: string
        Description
        The ISO 4217 three-letter currency code.
        
        Example
        USD
- OptionalpenaltyDifferential?: {
  amount: { amount: string; curCode?: string };
  taxSummary?: { totalTaxAmount?: { amount: string; curCode?: string } };
  }
  Description
  Penalty amount and tax information.
  - amount: { amount: string; curCode?: string }
    Description
    Monetary amount and currency code.
    - amount: string
      Description
      Amount value.
    - OptionalcurCode?: string
      Description
      The ISO 4217 three-letter currency code.
      
      Example
      USD
  - OptionaltaxSummary?: { totalTaxAmount?: { amount: string; curCode?: string } }
    Description
    Tax summary information, including total tax amount.
    - OptionaltotalTaxAmount?: { amount: string; curCode?: string }
      Description
      Total of all applicable tax amounts included in the price. If tax breakdowns are provided, this amount should match the sum of the tax breakdown amounts.
      - amount: string
        Description
        Amount value.
      - OptionalcurCode?: string
        Description
        The ISO 4217 three-letter currency code.
        
        Example
        USD
OfferCancelRequest: {
    diagnostics?: (
        | "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"
    )[];
    payloadAttributes?: {
        baseline?: string;
        echoToken?: string;
        host?: string;
        timeStamp?: string;
        trxId?: string;
        version?: string;
    };
    request: { orderId: string };
}
Description
Contains the necessary parameters to send a request for void/refund information.
- Optionaldiagnostics?: (
      | "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"
  )[]
  Description
  Lists diagnostic information that assists in debugging and troubleshooting possible processing errors.
- OptionalpayloadAttributes?: {
      baseline?: string;
      echoToken?: string;
      host?: string;
      timeStamp?: string;
      trxId?: string;
      version?: string;
  }
  Description
  Standard payload parameters.
  - Optional Readonlybaseline?: string
    Description
    Application baseline.
    Example
    PRICINGORCHESTRATOR.2019.12.AE
  - OptionalechoToken?: string
    Description
    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.
    Example
    7c6d6c52-a277-4539-a7f1-da225470d053
  - Optional Readonlyhost?: string
    Description
    The hostname and port of the machine.
    Example
    LTXL0651:2470
  - OptionaltimeStamp?: string
    Format: date-time
    Description
    The date and time the request was processed.
    Example
    2024-10-03T12:48:52.968Z
  - OptionaltrxId?: string
    Description
    A unique ID assigned to the transaction.
    Example
    b213e940-c89c-4dbb-96b1-d16a6c0249fb
  - Optional Readonlyversion?: string
    Description
    The version of the API.
    Example
    1.0.0
- request: { orderId: string }
  Description
  Main request body.
  - orderId: string
    Description
    The unique ID of an existing order that the seller wants to cancel.
    Example
    1SXXXC0ZS1YSD
OfferCancelRequestBody: { orderId: string }
Description
Contains the required parameters to request void/refund information for an order.
- orderId: string
  Description
  The unique ID of an existing order that the seller wants to cancel.
  Example
```
1SXXXC0ZS1YSD
```
OfferCancelResponse: {
    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 }[];
    };
}
Description
Contains information regarding the void/refund eligibility for order. This object also includes technical information.
- 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";
  }[]
  Description
  Lists any applicable diagnostic information to help debug and troubleshoot possible processing errors.
- Optionalerrors?: { code?: string; message?: string; service?: string }[]
  Description
  Errors returned during request processing.
- OptionalpayloadAttributes?: {
      baseline?: string;
      echoToken?: string;
      host?: string;
      timeStamp?: string;
      trxId?: string;
      version?: string;
  }
  Description
  Standard payload parameters.
  - Optional Readonlybaseline?: string
    Description
    Application baseline.
    Example
    PRICINGORCHESTRATOR.2019.12.AE
  - OptionalechoToken?: string
    Description
    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.
    Example
    7c6d6c52-a277-4539-a7f1-da225470d053
  - Optional Readonlyhost?: string
    Description
    The hostname and port of the machine.
    Example
    LTXL0651:2470
  - OptionaltimeStamp?: string
    Format: date-time
    Description
    The date and time the request was processed.
    Example
    2024-10-03T12:48:52.968Z
  - OptionaltrxId?: string
    Description
    A unique ID assigned to the transaction.
    Example
    b213e940-c89c-4dbb-96b1-d16a6c0249fb
  - Optional Readonlyversion?: string
    Description
    The version of the API.
    Example
    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 }[];
  }
  Description
  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;
    }[]
    Description
    Lists carrier offers based on the order to be canceled.
  - Optionalwarnings?: { code?: string; message?: string; service?: string }[]
    Description
    Lists any warnings returned during request processing.
OfferCancelResponseBody: {
    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 }[];
}
Description
Contains specific details of the order to be cancelled.
- 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;
  }[]
  Description
  Lists carrier offers based on the order to be canceled.
- Optionalwarnings?: { code?: string; message?: string; service?: string }[]
  Description
  Lists any warnings returned during request processing.
OfferTypeEnum: "VOID" | "REFUND"
Description
Lists order cancellation modes. Can be either VOID or REFUND.
Example
```
REFUND
@enum {string}
```
PayloadAttributes: {
    baseline?: string;
    echoToken?: string;
    host?: string;
    timeStamp?: string;
    trxId?: string;
    version?: string;
}
Description
Contains standard parameters related to processing the Reshop Cancel Order transaction.
- Optional Readonlybaseline?: string
  Description
  Application baseline.
  Example
```
PRICINGORCHESTRATOR.2019.12.AE
```
- OptionalechoToken?: string
  Description
  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.
  Example
```
7c6d6c52-a277-4539-a7f1-da225470d053
```
- Optional Readonlyhost?: string
  Description
  The hostname and port of the machine.
  Example
```
LTXL0651:2470
```
- OptionaltimeStamp?: string
  Format: date-time
  Description
  The date and time the request was processed.
  Example
```
2024-10-03T12:48:52.968Z
```
- OptionaltrxId?: string
  Description
  A unique ID assigned to the transaction.
  Example
```
b213e940-c89c-4dbb-96b1-d16a6c0249fb
```
- Optional Readonlyversion?: string
  Description
  The version of the API.
  Example
```
1.0.0
```
ReshopDifferentialType: {
amount: { amount: string; curCode?: string };
taxSummary?: { totalTaxAmount?: { amount: string; curCode?: string } };
}
Description
Contains monetary amount and tax information.
- amount: { amount: string; curCode?: string }
  Description
  Monetary amount and currency code.
  - amount: string
    Description
    Amount value.
  - OptionalcurCode?: string
    Description
    The ISO 4217 three-letter currency code.
    Example
    USD
- OptionaltaxSummary?: { totalTaxAmount?: { amount: string; curCode?: string } }
  Description
  Tax summary information, including total tax amount.
  - OptionaltotalTaxAmount?: { amount: string; curCode?: string }
    Description
    Total of all applicable tax amounts included in the price. If tax breakdowns are provided, this amount should match the sum of the tax breakdown amounts.
    - amount: string
      Description
      Amount value.
    - OptionalcurCode?: string
      Description
      The ISO 4217 three-letter currency code.
      
      Example
      USD
ReshopOffer: {
    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;
}
Description
Contains proposals to sell a specific set of products or services under specific conditions, for a certain price. Can be the response to a shopping request.
- OptionalofferExpirationDateTime?: string
  Format: date-time
  Description
  Defines the expiration date for the offer.
  Example
```
2024-04-21T11:38:35.97Z
```
- offerId: string
  Description
  The unique ID of the offer.
  Example
```
db054547769dwhkdskemtiq340-1-1
```
- OptionalofferItems?: {
      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 } };
      };
  }[]
  Description
  Lists the offer items the airline returned. Includes information about the refunded amount, penalties, and any additional details needed to present the offer.
- OptionalofferType?: "VOID" | "REFUND"
  Description
  Defines the cancellation type for the order.
- ownerCode: string
  Description
  Airline code assigned to a carrier. Either the ICAO-defined 3-character code or IATA-defined 2-character code.
  Example
```
UA
```
TaxSummary: { totalTaxAmount?: { amount: string; curCode?: string } }
Description
Contains detailed tax summary information, including total tax amount.
- OptionaltotalTaxAmount?: { amount: string; curCode?: string }
  Description
  Total of all applicable tax amounts included in the price. If tax breakdowns are provided, this amount should match the sum of the tax breakdown amounts.
  - amount: string
    Description
    Amount value.
  - OptionalcurCode?: string
    Description
    The ISO 4217 three-letter currency code.
    Example
    USD
Warning: { code?: string; message?: string; service?: string }
Description
Contains information related to potential business errors detected during processing of the preceding request.
- Optionalcode?: string
  Description
  Numbered or alphanumeric code that is used to determine the nature of a warning, and why it occurred.
  Example
```
404
```
- Optionalmessage?: string
  Description
  Warning message.
  Example
```
Refund not supported
```
- Optionalservice?: string
  Description
  Service or module in which a given warning situation originated from.
  Example
```
NDC_CONNECTOR
```

Interface components

Index

Properties

Properties

headers

parameters

pathItems

requestBodies

responses

schemas

Type Declaration

Amount: { amount: string; curCode?: string }

Description

amount: string

Description

OptionalcurCode?: string

Description

Example

Description

Example

Decimal: string

Description

Example

Description

Optionalbody?: string

Description

Example

OptionalcustomId?: string

Description

Example

Optionalheaders?: { [key: string]: string }

Description

Example

Description

Error: { code?: string; message?: string; service?: string }

Description

Optionalcode?: string

Description

Example

Optionalmessage?: string

Description

Example

Optionalservice?: string

Description

Example

Description

OptionaldifferentialAmountDue?: { amount: { amount: string; curCode?: string }; taxSummary?: { totalTaxAmount?: { amount: string; curCode?: string } };}

Description

amount: { amount: string; curCode?: string }

Description

amount: string

Description

OptionalcurCode?: string

Description

Example

OptionaltaxSummary?: { totalTaxAmount?: { amount: string; curCode?: string } }

Description

OptionaltotalTaxAmount?: { amount: string; curCode?: string }

Description

amount: string

Description

OptionalcurCode?: string

Description

Example

OptionalmandatoryInd?: boolean

Description

Example

OptionalnewOfferItemDifferential?: { amount: { amount: string; curCode?: string }; taxSummary?: { totalTaxAmount?: { amount: string; curCode?: string } };}

Description

amount: { amount: string; curCode?: string }

Description

amount: string

Description

OptionalcurCode?: string

Description

Example

OptionaltaxSummary?: { totalTaxAmount?: { amount: string; curCode?: string } }

Description

OptionaltotalTaxAmount?: { amount: string; curCode?: string }

Description

`Optional`curCode?: string

`Optional`body?: string

`Optional`customId?: string

`Optional`headers?: { [key: string]: string }

`Optional`code?: string

`Optional`message?: string

`Optional`service?: string

`Optional`differentialAmountDue?: {
amount: { amount: string; curCode?: string };
taxSummary?: { totalTaxAmount?: { amount: string; curCode?: string } };
}

`Optional`curCode?: string

`Optional`taxSummary?: { totalTaxAmount?: { amount: string; curCode?: string } }

`Optional`totalTaxAmount?: { amount: string; curCode?: string }

`Optional`curCode?: string

`Optional`mandatoryInd?: boolean

`Optional`newOfferItemDifferential?: {
amount: { amount: string; curCode?: string };
taxSummary?: { totalTaxAmount?: { amount: string; curCode?: string } };
}

`Optional`curCode?: string

`Optional`taxSummary?: { totalTaxAmount?: { amount: string; curCode?: string } }

`Optional`totalTaxAmount?: { amount: string; curCode?: string }

`Optional`curCode?: string

`Optional`offerItemId?: string

`Optional`originalOrderItemDifferential?: {
amount: { amount: string; curCode?: string };
taxSummary?: { totalTaxAmount?: { amount: string; curCode?: string } };
}

`Optional`curCode?: string

`Optional`taxSummary?: { totalTaxAmount?: { amount: string; curCode?: string } }

`Optional`totalTaxAmount?: { amount: string; curCode?: string }

`Optional`curCode?: string

`Optional`penaltyDifferential?: {
amount: { amount: string; curCode?: string };
taxSummary?: { totalTaxAmount?: { amount: string; curCode?: string } };
}

`Optional`curCode?: string

`Optional`taxSummary?: { totalTaxAmount?: { amount: string; curCode?: string } }

`Optional`totalTaxAmount?: { amount: string; curCode?: string }

`Optional`curCode?: string

`Optional`payloadAttributes?: {
baseline?: string;
echoToken?: string;
host?: string;
timeStamp?: string;
trxId?: string;
version?: string;
}

`Optional` `Readonly`baseline?: string

`Optional`echoToken?: string

`Optional` `Readonly`host?: string

`Optional`timeStamp?: string

`Optional`trxId?: string

`Optional` `Readonly`version?: string