0% found this document useful (0 votes)
16 views

Order API

The document describes the CreateOrderRQ and OrderViewRS messages used in flight booking. CreateOrderRQ includes details for submitting a booking request, while OrderViewRS provides the response with order details like ID, status, payments if the request was successful.

Uploaded by

Panos Koukios
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
16 views

Order API

The document describes the CreateOrderRQ and OrderViewRS messages used in flight booking. CreateOrderRQ includes details for submitting a booking request, while OrderViewRS provides the response with order details like ID, status, payments if the request was successful.

Uploaded by

Panos Koukios
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
You are on page 1/ 17

CreateOrderRQ

CreateOrderRQ Description

payloadAttributes.correlati The correlationId as returned by a previous


onId viewShoppingCartRS.
When a request message includes an echo
payloadAttributes.echoTo
token, the corresponding response message
ken
will include the same echo token.
authenticatedSenders. An agreed senderId that must be present in
authenticatedSenderId all the requests.
authenticatedSenders.
messageSender.pos.device IP address of the customer (IPV4).
.ipAddress
authenticatedSenders.
messageSender.pos.posCo Customer’s country code.
untry
authenticatedSenders.
messageSender.pos.posLa Language code. Values: “en-US”, “es-ES”
nguage
authenticatedSenders. Specifies the airline that this customer is a
messageSender.iataNumbe loyalty member of; 2-character IATA
r airline code, e.g. “BA”
authenticatedSenders.mess Specifies the device that the request was
ageSender. sent from. Values:
pos.device.deviceName
• AGENT_TERMINAL
• WEB_BROWSER
• AIRPORT_KIOSK
• MOBILE_WEB
• MOBILE_APP
• OTHER
• UNKNOWN
The selected offers (array) from the
selectedCartOffers
shopping cart.
selectedCartOffers.bundle The bundleSelectionId of the offer from
SelectionId the viewShoppingCartRS.
selectedCartOffers.selecte The selected price option for the offer
dOption from the viewShoppingCartRS.
selectedCartOffers.selectio Array of objects to specify the groups of
nGroup travelers.
Array of strings to specify the travelers of
selectedCartOffers.selectio this group.
nGroup. shopperRef Refers to travelers in the paxList.personId
within ths message.
Array of objects to define the travelers.
Apart from the personId, ptc, familyName
and firstName fields that are mandatory for
paxList all travelers, the rest of the fields specified
as mandatory should be present only for
the person that creates the booking (as
indicated by the primaryInd).
An identifier for a particular traveler. Must
paxList.personId
be unique inside a request message.
The PTC of the traveler. E.g. ADT, CHD,
paxList.ptc
INF
paxList.familyName Last name of the traveler.
paxList.firstName First name of the traveler. One item is
expected for ancillaries.
paxList.dateOfBirth.
The date of birth of the person
formattedDateTime
paxList.nameTitle The title of the person
paxList.phone Phone details
Country code for the phone number.
paxList.phone.countryCod
Should not include the leading ‘+’
e
character.
paxList.phone.phoneNumb Phone number
er
paxList.address Address details..
paxList.address.streetAddr
Street addresses array
ess
paxList.address.cityName City name
paxList.address.zipCode Zip or postal code
paxList.address.countryCo
Country code
de
paxList.address.stateOrPro
State or province
vince
paxList.email.emailAddres
Email address
s
Indicates if this is the traveler that creates
paxList.primaryInd the booking. One traveler is required to
contain this field with a “true” value.
Payments Array of payment objects. One payment
object is expected, when paying with
loyalty points. One payment object is
expected for card payments.

OrderViewRS
The table covers the OrderViewRS for flights

Flights Description
OrderViewRS OrderViewRS

payloadAttributes.correlati End-to-end correlation of


onId application logs
payloadAttributes.message
Timestamp of the response
Datetime.
message
formattedDateTime
When a request message
includes an echo token, the
payloadAttributes.echoTok
corresponding response
en
message will include the
same echo token.
order Details of the created order
Unique OrderID, e.g.
order.orderID
"BAIAGLPCNYU4QY"
order.recipients Recipient details
order.recipients.authenticat
The senderId of the request
edSenderId
Details of the message
order.recipients.messageSe
sender as provided in the
nder
request
order.recipients.messageSe The customer’s IP address
nder. pos.device.ipAddress as provided in the request
order.recipients.messageSe Currency code as provided
nder. pos.posCurrency in the request
order.recipients.messageSe Airline code as provided in
nder. pos.iataNumber the request
Timestamp of the creation
order.creationDate.formatte order.creatio
time of the order, e.g.
dDateTime nDateTime
"2021-06-23T20:27:04"
order.status Status of the order. Values:
 "OPENED" - order is
created on OMS side;
no communication
has taken place to
create a reservation
 "HELD" - book and
hold; order and
reservation have been
created, no payment
has been authorized
 "CONFIRMED" -
order and reservation
have been created. All
order items with a
confirmed status have
been fully paid.
Cancelled or pending
order items may exist
 "FAILED" - order
exists but reservation
has failed, booking
ref does not exist
 "CANCELLED" -
order and reservation
have been cancelled
 "SUSPENDED" -
when a cancellation
was requested, but the
outcome is unknown
 "CLOSED" - when
all the items of an
order have been
consumed (reached a
“final” service status)
The total price of the order.
The Price object is defined
in the individual objects
below (ref Error: Reference
order.totalPr source not found). Relevant
order.orderTotal
ice fields for this message:
totalAmount,
loyaltyAmount,
earnedPoints
Array of payment objects.
Each Payment object is
order.payments defined in the individual
objects below (ref Error:
Reference source not
found)
personalOrder Array of items. Each
contains the items that a
person purchases. Each
order should contain at
least one personalOrder.
response.dat Array of objects to define
personalOrder.person alists. the travelers.
paxList
Array of objects to define
the ordered items of this
traveler.
personalOrder.bundle
Each Bundle object is
defined in the individual
objects below (ref Bundle)
ticketDocInf
ticketList
o
ticketList.ticketNbr ticketDocInf
o.ticket.ticke
tNumber
ticketList.type ticketDocInf
o.ticket.repo
rtingTypeCo
de
ticketList.numberOfBoklet
s
ticketList.dateOfIssue ticketDocInf
o.
issueInfo.iss
ueDate
ticketList.issueAirline ticketDocInf
o.issueInfo.i
ssuingCarrie
r.airlineDesi
gCode
ticketList.issueLocation.co ticketDocInf
de o.
issueInfo.iat
aLocationCo
de
ticketList.coupons.fareBasi ticketDocInf
sCode o.coupon.far
eBasisCode
ticketList.coupons.status ticketDocInf
o.coupon.co
uponStatusC
ode
ticketList.coupons.segment ticketDocInf
Ref o.coupon.ser
viceRefID
ticketList.coupons.validity ticketDocInf
Start o.coupon.co
uponValidit
yPeriod.effe
ctiveDate
ticketList.coupons.validity ticketDocInf
End o.coupon.co
uponValidit
yPeriod.expi
rationDate
ticketList.personRef ticketDocInf
o.paxRefID
ticketDocInf
o.bookingRe
f
ticketList.totalTicketPrice ticketDocInf
o.coupon.val
ueAmount
The vendor’s id.
vendors.vendorId

The vendor’s name.


vendors.vendorName

Bundle
Bundle IAGL OrderViewRS Description

Unique identifier of this order


bundleId
item; unique within the order
References to the vendor of this
response.order.orde order item.
vendorRef
rItem.ownerCode  For Flights, BA or EI

References to the respective


recommendationR
recommendationId of the
ef
shopping response
Contains the details of the
ordered service. The array will
serviceItem
always contain one single item
for ancillaries.
serviceItem.servic Unique identifier of this service
eId instance; unique within the order
serviceItem.servic Specifies the type of the service:
eType “Air”
The status of this service. Values:
 "READY TO PROCEED" -
when the service is created
(that is the booking is
created to the vendor)
response.order.orde  "REMOVED" - when the
serviceItem.deliver
rItem.service. service is cancelled
yStatus
deliveryStatusCode  "SUSPENDED" - when
cancellation of the service
was requested, but the
outcome is unknown
 "DELIVERED" -when the
service is consumed
Contains the booking reference of
serviceItem.bookin the external system. The array
gReference will always contain one single
item for ancillaries.
serviceItem.bookin
response.order.orde The booking identifier in the
gReference.
rID external system
recordLocator
serviceItem.bookin response.order.own
Identifier of the external system
gReference. source erCode
serviceItem.flightS response.order.serv Trip details pertaining to this
egment ice.orderServiceAs ServiceItem.
sociation.paxSegm
entRef ->
datalists.paxSegme
ntList.paxSegment
response.order.orde
serviceItem.flightS
rItem.fareDetail.far
egment.flightLeg.a
eComponent.cabin
ircraftCabin.cabin
Type.cabinTypeCo
Code
de
response.order.orde
serviceItem.flightS
rItem.fareDetail.far
egment.flightLeg.a
eComponent.cabin
ircraftCabin.cabin
Type.cabinTypeNa
Name
me
response.order.orde
serviceItem.flightS
rItem.fareDetail.far
egment.flightLeg.a
eComponent.rbd.rb
ircraftCabin.rbd
dCode
The price applicability details.
response.order.orde
priceDetail The array will always contain one
rItem.price
single item for flights.
priceDetail.priceA Unique Price Applicability Id
pplicabilityId within the same message
Reference to the serviceId within
priceDetail.service this bundle. The array should
Ref contain the flight services along
with the included baggages.
priceDetail.passen Individual price for a person or a
gerPrice group of persons.
priceDetail.passen response.order.orde
gerPrice.
rItem.fareDetail.far
FareBasisCodeAss
eComponent.fareba
ociation.
sisCode
fareBasisCode
priceDetail.
Unique Group Price Id within an
passengerPrice.gro
offer
upPriceId
References to a person object
priceDetail. response.order.orde
defined either as an individual
passengerPrice.per rItem.service.paxR
person or within the
sonRefs efID
personsInGroup. Array of items.
priceDetail. response.order.orde
Price information for the group.
passengerPrice.pri rItem.fareCompone
Array of items.
ce nt.price
response.order.orde
priceDetail.packag
rItem.fareCompone
eTotalPrice
nt.price
expiration

Internal Mapping
Create an aerostream order based on shoppingCartRS
ShoppingCartRS OrderViewRS

shoppingCart.selectedOffers.trip.travelers order. personalOrder. person


shoppingCart.selectedOffers. order. personalOrder.bundle.serviceItem

serviceList
shoppingCart.selectedOffers.bu order. personalOrder.bundle.priceDetail

ndleBreakdown. priceDetail.
shoppingCart.selectedOffers. order. flightSectors
serviceList.flightSector
shoppingCart. cartTotal order. orderTotal
shoppingCart.selectedOffers. bundleId personalOrder.bundle.priceDetail.passengerPrice.offerRefs.
referenceText -> create one with referenceType=OfferId
shoppingCart.selectedOffers.bu
ndleBreakdown.
priceDetail.passengerPrice. personalOrder.bundle.priceDetail.passengerPrice.offerRefs.
groupPriceId referenceText -> create one with referenceType=OfferItemId

Send a request to IAGL for orderCreate


DM - orderViewRS Flights OrderCreateRQ

request.createOrder.
personalOrder.bundle.priceDetail.passengerPrice.offerRefs.
acceptSelectedQuotedOfferList
referenceText -> the one with referenceType=OfferId .
selectedPricedOffer.offerRefID
request.createOrder.
acceptSelectedQuotedOfferList
personalOrder.bundle.priceDetail.passengerPrice.offerRefs. . selectedPricedOffer.
referenceText -> the one with referenceType=OfferItemId
selectedOfferItem.
offerItemRefID
request.createOrder.
personalOrder.bundle.priceDetail.passen acceptSelectedQuotedOfferList
gerPrice. personRefs . selectedPricedOffer.
selectedOfferItem. paxRefID

Map IAGL’s orderViewRS to our orderViewRS


DM OrderViewRS Flights OrderViewRS

order.creationDate.formatte
order.creationDateTime
dDateTime
order.personalorder.bundle. order.orderId
serviceItem.
bookingReference.
recordLocator with
“bookingReference.source
=NDC”
order.personalorder.bundle. order.ownerCode
serviceItem.
bookingReference.
airlinecode
order.personalorder.bundle. ticketDocInfo.bookingRef. bookingID
serviceItem.
bookingReference.
recordLocator with
“bookingReference.source
=PSS”
order.personalOrder.bundle.
serviceItem. actionStatus (existing order.service. statusCode
services)
order.personalOrder.bundle.
serviceItem. deliveryStatus (existing order.service. deliveryStatusCode
services)
order.personalOrder.bundle.
order.service.orderServiceAssociation.seatOnLeg.seat.colu
serviceItem.seat.column
mnID
order.personalOrder.bundle.
serviceItem.seat.row order.service.orderServiceAssociation.seatOnLeg.seat.rowN
umber

order.personalOrder.bundle.
order.service.orderServiceAssociation.seatOnLeg.
serviceItem.flightSegmentRef
seatAssignmentAssociations. paxSegmentRef.
paxSegmentRefID
order.personalOrder.bundle.
serviceItem.seat.status order.service.orderServiceAssociation.seatOnLeg.occupatio
nStatusCode

ticketList ticketDocInfo
ticketList.ticketNbr ticketDocInfo.ticket.ticketNumber
ticketList.type ticketDocInfo.ticket.reportingTypeCode
ticketList.numberOfBoklet
s
ticketList.dateOfIssue ticketDocInfo. issueInfo.issueDate
ticketList.issueAirline ticketDocInfo.issueInfo.issuingCarrier.air
lineDesigCode
ticketList.issueLocation.co ticketDocInfo.
de issueInfo.iataLocationCode
ticketList.coupons.fareBasi ticketDocInfo.coupon.fareBasisCode
sCode
ticketList.coupons.status ticketDocInfo.coupon.couponStatusCode
ticketList.coupons.segment ticketDocInfo.coupon.serviceRefID
Ref
ticketList.coupons.validity ticketDocInfo.coupon.couponValidityPeri
Start od.effectiveDate
ticketList.coupons.validity ticketDocInfo.coupon.couponValidityPeri
End od.expirationDate
ticketList.personRef ticketDocInfo.paxRefID
ticketList.totalTicketPrice ticketDocInfo.coupon.valueAmount
order.payments paymentFunctions

Map IAGL’s TravelOrderCreateRS to our TravelOrderCreateRS


DM Flights OrderViewRS

TravelOrderCreateRS
bundle.serviceItem. order.orderId
bookingReference.
recordLocator with
“bookingReference.source
=NDC”
bundle.serviceItem. order.ownerCode
bookingReference.
airlinecode
bundle.serviceItem. ticketDocInfo.bookingRef. bookingID
bookingReference.
recordLocator with
“bookingReference.source
=PSS”
bundle. serviceItem. actionStatus
order.service. statusCode
(existing services)
bundle. serviceItem. deliveryStatus
order.service. deliveryStatusCode
(existing services)
bundle. serviceItem.seat.column order.service.orderServiceAssociation.seatOnLeg.seat.colu
mnID
bundle. serviceItem.seat.row
order.service.orderServiceAssociation.seatOnLeg.seat.rowN
umber
bundle. serviceItem.flightSegmentRef order.service.orderServiceAssociation.seatOnLeg.
seatAssignmentAssociations. paxSegmentRef.
paxSegmentRefID
bundle. serviceItem.seat.status
order.service.orderServiceAssociation.seatOnLeg.occupatio
nStatusCode

tickets ticketDocInfo
tickets.ticketNbr ticketDocInfo.ticket.ticketNumber
tickets.type ticketDocInfo.ticket.reportingTypeCode
tickets.numberOfBoklets
tickets.dateOfIssue ticketDocInfo. issueInfo.issueDate
tickets.issueAirline ticketDocInfo.issueInfo.issuingCarrier.air
lineDesigCode
tickets.issueLocation.code ticketDocInfo.
issueInfo.iataLocationCode
tickets.coupons.fareBasisC ticketDocInfo.coupon.fareBasisCode
ode
tickets .coupons.status ticketDocInfo.coupon.couponStatusCode
tickets .coupons.segmentR ticketDocInfo.coupon.serviceRefID
ef
tickets.coupons.validityStar ticketDocInfo.coupon.couponValidityPeri
t od.effectiveDate
tickets.coupons.validityEnd ticketDocInfo.coupon.couponValidityPeri
od.expirationDate
tickets.personRef ticketDocInfo.paxRefID
tickets.totalTicketPrice ticketDocInfo.coupon.valueAmount

You might also like