OfferPriceRS - ShortSell

User Guidance

Input Parameters

Type

Mandatory/Optional

Request Object

OfferPriceRS

M

<OfferPriceRS>

XML Example for the following elements

Elements

Details

Mandatory/Optional

Version (Attribute)

Specify NDC schema message version. Always pass 17.2
Note: This is a mandatory attribute in NDC schema. The service will not validate what is being passed in this attribute

M

Document

Elements

Details

Mandatory/Optional

Document

NDC Message Document information

M

Name

Document name will be always "NDC

O

ReferenceVersion

It will be NDC version

O

Success

Elements

Details

Mandatory/Optional

Success

The presence of the empty Success element explicitly indicates that the message succeeded

M

ShoppingResponseID

Elements

Details

Mandatory/Optional

ResponseID

Unique shopping session response ID.

O

PricedOffer

Elements

Details

Mandatory/Optional

PricedOffer

This returns total fare, fare per passenger type and tax details along with fare rules for the requested itinerary

M

XML Example for the following elements

OfferID (Attribute)

A unique offer ID

Eg: OF1-eJxlzDsKgDAQRdEVKfPJxKRMoWAjqBFM9fa-CxMtFLy3P.xJxZhMKBKmLaWSwRYYDFiz0hgFHGlCZit0Sq3slcf4nhUcShAaBLsXIJc0_

M

Owner (Attribute)

V1(AirLine Code)

M

Parameters

Parameters

Offer-wide parameters, including Traveler Applicability; Total Offer Quantity; Passenger Pricing Method.

O

XML Example for the following elements

PTC_Priced

Requested to be priced, and actually Priced PTC (Passenger Type Code) and associated Traveler(s) quantity.

O

Requested

This returns the requested passenger type

O

Quantity (Attribute)

This returns the requested quantity of passenger type.

O

Priced

This returns the priced passenger type

O

Quantity (Attribute)

This returns the priced quantity of passenger type.

O

TimeLimits

TimeLimits

Time Limit details of the Offer.

O

XML Example for the following elements

OfferExpiration

This is the time by which offer will remain in the system to be used by subsequent APIs calling ‘Order by reference’ method.

O

DateTime (Attribute)

Date and time.

Example: 2018-08-07T07:47:14.643Z

O

OfferItem

XML Example for the following elements

OfferItem Example for Flight Fare Details:-

OfferItem Example for SSR Details:-

OfferItem Example for Seat Details:-

OfferItem Example for Extra Baggage Details:-

OfferItem

This should be repeated for each passenger

M

OfferItemID

Unique ID

Example : OF1_OI1-eJxlzDsKgDAQRdEVKfPJxKRMoWAjqBFM9fa-CxMtFLy3P.xJxZhMKBKmLaWSwRYYDFiz0hgFHGlCZit0Sq3slcf4nhUcShAaBLsXIJc0_

M

TotalPriceDetail

Total price reflecting all services for all passengers across all segments referenced within this Offer Item.

M

TotalAmount

This returns the total price of the offer for all the passenger requested per passenger type

M

DetailCurrencyPrice

A (detailed) CURRENCY-based Price with Price Break-down.

M

Total

TotalAmount

M

Code

Currency code.

Example: TRY

M

Details

Details all price break-down item subtotals, which exclude taxes, fees and charges.

M

Detail

Price details. Note: This price does not include taxes and fee/ surcharges.

M

SubTotal

Amount

M

Code

Currency

Example: TRY

M

Taxes

Ticket Tax/fee/charge details to indicate taxes that apply to country of commencement of travel and routing.

O

Total

Sub-total of all applicable taxes. Monetary value and currency code.

M

Code

Currency

Example: TRY

M

Breakdown

Gives tax breakdown

O

Amount

Tax amount

M

Nation

Country code

Example: DE

M

Taxcode

Tax code

M

BaseAmount

Base amount

M

Code

Currency

Example: TRY

M

Discount

Discount Information

O

DiscountAmount

Discount amount

M

Code

Currency.

Example: TRY

M

Surcharges

Applicable Surcharge(s).

O

Surcharge

Surcharge detail.

M

Total

Total surcharge amount

M

Code

Currency

Example: TRY

M

Fee

Individual surcharge information would appear on the accountable document.

M

Breakdown

Breakdown of surcharges

O

Amount

Surcharge amount

M

Code

Currency eg TRY

M

Designator

Example: FUEL

M

Description

Description of surcharge

O

Service

This returns the service this OfferItem is entitled to.

M

ServiceID (Attribute)

A unique id

Example: V1_SRVC.1560995778611

M

PassengerRefs

This returns the passenger reference for all the passenger for who the service is applicable.

Each reference is delimited by a space.

Example: V1_PAX.1 V1_PAX.2

Each passenger reference should be detailed in PassengerList under DataLists

M

FlightRefs

This return the all the flight references which are part of this service.

Each reference is delimited by a space.

Example: V1_SEG.1560995803085 V1_SEG.1560995803086

Each Flight reference should be detailed in FlightList under DataLists

M

ServiceDefinitionRef

This returns the reference ID of the Service Definition in Data List

O

SegmentRefs (Attribute)

This returns the reference ID of the Flight Segment in Data List

M

SelectedSeat

The Seat location selected by the Passenger (via SeatAvailability)

M

Seat

Selection of specific seat location, as provided in seat availability . When used, only a single Passenger must be referenced for a single Segment

M

Row

Seat Row Number

M

Column

Seat Column Number

M

SegmentRef

Reference to the Segment on which this Passenger's Seat has been assigned.

M

ServiceDefinitionRef

Reference to the ServiceDefinition relating to the Seat assigned to the Passenger.

M

FareDetail

This returns FareRules and price detail applicable to flights & passenger type respectively applicable to this OfferItem

O

Price

Price returned per passenger type with total price, fare & tax along with the breakdown

M

TotalAmount

The total amount per passenger type

O

DetailCurrencyPrice

Total amount (Base fare + Tax) per passenger type for the itinerary

M

Code (Attribute)

Currency code

O

BaseAmount

Base fare per passenger type for the itinerary

M

Code

Currency code

O

Surcharges

Applicable Surcharge(s).

O

Surcharge

Surcharge detail.

M

Total

Total surcharge

M

Code

Currency code

O

Taxes

This returns taxes per passenger type for the itinerary

O

Total

Total tax

O

Code

Currency code

O

FareComponent

Repeat FareComponent per Origin & Destination

M

Price

Price returned per passenger type for a segment with total price, fare & tax along with the breakdown

M

TotalAmount

The total amount per passenger type for the segment.

O

DetailCurrencyPrice

Total amount (Base fare + Tax) per passenger type for the itinerary

M

Code (Attribute)

Currency code

O

BaseAmount

Base fare per passenger type for the itinerary

M

Code

Currency code

O

Surcharges

Applicable Surcharge(s).

O

Surcharge

Surcharge detail.

M

Total

Total surcharge for the segment

M

Code

Currency code

O

Taxes

This returns taxes per passenger type for the itinerary

O

Total

Total tax for the segment

O

Code

Currency code

O

FareBasis

Fare Basis information,

M

FareBasisCode

Fare Basis Code with optional application.

M

Code

Fare basis code.

Example: Y26

M

RBD

Reservation Booking Designator or Booking Class

Example : T

O

CabinType

Cabin Type information.

M

CabinTypeCode

Cabin Type Code.

Example : Y

M

CabinTypeName

Cabin Type Name

Example : ECONOMY

M

FareRules

This returns FareRules for the flights

O

PriceClassRef

Reference to the Price Class information in data List

M

SegmentRefs

This returns reference to all the segments applicable

M

BaggageAllowance

BaggageAllowance

This block contains references to the Baggage Allowance characteristics (no. of pieces / weight / dimensions, etc) included in the Flight services for one or more Passengers.

O

XML Example for the following elements

FlightRefs

Reference to FlightIDs in DataLists

M

PassengerRefs

Reference to PassengerIDs in DataLists

M

BaggageAllowanceRef

Reference to BaggageAllowanceIDs in DataLists

M

<DataList>

<PassengerList>

PassengerList

Passenger data list definition/details.

M

XML Example for the following elements

PassengerID (Attribute)

Uniquely identifies a Passenger within the context of one message.

M

Passenger

Any person except members of the crew carried or to be carried with the consent of the carrier, on board of any transport vehicle such as aircraft, train, bus, ship.

M

PTC

Type code applying to the Passenger which typically drives pricing

Example: ADT, CHD, etc.

M

<FlightSegmentList>

FlightSegmentList

Flight Segment details

M

XML Example for the following elements

FlightSegment

Flight Segment

M

SegmentKey (Attribute)

A globally unique identifier for this Flight Segment instance.

M

ElectronicTicketInd (Attribute)

When true, an electronic ticket may be issued.

O

Departure

Departure (origin) Airport, Date and Time information. (en, description)

M

AirportCode

Airport or a city code. Use a three letter location identifier assigned according to the IATA Resolution 763. Refer to IATA Airline Coding Directory .

Example: TPA

M

Date

Departure date. Example: 2017-01-13 Encoding Scheme: ISO 8601 Date Format (YYYY-MM-DD)

M

Time

Departure time. Example: 09:15 Encoding Scheme: ISO 8601 Military/ 24 Hour Format (HH:MM)

O

Terminal Information

Terminal information will be present under the Departure and Arrival tags only if the terminal information is available in the flight

O

Arrival

Arrival (destination) Airport, Date and Time information.

M

AirportCode

Airport or a city code. Use a three letter location identifier assigned according to the IATA Resolution 763. Refer to IATA Airline Coding Directory .

Example: TPA

M

Date

Arrival date. Example: 2017-01-13 Encoding Scheme: ISO 8601 Date Format (YYYY-MM-DD)

O

Time

Arrival time. Example: 09:15 Encoding Scheme: ISO 8601 Military/ 24 Hour Format (HH:MM)

O

MarketingCarrier

Marketing Carrier information

M

AirlineID

A two-character alpha-numeric code assigned according to the IATA Resolution 762 or a three-letter airline designator assigned by ICAO. Refer to IATA Airline Coding Directory .

M

FlightNumber

Flight Number.

Example: 1234

M

Equipment

Aircraft Equipment.

M

AircraftCode

The IATA aircraft type 3 character code; use SSIM Appendix A. Example: 318.

M

AirlineEquipCode

Airline-specific aircraft equipment code.

Example: 737-800

O

ClassOfService

Class of Service.

Example: T

M

Code

Class of Service Code

M

FareBasisCode

Fare basis code.

Example: Y26CH

O

FlightDetail

Flight Details.

O

FlightDuration

Flight Duration with application.

M

Stops

Flight Stop Quantity and Location(s).

O

StopQuantity

Stop Quantity. Example: 1

O

<FlightList>

FlightList

Flight Details

M

XML Example for the following elements

FlightList

List of Flight elements

M

Flight

Journey information describing the travel between an airport/city where travel commences and an airport/city where travel ultimately terminates. A journey may be comprised of one or more segments. Note: This node will be renamed to journey in future releases.

M

FlightKey (Attribute)

A globally unique identifier for this Flight instance.

O

Journey

Flight journey information.

O

Time

Total Journey Time. Example: PT7H45M (7 hours and 45 minutes) Note: Total journey time includes the combined air time, connection time and/ or stop information for all specified flight segments

O

SegmentReferences

Association to multiple Flight Segment instance(s). Example: segment1 segment2 Note: Flight Slice On and Off Board Points may also be specified.

M

<OriginDestinationList>

OriginDestinationList

Origin Destination details

M

XML Example for the following elements

OriginDestination

Origin/ Destination information. Contains a list of all Flight element that are part of that OD.

M

OriginDestinationKey

A globally unique identifier for this OriginDestination instance.

O

DepartureCode

Departure (origin) Airport Code.

M

ArrivalCode

Airport or a city code. Use a three letter location identifier assigned according to the IATA Resolution 763. Refer to IATA Airline Coding Directory .

Example: TPA

M

FlightReferences

Association to multiple Flight instance(s).

Example: V1_FL.1605138125285

M

OnPoint (Attribute)

Flight slice on point.

O

OffPoint (Attribute)

Flight slice off point.

O

<PriceClassList>

PriceClassList

Itinerary Fare Class details

M

XML Example for the following elements

PriceClass

Price/Fare Class details

M

PriceClassID (Attribute)

Unique ID referring to the PriceClassRef in Fare Details

O

Name

Price Class Name

Example: SUNECO

M

FareBasisCode

FareBasisCode Details

M

Code

FareBasis Code

M

ClassOfService

Class of Service Details

M

refs (Attribute)

Object association(s) between this object and any other object or metadata instance(s)

O

Code

Class of Service Code

Example: A

M

MarketingName

Cabin Class Marketing Name.

M

CabinDesignator (Attribute)

Designator Code of the Cabin

O

<ServiceDefinitionList>

ServiceDefinitionList

Service Definition List Deatils

O

XML Example for the following elements

ServiceDefinition

Service Definition

M

ServiceDefinitionID

A unique Service ID that has been returned in the Shopping results, and identifies an airline service item (ie a product or a service) that can be separately delivered and uniquely described by an airline.

M

Owner

Airline designator or CRS code of the owner/ assigner of the Offer ID, typically used for offer ordering purposes.

O

Name

Service name.

Example: Lounge Pass

M

Encoding

Service Codes and Reason for Issuance.

O

RFIC

Reason For Issuance Code

Example: A (Air Transportation) C (Baggage) E (Airport Services) F (Merchandise) G (In-flight Services) Refer to PADIS Codeset for data element 4183

M

Code

Service code.

Example: XLEG (Extra Leg Room Seat, implementer encoding) XBAG (Extra Bag, implementer encoding). Used in conjunction with SubCode (Associated Reason For Issuance SubCode)

O

SubCode

Associated Reason For Issuance Sub Code. Examples: 0CC (First Checked Bag) 0B1 (In-flight Entertainment) 0BX (Lounge) 0B3 (Meal/ Beverage) 0B5 (Pre-reserved Seat Assignment) 0G6 (Priority Boarding)

O

Descriptions

SERVICE Description. Note: Supports plain text, multimedia and code and link references

M

Description

Service Description detail.

M

Text

Description value

O

Settlement

Interline Settlement information between airlines, including method of settlement,

O

Method

Service settlement method.

Examples: AD (Internal Airline Document), EA (EMD Associated or Internal Airline Document), ES (EMD Standalone )

M

<SeatDefinitionList>

SeatDefinitionList

Seat Definition List

O

XML Example for the following elements

SeatDefinition

Seat Information Details

O

SeatDefinitionID (Attribute)

Seat Information by Aircraft section

O

<BaggageAllowanceList>

BaggageAllowanceList

Baggage Allowance Details List

O

XML Example for the following elements

BaggageAllowance

Checked or Carry-On Baggage Allowance detail. Use BaggageCategory to specify which of the two.

M

BaggageAllowanceID (Attribute)

Unique ID for Baggage Reference

M

BaggageCategory

Baggage Category.

Example: Checked

M

WeightAllowance

Baggage Weight Allowance with application information

M

ApplicableParty

Baggage weight restriction application. Examples: Party, Traveler Note: Party applies to all Travelers.

O

MaximumWeight

Maximum Weight and Unit Details

M

Value

Maximum Weight Value

M

UOM

Unit Of Measure

M

<Metadata>

<Shopping>

Shopping

Includes FareDetailAugPoint, ItineraryAmountDetailAugPoint, FareComponentAugPoint

M

XML Example for the following elements

ItineraryAmountDetailAugPoint

Total Itinerary amount details

M

TotalPriceAmount

Total Fare amount of the Priced Itinerary

M

TotalFeeAmount

Total Fee amount of the Priced Itinerary

M

TotalAmount

Total amount of the Priced Itinerary

M

FareDetailAugPoint

Fare Details including Fare ID, Fare Type and Fare Level

M

FareComponentAugPoint

Base Fare information with discount details

M

<Traveler>

Traveler

Includes TravellerAugPoint

M

XML Example for the following elements

<Other>

Other

Other metadatas to be included.

Example: PriceMetadatas

M

PriceMetadatas

Includes TaxDetailAugPoint

M

XML Example for the following elements