Order Management Table of Contents
1. Overview ...... 1
1.1. Version information ...... 1
1.2. Contact information...... 1
1.3. URI scheme...... 1
2. Paths ...... 2
2.1. POST /orders/cancel ...... 2
2.1.1. Description ...... 2
2.1.2. Parameters ...... 2
2.1.3. Responses ...... 2
2.1.4. Produces ...... 2
2.1.5. Tags ...... 2
2.2. POST /orders/change ...... 2
2.2.1. Description ...... 2
2.2.2. Parameters ...... 2
2.2.3. Responses ...... 3
2.2.4. Tags ...... 3
2.3. POST /orders/change/voiddoc ...... 3
2.3.1. Description ...... 3
2.3.2. Parameters ...... 3
2.3.3. Responses ...... 3
2.3.4. Produces ...... 3
2.3.5. Tags ...... 4
2.4. POST /orders/create ...... 4
2.4.1. Description ...... 4
2.4.2. Parameters ...... 4
2.4.3. Responses ...... 4
2.4.4. Consumes ...... 4
2.4.5. Produces ...... 4
2.4.6. Tags ...... 4
2.5. POST /orders/fulfill ...... 4
2.5.1. Description ...... 4
2.5.2. Parameters ...... 5
2.5.3. Responses ...... 5
2.5.4. Tags ...... 5
2.6. POST /orders/view ...... 5
2.6.1. Description ...... 5 2.6.2. Parameters ...... 5
2.6.3. Responses ...... 5
2.6.4. Produces ...... 5
2.6.5. Tags ...... 6
3. Security ...... 7
3.1. oauth2_authentication ...... 7
4. Definitions ...... 8
4.1. Action ...... 8
4.2. AirSegment...... 8
4.3. AirSegmentInformation ...... 9
4.4. AmountCurrency ...... 9
4.5. BookingReference...... 9
4.6. Carrier ...... 10
4.7. CarrierFlightInfo ...... 10
4.8. CarrierInfo ...... 11
4.9. ContactInfo...... 11
4.10. ContactInformationUpdate ...... 11
4.11. CreateOrder ...... 12
4.12. CustomerNumber...... 12
4.13. EmailAddress ...... 13
4.14. EmailAddressAdd ...... 13
4.15. Error ...... 13
4.16. ExternalOrder ...... 13
4.17. ExternalReference ...... 14
4.18. FareComponent ...... 14
4.19. FareDetail ...... 15
4.20. FareRemark ...... 16
4.21. FeeDetails ...... 16
4.22. FeeWarning ...... 17
4.23. FulfillOrder ...... 17
4.24. GenderCode ...... 18
4.25. IdentityDocument ...... 18
4.26. IdentityDocumentAdd...... 19
4.27. IdentityDocumentDelete ...... 21
4.28. IdentityDocumentUpdate ...... 21
4.29. Journey ...... 23
4.30. Leg ...... 23
4.31. LoyaltyProgramAccount ...... 24 4.32. LoyaltyProgramAccountAdd ...... 24
4.33. LoyaltyProgramAccountDelete ...... 24
4.34. ManualPrice ...... 25
4.35. Order ...... 25
4.36. OrderCancelRequest ...... 27
4.37. OrderCancelResponse ...... 27
4.38. OrderChangeRequest ...... 27
4.39. OrderChangeResponse ...... 28
4.40. OrderCreateRequest ...... 29
4.41. OrderCreateResponse ...... 29
4.42. OrderFulfillRequest ...... 30
4.43. OrderFulfillResponse ...... 30
4.44. OrderItem ...... 30
4.45. OrderViewRequest ...... 31
4.46. OrderViewResponse ...... 32
4.47. OrderVoidRetainRequest ...... 32
4.48. OrderVoidRetainResponse ...... 32
4.49. Party ...... 33
4.50. PartySender ...... 33
4.51. PartyTravelAgency ...... 33
4.52. Passenger ...... 33
4.53. PaymentCash ...... 34
4.54. PaymentCreditCard ...... 35
4.55. PaymentInfo ...... 35
4.56. PaymentMethod ...... 36
4.57. Phone ...... 36
4.58. PhoneAdd ...... 36
4.59. Price...... 37
4.60. PriceClass ...... 37
4.61. Product ...... 38
4.62. ProductTextDetailsItem ...... 38
4.63. Remark ...... 38
4.64. RequestType ...... 38
4.65. SeatAdd ...... 38
4.66. SeatDelete...... 39
4.67. Segment ...... 39
4.68. SelectedOfferItem ...... 40
4.69. SelectedSeat ...... 40 4.70. Service...... 41
4.71. ServiceAdd ...... 41
4.72. Tax ...... 42
4.73. TaxItem ...... 42
4.74. TicketingDocument ...... 43
4.75. TicketingDocumentCoupon ...... 43
4.76. TicketingDocumentInfo ...... 44
4.77. TransactionOptions ...... 45
4.78. Transport ...... 45
4.79. Warning ...... 46 Chapter 1. Overview
The Order Management is used to create, change, cancel and view the content of a specified airline order.
1.1. Version information
Version : v1
1.2. Contact information
Contact : Contact Us
1.3. URI scheme
Host : api-crt.cert.havail.sabre.com BasePath : /v1 Schemes : HTTPS
1 Chapter 2. Paths
2.1. POST /orders/cancel
2.1.1. Description
Cancels a specified order, and returns confirmation of the cancellation.
2.1.2. Parameters
Type Name Description Schema
orderCancelR Body equest Cancels a specified order. OrderCancelRequest optional
2.1.3. Responses
HTTP Description Schema Code
OrderCancelRespo 200 Success nse
400 Bad Request No Content
2.1.4. Produces
• application/json
2.1.5. Tags
• Cancel Order
2.2. POST /orders/change
2.2.1. Description
Modifies the elements of an order such as pax data, books the seats, fulfills the order.
2.2.2. Parameters
2 Type Name Description Schema
orderChangeR Body equest Modifies the elements of an order. OrderChangeRequest optional
2.2.3. Responses
HTTP Description Schema Code
OrderChangeRespo 200 Success nse
400 Bad Request No Content
2.2.4. Tags
• Change Order
2.3. POST /orders/change/voiddoc
2.3.1. Description
Voids retain a specified order, and returns confirmation.
2.3.2. Parameters
Type Name Description Schema
orderVoidRet OrderVoidRetainReq Body ainRequest Voids retain specified order. uest optional
2.3.3. Responses
HTTP Description Schema Code
OrderVoidRetainRe 200 Success sponse
400 Bad Request No Content
2.3.4. Produces
• application/json
3 2.3.5. Tags
• Void retain Order
2.4. POST /orders/create
2.4.1. Description
Creates an order.
2.4.2. Parameters
Type Name Description Schema
orderCreateR Body equest Creates an order. OrderCreateRequest optional
2.4.3. Responses
HTTP Description Schema Code
OrderCreateRespo 200 Success nse
400 Bad Request No Content
2.4.4. Consumes
• application/json
2.4.5. Produces
• application/json
2.4.6. Tags
• Create Order
2.5. POST /orders/fulfill
2.5.1. Description
[DEPRECATED] Fulfills an order.
4 2.5.2. Parameters
Type Name Schema
orderFulfillRequest Body OrderFulfillRequest optional
2.5.3. Responses
HTTP Description Schema Code
OrderFulfillRespon 200 Success se
400 Bad Request No Content
2.5.4. Tags
• Fulfill Order
2.6. POST /orders/view
2.6.1. Description
Views a single order.
2.6.2. Parameters
Type Name Description Schema
OrderViewRe Body quest Views a specified order by ID. OrderViewRequest optional
2.6.3. Responses
HTTP Description Schema Code
OrderViewRespons 200 Success e
2.6.4. Produces
• application/json
5 2.6.5. Tags
• View Order
6 Chapter 3. Security
3.1. oauth2_authentication
Type : oauth2 Flow : application Token URL : https://api-crt.cert.havail.sabre.com/v2/auth/token
Name Description
oauth2 oauth2
7 Chapter 4. Definitions
4.1. Action
Contains actions to execute.
Name Description Schema
fulfillOrder FulfillOrder optional
id The unique identifier of the action. string required Example : "12"
4.2. AirSegment
Contains details of the flight segment.
Name Description Schema
actionCode Action code. string optional Example : "HK"
arrivalAirport The three-letter IATA arrival airport code. string optional Example : "NYC"
arrivalDateTi The scheduled date and time of arrival. me string(date-time) Example : "2019-03-28T012:30:00" optional
departureAir The three-letter IATA departure airport code. port string Example : "LAX" optional
departureDat The scheduled date and time of departure. eTime string(date-time) Example : "2019-03-28T09:30:00" optional
legs < Leg > array optional
marketingCar rier Carrier optional
operatingCarr ier Carrier optional
8 4.3. AirSegmentInformation
Contains a list of basic segment information.
Name Description Schema
arrivalAirport The three-letter IATA airport code of the arrival airport. string optional Example : "ORD"
arrivalTime The scheduled arrival time. string(date-time) optional Example : "2018-05-26T17:48:00"
The Reservation Booking Designator (RBD) code is used in classOfService reservation transactions to identify the booking class. string optional Example : "Y"
departureAir The three-letter IATA airport code of the departure airport. port string Example : "MIA" optional
departureTim The scheduled departure time. e string(date-time) Example : "2018-05-26T15:48:00" optional
flightNumber The flight number. integer(int32) optional Example : 123
marketingAirl The two-letter IATA airline code responsible for the passenger ineCode during the flight. string optional Example : "XX"
4.4. AmountCurrency
Contains monetary information.
Name Description Schema
amount The monetary amount. string optional Example : "100.00"
code The three-letter ISO 4217 currency code. string optional Example : "USD"
4.5. BookingReference
Contains information related to the booking or reservation.
9 Name Description Schema
The code of the carrier issuing the ticket and all carriers carrierCode responsible for the passenger and baggage. string optional Example : "XX"
createDate The date when the booking was created (local to the system). string(date) optional Example : "2018-10-10"
id The existing booking reference identifier. string optional Example : "KB3DQT"
The booking reference type. Follows the IATA PADIS Codeset typeCode encoding scheme. string optional Example : "6"
4.6. Carrier
Contains airline carrier information.
Name Description Schema
airlineCode The two-letter IATA airline code. string optional Example : "XX"
banner The airline carrier’s banner name. string optional Example : "EXEX Airlines"
The Reservation Booking Designator (RBD) code is used in bookingClass reservation transactions to identify the booking class. string optional Example : "Y"
flightNumber The number assigned to the flight. string optional Example : "5260"
name The commercial name of the carrier. string optional Example : "EXEX Airlines"
4.7. CarrierFlightInfo
Name Description Schema
carrierCode The two-letter IATA airline code. string optional Example : "XX"
The full name of the airline responsible for the passenger carrierName during the flight. string optional Example : "XX Airlines"
10 Name Description Schema
The Reservation Booking Designator (RBD) code is used in classOfService reservation transactions to identify the booking class. string optional Example : "Y"
flightNumber The unique identifier of the flight. integer(int32) optional Example : 123
4.8. CarrierInfo
Name Description Schema
carrierCode The two-letter IATA airline code. string required Example : "XX"
4.9. ContactInfo
Contains the passenger’s contact information.
Name Description Schema
emailAddress < EmailAddress > es array optional
givenName The passenger’s first name. string optional Example : "Martin"
The unique identifier assigned to the contact information id within the message. string optional Example : "CI-1"
phones < Phone > array optional
surname The passenger’s surname. string optional Example : "Doe"
4.10. ContactInformationUpdate
Contains parameters used to update contact information.
Name Description Schema
emailAddress < EmailAddressAdd > Adds array optional
11 Name Description Schema
emailAddress DeleteIds < string > array optional
emailAddress < EmailAddress > Updates array optional
The unique id assigned to the contact information, which is id required in order to perform an update. string optional Example : "CI-1"
phoneAdds < PhoneAdd > array optional
phoneUpdates < Phone > array optional
4.11. CreateOrder
Contains the order to be created.shoppingOffer Items may be converted into orderItems by specifying OfferItems from one or more offers as standard offers or “A-La-Carte” offers.
Name Description Schema
The unique identifier of the selected Offer (either a standard offerId offer or an a-la-carte offer) returned in a previous shopping string required response. Example : "dx369rfr7jt8dnd2i0-1"
Lists the offerItem selected by the passenger for inclusion in selectedOfferI the requested order. Repeats (once per passenger), if different < SelectedOfferItem > tems passengers want to select different service options, different array required quantities of a-la-carte items, or different seat locations.
4.12. CustomerNumber
Contains the customer’s DK number.
Name Description Schema
number The customer’s DK number. string optional Example : "1234567"
12 4.13. EmailAddress
Contains the email address(es) used for contact purposes.
Name Description Schema
address The contact email address. string optional Example : "[email protected]"
The unique identifier assigned to an email address in a PNR. id This id is required for update purposes. string optional Example : "4d546b3d"
The label is used to differentiate multiple email addresses for label one contact. string optional Example : "Payments"
4.14. EmailAddressAdd
Contains the email address(es) used for create purposes.
Name Description Schema
address The contact email address. string optional Example : "[email protected]"
The label is used to differentiate multiple email addresses for label a contact. string optional Example : "Payments"
4.15. Error
Contains information related to errors detected during processing of the preceding request
Name Description Schema
code The code corresponding to the processing error. string optional Example : "ER-1"
message The free text description of the provided error. string optional Example : "Incorrect field definition."
4.16. ExternalOrder
Contains the details of an external order.
13 Name Description Schema
airSegmentInf < ormations AirSegmentInformati optional on > array
bookingRefer < BookingReference > ences array optional
externalOrder CreateDateTi The date and time the external order was created. string(date) me Example : "2011-12-21T15:34:28" optional
externalOrder The unique identifier of the order in the external system. Id string Example : "XX000ABC99DEF" optional
id The unique identifier of the order within the Sabre system. string optional Example : "ORD1"
The unique identifier of the external system being used (e.g. systemId carrier code). string optional Example : "XX"
totalPrice Price optional
4.17. ExternalReference
Name Description Schema
The unique reference id received from external service id provider. string optional Example : "68494416-036f-44d1-978d-4156b4f03df5"
system The external service provider. string optional Example : "XX"
4.18. FareComponent
Contains the various components of the fare.
Name Description Schema
accountCode The code belonging to the account used to select the fare. string optional Example : "ACT1"
14 Name Description Schema
cabinTypeCod The cabin code. e string Example : "Y" optional
cabinTypeNa The name of the type of cabin. me string Example : "Economy" optional
fareBasisCityP The sum of the origin, destination and the carrier code. air string Example : "WAWLASBA" optional
The alpha-numeric code used by airlines to identify a fare fareBasisCode type, for which specific rules are applied. string optional Example : "YA2AA/ABCD"
fareType The fare type can be P-published, or N-negotiated. string optional Example : "P"
price Price optional
segmentRefId s Lists all segment ids to which fares are applied. < string > array optional
type The type indicates if the fare is one way, round trip, or none. enum (O, R, X) optional Can be O-one way, R-round trip, X-none."
4.19. FareDetail
Contains details of the fare. This data is required by hosted carriers.
Name Description Schema
commissionA mount AmountCurrency optional
commissionPe The percentage of the commission in numeric decimal rcentage format. number optional Example : 2.0
commissionSo The source of the commission. urce string Example : "C-Cat35, A-AMC, M-Manual" optional
fareCompone < FareComponent > nts array optional
15 Name Description Schema
fareIndicator The alphabetic or alpha-numeric code used by airlines to Code identify the fare type. string optional Example : "BU"
fareQualifiers Lists the fare qualifiers that are applicable to the order item. < string > array optional
If true, indicates MIP originated solutions. It is set to false for filedFareInd LCC. boolean optional Example : true
paxRefIds Lists the unique passenger identifiers for which the fare is < string > array optional applicable.
price Price optional
remarks < FareRemark > optional array
tourCode The tour code associated with the fare, if applicable. string optional Example : "ITGF12"
4.20. FareRemark
Contains various text-based remarks regarding the fare.
Name Description Schema
displayInd If true, displays the remark to the passenger. boolean optional Example : true
type The type of the remark. string optional Example : "B - baggage"
4.21. FeeDetails
Contains all details regarding a fee.
Name Description Schema
applied If true, indicates that the fee is applied. boolean optional Example : true
basePrice Base price of the fee. AmountCurrency optional
16 Name Description Schema
description The text-based description of the given fee. string optional Example : "CARD FEE"
passengerRefI ds Lists the reference ids of each passenger assigned to the fee. < string > array optional
percentageVal ue The value of the tax percentage. string optional
price Total price of the fee. AmountCurrency optional
refundable If true, the fee is refundable. boolean optional Example : true
serviceCode The service code associated with the fee. string optional Example : "OB"
subCode The fee’s sub code. string optional Example : "FCA"
taxBreakdow ns < Tax > array optional
totalTaxAmou nt The amount of the total tax applicable. AmountCurrency optional
4.22. FeeWarning
Contains a representation of the fee warning received from an external service.
Name Description Schema
owner The code of the external service providing the fee warning. string optional Example : "XX"
text The fee detail information, currently returned as warnings. Example : "OB Fees of 4.20 for CARD FEE FCA may be applied string optional for traveler T1."
4.23. FulfillOrder
Contains information related to the settlement of a transaction through monetary or other compensations.
17 Name Description Schema
externalOrder The unique identifier of the external order. Id string Example : "XX000ABC99DEF" optional
orderItemIds Lists the identifiers of order items from provided external < string > array optional order which should be fulfilled.
paymentInfo PaymentInfo optional
4.24. GenderCode
The gender of the individual. Can be M, F, or X for unspecified.
Type : string
4.25. IdentityDocument
Name Description Schema
The date of birth of the passenger as written on the birthdate document. The date should be in the YYYY-MM-DD format. string(date) optional Example : "1980-01-20"
[NOT SUPPORTED] The two-letter ISO 3166-1 code of the citizenshipCo country issuing the citizenship. Support may be added in the untryCode string subsequent releases. optional Example : "US"
The unique identifier of the document from all other identity documentNu documents issued by the state or organization. E.g., passport mber string number, driver’s license number. optional Example : "1.23456789E8"
documentTyp The type of passenger document. Can be PT (Passport). eCode string Example : "PT" optional
expiryDate The expiry date of the identity document. string optional Example : "2021-12-30"
genderCode GenderCode optional
The holder’s first or given name, as written on the document. givenName E.g. JOHN. string optional Example : "MARTIN"
18 Name Description Schema
[NOT SUPPORTED] The two-letter ISO 3166-1 country code hostCountryC where the document/visa is valid. Support may be added in ode string the subsequent releases. optional Example : "US"
The unique identifier of the identity document within the id content of a message. string optional Example : "4d6a453d"
issueDate The issue date of the identity document. string(date) optional Example : "2011-12-20"
issuingCountr The ISO code of the country issuing the passenger document. yCode string Example : "US" optional
[NOT SUPPORTED] The holder’s middle name or initial, as middleName written on the document. Support may be added in the string optional subsequent releases. Example : "GEORGE"
[NOT SUPPORTED] The two letter ISO 3166-1 code of the placeOfIssue country issuing the passenger document. Support may be string optional added in the subsequent releases. Example : "FR"
residenceCou The two-letter ISO 3166-1 code of the residing country. ntryCode string Example : "US" optional
[NOT SUPPORTED] The holder’s name suffixes and letters, as suffixName written on the document. Support may be added in the string optional subsequent releases. Example : "Jr."
The holder’s family name or last name, as written on the surname document. Excludes any potential suffix. string optional Example : "SMITH"
[NOT SUPPORTED] The holder’s title as written on the titleName document. Support may be added in the subsequent releases. string optional Example : "Mr"
4.26. IdentityDocumentAdd
Contains actions used for adding passenger’s identity document.
19 Name Description Schema
The date of birth of the passenger as written on the birthdate document. The date should be in the YYYY-MM-DD format. string(date) optional Example : "1980-01-20"
[NOT SUPPORTED] The two-letter ISO 3166-1 code of the citizenshipCo country issuing the citizenship. Support may be added in the untryCode string subsequent releases. optional Example : "US"
The unique identifier of the document from all other identity documentNu documents issued by the state or organization. E.g., passport mber string number, driver’s license number. optional Example : "1.23456789E8" documentTyp The type of the passenger document. Can be PT (Passport). eCode string Example : "PT" optional expiryDate The expiry date of the identity document. string optional Example : "2021-12-30" genderCode GenderCode optional
The holder’s first or given name, as written on the document. givenName E.g. JOHN. string optional Example : "MARTIN"
[NOT SUPPORTED] The two-letter ISO 3166-1 country code hostCountryC where the document/visa is valid. Support may be added in ode string the subsequent releases. optional Example : "US" issueDate The issue date of the identity document. string(date) optional Example : "2011-12-20" issuingCountr The ISO code of the country issuing the passenger document. yCode string Example : "US" optional
[NOT SUPPORTED] The holder’s middle name or initial, as middleName written on the document. Support may be added in the string optional subsequent releases. Example : "GEORGE" nameReferenc The reference given to the passenger’s name. e string Example : "ABC_X1CB508E0-D65F-4F8E-82E7_pax_0" optional
20 Name Description Schema
[NOT SUPPORTED] The two letter ISO 3166-1 code of the placeOfIssue country issuing the passenger document. Support may be string optional added in the subsequent releases. Example : "FR"
residenceCou The two-letter ISO 3166-1 code of the residing country. ntryCode string Example : "US" optional
[NOT SUPPORTED] The holder’s name suffixes and letters, as suffixName written on the document. Support may be added in the string optional subsequent releases. Example : "Jr."
The holder’s family name or last name, as written on the surname document. Excludes any potential suffix. string optional Example : "SMITH"
[NOT SUPPORTED] The holder’s title as written on the titleName document. Support may be added in the subsequent releases. string optional Example : "Mr"
4.27. IdentityDocumentDelete
Contains action used for deleting passenger’s identity document.
Name Description Schema
The unique identifier of the identity document within the id content of a message. string optional Example : "4d6a453d"
4.28. IdentityDocumentUpdate
Contains action used for updating passenger’s identity document.
Name Description Schema
The date of birth of the passenger as written on the birthdate document. The date should be in the YYYY-MM-DD format. string(date) optional Example : "1980-01-20"
[NOT SUPPORTED] The two-letter ISO 3166-1 citizenship citizenshipCo country code. Support may be added in the subsequent untryCode string releases. optional Example : "US"
21 Name Description Schema
The unique identifier of the document from all other identity documentNu documents issued by the state or organization. E.g., passport mber string number, driver’s license number. optional Example : "1.23456789E8" documentTyp The type of passenger document. Can be PT (Passport). eCode string Example : "PT" optional expiryDate The expiry date of the identity document. string optional Example : "2021-12-30" genderCode GenderCode optional
The holder’s first or given name, as written on the document. givenName E.g. JOHN. string optional Example : "MARTIN"
[NOT SUPPORTED] The two-letter ISO 3166-1 country code hostCountryC where the document/visa is valid. Support may be added in ode string the subsequent releases. optional Example : "US"
The unique identifier of the identity document within the id content of a message. string optional Example : "4d6a453d" issueDate The issue date of the identity document. string(date) optional Example : "2011-12-20" issuingCountr The ISO code of the country issuing the passenger document. yCode string Example : "US" optional
[NOT SUPPORTED] The holder’s middle name or initial, as middleName written on the document. Support may be added in the string optional subsequent releases. Example : "GEORGE" nameReferenc The reference associated with the name. e string Example : "ABC_X1CB508E0-D65F-4F8E-82E7_pax_0" optional
[NOT SUPPORTED] The two-letter ISO 3166-1 issuing country placeOfIssue code. Support may be added in the subsequent releases. string optional Example : "FR" residenceCou The two-letter ISO 3166-1 residence country code. ntryCode string Example : "US" optional
22 Name Description Schema
[NOT SUPPORTED] The holder’s name suffixes and letters, as suffixName written on the document. Support may be added in the string optional subsequent releases. Example : "Jr."
The holder’s family name or last name, as written on the surname document. Excludes any potential suffix. string optional Example : "SMITH"
[NOT SUPPORTED] The holder’s title as written on the titleName document. Support may be added in the subsequent releases. string optional Example : "Mr"
4.29. Journey
Contains all segments as part of the larger journey.
Name Description Schema
id The unique identifier of the journey. string optional Example : "J-DFW-LGA-1"
segmentRefId s Lists the segments by id that apply to the journey. < string > array optional
4.30. Leg
Contains flight leg information. Leg refers to the trip of an aircraft, from take-off to landing, and is a smaller part of an overall journey.
Name Description Schema
arrivalAirport The three-letter IATA arrival airport code. string optional Example : "NYC"
arrivalDateTi The scheduled date and time of arrival. me string(date-time) Example : "2019-03-28T012:30:00" optional
departureAir The three-letter IATA departure airport code. port string Example : "LAX" optional
departureDat The scheduled date and time of departure. eTime string(date-time) Example : "2019-03-28T09:30:00" optional
23 Name Description Schema
marketingCar rier Carrier optional
operatingCarr ier Carrier optional
4.31. LoyaltyProgramAccount
Contains the passenger’s frequent flyer information.
Name Description Schema
accountNumb The frequent flyer account number. er string Example : "4d6a453d" optional
carrier CarrierInfo optional
The unique identifier of the loyalty program account within id the content of a message. string optional Example : "4d6a453d"
4.32. LoyaltyProgramAccountAdd
Contains action used for adding passenger’s frequent flyer information.
Name Description Schema
accountNumb The frequent flyer account number. er string Example : "4d6a453d" optional
carrier CarrierInfo optional
nameReferenc The reference associated with the name. e string Example : "4d6a453d" optional
4.33. LoyaltyProgramAccountDelete
Contains action used for deleting passenger’s frequent flyer information.
24 Name Description Schema
The unique identifier of the loyalty program account within id the content of a message. string optional Example : "4d6a453d"
4.34. ManualPrice
Price details used to override value obtained from offer.
Name Description Schema
basePrice Base price. AmountCurrency optional
equivPrice EquivPrice. AmountCurrency optional
taxesIncluded TaxesIncluded. < TaxItem > array optional
ttlPrice TTLPrice. AmountCurrency optional
4.35. Order
Contains details of an order.
Name Description Schema
contactInfos < ContactInfo > array optional
countryCode The two-letter ISO-3166-1 country code of the order creator. string optional Example : "GB"
customerNum ber CustomerNumber optional
externalOrder < ExternalOrder > s array optional
id The unique identifier of the order. string optional Example : "542cb260c4114bc1ad51b85efa8118bd"
journeys < Journey > array optional
25 Name Description Schema offerVendor The two-letter IATA airline code. string optional Example : "XX" orderItems < OrderItem > array optional orderOwner The order owner code. This value can be 1S, 1F or 1B. string optional Example : "YY" partition The internal Sabre order location code. string optional Example : "AA" passengers < Passenger > array optional paymentTime The date by which a payment must be made for the Limit confirmed items in the order. string(date-time) optional Example : "2019-01-13T13:59:38Z" pnrCreateDat The PNR create date. e string Example : "2020-02-14" optional pnrLocator The PNR locator. string optional Example : "IXLFLT" priceClasses < PriceClass > array optional
The identification code for the prime host (global distribution primeHost system) associated with the reservation. string optional Example : "1S" products < Product > array optional pseudoCityCo The travel agency’s pseudo city code (PCC). de string Example : "F4X0" optional segments < Segment > array optional ticketingDocu < mentInfo TicketingDocumentIn optional fo > array totalPrice Price optional
26 4.36. OrderCancelRequest
Contains criteria to cancel an order.
Name Description Schema
id The unique identifier of the Order. string required Example : "542cb260c4114bc1ad51b85efa8118bd"
reshopOfferId The unique identifier of the reshopped offer. string optional Example : "db857d657cb7kdz4rk7es00yq0-1"
4.37. OrderCancelResponse
Contains the results of the order cancel operation.
Name Schema
errors < Error > array optional
order Order optional
warnings < Warning > array optional
4.38. OrderChangeRequest
Name Description Schema
actions < Action > array required
contactInform < ationUpdates ContactInformationU optional pdate > array
context Client sets this value and server echoes data in the response. string optional Example : "CLIENT_CONTEXT_VALUE"
The unique identifier of an Order within the context of one id message. string required Example : "XX000ABC99DEF"
identityDocu < mentAdds IdentityDocumentAd optional d > array
27 Name Description Schema
identityDocu < mentDeletes IdentityDocumentDel optional ete > array
identityDocu < mentUpdates IdentityDocumentUp optional date > array
loyaltyProgra < mAccountAdd LoyaltyProgramAcco s untAdd > array optional
loyaltyProgra < mAccountDel LoyaltyProgramAcco etes untDelete > array optional
mode enum (BOOKING, Mode information used when adding ancillary services. optional CHECKING)
offerId The unique identifier of the selected Offer. string optional Example : "dg7d9d79cd969vpfsk8a2nzsm0"
party Party required
requestType Type of request, stateful or stateless. enum (STATELESS, optional Example : "STATELESS" STATEFUL)
seatAdds < SeatAdd > array optional
seatDeletes < SeatDelete > array optional
serviceAdds Ancillaries to add. < ServiceAdd > array optional
4.39. OrderChangeResponse
Contains the order change response.
Name Description Schema
context Client sets this value and server echoes data in the response. string optional Example : "CLIENT_CONTEXT_VALUE"
errors < Error > array optional
28 Name Description Schema
order Order optional
warnings < Warning > array optional
4.40. OrderCreateRequest
Contains the criteria needed to create an order.
Name Description Schema
contactInfos < ContactInfo > array required
createOrders < CreateOrder > required array
Requests a Price Quote information to the associated PNR. createPriceQu This capability is currently available only for Sabre hosted ote carriers. boolean optional Default : false Example : true
customerNum ber CustomerNumber optional
party Party required
passengers < Passenger > array required
transactionOp tions TransactionOptions optional
4.41. OrderCreateResponse
Contains confirmation of an order creation.
Name Schema
errors < Error > array optional
29 Name Schema
order Order optional
warnings < Warning > array optional
4.42. OrderFulfillRequest
Name Description Schema
externalOrder The unique identifier of the external order reference id. Id string Example : "XX000ABC99DEF" optional
The unique identifier of an order within the context of one id message. string required Example : "XX000ABC99DEF"
orderItemIds Lists the identifiers of order items from provided external < string > array optional order which should be fulfilled.
paymentInfo PaymentInfo required
4.43. OrderFulfillResponse
Contains the order in response after fulfillment.
Name Schema
errors < Error > array optional
order Order optional
warnings < Warning > array optional
4.44. OrderItem
Name Description Schema
creationDateT The creation date and time of the order item. ime string(date-time) Example : "2011-12-21T15:34:28" optional
30 Name Description Schema
externalId The unique identifier of the order item in an external system. string optional Example : "EOI-1"
externalOffer The unique identifier of the offer in an external system. ItemId string Example : "EOFI-1" optional
externalOrder The unique identifier of the order in an external system. RefId string Example : "EOI-1" optional
fareDetails < FareDetail > array optional
feeWarnings Lists the warnings containing fee information. < FeeWarning > array optional
fees Lists the fee details. < FeeDetails > array optional
id The unique identifier of the order item. string optional Example : "OI-1"
offerItemId The unique identifier assigned to the offer item. string optional Example : "OFI-1"
price Price optional
productRefIds Lists all the products associated with the order. < string > array optional
services < Service > array optional
statusCode The current status code of the order item. string optional Example : "Booked"
validatingCar The two-letter IATA airline code validating the offer. rierCode string Example : "XX" optional
4.45. OrderViewRequest
Contains required criteria to retreive an order.
Name Description Schema
id The unique identifier of the order or the PNR locator. string required Example : "542cb260c4114bc1ad51b85efa8118bd"
31 Name Description Schema
The specification of the type of request, if it is STATEFUL or requestType enum (STATELESS, STATELESS. optional STATEFUL) Example : "STATELESS"
4.46. OrderViewResponse
Contains the retrieved order.
Name Schema
errors < Error > array optional
order Order optional
warnings < Warning > array optional
4.47. OrderVoidRetainRequest
Contains criteria to void retain an order.
Name Description Schema
id The unique identifier of the Order. string required Example : "542cb260c4114bc1ad51b85efa8118bd"
reshopOfferId The unique identifier of the reshopped offer. string required Example : "db857d657cb7kdz4rk7es00yq0-1"
4.48. OrderVoidRetainResponse
Contains the results of the order void retain operation.
Name Schema
errors < Error > array optional
order Order optional
warnings < Warning > array optional
32 4.49. Party
Contains the sender of the request.
Name Schema
sender PartySender optional
4.50. PartySender
Contains the travel agency sender.
Name Schema
travelAgency PartyTravelAgency optional
4.51. PartyTravelAgency
Contains details of the travel agency.
Name Description Schema
agencyId The unique identifier of the travel agency seller. string optional Example : "CTXX"
iataNumber The travel agency’s assigned IATA number. string optional Example : "12345678"
name The travel agency seller’s name. string optional Example : "McQueen Travel"
pseudoCityCo The travel agency’s pseudo city code (PCC). de string Example : "F4X0" optional
4.52. Passenger
Contains passenger details.
Name Description Schema
age The age of the passenger. integer(int32) optional Example : 3
33 Name Description Schema
ageUnitCode The age unit of measure. string optional Example : "Years"
The date on which the passenger was born in YYYY-MM-DD birthdate format. string(date) optional Example : "1980-01-20"
contactInfoRe The reference to the passenger’s contact information. fId string Example : "CI-1" optional
genderCode GenderCode optional
givenName The passenger’s first name. string optional Example : "MARTIN"
The passenger’s unique identifier obtained from the priced id offer. string optional Example : "ABC_X1CB508E0-D65F-4F8E-82E7_pax_0"
identityDocu Lists any documents which may be used to identify a person < IdentityDocument > ments or verify aspects of a person’s personal identity. array optional
loyaltyProgra < Lists an account set up for a customer within a rewards mAccounts LoyaltyProgramAcco program which holds funds on behalf of that customer. optional unt > array
middleName The passenger’s middle name or initial. string optional Example : "GEORGE"
remarks Lists the additional, supplementary information about the < Remark > array optional document or service.
The individual’s name suffixes and letters, such as Jr., Sr., III, suffixName Ret., and Esq. string optional Example : "III"
surname The passenger’s last name. string optional Example : "SMITH"
titleName The title used before the passenger’s surname. string optional Example : "Mr"
typeCode The three-letter IATA-standard Passenger Type Code (PTC). string optional Example : "CNN"
4.53. PaymentCash
Contains cash as the mode of payment.
34 Type : object
4.54. PaymentCreditCard
Contains credit card information.
Name Description Schema
cardNumber The credit card number. string optional Example : "4444333322221111"
cardNumberT The credit card number token. oken string Example : "444433ABCDEF1111" optional
contactInfoRe The reference to card holder contact information. fId string Example : "CI-1" optional
cvv The credit card CVV 3 or 4 digit verification code. string optional Example : "1234"
cvvToken The credit card CVV code token. string optional Example : "ABCD"
expirationDat The credit card expiration date in MMYY format. e string Example : "0119" optional
vendorCode The credit card vendor’s code. string optional Example : "VI"
4.55. PaymentInfo
Name Description Schema
amount AmountCurrency required
id The PaymentInfo unique identifier. string required Example : "FOP1"
orderItemRefI Lists the OrderItem unique identifiers associated with the ds < string > array payment. required
paymentMeth od PaymentMethod required
35 4.56. PaymentMethod
Contains payment method details.
Name Schema
paymentCard PaymentCreditCard optional
paymentCash PaymentCash optional
4.57. Phone
Contains telephone contact information.
Name Description Schema
cityCode The three-letter IATA city code city code. string optional Example : "DFW"
The numeric telephone dialing prefixes for the member countryCode countries of the International Telecommunication Union string optional (ITU). Example : "44"
id The unique identifier assigned to the phone. string optional Example : "4d6a453d"
The label is used to differentiate multiple phone numbers of label one contact. string optional Example : "Agency, Business, Home, Mobile, Cell, Fax, Hotel"
number The phone number. string optional Example : "+1123456789"
4.58. PhoneAdd
Contains telephone contact information.
Name Description Schema
cityCode The three-letter IATA city code city code. string optional Example : "DFW"
36 Name Description Schema
The numeric telephone dialing prefixes for the member countryCode countries of the International Telecommunication Union string optional (ITU). Example : "44"
The label is used to differentiate multiple Phone numbers of label one contact. string optional Example : "Agency, Business, Home, Mobile, Cell, Fax, Hotel"
number The phone number. string optional Example : "+1123456789"
4.59. Price
Contains the amount of money expected, required, or given in payment.
Name Schema
baseAmount AmountCurrency optional
taxBreakdowns < Tax > array optional
totalAmount AmountCurrency optional
totalTaxAmount AmountCurrency optional
4.60. PriceClass
Contains special brand pricing information.
Name Description Schema
code The ID of the price class. string optional Example : "SS"
id The unique identifier of the price class. string optional Example : "PC-SS-1"
name The marketing name of the price class. string optional Example : "SuperSaver"
37 4.61. Product
Contains the product associated with a given segment.
Name Description Schema
airSegment AirSegment optional
id The unique identifier of the product. string optional Example : "4d54453d"
4.62. ProductTextDetailsItem
Product text details item
Name Description Schema
itemName Item name string optional Example : "WIDTH"
itemValue Item value string optional Example : "40"
4.63. Remark
Contains additional, supplementary information about the document or service.
Name Description Schema
id The unique identifier of the remark. string optional Example : "RM-1"
text The free text describing the remark. string optional Example : "DELADR REMARK"
4.64. RequestType
The specification of the type of request, if it is STATEFUL or STATELESS.
Type : enum (STATELESS, STATEFUL)
4.65. SeatAdd
Contains information required to book a seat.
38 Name Description Schema
column The column letter of the seat to book. string optional Example : "F"
offerItemId The seat availability offer item ID. string optional Example : "dx71wzhgpjxpvmuy80-1"
passengerRefs The sequential reference number of the passenger. string optional Example : "ABC_X1CB508E0-D65F-4F8E-82E7_pax_0"
row The row number of the seat to book. string optional Example : "33"
segmentRefId Segment ID for the seat selection. Example : string optional "SGMIDWUY150NAAIUM4O3BCHTCYUEPBE0YLU2LVHB01BL03FUWBF2KWYJ"
4.66. SeatDelete
Contains information required to remove booked seat.
Name Description Schema
orderItemId The id of the order item with seat to be deleted. string optional Example : "2"
4.67. Segment
Contains a list of flight segments.
Name Description Schema
If true, indicates an ARNK (Arrival Unknown) condition. This is a gap between a current segment departure and previous arnkInd segment arrival location, implying unknown passenger boolean optional movement. Example : false
arrival Transport optional
cabinTypeCod The single-letter cabin code. Can be one of Y, S, C, J, F, P. e string Example : "Y" optional
departure Transport optional
39 Name Description Schema
The unique identifier of the passenger segment within the id content of a message. string optional Example : "SGMIDLGOKQDDCABNVDY2CEZKGQ0IN5MFKAO2QDAMZAMB0CNBRAUD2RMCC "
marketingCar rier CarrierFlightInfo optional
operatingCarr ier CarrierFlightInfo optional
references < ExternalReference optional > array
4.68. SelectedOfferItem
Contains the offerItem selected by the passenger for inclusion in the requested Order. Repeats (once per passenger), if different passengers want to select different service options, different quantities of a- la-carte items, or different seat locations.
Name Description Schema
The unique identifier of the selected Offer (either a standard id offer or an a-la-carte Offer) returned in a previous shopping string required response. Example : "dx369rfr7jt8dnd2i0-1-1"
4.69. SelectedSeat
Contains information about a booked seat.
Name Description Schema
characteristic s Lists all characteristic codes associated with the seat. < string > array optional
column The column where the booked seat is located. string optional Example : "C"
row The row where the booked seat is located. string optional Example : "2"
40 Name Description Schema
segmentRefId The passenger segment ID of the selected seat. Example : string optional "SGMIDWUY150NAAIUM4O3BCHTCYUEPBE0YLU2LVHB01BL03FUWBF2KWYJ"
4.70. Service
Contains services, or ancillaries, included in an offer or order, pertaining to a given flight.
Name Description Schema
externalId The unique identifier of a service in an external system. string optional Example : "SVC-1"
id The unique identifier of the service. string optional Example : "SVC-1"
passengerRefI The passenger’s identifier in a data list. d string Example : "ABC_X1CB508E0-D65F-4F8E-82E7_pax_0" optional
pnrSegmentN Identifies the segment number in a PNR booked for the umber passenger and service. integer(int32) optional Example : 1
segmentRefId The reference to the Passenger Segment id within a message. Example : string optional "SGMIDWUY150NAAIUM4O3BCHTCYUEPBE0YLU2LVHB01BL03FUWBF2KWYJ"
selectedSeat SelectedSeat optional
statusCode The status of the service instance. string optional Example : "Confirmed"
4.71. ServiceAdd
Provides details of the new service
Name Description Schema
manualPrice Price details used to override value obtained from offer. ManualPrice optional
offerItemId The unique identifier of the selected OfferItem. string required Example : "offerItem_1"
passengerRefI Reference to the Passenger. d string Example : "01.01" optional
41 Name Description Schema
Product text. Only one of 'productText' and productText 'productTextDetails' should be provided in request. string optional Example : "productTextFreeText"
productTextD < Product text details item. Only one of 'productText' and etails ProductTextDetailsIt 'productTextDetails' should be provided in request. optional em > array
quantity Quantity. integer optional Example : 1
segmentRefId Reference to the segment. string optional Example : "1"
4.72. Tax
Contains tax summary information, including total tax amount.
Name Description Schema
amount AmountCurrency optional
countryCode The two-letter ISO 3166-1 country code. string optional Example : "US"
description The tax description used for fulfillment. string optional Example : "airport tax"
taxCode The tax code. string optional Example : "GB"
taxType The tax type. Can be F-fixed, or P-percent. string optional Example : "F"
4.73. TaxItem
TaxItem.
Name Description Schema
taxAmount Tax Amount. string optional Example : "100.00"
taxCode Tax Code. string optional Example : "US Marshal Tax"
42 4.74. TicketingDocument
Contains details of the ticketing document.
Name Description Schema
< coupons TicketingDocumentC optional oupon > array
inConnection DocumentNu The connected document number. string mber Example : "1231234567890" optional
issueDateTim The date and time of documentation issuance in the ticketing e location’s time zone. string(date-time) optional Example : "2018-05-26T15:48:17Z"
number The ticket document number. string optional Example : "1231234567890"
numberOfBoo Number of booklets issued. klets integer Example : 1 optional
primaryDocu If true, indicates that the document is a primary document. mentInd boolean Example : true optional
The document reconciliation method. Can be BSP, ARC, or reportingType directly via ORA. string optional Example : "ORA"
The code that determines if the route is domestic or routingCode international. Can be D-Domestic, I-International. string optional Example : "D"
ticketingLocat The three-letter ticketing location code. ion string Example : "LON" optional
type The document Type. IATA PADIS Codeset 1001. string optional Example : "T"
4.75. TicketingDocumentCoupon
Contains coupon information.
43 Name Description Schema
consumedAtIs If true, the coupon is consumed at issuance. suanceInd boolean Example : false optional
inConnection CouponNumb The connected document coupon number. string er Example : "2" optional
inConnection DocumentNu The connected document number. string mber Example : "1231234567890" optional
number The coupon number. integer optional Example : 1
presentAt The location of the provider of the service. string optional Example : "JFK"
presentTo The name of the provider of the service. string optional Example : "XX"
reasonForIssu The ancillary service RFCI, follows IATA PADIS Codeset 4183. anceCode string Example : "C" optional
reasonForIssu The ancillary service code based on Reason For Issuance Sub anceSubCode Codes (RFISC). string optional Example : "99"
serviceCode The ancillary service code. string optional Example : "EBAG"
serviceRefId The reference to the Service, the coupon is associated with. string optional Example : "SVC-1"
settlementAut The settlement authorization code is generated by the hCode validating carrier authorizing settlement of the coupon. string optional Example : "AUTH123"
The current coupon status code based on IATA PADIS Codeset status 4405. string optional Example : "I"
4.76. TicketingDocumentInfo
44 Name Description Schema
document TicketingDocument optional
paxRefId The reference to the passenger. string optional Example : "ABC_X1CB508E0-D65F-4F8E-82E7_pax_0"
price Price optional
4.77. TransactionOptions
Name Description Schema
If true, transaction is committed at the end of request commitTrans processing. This option is ignored in STATELESS mode. action boolean Default : true optional Example : false
If true, current session should be ignored before processing initialIgnore the request. This option is ignored in STATELESS mode. boolean optional Default : false Example : true
If true, passenger data should be moved to PNR. By default, movePassenge this option is set to true in STATELESS mode. rDetails boolean Default : true optional Example : false
requestType RequestType optional
4.78. Transport
Contains location, terminal, gate, and time information.
Name Description Schema
gateId The identifier of the airport gate. string optional Example : "D40"
locationCode The three-letter IATA city or airport code. string optional Example : "DFW"
scheduledDat The Scheduled date and time of the aircraft at the terminal or eTime gate at an airport. string(date-time) optional Example : "2018-03-28T09:30:00"
45 Name Description Schema
stationName The formal name of the airport. string optional Example : "Dallas International Airport"
terminalNam The name of the airport terminal. e string Example : "D" optional
4.79. Warning
Name Description Schema
code The code corresponding to the processing warning. string optional Example : "WR-1"
message The free text description of the provided warning. string optional Example : "Incorrect field value."
46