ItinReshop

1.1 Functional Description

version: 2.38

Functionality:

ItinReshop.zip message examples

The ItinReshop API is used to shop for changes to the itinerary of an existing Order.

Today you can change the date, time and class of flight(s). Change of routing is under developement.

When using the action type pair "Delete/Create" the response will include the various offers available.

The action type "Reprice" is similar to a FlightPrice and returns the details (conditions, etc...) of the offer selected.

EndPoint:

 

(version: 2.38)

  • Post sale services only verify Iata Number to allow servicing to the seller 
  • Improvement on error message in Servicing when PNR is cancelled
  • CNQ does not return any detail of the hold baggage included in the rate when the number of pieces is 0

(version: 2.25) Added the functionality to allow flight changes for a subset of passengers from the original order.

  • New element in the SOAP response for Delete & Create action type.
  • New element in the SOAP response for Reprice action type.

 

ActionType Use/ Description
Delete & Create

This combination allows to look for new availabilities for date, time and/or cabin for an initial booking.

  • Flight changes are only permitted over those ones with all coupons are in open for use/airport control status.
  • Allows searching for all passengers of the booking or only some of them.
  • Limited to searches for the same number of segments and same airport codes of the initial booking.

Reprice

Allows selecting and pricing one of the offer resulting on previous itin reshop Delete & Create.

  • Previous call to itin reshop D&C is mandatory.

Delete

To know in advance what is the devolution of a partial or total refund of a specific group of passengers (not all passenger of the order).

Passenger/s can be deleted when at least one coupon is in Open for Use/Airport Control status.
Cancel / Refund

To know in advance what is the cost of a partial or total refund for an initial booking.

  • At least one coupon have to be in Open for Use/Airport Control status.

Add = New

1.2 Request Body

NAME

DESCRIPTION

FORMAT

ALLOWED VALUES

MANDATORY FOR

PrimaryLangID

Two character ISO Language Code, for the agent’s preferred language. This is for error messages and some other data such as legal waivers.

2 alpha

  • EN
  • ES

Version

The IATA version of the message

numeric

any

Schema

<PointOfSale>

CountryCode

Country code

2 alpha

List of countries


<Document>

ReferenceVersion

The IATA Schema version.

numeric

any


<Party>

Sender / IATA_Number

Sender unique identifier such as:

IATA number (if you have one)

TIDs  number (recommended if you do not have an IATA)

Pseudo IATA(assigned by Iberia)

7 numeric

7 numbers

NDC Mandatory

Sender / AgencyID

Name of the Sender / Agency

alphanumeric

any

Schema

Participant / AggregatorID

Participant / Aggregator unique identifier:

IATA number (if you have one)

TIDs  number (recommended if you do not have an IATA)

Pseudo IATA(assigned by Iberia)

7 numeric

7 numbers

Mandatory for schema if 'Participants' tag is indicated.

<Query / Reshop / Actions>  Order by OrderID

Action Type

Action type

alphabetic

  • Create  
  • Delete  
  • Reprice  
  • Cancel

****The Action types Delete and Create cannot be provided in an isolated way. It must be provided as a pair in the same message.**** Add

Schema

OrderID

Order ID

alphanumeric

any


< Query / Reshop / Action / Passenger> Only for Delete action type Add
Passenger / ObjectKey Passenger reference ID alphanumeric any
PTC / Quantity Passenger reference ID numeric any
Surname Quantity of same passengers alphabetica any
Given Passenger name alphabetical any
<Query / Reshop / Actions / Action / OrderItem> Only for Delete and Create action types 
OrderItemID Order Item ID alphanumeric any Schema
<Query / Reshop / Actions / OrderItem>  Only for Reprice action type 
OrderItemID Offer ID alphanumeric any
<Query / Reshop / Actions / OfferItem> Only for Reprice action type
OfferItemID Offer item ID alphanumeric any Schema
<Query / Reshop / Actions / OrderItems / OrderItem / FlightItem / Flight> Only for Create and Reprice action types

Departure / AirportCode

the departure city (or airport)

3 alpha

any valid airport or city code


Arrival/AirportCode

the arrival city (or airport)

3 alpha

any valid airport or city code


Departure/Date

Date of travel

date

any future date


 MarketingCarrier/ AirlineID The airline ID 2 alpha any
MarketingCarrier / Flight Number The number of the flight 4 numbers OPEN(Any flight number) or flight number
<Query / Reshop / Actions>Add
Preference / CabinPreferences / CabinType / Code Cabin type code selected at order level. It is sent to QPX tos ask for a specific cabin type for all flights associatted. 1 numeric Values allowed in CABIN_PROVIDER_TYPE (In this case values from 1 to 5 )

1.3 Response Body

NAME

DESCRIPTION

FORMAT

Nullable

<Warnings>Add
warning Warning of loss of special services and ancillaries in the change of segment alpha True
<Response / ItinReshopProcessing / MarketingMessages / MarketMessage>Add
Text

Notice message to contact the company if additional services were added to the order

alpha True

< ReShoppingResponseID / Response ID >

Response ID

Responde ID

alphanumeric

False

< Passengers >

Passenger

Passenger Object Key

alphanumeric

False

PTC

Passenger Type Code

3 alpha

False

Birthdate

Birthdate of the passenger

Date

False

Surname

Surname of the passenger

alphanumeric

False

Given

Name of the passenger

alphanumeric

False

Title

Title of the passenger (Mandatory for secure flights)

alpha

False

PhoneContact

Number of the phone contact

alphanumeric

False

Address

Email address

alphanumeric

False

Gender

Gender of the passenger (Mandatory for Infants)

alphabetic

False

Type

Type of the passenger ID Info

2 alpha

False

ID

ID of the passenger

alphanumeric

False

<Order>

OrderID

Order ID

alphanumeric

False

ID

Order's Locator

alphanumeric

False

Airline ID

Airline ID

2 alpha

False

<Order / OrderItem>

OrderItemID

OrderItem ID

alphanumeric

False

PassengerReferences

Passenger references of OrderItem

alphanumeric

False

OriginDestinatioKey

OriginDestination Key

alphanumeric

False

SegmentKey

Segment Key

alphanumeric

False

AirportCode

Departure airport code

3 alpha

False

Date

Departure date

date

False

Time

Departure time

time

False

Terminal

Departure Terminal number

number

False

AirpotCode

Arrival airport code

3 alpha

False

Date

Arrival date

date

False

Time

Arrival time

time

False

ChangeOfDay

Days between the departure and the arrival

numeric

False

Terminal

Arrival Terminal number

number

False

AirlineID

Airline ID of marketing carrier

2 alpha

False

Name

Airline name of marketing carrier

alphabetic

False

Flight number

Flight Number of marketing carrier

numeric

False

Airline ID

Airline ID of operating carrier

2 alpha

False

Name

Airline name of operating carrier

alphabetic

False

Flight number

Flight Number of marketing carrier

numeric

False

Text

Disclosures text

2 alpha

False

<ReShopOffer>

OfferID

OfferID

alphanumeric

False

OriginalOrder/Amount

Base amount

numeric

False

Taxes

Amount of taxes and breakdown

numeric

False

TimeLimits/OfferExpiration 

Offer date limit

Date

True

Disclosure/Description 

Code related to the fare

Alphanumeric

True

<ReShopOffer / OfferPrice>  
Total Amount Sum of Base Amount and Taxes Numeric False
Taxes Taxes breakdown Numeric False
Associations Traveler references Alphanumeric False
<ReShopOffer / ReshopDifferential> 
NewOffer/Amount Amount of the new offer numeric False
PenaltyAmount/Amount Non refundable amount due to Penalty. numeric False
FeesAmount/Amount Fees amount. The associated price to the operation management. It is not currently in use. numeric False
ReshopDue /
     ByAirline / Total / Amount
     ByPassenger / Total / Amount
Total amount of the new offer. It can be indicated per airline (to be refunded to the client) or per passenger (to be payed by the client).
Calculated as (OriginalOrder + Taxes) - (NewOffer + PenaltyAmount)
numeric False
PurposeAdd Identifies if the amont is complete (Sell) or without taxes (base) alphabetical False
<ReShopOffer / Associations>
ClassOfService / Code Cabin code alphabetical False
ClassOfService / MarketingName Cabin type alphabetical False
OriginDestinationReferences Origin destination reference alphabetical False
FlightReferences Flight reference Alphanumeric False
<Commission> 

Percentage

Percentage of commission Numeric True

Amount

Amount of commission Numeric True

Remarks

Detaill for more than one commission Alphanumeric True
ActionType ActionType (CANCEL or UPDATE)
alphabetical True
<Metadata>
CurrencyMetadata / Decimals Decimals numeric False
<Datalists / CarryOnAllowanceList>Add
CarryOnAllowance ListKey Carry on Allowance Identifier Alphanumeric False
CarryOnAllowance / PieceAllowance / ApplicableParty Text "Party" (Identifier for all conditions) Alphabetical False
CarryOnAllowance / PieceAllowance / TotalQuantity Quantity allowed Numeric False
CarryOnAllowance / PieceAllowance / ApplicableBag Identifier (Carry-On) Alphabetical False
CarryOnAllowance / PieceAllowance / PieceMeasurements Quantity Quantity allowed Numeric False
<Datalists / CheckedBagAllowanceList>Add
CheckedBagAllowance ListKey Bag Allowance Identifier
Alphanumeric False
AllowanceDescription / ApplicableParty Text "Party" (Identifier for all conditions) Alphabetical False
Descriptions / Description / Text Associated quantity text Alphanumeric False
PieceAllowance PieceAllowanceCombination Piece Allowance Identifier Alphabetical False
PieceAllowance PieceAllowanceCombination / ApplicableParty Text "Party" (Identifier for all conditions) Alphabetical False
PieceAllowance PieceAllowanceCombination / TotalQuantity Quantity of allowed pieces
Numeric False
PieceAllowance PieceAllowanceCombination / Descriptions / Description / Text Associated and descriptive text (Golf equipment...) Alphanumeric False
PieceAllowance PieceAllowanceCombination / PieceMeasurements Quantity Quantity of pieces Numeric False
<Datalists / DisclosureList>Add
Disclosures ListKey Identifier of selected fare (BFLROES, TBAESEU...) Alphabetical False
Disclosures / Description / Text Descriptive text indicating services included in selected fare (Selección de asiento: Incluido) Alphanumeric False
<Datalists / FlightSegmentList>Add
FlightSegment SegmentKey Segment Identifier Alphanumeric False
 FlightSegment / Departure / AirportCode Departure Airport Code Identifier (MAD, LIS...) Alphabetical False
FlightSegment / Departure / Date Departure Flight Date (2018-12-27) Numeric False
FlightSegment / Departure / Time Departure Flight Time (17:50) Numeric False
FlightSegment / Departure / AirportName Departure Airport Name (Madrid Adolfo Suarez-Barajas...) Alphabetical False
FlightSegment / Departure / Terminal / Name Departure Terminal Name (4, 4S...) Alphanumeric False
FlightSegment / Arrival / AirportCode Arrival Airport Code Identifier (MAD, LIS...) Alphabetical False
FlightSegment / Arrival / Date Arrival Flight Date (2018-12-27) Numeric False
FlightSegment / Arrival / Time Arrival Flight Time (17:50) Numeric False
FlightSegment / Arrival / AirportName Arrival Airport Name (Madrid Adolfo Suarez-Barajas...) Alphabetical False
FlightSegment / Arrival / Name Arrival Terminal Name (4, 4S...) Alphanumeric False
FlightSegment / MarketingCarrier / AirlineID Marketing airline Identifier (IB, I2...) Alphanumeric False
FlightSegment / MarketingCarrier / Name Marketing airline Name (Iberia...) Alphanumeric False
FlightSegment / MarketingCarrier / FlightNumer Marketing flight Number Identifier (4370...) Numeric False
FlightSegment / OperatingCarrier / AirlineID Operating airline Identifier (IB, I2...) Alphanumeric False
FlightSegment / OperatingCarrier / Name Operating airline Name (I2...) Alphanumeric False
FlightSegment / OperatingCarrier / Disclosures / Description / Text Operating airline text description
Alphanumeric False
FlightSegment / Equipment/ AircraftCode Aircraft identifier (32A...) Alphanumeric False
FlightSegment / Equipment/ Name Aircraft Name (Airbus Industrie A320 (Sharklets) Alphanumeric False
<Datalists / FlightList>Add
Flight FlightKey Flight Identifier (MADCDG20180927175000...)
Flight / Journey / Time Flight time duration (PT2H5M)
Flight / Journey / SegmentReferences Segment Identifier (IB374020180927)
<Datalists / OriginDestinationList>
OriginDestination OriginDestinationKey Origin and destination Identifier (MADCDG) Alphabetical False
OriginDestination / DepartureCode Departure Airport Code (MAD...) Alphabetical False
OriginDestination / ArrivalCode Arrival Airport Code (PAR...) Alphabetical False
OriginDestination / FlightReferences Complete flight reference (MADCDG20180927175000) Alphabetical False
 <Datalists / MediaList>Add
Media ListKey Identifier (Legal-Information") Alphabetical False
Media / MediaLink Link to information
Alphabetical False

1.4 Error messages

NDC Standard allow errors and warnings to be returned inside an 200 OK response. Errors returned with 200 OK will always be controlled errors result of external limitations as "Max accepted non-infant passengers is 9".

The following codes are enclosed in the response returned with a 200 OK.

PADIS STATUS CODE

EXAMPLE MESSAGE ERROR

REASON

486 Invalid action code Incorrect action
486 Action code missing Action missing
396 Invalid ticket/document coupon status Order without tickets
396 Invalid ticket/document coupon status Order with some ticket in status distinct of OPEN FOR USE
396 Invalid ticket/document coupon status Order with some ticket reissued
396 Refund request for tickets not issued. Please check the information entered and if the issue persists get in touch with us. Not Issued Tickets
911 Ha habido un error en tu localizador. Por favor ponte en contacto con nosotros. PNR cancelled
915 No action - processing host cannot support function Same flight
76D Modified itinerary – change options not allowed New origen/arrival
73H Changes not allowed in original itinerary Add a segment
74T Reembolso por cancelación no permitido Reissued ticket
486 Changes have been made to the reservation from outside of NDC. Sorry we can’t process the request. Reserve modificated outside NDC.