Query (OrderCreate)

Owned by Alvaro Chaparro
Last updated: Apr 25, 2024
3 min read

NAME

DESCRIPTION

FORMAT

ALLOWED/POSSIBLE VALUES

<Query / Order>

Offer

Attribute

OfferID

Attribute

Owner

Attribute

ResponseID

 

Id of a returned offer

 

 

Airline code

 

 

Id of the response

 

Alphanumeric

 

 

Alphabetical

 

 

Alphanumeric

 

Any

 

 

Any

 

 

Any

Offer / OfferItem

Id for OfferItem

Alphanumeric

Any

Offer / OfferItem / PassengerRefs

Type of passenger

Alphanumeric

Type of Passengers

Offer / OfferItem / ALaCarteSelection / Quantity

Quantity of ancillaries

Mandatory for schema if "ALaCarteSelection" tag is indicated

Numeric

Any

Offer / OfferItem / ALaCarteSelection / SegmentID

Id for the segment that applies the ancillaries

Alphanumeric

Any

Offer / OfferItem / SeatSelection / Row

Row for the seat

Mandatory for schema if "SeatSelection" tag is indicated

Numeric

Any

Offer / OfferItem / Seat Selection / Column

Column for the seat

Mandatory for schema if "SeatSelection" tag is indicated

Alphabetical

Any

Offer / OfferItem / ServiceSelection

Id for the special service

NDC Mandatory for Special Needs selections.

Alphanumeric

Any

Offer / OfferItem / ServiceSelection / ServiceDefinitionID

Definition for the special service

Mandatory for schema if "ServiceSelection" tag is indicated

4 Alphabetical

Special Services

<Query / Payments / Payment>

Type

Payment Methods can vary depending on market and type of seller.

Please check here.

Alphabetical

  • CA (Cash)

  • CC (Credit Card)

  • MS (Voucher)

  • SF (ServiceFee)

--  This refers to Cash payment method  --

Method / Cash

Cash payment method.

Alphabetical

true

-- This refers to Credit Card method  – If Secure Payment applies additional info needed is defined below in 3DS INFO --

Method / PaymentCard

NDC Mandatory for 3DS and/or installments payment.

This is used to reference the associated 3DS info in PaymentCardSecureInfo ObjectKey, and/or the installment payment info in PaymentFormMetadata MetadataKey.

If both 3DS and installment payments are being used for the same Order, then the two references are included here together separated by a space.

Example:

<PaymentCard refs="KEY_3DS KEY_QUOTAS">

Alphanumeric

Any

Method / PaymentCard / CardType 

Type of credit card

Alphanumeric

1-6 characters

Method / PaymentCard / CardNumber

Number of credit card

Numeric

1-19 characters

Method / PaymentCard / SeriesCode

Series Code of credit card

Numeric

1-8 characters

Method / PaymentCard / CardHolderName

Card Holder Name

Alphanumeric

0-50 characters

Method / PaymentCard / CardHolderBillingAddress / Street

NDC Mandatory that at least one field has to be filled in inside "CardHolderBillingAddress" tag.

Alphanumeric

If tag is indicated once, only first 40 characters will be considered

If tag is indicated twice, only first 80 characters will be considered

Method / PaymentCard / CardHolderBillingAddress / CityName

City of the Billing Address of cardholder

NDC Mandatory that at least one field has to be filled in inside "CardHolderBillingAddress" tag.

Alphanumeric

Only first 50 characters will be considered

Method / PaymentCard / CardHolderBillingAddress / StateProv

State Prov. of the Billing Address of cardholder

NDC Mandatory that at least one field has to be filled in inside "CardHolderBillingAddress" tag.

Alphanumeric

1-40 characters

Method / PaymentCard / CardHolderBillingAddress / PostalCode

Postal Code of the Billing Address of cardholder

NDC Mandatory that at least one field has to be filled in inside "CardHolderBillingAddress" tag.

Alphanumeric

2-10 characters

Method / PaymentCard / CardHolderBillingAddress / CountryCode

Country Code of the Billing Address of cardholder

NDC Mandatory that at least one field has to be filled in inside "CardHolderBillingAddress" tag.

Alphabetical

2 characters

Method / PaymentCard / EffectiveExpireDate / Expiration

Effective expiration date of the credit card

Numeric

4 characters

-- This refers to Voucher payment method  --

Method / Voucher

Voucher payment method.

Alphabetical

true

Method / Voucher / Number 

Number of the voucher

Alphanumeric

any

-- This refers to Service Fee method  --

Method / Other / Remarks

References for all passengers of the order

Alphanumeric

any

Method / Other / Remarks / Remark

Service Fee payment method

Mandatory for schema if "Remarks" tag is indicated

Alphabetical

ServiceFee

Amount

Total amount of the offer

Numeric

Any

Payer / ContactInfoRefs

Reference for the payer info, that must be associated correctly in the XML below.

In Cash Payment Method is OPTIONAL

Alphanumeric

Any valid reference associated in the XML below.

<Query / BookingReferences / BookingReference>

ID

External reference ID

Mandatory for Sender External Reference

Alphabetical

XRef

OtherID

This attribute must contain the senders IATA Number and will be matched against the Senders IATANumber from TravelAgencySender

Mandatory for Sender External Reference

Numeric

7/8 Numbers

OtherID

Sender's external reference

Mandatory for Sender External Reference

Alphanumeric

Any (Strings exceeding 30 chars will be truncated)