Saved Successfully.
On this page
Schema Data Model
 

Response Definition

<DataLists>
Element
Details
DataType
M/O/C
<BaggageAllowanceList>
Baggage Allowance Details
O
<ContactInfoList>
Pax contact details
O
<DatedMarketingSegmentList>
Marketing carrier information.
O
<DatedOperatingLegList>
A list of flight leg information.
O
<DatedOperatingSegmentList>
A list of dated operating segments used in the contained message.
O
<OrigDestList>
Requested list of Origin and Destination.
O
<PaxJourneyList>
Journey data list definition
M
<PaxList>
Travellers in the shopping transaction.
Note: Note: 1 to 9 paxs are supported. This is mandatory but Optional in IATA NDC Schema.
M
<PaxSegmentList>
Flight Segment details
M
<ServiceDefinitionList>
List of Service Definitions
O
<DatedOperatingLegList>
A list of flight leg information.
O
 
<Order>
XML Snippet
Element
Details
DataType
M/O/C
<Order>
List[1]
M
<OrderID>
Unique identifier of the Order
Alphanumeric
M
<Order>
  <OrderID>VS932EWYDWQ22</OrderID>
  <OrderItem>
  ...
  </OrderItem>
  <OrderItem>
  ...
  </OrderItem>
  <OrderItem>
  ...
  </OrderItem>
  <OwnerCode>VS</OwnerCode>
  <TotalPrice>
    <TotalAmount CurCode="GBP">1954.62</TotalAmount>
  </TotalPrice>
</Order>
 
<OrderItem>
XML Snippet
Element
Details
DataType
M/O/C
<OrderItem>
List of OrderItems [1..*]
List [1..*]
M
<OrderItemID>
Unique identifier of an OrderItemID
Alphanumeric
M
<OwnerCode>
IATA carrier code of the airline that owns the offer
Note: Note: Current implementation always returns "VS"
Char(2)
M
<PaymentTimeLimitDateTime>
A date/time by which payment commitment is required for a given Order Item represented in GMT/UTC. Applicable only for Hold Booking. Example: Unticketed Order.
DateTime
O
<OrderItem>
  <OrderItemID>VS932EWYDWQ22-1</OrderItemID>
  <OwnerCode>VS</OwnerCode>
  <Price>
    <BaseAmount CurCode="GBP">328.00</BaseAmount>
    <TaxSummary>
      <Tax>
        <Amount CurCode="GBP">91.00</Amount>
        <DescText>United Kingdom Air Passenger Duty APD</DescText>
        <TaxCode>GB</TaxCode>
      </Tax>
      <Tax>
        <Amount CurCode="GBP">55.84</Amount>
        <DescText>United Kingdom Passenger Service Charge Departures</DescText>
        <TaxCode>UB</TaxCode>
      </Tax>
      <Tax>
        <Amount CurCode="GBP">1.40</Amount>
        <DescText>South Africa Passenger Safety Charge</DescText>
        <TaxCode>EV</TaxCode>
      </Tax>
      <Tax>
        <Amount CurCode="GBP">1.50</Amount>
        <DescText>South Africa Asc Charge</DescText>
        <TaxCode>UM</TaxCode>
      </Tax>
      <Tax>
        <Amount CurCode="GBP">9.30</Amount>
        <DescText>South Africa Air Passenger Tax</DescText>
        <TaxCode>WC</TaxCode>
      </Tax>
      <Tax>
        <Amount CurCode="GBP">12.50</Amount>
        <DescText>South Africa Passenger Service Charge</DescText>
        <TaxCode>ZA</TaxCode>
      </Tax>
      <Tax>
        <Amount CurCode="GBP">240.00</Amount>
        <DescText>VS YQ surcharge</DescText>
        <TaxCode>YQ</TaxCode>
      </Tax>
      <TotalTaxAmount CurCode="GBP">411.54</TotalTaxAmount>
    </TaxSummary>
    <TotalAmount CurCode="GBP">739.54</TotalAmount>
  </Price>
  <Service>
    <BookingRef>
      <BookingEntity>
        <Carrier>
          <AirlineDesigCode>VS</AirlineDesigCode>
        </Carrier>
      </BookingEntity>
      <BookingID>EWYDWQ</BookingID>
    </BookingRef>
    <OrderServiceAssociation>
      <PaxSegmentRef>
        <PaxSegmentRefID>SEG1</PaxSegmentRefID>
      </PaxSegmentRef>
    </OrderServiceAssociation>
    <PaxRefID>ADULT_1</PaxRefID>
    <ServiceID>SV1</ServiceID>
    <StatusCode>CONFIRMED</StatusCode>
  </Service>
  <Service>
  ...
  </Service>
  <Service>
  ...
  </Service>
  <Service>
  ...
  </Service>
  <Service>
  ...
  </Service>
  <Service>
  ...
  </Service>
</OrderItem>
 
<Price>
XML Snippet
Element
Details
DataType
M/O/C
<Price>
Amount paid per OrderItem.
O
<BaseAmount>
Base price of the OrderItem (excludes taxes).
Decimal
O
CurCode attr
ISO 3 Char currency code. Example: GBP, USD
Char(3)
O
<TaxSummary>
Tax summary information.
List [1..*]
O
<Tax>
List of tax breakdown details.
List[1..*]
M
<Amount>
Tax amount.
Decimal
M
CurCode attr
Currency code
Char(3)
M
<CollectionPointTax>
Tax Breakdown by Collection Point for XF tax (Passenger Facility Fee) OR ZP tax(Federal Tax segment)
O
<AirportAmount>
Amount imposed by Airport
Decimal
M
CurCode attr
Currency applicable to the geographical location of the airport
Char(3)
M
<Station>
Airport Location details 
<IATA_LocationCode>
IATA defined Airport Code
Char(3)
M
<DescText>
Tax Description
String
O
<TaxCode>
Tax Code
String
O
<TotalTaxAmount>
Total tax of the OrderItem.
Decimal
O
CurCode attr
ISO 3 Char currency code. Example: GBP, USD
Char(3)
O
<TotalAmount>
Total price of the OrderItem (includes taxes).
Decimal
O
CurCode attr
ISO 3 Char currency code. Example: GBP, USD
Char(3)
O
<Price>
  <BaseAmount CurCode="GBP">328.00</BaseAmount>
  <TaxSummary>
    <Tax>
      <Amount CurCode="GBP">91.00</Amount>
      <DescText>United Kingdom Air Passenger Duty APD</DescText>
      <TaxCode>GB</TaxCode>
    </Tax>
    <Tax>
      <Amount CurCode="GBP">55.84</Amount>
      <DescText>United Kingdom Passenger Service Charge Departures</DescText>
      <TaxCode>UB</TaxCode>
    </Tax>
    <Tax>
      <Amount CurCode="GBP">1.40</Amount>
      <DescText>South Africa Passenger Safety Charge</DescText>
      <TaxCode>EV</TaxCode>
    </Tax>
    <Tax>
      <Amount CurCode="GBP">1.50</Amount>
      <DescText>South Africa Asc Charge</DescText>
      <TaxCode>UM</TaxCode>
    </Tax>
    <Tax>
      <Amount CurCode="GBP">9.30</Amount>
      <DescText>South Africa Air Passenger Tax</DescText>
      <TaxCode>WC</TaxCode>
    </Tax>
    <Tax>
      <Amount CurCode="GBP">12.50</Amount>
      <DescText>South Africa Passenger Service Charge</DescText>
      <TaxCode>ZA</TaxCode>
    </Tax>
    <Tax>
      <Amount CurCode="GBP">240.00</Amount>
      <DescText>VS YQ surcharge</DescText>
      <TaxCode>YQ</TaxCode>
    </Tax>
    <TotalTaxAmount CurCode="GBP">411.54</TotalTaxAmount>
  </TaxSummary>
  <TotalAmount CurCode="GBP">739.54</TotalAmount>
</Price>
 
<PriceDifferential>
Element
Details
DataType
M/O/C
<PriceDifferential>
For OrderChange – Confirm change booking only
Price Differential per Offer Item.
M
<DifferentialTypeCode>
For OrderChange only
Type of Offers as part of Reshop.
Note: Virgin Atlantic only returns the following values from the enum:
AddCol
EvenExchange
Refund
Enum
M
<DiffPrice>
For OrderChange only
Price and Fare Details.
M
<FareDetail>
For OrderChange only
The Fare Details per PTC
List[1..*]
O
<PaxRefID>
For OrderChange only
Reference to the PassengerID.
Alphanumeric
O
<Price>
For OrderChange only
Price Differential info.
O
CurCode attr
For OrderChange only
ISO 3 char Currency code. Example: GBP,USD.
Char(3)
O
<DueByAirlineAmount>
For OrderChange only
Total amount including tax and Cancel/Change Fee due by Airline.
Decimal
O
CurCode attr
For OrderChange only
ISO 3 char Currency code. Example: GBP, USD.
Char(3)
O
<DueToAirlineAmount>
For OrderChange only
Total amount including tax and Cancel/Change Fee due to Airline
Decimal
O
CurCode attr
For OrderChange only
ISO 3 char Currency code. Example: GBP, USD.
Char(3)
O
<TaxSummary>
For OrderChange only
Tax Summary Information.
O
<TotalTaxAmount>
For OrderChange only
Total amount including Tax.
Decimal
O
CurCode attr
For OrderChange only
ISO 3 char Currency code. Example: GBP, USD.
Char(3)
O
<TotalAmount>
For OrderChange only
Total amount including Tax.
Decimal
O
CurCode attr
For OrderChange only
ISO 3 char Currency code. Example: GBP, USD.
Char(3)
O
NewPrice
For OrderChange only
New Price and Fare detail information.
M
<FareDetail>
For OrderChange only
The Fare Details per PTC
List[1..*]
O
<PaxRefID>
For OrderChange only
Reference to the PassengerID.
Alphanumeric
O
<Price>
For OrderChange only
Price Details.
O
<BaseAmount>
For OrderChange only
Fee Amount.
Decimal
M
CurCode attr
For OrderChange only
ISO 3 char Currency code. Example: GBP,USD.
Char(3)
O
<TotalTaxAmount>
For OrderChange only
Total Tax amount.
Decimal
O
<TaxSummary>
For OrderChange only
Tax Summary Information.
O
CurCode attr
For OrderChange only
ISO 3 char Currency code. Example: GBP, USD.
Char(3)
O
<TotalAmount>
For OrderChange only
Total amount including Tax.
Decimal
O
CurCode attr
For OrderChange only
ISO 3 char Currency code. Example: GBP, USD.
Char(3)
O
<OldPrice>
For OrderChange only
Price information of Booked Order.
O
<FareDetail>
For OrderChange only
The Fare Details per PTC
List[1..*]
O
<PaxRefID>
For OrderChange only
Reference to the PassengerID.
Alphanumeric
O
<Price>
For OrderChange only
Price Details.
O
<BaseAmount>
For OrderChange only
Fee Amount.
Decimal
M
CurCode attr
For OrderChange only
ISO 3 char Currency code. Example: GBP, USD.
Char(3)
M
<TaxSummary>
For OrderChange only
Tax Summary Information.
M
<TotalTaxAmount>
For OrderChange only
Total Tax amount.
Decimal
O
CurCode attr
For OrderChange only
ISO 3 char Currency code. Example: GBP, USD.
Char(3)
O
<TotalAmount>
For OrderChange only
Total amount including Tax.
Decimal
O
CurCode attr
For OrderChange only
ISO 3 char Currency code. Example: GBP, USD.
Char(3)
O
 
<Service>
XML Snippet
Element
Details
DataType
M/O/C
<Service>
Specific offered service instance.
List[1..*]
M
<BookingRef>
Information related to booking
List[1..3]
O
<BookingEntity>
Booking Entity Information
O
<Carrier>
Carrier Information
M
<AirlineDesigCode>
Airline Associated to the carrier.
Note: Current implementation always returns 'VS'
Alphanumeric
M
<BookingID>
Booking ReferenceID
Alphanumeric
M
<DeliveryStatusCode>
Status of the Service Delivery instance
Note:
  • REQUESTED
  • READY TO DELIVER
  • CONFIRMED
  • READY TO PROCEED
  • DELIVERED
  • REMOVED
String
O
<OrderServiceAssociations>
Service Association details
M
<PaxSegmentRef>
M
<PaxSegmentRefID>
Reference to PaxSegmentID
Alphanumeric
M
<SeatOnLeg>
Seat details.
Note: This is optional for 'VS' implementation.
O
<Seat>
This is optional for 'VS' implementation.
M
<ColumnID>
Seat Column ID
Char(1)
M
<RowNumber>
Seat Row Number
Integer
M
<SeatAssignmentAssociations>
Association of Seat with the Segement
M
<PaxSegmentRef>
Alphanumeric
M
<PaxSegmentRefID>
Reference to PaxSegmentID
Alphanumeric
M
<ServiceDefinitionRef>
Service definition reference which should be defined in ServiceDefinitionList.
O
<OrderFlightAssociations>
Associating Service Definition Ref to the Ordered Flight.
O
<PaxSegmentRef>
M
<PaxSegmentRefID>
Reference to a Passenger SegmentID
M
<ServiceDefinitionRefID>
Reference of Service ID that defines the Service information Example: Ticketed Baggage Allowance
M
<PaxRefID>
Pax referenceID
Alphanumeric
M
<ServiceID>
Unique Service Identifier
Alphanumeric
M
<ServiceRefID>
Flight Service RefID that refers to a flight segment to which the baggage is associated with.
Alphanumeric
O
<StatusCode>
Status of the Order Service Status instance
Note:
  • Confirmed
  • Requested
  • Waitlisted
  • Cancelled
Alphanumeric
O
<StatusCode>
Status of the Order Item Status instance.
String
O
<StatusCode>
Status of the Order Item Status instance.
String
O
<Service>
  <BookingRef>
    <BookingEntity>
      <Carrier>
        <AirlineDesigCode>VS</AirlineDesigCode>
      </Carrier>
    </BookingEntity>
    <BookingID>EWYDWQ</BookingID>
  </BookingRef>
  <OrderServiceAssociation>
    <PaxSegmentRef>
      <PaxSegmentRefID>SEG1</PaxSegmentRefID>
    </PaxSegmentRef>
  </OrderServiceAssociation>
  <PaxRefID>ADULT_1</PaxRefID>
  <ServiceID>SV1</ServiceID>
  <StatusCode>CONFIRMED</StatusCode>
</Service>
 
<OwnerCode>
XML Snippet
Element
Details
DataType
M/O/C
<OwnerCode>
Current implementation always returns 'VS'
Char(2)
M
<OwnerCode>VS</OwnerCode>
 
<TotalPrice>
XML Snippet
Element
Details
DataType
M/O/C
<TotalPrice>
Order Price details. (All OrderItem total).
O
<TotalAmount>
Total price of all OrderItem(s). (includes taxes)
Decimal
O
CurCode attr
ISO 3 Chat currency code. Example: GBP, USD
Char(3)
O
<TotalPrice>
    <TotalAmount CurCode="GBP">1954.62</TotalAmount>
</TotalPrice>
 
<TicketDocInfo>
XML Snippet
Element
Details
DataType
M/O/C
<TicketDocInfo>
Ticket Information. Repeated per ETicket and EMD.
List [1..*]
O
<BookletQty>
Number of booklets issued for a given ticket/document set.
String
O
<IssueInfo>
Issuing carrier and issuing location of a ticket.
O
<IssueDate>
Date that the document was originally issued.
DateType YYY-MM-DD
O
<IssuingCarrier>
Carrier information
M
<AirlineDesigCode>
AirlineCode Associated to the carrier.
Note: Note: Current implementation always returns "VS"
Alphanumeric
M
<PaxRefID>
Reference to the PaxID
Alphanumeric
M
<OriginalIssueInfo>
For OrderChange – Confirm change booking only
Originally issued Ticket and carrier information.
O
<IssueDate>
For OrderChange – Confirm change booking only
Date that the document was originally issued.
DateType YYY-MM-DD
O
<IssueCarrier>
For OrderChange – Confirm change booking only
Carrier Information.
M
<AirlineDesigCode>
For OrderChange – Confirm change booking only
AirlineCode Associated to the carrier Eg: VS as per the current implementation.
Alphanumeric
M
<TicketNumber>
For OrderChange – Confirm change booking only
Original Ticket Number.
Integer
O
<PaxRefID>
Reference to the PaxID
Alphanumeric
M
<PaymentRefID>
References a payment transaction.
List[1...*]
O
<Ticket>
Ticket/EMD Number. The accountable document issued by or on behalf of a carrier which includes flight and passenger coupons.
O
<Coupon>
A reference to the passenger journey(s) to which the Baggage Allowance is associated. Part of the Passenger Ticket and Baggage Ticket that indicates particular places between which the coupon is good for carriage.
M
<CouponNumber>
ETicket or EMD coupon number
Decimal
M
<CouponStatusCode>
ETicket or EMD coupon status. Example: Open (OPE), Exchanged/ReIssued, and Refunded (RF)
Alphanumeric
O
<FareBasisCode>
FareBasisCode returned only for ETickets.
Alphanumeric
O
<PaxSegmentRefID>
Reference to PaxSegmentID
Alphanumeric
M
<PrimaryDocInd>
When TRUE, this is the primary ticket/document number.
Boolean
O
<ReportingTypeCode>
This is an ENUM with the following values. Example: Airline, ARC, BSP, and Not applicable.
Note: It should be Airline for Billing and settlement Purpose. The API will only return 'Airline' as currently only card payment is supported.
String
M
<TicketDocTypeCode>
Document type code as defined by PADIS 1001(eg: T for Ticket, J for EMD-A)
Alphanumeric
O
<TicketNumber>
Flight/EMD Ticket Number
Integer
O
<SoldAirlineInfo>
Reference to PaxSegment information.
O
<TicketDocInfo>
         <BookletQty>1</BookletQty>
         <IssueInfo>
            <IssueDate>2022-11-15</IssueDate>
            <IssuingCarrier>
               <AirlineDesigCode>VS</AirlineDesigCode>
            </IssuingCarrier>
         </IssueInfo>
         <PaxRefID>ADULT_1</PaxRefID>
         <Ticket>
            <Coupon>
               <CouponNumber>1</CouponNumber>
               <CouponStatusCode>OPE</CouponStatusCode>
               <FareBasisCode>OL10CCSB</FareBasisCode>
               <SoldAirlineInfo>
                  <PaxSegmentRefID>SEG1</PaxSegmentRefID>
               </SoldAirlineInfo>
            </Coupon>
            <Coupon>
               <CouponNumber>2</CouponNumber>
               <CouponStatusCode>OPE</CouponStatusCode>
               <FareBasisCode>OL10CCSB</FareBasisCode>
               <SoldAirlineInfo>
                  <PaxSegmentRefID>SEG2</PaxSegmentRefID>
               </SoldAirlineInfo>
            </Coupon>
            <ReportingTypeCode>Airline</ReportingTypeCode>
            <TicketDocTypeCode>T</TicketDocTypeCode>
            <TicketNumber>9321490903509</TicketNumber>
         </Ticket>
      </TicketDocInfo>
      <TicketDocInfo>
         <BookletQty>1</BookletQty>
         <IssueInfo>
            <IssueDate>2022-11-15</IssueDate>
            <IssuingCarrier>
               <AirlineDesigCode>VS</AirlineDesigCode>
            </IssuingCarrier>
         </IssueInfo>
         <PaxRefID>CHILD_1</PaxRefID>
         <Ticket>
            <Coupon>
               <CouponNumber>1</CouponNumber>
               <CouponStatusCode>OPE</CouponStatusCode>
               <FareBasisCode>OL10CCSB/CH</FareBasisCode>
               <SoldAirlineInfo>
                  <PaxSegmentRefID>SEG1</PaxSegmentRefID>
               </SoldAirlineInfo>
            </Coupon>
            <Coupon>
               <CouponNumber>2</CouponNumber>
               <CouponStatusCode>OPE</CouponStatusCode>
               <FareBasisCode>OL10CCSB/CH</FareBasisCode>
               <SoldAirlineInfo>
                  <PaxSegmentRefID>SEG2</PaxSegmentRefID>
               </SoldAirlineInfo>
            </Coupon>
            <ReportingTypeCode>Airline</ReportingTypeCode>
            <TicketDocTypeCode>T</TicketDocTypeCode>
            <TicketNumber>9321490903511</TicketNumber>
         </Ticket>
      </TicketDocInfo>
      <TicketDocInfo>
         <BookletQty>1</BookletQty>
         <IssueInfo>
            <IssueDate>2022-11-15</IssueDate>
            <IssuingCarrier>
               <AirlineDesigCode>VS</AirlineDesigCode>
            </IssuingCarrier>
         </IssueInfo>
         <PaxRefID>YOUTH_1</PaxRefID>
         <Ticket>
            <Coupon>
               <CouponNumber>1</CouponNumber>
               <CouponStatusCode>OPE</CouponStatusCode>
               <FareBasisCode>OL10CCSB/YP</FareBasisCode>
               <SoldAirlineInfo>
                  <PaxSegmentRefID>SEG1</PaxSegmentRefID>
               </SoldAirlineInfo>
            </Coupon>
            <Coupon>
               <CouponNumber>2</CouponNumber>
               <CouponStatusCode>OPE</CouponStatusCode>
               <FareBasisCode>OL10CCSB/YP</FareBasisCode>
               <SoldAirlineInfo>
                  <PaxSegmentRefID>SEG2</PaxSegmentRefID>
               </SoldAirlineInfo>
            </Coupon>
            <ReportingTypeCode>Airline</ReportingTypeCode>
            <TicketDocTypeCode>T</TicketDocTypeCode>
            <TicketNumber>9321490903510</TicketNumber>
         </Ticket>
</TicketDocInfo>
 
<PaymentFunctions>
Element
Details
DataType
M/O/C
<PaymentFunctions>
Information related to the payment.
O
<OrderAssociation>
Reference to an Order or Order Items.
O
<OrderitemRefID>
Reference to the list of Order Item IDs.
List[1...*]
O
<OrderRefID>
Reference to an Order ID for which this payment method applies.
String
M
<PaymentProcessingSummary>
Information relating to a payment transaction.
O
<Amount>
The amount applied to the associated payment method.
Decimal
M
CurCode attr
ISO 3 char Currency code.
Note: Example: GBP, USD.
Char(3)
M
<PaymentID>
Uniquely identifies payment information within a message.
String
M
<PaymentProcessingSummaryPaymentMethod>
Details of the payment method.
M
<PaymentCode>
Details of the Payment Card.
M
<CardBrandCode>
A two-letter code assigned according to IATA Resolution 728.
Note: Example: VI - Visa.
Char(2)
O
<ExpirationDate>
The last month of validity Example: 0119.
String
O
<MaskedCardID>
Concealed credit card number.
String
O
<CardBrandCode> attr
A two-letter code assigned according to IATA Resolution 728. Example: VI - Visa.
Char(2)
O
 
<CommonTypes>
Element
Details
DataType
M/O/C
<Warning>
Contains information of potential business errors detected during request processing.
List [0..*]
O
<Error>
Error information (more than one error will be returned by repeating error),
List [1..*]
M
 
   

Loading...

Loading...