Documentation
Preparing search index...
utils/SABRE/orderCreation.utils
jsonOrderCreateRQ
Function jsonOrderCreateRQ
jsonOrderCreateRQ
(
body
:
OrderCreatePayload
,
)
:
Promise
<
{
agency
?:
{
address
?:
{
city
?:
string
;
countryCode
?:
string
;
postalCode
?:
string
;
stateProvince
?:
string
;
street
?:
string
;
}
&
{
freeText
?:
string
;
name
?:
string
}
;
agencyCustomerNumber
?:
string
;
contactInfo
?:
{
emails
?:
string
[]
}
;
futureTicketingPolicy
?:
{
comment
?:
string
;
queueNumber
?:
string
;
ticketingDate
?:
string
;
ticketingPcc
?:
string
;
ticketingTime
?:
string
;
}
;
ticketingPolicy
?:
|
"TODAY"
|
"ALREADY_TICKETED"
|
"FUTURE_TICKETING"
|
"TICKETING_TIME_LIMIT"
;
ticketingTimeLimitPolicy
?:
{
airlineCode
?:
string
;
ticketingDate
?:
string
;
ticketingTime
?:
string
;
}
;
}
;
asynchronousUpdateWaitTime
:
number
;
car
?:
{
bookingKey
:
string
;
collectionAddress
?:
{
city
?:
string
;
countryCode
?:
string
;
postalCode
?:
string
;
stateProvince
?:
string
;
street
?:
string
;
}
;
collectionSite
?:
{
id
?:
string
;
name
?:
string
;
phone
?:
string
}
;
deliveryAddress
?:
{
city
?:
string
;
countryCode
?:
string
;
postalCode
?:
string
;
stateProvince
?:
string
;
street
?:
string
;
}
;
deliverySite
?:
{
id
?:
string
;
name
?:
string
;
phone
?:
string
}
;
emailIndex
?:
number
;
flightIndex
?:
number
;
formOfPayment
?:
number
;
paymentPolicy
?:
"DEPOSIT"
|
"GUARANTEE"
;
quantity
:
number
;
specialInstructions
?:
string
;
travelerIndex
?:
number
;
}
;
contactInfo
?:
{
emails
?:
string
[]
}
&
{
emergencyPhones
?:
string
[]
;
faxes
?:
string
[]
;
phones
?:
string
[]
;
}
;
errorHandlingPolicy
?:
(
|
"HALT_ON_ERROR"
|
"HALT_ON_INVALID_MINIMUM_CONNECTING_TIME_ERROR"
|
"DO_NOT_HALT_ON_FLIGHT_PRICING_ERROR"
|
"DO_NOT_HALT_ON_HOTEL_BOOKING_ERROR"
|
"DO_NOT_HALT_ON_ANCILLARY_BOOKING_ERROR"
|
"DO_NOT_HALT_ON_SEAT_BOOKING_ERROR"
|
"DO_NOT_HALT_ON_CAR_BOOKING_ERROR"
)
[]
;
flightDetails
?:
{
flightPricing
?:
{
priceComparisons
?:
{
amount
?:
string
;
comparisonType
:
|
"INCREASE_BY_AMOUNT"
|
"INCREASE_BY_PERCENT"
|
"DECREASE_BY_AMOUNT"
|
"DECREASE_BY_PERCENT"
;
desiredAmount
:
string
;
percent
?:
string
;
}
[]
;
qualifiers
?:
{
commissionAmount
?:
string
;
commissionPercentage
?:
string
;
endorsements
?:
{
description
?:
string
;
useOverride
?:
boolean
}
;
excludeFareFocusFares
?:
boolean
;
tourCode
?:
string
;
tourCodeOverrides
?:
|
"REPLACE_WITH_BT"
|
"REPLACE_WITH_IT"
|
"SUPPRESS_IT"
|
"SUPPRESS_IT_AND_FARE"
;
travelerIndices
?:
number
[]
;
validatingAirlineCode
?:
string
;
}
&
{
accountCode
?:
{
accountCodes
:
string
[]
;
forceAccountCodes
?:
boolean
;
}
;
adjustedSellingLevel
?:
{
ignore
?:
boolean
;
markDownAmount
?:
string
;
markUpAmount
?:
string
;
returnBreakdown
?:
boolean
;
}
;
baggageAllowance
?:
{
baggagePieces
?:
number
;
flightIndices
?:
number
[]
;
totalWeightInKilograms
?:
number
;
}
[]
;
brandedFares
?:
{
brandCode
:
string
;
flightIndices
?:
number
[]
}
[]
;
breakFareFlightIndices
?:
number
[]
;
cabinCode
?:
string
;
commissionContractNames
?:
string
[]
;
considerMultiTicket
?:
boolean
;
corporateFare
?:
{
corporateIds
:
string
[]
;
forceCorporateId
?:
boolean
}
;
currencyPricing
?:
string
;
exchangePenalties
?:
{
applicability
?:
"BEFORE_DEPARTURE"
|
"AFTER_DEPARTURE"
;
penaltyAmount
?:
{
amount
?:
string
}
;
restrictionType
:
|
"CHANGEABLE"
|
"REFUNDABLE"
|
"CHANGEABLE_AND_REFUNDABLE"
;
}
;
excludeBasicEconomyFares
?:
string
[]
;
exemptTaxes
?:
string
[]
;
flightIndices
?:
number
[]
;
forceConnectionFlightIndices
?:
number
[]
;
forceStopoverFlightIndices
?:
number
[]
;
hemisphereCode
?:
number
;
journeyCode
?:
number
;
netRemit
?:
{
cashValue
?:
{
amount
:
string
;
currencyCode
:
string
}
;
commercialAgreementReferenceCode
?:
string
;
creditValue
?:
{
amount
:
string
;
currencyCode
:
string
}
;
netRemitCode
?:
string
;
}
;
overrideTaxes
?:
{
amount
:
string
;
taxCode
:
string
}
[]
;
passengersPricing
?:
{
forcePassengerCode
?:
boolean
;
numberOfpassengers
?:
number
;
passengerCode
?:
string
;
}
[]
;
passengerStatus
?:
"RESIDENT"
|
"NATIONALITY"
|
"EMPLOYEE"
;
passengerStatusCountryCode
?:
string
;
payment
?:
{
amountOnSecondFormOfPayment
?:
string
;
primaryFormOfPayment
:
number
;
secondaryFormOfPayment
?:
number
;
}
;
priceWithTaxes
:
boolean
;
rebookLowestFares
?:
boolean
;
retailerRule
?:
{
forceQualifiers
?:
boolean
;
qualifiers
:
string
[]
}
;
settlementMethod
?:
string
;
sideTripFlightIndices
?:
number
[]
;
spanishIslandResidentDiscountCode
?:
string
;
spanishLargeFamilyDiscountLevel
?:
number
;
specificFares
?:
{
fareBasisCode
:
string
;
flightIndices
?:
number
[]
}
[]
;
useExcursionFare
?:
boolean
;
useNetFare
?:
boolean
;
usePrivateFare
?:
boolean
;
usePublicFare
?:
boolean
;
useRoundTheWorldFare
?:
boolean
;
}
;
}
[]
;
flights
?:
{
airlineCode
:
string
;
arrivalDate
?:
string
;
arrivalTime
?:
string
;
bookingClass
:
string
;
confirmationId
?:
string
;
departureDate
:
string
;
departureTime
:
string
;
flightNumber
:
number
;
flightStatusCode
:
string
;
fromAirportCode
:
string
;
isMarriageGroup
?:
boolean
;
seats
?:
{
areaPreferences
?:
(
|
"AISLE"
|
"BULKHEAD"
|
"FRONT"
|
"LEFT_SIDE"
|
"RIGHT_SIDE"
|
"TAIL"
|
"WINDOW"
)
[]
;
number
?:
string
;
travelerIndex
:
number
;
}
[]
;
source
?:
"LCC"
|
"ATPCO"
;
toAirportCode
:
string
;
}
[]
;
haltOnFlightStatusCodes
?:
(
"US"
|
"NO"
|
"NN"
|
"UC"
|
"UN"
|
"UU"
|
"LL"
|
"HL"
)
[]
;
retryBookingUnconfirmedFlights
?:
boolean
;
}
;
flightOffer
?:
{
offerId
:
string
;
selectedOfferItems
:
string
[]
}
;
hotel
?:
{
associatedFlightDetails
?:
{
arrivalAirlineCode
?:
string
;
arrivalFlightNumber
?:
number
;
arrivalTime
?:
string
;
departureAirlineCode
?:
string
;
departureFlightNumber
?:
number
;
departureTime
?:
string
;
}
;
bookingKey
:
string
;
corporateDiscountCode
?:
number
;
formOfPayment
?:
number
;
paymentPolicy
?:
"DEPOSIT"
|
"GUARANTEE"
|
"LATE"
;
rooms
?:
{
bedTypeCode
?:
number
;
isSmoking
:
boolean
;
physicalDisabilityCode
?:
number
;
roomExtras
?:
{
amount
?:
string
;
quantity
:
number
;
roomExtraType
:
number
;
}
[]
;
travelerIndices
?:
number
[]
;
}
[]
;
specialInstruction
?:
string
;
useCsl
:
boolean
;
}
;
notification
?:
{
email
?:
|
"DEFAULT"
|
"INVOICE"
|
"ETICKET"
|
"ETICKET_PDF"
|
"ITINERARY"
|
"ITINERARY_PDF"
;
queuePlacement
?:
{
futureQueuePlacementDate
?:
string
;
pcc
?:
string
;
prefatoryInstructionCode
:
number
;
queueName
?:
string
;
queueNumber
?:
number
;
}
[]
;
}
;
otherServices
?:
{
airlineCode
?:
string
;
chainCode
?:
string
;
serviceMessage
?:
string
;
travelerIndex
?:
number
;
vendorCode
?:
string
;
}
[]
;
payment
?:
{
billingAddress
?:
{
city
?:
string
;
countryCode
?:
string
;
postalCode
?:
string
;
stateProvince
?:
string
;
street
?:
string
;
}
&
{
freeText
?:
string
;
name
?:
string
}
;
formsOfPayment
?:
(
{
airlinePlanCode
?:
string
;
cardNumber
?:
string
;
cardSecurityCode
?:
string
;
cardTypeCode
?:
string
;
expiryDate
?:
string
;
extendedPayment
?:
number
;
installmentAmount
?:
string
;
miscellaneousCreditCode
?:
string
;
numberOfInstallments
?:
number
;
}
&
{
agencyAddress
?:
{
city
?:
string
;
countryCode
?:
string
;
postalCode
?:
string
;
stateProvince
?:
string
;
street
?:
string
;
}
&
{
freeText
?:
string
;
name
?:
string
}
;
agencyIataNumber
?:
string
;
authentications
?:
{
amount
?:
string
;
cardNumberCollectionCode
?:
string
;
channelCode
?:
string
;
currencyCode
?:
string
;
electronicCommerceIndicator
?:
string
;
exemptionTypeCode
?:
string
;
issueCode
?:
string
;
mandateTypeCode
?:
string
;
merchantName
?:
string
;
originalPaymentReference
?:
string
;
resultCode
?:
string
;
secureAuthenticationValue
?:
string
;
secureTransactionId
?:
string
;
tokenAuthenticationValue
?:
string
;
updatedDateTime
?:
string
;
verificationResultCode
?:
string
;
version
?:
string
;
}
[]
;
cardHolder
?:
{
address
?:
{
city
?:
string
;
countryCode
?:
string
;
postalCode
?:
string
;
stateProvince
?:
string
;
street
?:
string
;
}
;
email
?:
string
;
givenName
:
string
;
phone
?:
string
;
surname
:
string
;
}
;
companyAddress
?:
{
city
?:
string
;
countryCode
?:
string
;
postalCode
?:
string
;
stateProvince
?:
string
;
street
?:
string
;
}
&
{
freeText
?:
string
;
name
?:
string
}
;
corporateId
?:
string
;
docketDescription
?:
string
;
docketIssuingAgentInitials
?:
string
;
docketNumber
?:
string
;
docketPrefix
?:
string
;
governmentTravelRequestDescription
?:
string
;
invoiceDescription
?:
string
;
isAgencyPaymentCard
?:
boolean
;
manualApproval
?:
{
airlineCode
:
string
;
amount
:
string
;
code
:
string
;
currencyCode
:
string
;
expiryDateTime
:
string
;
requestDateTime
:
string
;
}
;
netBalance
?:
string
;
tripType
?:
|
"All"
|
"Unknown"
|
"Corporate/Business"
|
"Leisure"
|
"Emergency"
|
"Family"
|
"Group"
;
tripTypes
?:
(
|
"All"
|
"Unknown"
|
"Corporate/Business"
|
"Leisure"
|
"Emergency"
|
"Family"
|
"Group"
)
[]
;
type
:
|
"INVOICE"
|
"CORPORATE"
|
"PAYMENTCARD"
|
"CASH"
|
"CHECK"
|
"MISCELLANEOUS"
|
"INSTALLMENTS"
|
"VIRTUAL_CARD"
|
"AGENCY_NAME"
|
"AGENCY_IATA"
|
"COMPANY_NAME"
|
"VOUCHER"
|
"DOCKET"
|
"GOVERNMENT_TRAVEL_REQUEST"
;
useType
?:
|
"All"
|
"Other"
|
"Tour"
|
"Unknown"
|
"Ancillary"
|
"Hotel"
|
"Car"
|
"Cruise"
|
"Airline"
|
"Bus/Ground Transportation"
|
"Insurance"
|
"Low-Cost Carrier"
|
"Rail"
|
"Specialty Service"
|
"Interface Record"
;
useTypes
?:
(
|
"All"
|
"Other"
|
"Tour"
|
"Unknown"
|
"Ancillary"
|
"Hotel"
|
"Car"
|
"Cruise"
|
"Airline"
|
"Bus/Ground Transportation"
|
"Insurance"
|
"Low-Cost Carrier"
|
"Rail"
|
"Specialty Service"
|
"Interface Record"
)
[]
;
virtualCard
?:
{
agencyEmail
?:
string
;
customerAccountCode
?:
string
;
hotelFax
?:
string
;
hotelName
?:
string
;
rateAmount
?:
{
amount
:
string
;
currencyCode
:
string
}
;
roomDescription
?:
string
;
roomType
?:
string
;
virtualCardCharges
?:
string
[]
;
}
;
voucher
?:
{
billingNumber
?:
string
;
type
?:
string
}
;
}
)
[]
;
}
;
profiles
?:
{
domainId
:
string
;
filterId
?:
string
;
profileName
?:
string
;
profileTypeCode
:
string
;
uniqueId
?:
string
;
}
[]
;
receivedFrom
:
string
;
remarks
?:
(
{
alphaCode
?:
string
;
text
?:
string
;
type
?:
|
"INVOICE"
|
"ITINERARY"
|
"GENERAL"
|
"HISTORICAL"
|
"CLIENT_ADDRESS"
|
"ALPHA_CODED"
|
"DELIVERY_ADDRESS"
|
"HIDDEN"
|
"CORPORATE"
|
"FORM_OF_PAYMENT"
|
"PRINT_ON_TICKET"
|
"FILLER_STRIP"
|
"INTERFACE"
|
"QUEUE_PLACE"
;
}
&
{
queuePlacement
?:
{
futureQueuePlacementDate
?:
string
;
pcc
?:
string
;
prefatoryInstructionCode
:
number
;
queueName
?:
string
;
queueNumber
?:
number
;
}
;
}
)
[]
;
retentionEndDate
?:
string
;
retentionLabel
?:
string
;
targetPcc
?:
string
;
travelers
?:
{
age
?:
number
;
ancillaries
?:
{
airlineCode
:
string
;
basePrice
:
string
;
commercialName
?:
string
;
currencyCode
:
string
;
electronicMiscellaneousDocumentType
:
|
"ETICKET"
|
"STANDALONE"
|
"FLIGHT_COUPON_ASSOCIATED"
|
"STANDALONE_TICKET_ASSOCIATED"
|
"OTHER_THAN_EMD"
;
firstTravelDate
?:
string
;
flightApplicabilityType
?:
"Unknown"
|
"Single"
|
"Multiple"
;
flightIndices
:
number
[]
;
groupCode
:
string
;
lastTravelDate
?:
string
;
numberOfItems
:
number
;
purchaseDateTime
?:
string
;
reasonForIssuance
?:
|
"UNKNOWN"
|
"AIR_TRANSPORTATION"
|
"SURFACE_TRANSPORTATION_NON_AIR_SERVICES"
|
"BAGGAGE"
|
"FINANCIAL_IMPACT"
|
"AIRPORT_SERVICES"
|
"MERCHANDISE"
|
"INFLIGHT_SERVICES"
|
"INDIVIDUAL_AIRLINE_USE"
;
source
?:
"ATPCO"
|
"MERCHANDISING_MANAGER"
;
specialServiceIndex
?:
number
;
subcode
:
string
;
totalPrice
?:
string
;
vendorCode
?:
string
;
}
[]
;
birthDate
?:
string
;
emails
?:
string
[]
;
formOfPaymentIndices
?:
number
[]
;
gender
?:
|
"FEMALE"
|
"MALE"
|
"INFANT_FEMALE"
|
"INFANT_MALE"
|
"UNDISCLOSED"
|
"UNDEFINED"
;
givenName
?:
string
;
id
?:
string
;
identityDocuments
?:
{
birthDate
?:
string
;
documentNumber
?:
string
;
documentSubType
?:
"RUC"
|
"CUIT/CUIL"
|
"NIT"
;
documentType
:
|
"MILITARY"
|
"PASSPORT"
|
"VISA"
|
"SECURE_FLIGHT_PASSENGER_DATA"
|
"RESIDENCE_ADDRESS"
|
"DESTINATION_ADDRESS"
|
"KNOWN_TRAVELER_NUMBER"
|
"REDRESS_NUMBER"
|
"ALIEN_RESIDENT"
|
"PERMANENT_RESIDENT"
|
"FACILITATION_DOCUMENT"
|
"NATIONAL_ID_CARD"
|
"NEXUS_CARD"
|
"NATURALIZATION_CERTIFICATE"
|
"REFUGEE_REENTRY_PERMIT"
|
"BORDER_CROSSING_CARD"
|
"FISCAL_ID"
;
expiryDate
?:
string
;
flightIndices
?:
number
[]
;
gender
?:
|
"FEMALE"
|
"MALE"
|
"INFANT_FEMALE"
|
"INFANT_MALE"
|
"UNDISCLOSED"
|
"UNDEFINED"
;
givenName
?:
string
;
hostCountryCode
?:
string
;
isLapChildDocument
?:
boolean
;
isPrimaryDocumentHolder
?:
boolean
;
issueDate
?:
string
;
issuingCountryCode
?:
string
;
middleName
?:
string
;
placeOfBirth
?:
string
;
placeOfIssue
?:
string
;
residenceCountryCode
?:
string
;
residenceOrDestinationAddress
?:
{
city
?:
string
;
countryCode
?:
string
;
postalCode
?:
string
;
stateProvince
?:
string
;
street
?:
string
;
}
;
surname
?:
string
;
}
[]
;
loyaltyPrograms
?:
{
programNumber
:
string
;
programType
?:
|
"FREQUENT_FLYER"
|
"FREQUENT_RENTER"
|
"LOYALTY_ID"
|
"CORPORATE_LOYALTY_ID"
;
receiverCode
?:
string
;
supplierCode
?:
string
;
tierLevel
?:
number
;
}
[]
;
nameReferenceCode
?:
string
;
passengerCode
?:
string
;
phones
?:
{
label
?:
string
;
number
:
string
}
[]
;
specialServices
?:
{
code
:
string
;
flightIndices
?:
number
[]
;
message
?:
string
;
}
[]
;
surname
?:
string
;
}
[]
;
}
,
>
Parameters
body
:
OrderCreatePayload
Returns
Promise
<
{
agency
?:
{
address
?:
{
city
?:
string
;
countryCode
?:
string
;
postalCode
?:
string
;
stateProvince
?:
string
;
street
?:
string
;
}
&
{
freeText
?:
string
;
name
?:
string
}
;
agencyCustomerNumber
?:
string
;
contactInfo
?:
{
emails
?:
string
[]
}
;
futureTicketingPolicy
?:
{
comment
?:
string
;
queueNumber
?:
string
;
ticketingDate
?:
string
;
ticketingPcc
?:
string
;
ticketingTime
?:
string
;
}
;
ticketingPolicy
?:
|
"TODAY"
|
"ALREADY_TICKETED"
|
"FUTURE_TICKETING"
|
"TICKETING_TIME_LIMIT"
;
ticketingTimeLimitPolicy
?:
{
airlineCode
?:
string
;
ticketingDate
?:
string
;
ticketingTime
?:
string
;
}
;
}
;
asynchronousUpdateWaitTime
:
number
;
car
?:
{
bookingKey
:
string
;
collectionAddress
?:
{
city
?:
string
;
countryCode
?:
string
;
postalCode
?:
string
;
stateProvince
?:
string
;
street
?:
string
;
}
;
collectionSite
?:
{
id
?:
string
;
name
?:
string
;
phone
?:
string
}
;
deliveryAddress
?:
{
city
?:
string
;
countryCode
?:
string
;
postalCode
?:
string
;
stateProvince
?:
string
;
street
?:
string
;
}
;
deliverySite
?:
{
id
?:
string
;
name
?:
string
;
phone
?:
string
}
;
emailIndex
?:
number
;
flightIndex
?:
number
;
formOfPayment
?:
number
;
paymentPolicy
?:
"DEPOSIT"
|
"GUARANTEE"
;
quantity
:
number
;
specialInstructions
?:
string
;
travelerIndex
?:
number
;
}
;
contactInfo
?:
{
emails
?:
string
[]
}
&
{
emergencyPhones
?:
string
[]
;
faxes
?:
string
[]
;
phones
?:
string
[]
;
}
;
errorHandlingPolicy
?:
(
|
"HALT_ON_ERROR"
|
"HALT_ON_INVALID_MINIMUM_CONNECTING_TIME_ERROR"
|
"DO_NOT_HALT_ON_FLIGHT_PRICING_ERROR"
|
"DO_NOT_HALT_ON_HOTEL_BOOKING_ERROR"
|
"DO_NOT_HALT_ON_ANCILLARY_BOOKING_ERROR"
|
"DO_NOT_HALT_ON_SEAT_BOOKING_ERROR"
|
"DO_NOT_HALT_ON_CAR_BOOKING_ERROR"
)
[]
;
flightDetails
?:
{
flightPricing
?:
{
priceComparisons
?:
{
amount
?:
string
;
comparisonType
:
|
"INCREASE_BY_AMOUNT"
|
"INCREASE_BY_PERCENT"
|
"DECREASE_BY_AMOUNT"
|
"DECREASE_BY_PERCENT"
;
desiredAmount
:
string
;
percent
?:
string
;
}
[]
;
qualifiers
?:
{
commissionAmount
?:
string
;
commissionPercentage
?:
string
;
endorsements
?:
{
description
?:
string
;
useOverride
?:
boolean
}
;
excludeFareFocusFares
?:
boolean
;
tourCode
?:
string
;
tourCodeOverrides
?:
|
"REPLACE_WITH_BT"
|
"REPLACE_WITH_IT"
|
"SUPPRESS_IT"
|
"SUPPRESS_IT_AND_FARE"
;
travelerIndices
?:
number
[]
;
validatingAirlineCode
?:
string
;
}
&
{
accountCode
?:
{
accountCodes
:
string
[]
;
forceAccountCodes
?:
boolean
;
}
;
adjustedSellingLevel
?:
{
ignore
?:
boolean
;
markDownAmount
?:
string
;
markUpAmount
?:
string
;
returnBreakdown
?:
boolean
;
}
;
baggageAllowance
?:
{
baggagePieces
?:
number
;
flightIndices
?:
number
[]
;
totalWeightInKilograms
?:
number
;
}
[]
;
brandedFares
?:
{
brandCode
:
string
;
flightIndices
?:
number
[]
}
[]
;
breakFareFlightIndices
?:
number
[]
;
cabinCode
?:
string
;
commissionContractNames
?:
string
[]
;
considerMultiTicket
?:
boolean
;
corporateFare
?:
{
corporateIds
:
string
[]
;
forceCorporateId
?:
boolean
}
;
currencyPricing
?:
string
;
exchangePenalties
?:
{
applicability
?:
"BEFORE_DEPARTURE"
|
"AFTER_DEPARTURE"
;
penaltyAmount
?:
{
amount
?:
string
}
;
restrictionType
:
|
"CHANGEABLE"
|
"REFUNDABLE"
|
"CHANGEABLE_AND_REFUNDABLE"
;
}
;
excludeBasicEconomyFares
?:
string
[]
;
exemptTaxes
?:
string
[]
;
flightIndices
?:
number
[]
;
forceConnectionFlightIndices
?:
number
[]
;
forceStopoverFlightIndices
?:
number
[]
;
hemisphereCode
?:
number
;
journeyCode
?:
number
;
netRemit
?:
{
cashValue
?:
{
amount
:
string
;
currencyCode
:
string
}
;
commercialAgreementReferenceCode
?:
string
;
creditValue
?:
{
amount
:
string
;
currencyCode
:
string
}
;
netRemitCode
?:
string
;
}
;
overrideTaxes
?:
{
amount
:
string
;
taxCode
:
string
}
[]
;
passengersPricing
?:
{
forcePassengerCode
?:
boolean
;
numberOfpassengers
?:
number
;
passengerCode
?:
string
;
}
[]
;
passengerStatus
?:
"RESIDENT"
|
"NATIONALITY"
|
"EMPLOYEE"
;
passengerStatusCountryCode
?:
string
;
payment
?:
{
amountOnSecondFormOfPayment
?:
string
;
primaryFormOfPayment
:
number
;
secondaryFormOfPayment
?:
number
;
}
;
priceWithTaxes
:
boolean
;
rebookLowestFares
?:
boolean
;
retailerRule
?:
{
forceQualifiers
?:
boolean
;
qualifiers
:
string
[]
}
;
settlementMethod
?:
string
;
sideTripFlightIndices
?:
number
[]
;
spanishIslandResidentDiscountCode
?:
string
;
spanishLargeFamilyDiscountLevel
?:
number
;
specificFares
?:
{
fareBasisCode
:
string
;
flightIndices
?:
number
[]
}
[]
;
useExcursionFare
?:
boolean
;
useNetFare
?:
boolean
;
usePrivateFare
?:
boolean
;
usePublicFare
?:
boolean
;
useRoundTheWorldFare
?:
boolean
;
}
;
}
[]
;
flights
?:
{
airlineCode
:
string
;
arrivalDate
?:
string
;
arrivalTime
?:
string
;
bookingClass
:
string
;
confirmationId
?:
string
;
departureDate
:
string
;
departureTime
:
string
;
flightNumber
:
number
;
flightStatusCode
:
string
;
fromAirportCode
:
string
;
isMarriageGroup
?:
boolean
;
seats
?:
{
areaPreferences
?:
(
|
"AISLE"
|
"BULKHEAD"
|
"FRONT"
|
"LEFT_SIDE"
|
"RIGHT_SIDE"
|
"TAIL"
|
"WINDOW"
)
[]
;
number
?:
string
;
travelerIndex
:
number
;
}
[]
;
source
?:
"LCC"
|
"ATPCO"
;
toAirportCode
:
string
;
}
[]
;
haltOnFlightStatusCodes
?:
(
"US"
|
"NO"
|
"NN"
|
"UC"
|
"UN"
|
"UU"
|
"LL"
|
"HL"
)
[]
;
retryBookingUnconfirmedFlights
?:
boolean
;
}
;
flightOffer
?:
{
offerId
:
string
;
selectedOfferItems
:
string
[]
}
;
hotel
?:
{
associatedFlightDetails
?:
{
arrivalAirlineCode
?:
string
;
arrivalFlightNumber
?:
number
;
arrivalTime
?:
string
;
departureAirlineCode
?:
string
;
departureFlightNumber
?:
number
;
departureTime
?:
string
;
}
;
bookingKey
:
string
;
corporateDiscountCode
?:
number
;
formOfPayment
?:
number
;
paymentPolicy
?:
"DEPOSIT"
|
"GUARANTEE"
|
"LATE"
;
rooms
?:
{
bedTypeCode
?:
number
;
isSmoking
:
boolean
;
physicalDisabilityCode
?:
number
;
roomExtras
?:
{
amount
?:
string
;
quantity
:
number
;
roomExtraType
:
number
;
}
[]
;
travelerIndices
?:
number
[]
;
}
[]
;
specialInstruction
?:
string
;
useCsl
:
boolean
;
}
;
notification
?:
{
email
?:
|
"DEFAULT"
|
"INVOICE"
|
"ETICKET"
|
"ETICKET_PDF"
|
"ITINERARY"
|
"ITINERARY_PDF"
;
queuePlacement
?:
{
futureQueuePlacementDate
?:
string
;
pcc
?:
string
;
prefatoryInstructionCode
:
number
;
queueName
?:
string
;
queueNumber
?:
number
;
}
[]
;
}
;
otherServices
?:
{
airlineCode
?:
string
;
chainCode
?:
string
;
serviceMessage
?:
string
;
travelerIndex
?:
number
;
vendorCode
?:
string
;
}
[]
;
payment
?:
{
billingAddress
?:
{
city
?:
string
;
countryCode
?:
string
;
postalCode
?:
string
;
stateProvince
?:
string
;
street
?:
string
;
}
&
{
freeText
?:
string
;
name
?:
string
}
;
formsOfPayment
?:
(
{
airlinePlanCode
?:
string
;
cardNumber
?:
string
;
cardSecurityCode
?:
string
;
cardTypeCode
?:
string
;
expiryDate
?:
string
;
extendedPayment
?:
number
;
installmentAmount
?:
string
;
miscellaneousCreditCode
?:
string
;
numberOfInstallments
?:
number
;
}
&
{
agencyAddress
?:
{
city
?:
string
;
countryCode
?:
string
;
postalCode
?:
string
;
stateProvince
?:
string
;
street
?:
string
;
}
&
{
freeText
?:
string
;
name
?:
string
}
;
agencyIataNumber
?:
string
;
authentications
?:
{
amount
?:
string
;
cardNumberCollectionCode
?:
string
;
channelCode
?:
string
;
currencyCode
?:
string
;
electronicCommerceIndicator
?:
string
;
exemptionTypeCode
?:
string
;
issueCode
?:
string
;
mandateTypeCode
?:
string
;
merchantName
?:
string
;
originalPaymentReference
?:
string
;
resultCode
?:
string
;
secureAuthenticationValue
?:
string
;
secureTransactionId
?:
string
;
tokenAuthenticationValue
?:
string
;
updatedDateTime
?:
string
;
verificationResultCode
?:
string
;
version
?:
string
;
}
[]
;
cardHolder
?:
{
address
?:
{
city
?:
string
;
countryCode
?:
string
;
postalCode
?:
string
;
stateProvince
?:
string
;
street
?:
string
;
}
;
email
?:
string
;
givenName
:
string
;
phone
?:
string
;
surname
:
string
;
}
;
companyAddress
?:
{
city
?:
string
;
countryCode
?:
string
;
postalCode
?:
string
;
stateProvince
?:
string
;
street
?:
string
;
}
&
{
freeText
?:
string
;
name
?:
string
}
;
corporateId
?:
string
;
docketDescription
?:
string
;
docketIssuingAgentInitials
?:
string
;
docketNumber
?:
string
;
docketPrefix
?:
string
;
governmentTravelRequestDescription
?:
string
;
invoiceDescription
?:
string
;
isAgencyPaymentCard
?:
boolean
;
manualApproval
?:
{
airlineCode
:
string
;
amount
:
string
;
code
:
string
;
currencyCode
:
string
;
expiryDateTime
:
string
;
requestDateTime
:
string
;
}
;
netBalance
?:
string
;
tripType
?:
|
"All"
|
"Unknown"
|
"Corporate/Business"
|
"Leisure"
|
"Emergency"
|
"Family"
|
"Group"
;
tripTypes
?:
(
|
"All"
|
"Unknown"
|
"Corporate/Business"
|
"Leisure"
|
"Emergency"
|
"Family"
|
"Group"
)
[]
;
type
:
|
"INVOICE"
|
"CORPORATE"
|
"PAYMENTCARD"
|
"CASH"
|
"CHECK"
|
"MISCELLANEOUS"
|
"INSTALLMENTS"
|
"VIRTUAL_CARD"
|
"AGENCY_NAME"
|
"AGENCY_IATA"
|
"COMPANY_NAME"
|
"VOUCHER"
|
"DOCKET"
|
"GOVERNMENT_TRAVEL_REQUEST"
;
useType
?:
|
"All"
|
"Other"
|
"Tour"
|
"Unknown"
|
"Ancillary"
|
"Hotel"
|
"Car"
|
"Cruise"
|
"Airline"
|
"Bus/Ground Transportation"
|
"Insurance"
|
"Low-Cost Carrier"
|
"Rail"
|
"Specialty Service"
|
"Interface Record"
;
useTypes
?:
(
|
"All"
|
"Other"
|
"Tour"
|
"Unknown"
|
"Ancillary"
|
"Hotel"
|
"Car"
|
"Cruise"
|
"Airline"
|
"Bus/Ground Transportation"
|
"Insurance"
|
"Low-Cost Carrier"
|
"Rail"
|
"Specialty Service"
|
"Interface Record"
)
[]
;
virtualCard
?:
{
agencyEmail
?:
string
;
customerAccountCode
?:
string
;
hotelFax
?:
string
;
hotelName
?:
string
;
rateAmount
?:
{
amount
:
string
;
currencyCode
:
string
}
;
roomDescription
?:
string
;
roomType
?:
string
;
virtualCardCharges
?:
string
[]
;
}
;
voucher
?:
{
billingNumber
?:
string
;
type
?:
string
}
;
}
)
[]
;
}
;
profiles
?:
{
domainId
:
string
;
filterId
?:
string
;
profileName
?:
string
;
profileTypeCode
:
string
;
uniqueId
?:
string
;
}
[]
;
receivedFrom
:
string
;
remarks
?:
(
{
alphaCode
?:
string
;
text
?:
string
;
type
?:
|
"INVOICE"
|
"ITINERARY"
|
"GENERAL"
|
"HISTORICAL"
|
"CLIENT_ADDRESS"
|
"ALPHA_CODED"
|
"DELIVERY_ADDRESS"
|
"HIDDEN"
|
"CORPORATE"
|
"FORM_OF_PAYMENT"
|
"PRINT_ON_TICKET"
|
"FILLER_STRIP"
|
"INTERFACE"
|
"QUEUE_PLACE"
;
}
&
{
queuePlacement
?:
{
futureQueuePlacementDate
?:
string
;
pcc
?:
string
;
prefatoryInstructionCode
:
number
;
queueName
?:
string
;
queueNumber
?:
number
;
}
;
}
)
[]
;
retentionEndDate
?:
string
;
retentionLabel
?:
string
;
targetPcc
?:
string
;
travelers
?:
{
age
?:
number
;
ancillaries
?:
{
airlineCode
:
string
;
basePrice
:
string
;
commercialName
?:
string
;
currencyCode
:
string
;
electronicMiscellaneousDocumentType
:
|
"ETICKET"
|
"STANDALONE"
|
"FLIGHT_COUPON_ASSOCIATED"
|
"STANDALONE_TICKET_ASSOCIATED"
|
"OTHER_THAN_EMD"
;
firstTravelDate
?:
string
;
flightApplicabilityType
?:
"Unknown"
|
"Single"
|
"Multiple"
;
flightIndices
:
number
[]
;
groupCode
:
string
;
lastTravelDate
?:
string
;
numberOfItems
:
number
;
purchaseDateTime
?:
string
;
reasonForIssuance
?:
|
"UNKNOWN"
|
"AIR_TRANSPORTATION"
|
"SURFACE_TRANSPORTATION_NON_AIR_SERVICES"
|
"BAGGAGE"
|
"FINANCIAL_IMPACT"
|
"AIRPORT_SERVICES"
|
"MERCHANDISE"
|
"INFLIGHT_SERVICES"
|
"INDIVIDUAL_AIRLINE_USE"
;
source
?:
"ATPCO"
|
"MERCHANDISING_MANAGER"
;
specialServiceIndex
?:
number
;
subcode
:
string
;
totalPrice
?:
string
;
vendorCode
?:
string
;
}
[]
;
birthDate
?:
string
;
emails
?:
string
[]
;
formOfPaymentIndices
?:
number
[]
;
gender
?:
|
"FEMALE"
|
"MALE"
|
"INFANT_FEMALE"
|
"INFANT_MALE"
|
"UNDISCLOSED"
|
"UNDEFINED"
;
givenName
?:
string
;
id
?:
string
;
identityDocuments
?:
{
birthDate
?:
string
;
documentNumber
?:
string
;
documentSubType
?:
"RUC"
|
"CUIT/CUIL"
|
"NIT"
;
documentType
:
|
"MILITARY"
|
"PASSPORT"
|
"VISA"
|
"SECURE_FLIGHT_PASSENGER_DATA"
|
"RESIDENCE_ADDRESS"
|
"DESTINATION_ADDRESS"
|
"KNOWN_TRAVELER_NUMBER"
|
"REDRESS_NUMBER"
|
"ALIEN_RESIDENT"
|
"PERMANENT_RESIDENT"
|
"FACILITATION_DOCUMENT"
|
"NATIONAL_ID_CARD"
|
"NEXUS_CARD"
|
"NATURALIZATION_CERTIFICATE"
|
"REFUGEE_REENTRY_PERMIT"
|
"BORDER_CROSSING_CARD"
|
"FISCAL_ID"
;
expiryDate
?:
string
;
flightIndices
?:
number
[]
;
gender
?:
|
"FEMALE"
|
"MALE"
|
"INFANT_FEMALE"
|
"INFANT_MALE"
|
"UNDISCLOSED"
|
"UNDEFINED"
;
givenName
?:
string
;
hostCountryCode
?:
string
;
isLapChildDocument
?:
boolean
;
isPrimaryDocumentHolder
?:
boolean
;
issueDate
?:
string
;
issuingCountryCode
?:
string
;
middleName
?:
string
;
placeOfBirth
?:
string
;
placeOfIssue
?:
string
;
residenceCountryCode
?:
string
;
residenceOrDestinationAddress
?:
{
city
?:
string
;
countryCode
?:
string
;
postalCode
?:
string
;
stateProvince
?:
string
;
street
?:
string
;
}
;
surname
?:
string
;
}
[]
;
loyaltyPrograms
?:
{
programNumber
:
string
;
programType
?:
|
"FREQUENT_FLYER"
|
"FREQUENT_RENTER"
|
"LOYALTY_ID"
|
"CORPORATE_LOYALTY_ID"
;
receiverCode
?:
string
;
supplierCode
?:
string
;
tierLevel
?:
number
;
}
[]
;
nameReferenceCode
?:
string
;
passengerCode
?:
string
;
phones
?:
{
label
?:
string
;
number
:
string
}
[]
;
specialServices
?:
{
code
:
string
;
flightIndices
?:
number
[]
;
message
?:
string
;
}
[]
;
surname
?:
string
;
}
[]
;
}
,
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
Documentation
Loading...