Order Management - developer.sabre.com · Example: "[email protected]" string id optional The unique identifier assigned to an email address in a PNR. This id is required for update

Order Management

Table of Contents1. 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/create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

2.3.1. Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

2.3.2. Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

2.3.3. Responses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

2.3.4. Consumes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

2.3.5. Produces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

2.3.6. Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

2.4. POST /orders/fulfill . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

2.4.1. Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

2.4.2. Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

2.4.3. Responses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

2.4.4. Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

2.5. POST /orders/view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

2.5.1. Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

2.5.2. Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

2.5.3. Responses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

2.5.4. Produces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

2.5.5. Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

3. Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

3.1. oauth2_authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

4. Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

4.1. Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

4.2. AirSegment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

4.3. AirSegmentInformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

4.4. AmountCurrency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

4.5. BookingReference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

4.6. Carrier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

4.7. CarrierFlightInfo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

4.8. CarrierInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

4.9. ContactInfo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

4.10. ContactInformationUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

4.11. CreateOrder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

4.12. CustomerNumber. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

4.13. EmailAddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

4.14. EmailAddressAdd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

4.15. Error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

4.16. ExternalOrder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

4.17. ExternalReference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

4.18. FareComponent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

4.19. FareDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

4.20. FareRemark . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

4.21. FeeDetails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

4.22. FeeWarning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

4.23. FulfillOrder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

4.24. GenderCode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

4.25. IdentityDocument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

4.26. IdentityDocumentAdd. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

4.27. IdentityDocumentDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

4.28. IdentityDocumentUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

4.29. Journey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

4.30. Leg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

4.31. LoyaltyProgramAccount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

4.32. LoyaltyProgramAccountAdd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

4.33. LoyaltyProgramAccountDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

4.34. Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

4.35. OrderCancelRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

4.36. OrderCancelResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

4.37. OrderChangeRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

4.38. OrderChangeResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

4.39. OrderCreateRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

4.40. OrderCreateResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

4.41. OrderFulfillRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

4.42. OrderFulfillResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

4.43. OrderItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

4.44. OrderViewRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

4.45. OrderViewResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

4.46. Party . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

4.47. PartySender . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

4.48. PartyTravelAgency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

4.49. Passenger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

4.50. PaymentCash . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

4.51. PaymentCreditCard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

4.52. PaymentInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

4.53. PaymentMethod . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

4.54. Phone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

4.55. PhoneAdd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

4.56. Price . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

4.57. PriceClass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

4.58. Product . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

4.59. Remark . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

4.60. RequestType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

4.61. SeatAdd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

4.62. SeatDelete. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

4.63. Segment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

4.64. SelectedOfferItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

4.65. SelectedSeat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

4.66. Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

4.67. Tax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

4.68. TicketingDocument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

4.69. TicketingDocumentCoupon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

4.70. TicketingDocumentInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

4.71. TransactionOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

4.72. Transport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

4.73. Warning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Chapter 1. OverviewThe Order Management is used to create, change, cancel and view the content of a specified airlineorder.

1.1. Version informationVersion : v1

1.2. Contact informationContact : Contact Us

1.3. URI schemeHost : api-crt.cert.havail.sabre.comBasePath : /v1Schemes : 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

BodyorderCancelRequestoptional

Cancels a specified order. OrderCancelRequest

2.1.3. Responses

HTTPCode

Description Schema

200 SuccessOrderCancelResponse

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


BodyorderChangeRequestoptional

Modifies the elements of an order. OrderChangeRequest

2.2.3. Responses

HTTPCode

Description Schema

200 SuccessOrderChangeResponse


2.2.4. Tags

• Change Order

2.3. POST /orders/create

2.3.1. Description

Creates an order.

2.3.2. Parameters


BodyorderCreateRequestoptional

Creates an order. OrderCreateRequest

2.3.3. Responses

HTTPCode

Description Schema

200 SuccessOrderCreateResponse


2.3.4. Consumes


3

2.3.5. Produces


2.3.6. Tags

• Create Order

2.4. POST /orders/fulfill

2.4.1. Description

[DEPRECATED] Fulfills an order.

2.4.2. Parameters

Type Name Schema

BodyorderFulfillRequestoptional

OrderFulfillRequest

2.4.3. Responses

HTTPCode

Description Schema

200 SuccessOrderFulfillResponse


2.4.4. Tags

• Fulfill Order

2.5. POST /orders/view

2.5.1. Description

Views a single order.

2.5.2. Parameters

4


BodyOrderViewRequestoptional

Views a specified order by ID. OrderViewRequest

2.5.3. Responses

HTTPCode

Description Schema

200 SuccessOrderViewResponse

2.5.4. Produces


2.5.5. Tags

• View Order

5

Chapter 3. Security

3.1. oauth2_authenticationType : oauth2Flow : applicationToken URL : https://api-crt.cert.havail.sabre.com/v2/auth/token

Name Description

oauth2 oauth2

6

https://api-crt.cert.havail.sabre.com/v2/auth/token

Chapter 4. Definitions

4.1. ActionContains actions to execute.

Name Description Schema

fulfillOrderoptional

FulfillOrder

idrequired

The unique identifier of the action.Example : "12"

string

4.2. AirSegmentContains details of the flight segment.


actionCodeoptional

Action code.Example : "HK"

string

arrivalAirportoptional

The three-letter IATA arrival airport code.Example : "NYC"

string

arrivalDateTimeoptional

The scheduled date and time of arrival.Example : "2019-03-28T012:30:00"

string(date-time)

departureAirportoptional

The three-letter IATA departure airport code.Example : "LAX"

string

departureDateTimeoptional

The scheduled date and time of departure.Example : "2019-03-28T09:30:00"

string(date-time)

legsoptional

< Leg > array

marketingCarrieroptional

Carrier

operatingCarrieroptional

Carrier

7

https://www.iata.org/publications/Pages/code-search.aspx


4.3. AirSegmentInformationContains a list of basic segment information.



The three-letter IATA airport code of the arrival airport.Example : "ORD"

string

arrivalTimeoptional

The scheduled arrival time.Example : "2018-05-26T17:48:00"

string(date-time)

classOfServiceoptional

The Reservation Booking Designator (RBD) code is used inreservation transactions to identify the booking class.Example : "Y"

string


The three-letter IATA airport code of the departure airport.Example : "MIA"

string

departureTimeoptional

The scheduled departure time.Example : "2018-05-26T15:48:00"

string(date-time)

flightNumberoptional

The flight number.Example : 123

integer(int32)

marketingAirlineCodeoptional

The two-letter IATA airline code responsible for the passengerduring the flight.Example : "XX"

string

4.4. AmountCurrencyContains monetary information.


amountoptional

The monetary amount.Example : "100.00"

string

codeoptional

The three-letter ISO 4217 currency code.Example : "USD"

string

4.5. BookingReferenceContains information related to the booking or reservation.

8




https://www.iso.org/iso-4217-currency-codes.html


carrierCodeoptional

The code of the carrier issuing the ticket and all carriersresponsible for the passenger and baggage.Example : "XX"

string

createDateoptional

The date when the booking was created (local to the system).Example : "2018-10-10"

string(date)

idoptional

The existing booking reference identifier.Example : "KB3DQT"

string

typeCodeoptional

The booking reference type. Follows the IATA PADIS Codesetencoding scheme.Example : "6"

string

4.6. CarrierContains airline carrier information.


airlineCodeoptional

The two-letter IATA airline code.Example : "XX"

string

banneroptional

The airline carrier’s banner name.Example : "EXEX Airlines"

string

bookingClassoptional


string


The number assigned to the flight.Example : "5260"

string

nameoptional

The commercial name of the carrier.Example : "EXEX Airlines"

string

4.7. CarrierFlightInfo


carrierCodeoptional


string

carrierNameoptional

The full name of the airline responsible for the passengerduring the flight.Example : "XX Airlines"

string

9

https://www.iata.org/whatwedo/workgroups/Pages/padis.aspx




classOfServiceoptional


string


The unique identifier of the flight.Example : 123

integer(int32)

4.8. CarrierInfo


carrierCoderequired


string

4.9. ContactInfoContains the passenger’s contact information.


emailAddressesoptional

< EmailAddress >array

givenNameoptional

The passenger’s first name.Example : "Martin"

string

idoptional

The unique identifier assigned to the contact informationwithin the message.Example : "CI-1"

string

phonesoptional

< Phone > array

surnameoptional

The passenger’s surname.Example : "Doe"

string

4.10. ContactInformationUpdateContains parameters used to update contact information.


emailAddressAddsoptional

< EmailAddressAdd >array

10



emailAddressDeleteIdsoptional

< string > array

emailAddressUpdatesoptional

< EmailAddress >array

idoptional

The unique id assigned to the contact information, which isrequired in order to perform an update.Example : "CI-1"

string

phoneAddsoptional

< PhoneAdd > array

phoneUpdatesoptional

< Phone > array

4.11. CreateOrderContains the order to be created.shoppingOffer Items may be converted into orderItems by specifyingOfferItems from one or more offers as standard offers or “A-La-Carte” offers.


offerIdrequired

The unique identifier of the selected Offer (either a standardoffer or an a-la-carte offer) returned in a previous shoppingresponse.Example : "dx369rfr7jt8dnd2i0-1"

string

selectedOfferItemsrequired

Lists the offerItem selected by the passenger for inclusion inthe requested order. Repeats (once per passenger), if differentpassengers want to select different service options, differentquantities of a-la-carte items, or different seat locations.

< SelectedOfferItem >array

4.12. CustomerNumberContains the customer’s DK number.


numberoptional

The customer’s DK number.Example : "1234567"

string

11

4.13. EmailAddressContains the email address(es) used for contact purposes.


addressoptional

The contact email address.Example : "[email protected]"

string

idoptional

The unique identifier assigned to an email address in a PNR.This id is required for update purposes.Example : "4d546b3d"

string

labeloptional

The label is used to differentiate multiple email addresses forone contact.Example : "Payments"

string

4.14. EmailAddressAddContains the email address(es) used for create purposes.


addressoptional

The contact email address.Example : "[email protected]"

string

labeloptional

The label is used to differentiate multiple email addresses fora contact.Example : "Payments"

string

4.15. ErrorContains information related to errors detected during processing of the preceding request


codeoptional

The code corresponding to the processing error.Example : "ER-1"

string

messageoptional

The free text description of the provided error.Example : "Incorrect field definition."

string

4.16. ExternalOrderContains the details of an external order.

12

mailto:[email protected]

mailto:[email protected]


airSegmentInformationsoptional

<AirSegmentInformation > array

bookingReferencesoptional

< BookingReference >array

externalOrderCreateDateTimeoptional

The date and time the external order was created.Example : "2011-12-21T15:34:28"

string(date)

externalOrderIdoptional

The unique identifier of the order in the external system.Example : "XX000ABC99DEF"

string

idoptional

The unique identifier of the order within the Sabre system.Example : "ORD1"

string

systemIdoptional

The unique identifier of the external system being used (e.g.carrier code).Example : "XX"

string

totalPriceoptional

Price

4.17. ExternalReference


idoptional

The unique reference id received from external serviceprovider.Example : "68494416-036f-44d1-978d-4156b4f03df5"

string

systemoptional

The external service provider.Example : "XX"

string

4.18. FareComponentContains the various components of the fare.


accountCodeoptional

The code belonging to the account used to select the fare.Example : "ACT1"

string

13


cabinTypeCodeoptional

The cabin code.Example : "Y"

string

cabinTypeNameoptional

The name of the type of cabin.Example : "Economy"

string

fareBasisCityPairoptional

The sum of the origin, destination and the carrier code.Example : "WAWLASBA"

string

fareBasisCodeoptional

The alpha-numeric code used by airlines to identify a faretype, for which specific rules are applied.Example : "YA2AA/ABCD"

string

fareTypeoptional

The fare type can be P-published, or N-negotiated.Example : "P"

string

priceoptional

Price

segmentRefIdsoptional

Lists all segment ids to which fares are applied. < string > array

typeoptional

The type indicates if the fare is one way, round trip, or none.Can be O-one way, R-round trip, X-none."

enum (O, R, X)

4.19. FareDetailContains details of the fare. This data is required by hosted carriers.


commissionAmountoptional

AmountCurrency

commissionPercentageoptional

The percentage of the commission in numeric decimalformat.Example : 2.0

number

commissionSourceoptional

The source of the commission.Example : "C-Cat35, A-AMC, M-Manual"

string

fareComponentsoptional

< FareComponent >array

14


fareIndicatorCodeoptional

The alphabetic or alpha-numeric code used by airlines toidentify the fare type.Example : "BU"

string

fareQualifiersoptional

Lists the fare qualifiers that are applicable to the order item. < string > array

filedFareIndoptional

If true, indicates MIP originated solutions. It is set to false forLCC.Example : true

boolean

paxRefIdsoptional

Lists the unique passenger identifiers for which the fare isapplicable.

< string > array

priceoptional

Price

remarksoptional

< FareRemark >array

tourCodeoptional

The tour code associated with the fare, if applicable.Example : "ITGF12"

string

4.20. FareRemarkContains various text-based remarks regarding the fare.


displayIndoptional

If true, displays the remark to the passenger.Example : true

boolean

typeoptional

The type of the remark.Example : "B - baggage"

string

4.21. FeeDetailsContains all details regarding a fee.


appliedoptional

If true, indicates that the fee is applied.Example : true

boolean

basePriceoptional

Base price of the fee. AmountCurrency

15


descriptionoptional

The text-based description of the given fee.Example : "CARD FEE"

string

passengerRefIdsoptional

Lists the reference ids of each passenger assigned to the fee. < string > array

percentageValueoptional

The value of the tax percentage. string

priceoptional

Total price of the fee. AmountCurrency

refundableoptional

If true, the fee is refundable.Example : true

boolean

serviceCodeoptional

The service code associated with the fee.Example : "OB"

string

subCodeoptional

The fee’s sub code.Example : "FCA"

string

taxBreakdownsoptional

Lists the tax breakdown amount. < Tax > array

totalTaxAmountoptional

The amount of the total tax applicable. AmountCurrency

4.22. FeeWarningContains a representation of the fee warning received from an external service.


owneroptional

The code of the external service providing the fee warning.Example : "XX"

string

textoptional

The fee detail information, currently returned as warnings.Example : "OB Fees of 4.20 for CARD FEE FCA may be appliedfor traveler T1."

string

4.23. FulfillOrderContains information related to the settlement of a transaction through monetary or othercompensations.

16



The unique identifier of the external order.Example : "XX000ABC99DEF"

string

orderItemIdsoptional

Lists the identifiers of order items from provided externalorder which should be fulfilled.

< string > array

paymentInfooptional

PaymentInfo

4.24. GenderCodeThe gender of the individual. Can be M, F, or X for unspecified.

Type : string

4.25. IdentityDocument


birthdateoptional

The date of birth of the passenger as written on thedocument. The date should be in the YYYY-MM-DD format.Example : "1980-01-20"

string(date)

citizenshipCountryCodeoptional

[NOT SUPPORTED] The two-letter ISO 3166-1 code of thecountry issuing the citizenship. Support may be added in thesubsequent releases.Example : "US"

string

documentNumberoptional

The unique identifier of the document from all other identitydocuments issued by the state or organization. E.g., passportnumber, driver’s license number.Example : "1.23456789E8"

string

documentTypeCodeoptional

The type of passenger document. Can be PT (Passport).Example : "PT"

string

expiryDateoptional

The expiry date of the identity document.Example : "2021-12-30"

string

genderCodeoptional

GenderCode

givenNameoptional

The holder’s first or given name, as written on the document.E.g. JOHN.Example : "MARTIN"

string

17


hostCountryCodeoptional

[NOT SUPPORTED] The two-letter ISO 3166-1 country codewhere the document/visa is valid. Support may be added inthe subsequent releases.Example : "US"

string

idoptional

The unique identifier of the identity document within thecontent of a message.Example : "4d6a453d"

string

issueDateoptional

The issue date of the identity document.Example : "2011-12-20"

string(date)

issuingCountryCodeoptional

The ISO code of the country issuing the passenger document.Example : "US"

string

middleNameoptional

[NOT SUPPORTED] The holder’s middle name or initial, aswritten on the document. Support may be added in thesubsequent releases.Example : "GEORGE"

string

placeOfIssueoptional

[NOT SUPPORTED] The two letter ISO 3166-1 code of thecountry issuing the passenger document. Support may beadded in the subsequent releases.Example : "FR"

string

residenceCountryCodeoptional

TThe two-letter ISO 3166-1 code of the residing country.Example : "US"

string

suffixNameoptional

[NOT SUPPORTED] The holder’s name suffixes and letters, aswritten on the document. Support may be added in thesubsequent releases.Example : "Jr."

string

surnameoptional

The holder’s family name or last name, as written on thedocument. Excludes any potential suffix.Example : "SMITH"

string

titleNameoptional

[NOT SUPPORTED] The holder’s title as written on thedocument. Support may be added in the subsequent releases.Example : "Mr"

string

4.26. IdentityDocumentAddContains actions used for adding passenger’s identity document.

18

https://www.iso.org/obp/ui/#search/code/


birthdateoptional


string(date)


[NOT SUPPORTED] The two-letter ISO 3166-1 code of thecountry issuing the citizenship. Support may be added in thesubsequent releases.Example : "US"

string



string


The type of the passenger document. Can be PT (Passport).Example : "PT"

string

expiryDateoptional


string

genderCodeoptional

GenderCode

givenNameoptional


string



string

issueDateoptional


string(date)



string

middleNameoptional


string

nameReferenceoptional

The reference given to the passenger’s name.Example : "ABC_X1CB508E0-D65F-4F8E-82E7_pax_0"

string

19




[NOT SUPPORTED] The two letter ISO 3166-1 code of thecountry issuing the passenger document. Support may beadded in the subsequent releases.Example : "FR"

string


The two-letter ISO 3166-1 code of the residing country.Example : "US"

string

suffixNameoptional


string

surnameoptional


string

titleNameoptional


string

4.27. IdentityDocumentDeleteContains action used for deleting passenger’s identity document.


idoptional


string

4.28. IdentityDocumentUpdateContains action used for updating passenger’s identity document.


birthdateoptional


string(date)


[NOT SUPPORTED] The two-letter ISO 3166-1 citizenshipcountry code. Support may be added in the subsequentreleases.Example : "US"

string

20





string


The type of passenger document. Can be PT (Passport).Example : "PT"

string

expiryDateoptional


string

genderCodeoptional

GenderCode

givenNameoptional


string



string

idoptional


string

issueDateoptional


string(date)



string

middleNameoptional


string


The reference associated with the name.Example : "ABC_X1CB508E0-D65F-4F8E-82E7_pax_0"

string


[NOT SUPPORTED] The two-letter ISO 3166-1 issuing countrycode. Support may be added in the subsequent releases.Example : "FR"

string


The two-letter ISO 3166-1 residence country code.Example : "US"

string

21





suffixNameoptional


string

surnameoptional


string

titleNameoptional


string

4.29. JourneyContains all segments as part of the larger journey.


idoptional

The unique identifier of the journey.Example : "J-DFW-LGA-1"

string

segmentRefIdsoptional

Lists the segments by id that apply to the journey. < string > array

4.30. LegContains flight leg information. Leg refers to the trip of an aircraft, from take-off to landing, and is asmaller part of an overall journey.



The three-letter IATA arrival airport code.Example : "NYC"

string

arrivalDateTimeoptional

The scheduled date and time of arrival.Example : "2019-03-28T012:30:00"

string(date-time)


The three-letter IATA departure airport code.Example : "LAX"

string

departureDateTimeoptional

The scheduled date and time of departure.Example : "2019-03-28T09:30:00"

string(date-time)

22





Carrier


Carrier

4.31. LoyaltyProgramAccountContains the passenger’s frequent flyer information.


accountNumberoptional

The frequent flyer account number.Example : "4d6a453d"

string

carrieroptional

CarrierInfo

idoptional

The unique identifier of the loyalty program account withinthe content of a message.Example : "4d6a453d"

string

4.32. LoyaltyProgramAccountAddContains action used for adding passenger’s frequent flyer information.


accountNumberoptional

The frequent flyer account number.Example : "4d6a453d"

string

carrieroptional

CarrierInfo


The reference associated with the name.Example : "4d6a453d"

string

4.33. LoyaltyProgramAccountDeleteContains action used for deleting passenger’s frequent flyer information.

23


idoptional

The unique identifier of the loyalty program account withinthe content of a message.Example : "4d6a453d"

string

4.34. OrderContains details of an order.


contactInfosoptional

< ContactInfo > array

countryCodeoptional

The two-letter ISO-3166-1 country code of the order creator.Example : "GB"

string

customerNumberoptional

CustomerNumber

externalOrdersoptional

< ExternalOrder >array

idoptional

The unique identifier of the order.Example : "542cb260c4114bc1ad51b85efa8118bd"

string

journeysoptional

< Journey > array

offerVendoroptional


string

orderItemsoptional

< OrderItem > array

orderOwneroptional

The order owner code. This value can be 1S, 1F or 1B.Example : "YY"

string

partitionoptional

The internal Sabre order location code.Example : "AA"

string

passengersoptional

< Passenger > array

paymentTimeLimitoptional

The date by which a payment must be made for theconfirmed items in the order.Example : "2019-01-13T13:59:38Z"

string(date-time)

24



pnrCreateDateoptional

The PNR create date.Example : "2020-02-14"

string

pnrLocatoroptional

The PNR locator.Example : "IXLFLT"

string

priceClassesoptional

< PriceClass > array

primeHostoptional

The identification code for the prime host (global distributionsystem) associated with the reservation.Example : "1S"

string

productsoptional

< Product > array

pseudoCityCodeoptional

The travel agency’s pseudo city code (PCC).Example : "F4X0"

string

segmentsoptional

< Segment > array

ticketingDocumentInfooptional

<TicketingDocumentInfo > array

totalPriceoptional

Price

4.35. OrderCancelRequestContains criteria to cancel an order.


idrequired

The unique identifier of the Order.Example : "542cb260c4114bc1ad51b85efa8118bd"

string

4.36. OrderCancelResponseContains the results of the order cancel operation.

Name Schema

errorsoptional

< Error > array

25

Name Schema

orderoptional

Order

warningsoptional

< Warning > array

4.37. OrderChangeRequest


actionsrequired

< Action > array

contactInformationUpdatesoptional

<ContactInformationUpdate > array

idrequired

The unique identifier of an Order within the context of onemessage.Example : "XX000ABC99DEF"

string

identityDocumentAddsoptional

<IdentityDocumentAdd > array

identityDocumentDeletesoptional

<IdentityDocumentDelete > array

identityDocumentUpdatesoptional

<IdentityDocumentUpdate > array

loyaltyProgramAccountAddsoptional

<LoyaltyProgramAccountAdd > array

loyaltyProgramAccountDeletesoptional

<LoyaltyProgramAccountDelete > array

partyrequired

Party

seatAddsoptional

< SeatAdd > array

26


seatDeletesoptional

< SeatDelete > array

4.38. OrderChangeResponseContains the order change response.

Name Schema

errorsoptional

< Error > array

orderoptional

Order

warningsoptional

< Warning > array

4.39. OrderCreateRequestContains the criteria needed to create an order.

Name Schema

contactInfosrequired

< ContactInfo > array

createOrdersrequired

< CreateOrder > array

customerNumberoptional

CustomerNumber

partyrequired

Party

passengersrequired

< Passenger > array

transactionOptionsoptional

TransactionOptions

4.40. OrderCreateResponseContains confirmation of an order creation.

27

Name Schema

errorsoptional

< Error > array

orderoptional

Order

warningsoptional

< Warning > array

4.41. OrderFulfillRequest



The unique identifier of the external order reference id.Example : "XX000ABC99DEF"

string

idrequired

The unique identifier of an order within the context of onemessage.Example : "XX000ABC99DEF"

string

orderItemIdsoptional

Lists the identifiers of order items from provided externalorder which should be fulfilled.

< string > array

paymentInforequired

PaymentInfo

4.42. OrderFulfillResponseContains the order in response after fulfillment.

Name Schema

errorsoptional

< Error > array

orderoptional

Order

warningsoptional

< Warning > array

4.43. OrderItem

28


creationDateTimeoptional

The creation date and time of the order item.Example : "2011-12-21T15:34:28"

string(date-time)

externalIdoptional

The unique identifier of the order item in an external system.Example : "EOI-1"

string

externalOfferItemIdoptional

The unique identifier of the offer in an external system.Example : "EOFI-1"

string

externalOrderRefIdoptional

The unique identifier of the order in an external system.Example : "EOI-1"

string

fareDetailsoptional

< FareDetail > array

feeWarningsoptional

Lists the warnings containing fee information. < FeeWarning > array

feesoptional

Lists the fee details. < FeeDetails > array

idoptional

The unique identifier of the order item.Example : "OI-1"

string

offerItemIdoptional

The unique identifier assigned to the offer item.Example : "OFI-1"

string

priceoptional

Price

productRefIdsoptional

Lists all the products associated with the order. < string > array

servicesoptional

< Service > array

statusCodeoptional

The current status code of the order item.Example : "Booked"

string

validatingCarrierCodeoptional

The two-letter IATA airline code validating the offer.Example : "XX"

string

4.44. OrderViewRequestContains required criteria to retreive an order.

29



idrequired

The unique identifier of the order or the PNR locator.Example : "542cb260c4114bc1ad51b85efa8118bd"

string

requestTypeoptional

The specification of the type of request, if it is STATEFUL orSTATELESS.Example : "STATELESS"

enum (STATELESS,STATEFUL)

4.45. OrderViewResponseContains the retrieved order.

Name Schema

errorsoptional

< Error > array

orderoptional

Order

warningsoptional

< Warning > array

4.46. PartyContains the sender of the request.

Name Schema

senderoptional

PartySender

4.47. PartySenderContains the travel agency sender.

Name Schema

travelAgencyoptional

PartyTravelAgency

4.48. PartyTravelAgencyContains details of the travel agency.

30


agencyIdoptional

The unique identifier of the travel agency seller.Example : "CTXX"

string

iataNumberoptional

The travel agency’s assigned IATA number.Example : "12345678"

string

nameoptional

The travel agency seller’s name.Example : "McQueen Travel"

string

pseudoCityCodeoptional

The travel agency’s pseudo city code (PCC).Example : "F4X0"

string

4.49. PassengerContains passenger details.


ageoptional

The age of the passenger.Example : 3

integer(int32)

ageUnitCodeoptional

The age unit of measure.Example : "Years"

string

birthdateoptional

The date on which the passenger was born in YYYY-MM-DDformat.Example : "1980-01-20"

string(date)

contactInfoRefIdoptional

The reference to the passenger’s contact information.Example : "CI-1"

string

genderCodeoptional

GenderCode

givenNameoptional

The passenger’s first name.Example : "MARTIN"

string

idoptional

The passenger’s unique identifier obtained from the pricedoffer.Example : "ABC_X1CB508E0-D65F-4F8E-82E7_pax_0"

string

identityDocumentsoptional

Lists any documents which may be used to identify a personor verify aspects of a person’s personal identity.

< IdentityDocument >array

loyaltyProgramAccountsoptional

Lists an account set up for a customer within a rewardsprogram which holds funds on behalf of that customer.

<LoyaltyProgramAccount > array

31


middleNameoptional

The passenger’s middle name or initial.Example : "GEORGE"

string

remarksoptional

Lists the additional, supplementary information about thedocument or service.

< Remark > array

suffixNameoptional

The individual’s name suffixes and letters, such as Jr., Sr., III,Ret., and Esq.Example : "III"

string

surnameoptional

The passenger’s last name.Example : "SMITH"

string

titleNameoptional

The title used before the passenger’s surname.Example : "Mr"

string

typeCodeoptional

The three-letter IATA-standard Passenger Type Code (PTC).Example : "CNN"

string

4.50. PaymentCashContains the amount of cash that needs to be paid.

Type : object

4.51. PaymentCreditCardContains credit card information.


cardNumberoptional

The credit card number.Example : "4444333322221111"

string

cardNumberTokenoptional

The credit card number token.Example : "444433ABCDEF1111"

string

contactInfoRefIdoptional

the reference to card holder contact information.Example : "CI-1"

string

cvvoptional

The credit card CVV 3 or 4 digit verification code.Example : "1234"

string

cvvTokenoptional

The credit card CVV code token.Example : "ABCD"

string

32


expirationDateoptional

The credit card expiration date in MMYY format.Example : "0119"

string

vendorCodeoptional

The credit card vendor’s code.Example : "VI"

string

4.52. PaymentInfo


amountrequired

AmountCurrency

idrequired

The PaymentInfo unique identifier.Example : "FOP1"

string

orderItemRefIdsrequired

Lists the OrderItem unique identifiers associated with thepayment.

< string > array

paymentMethodrequired

PaymentMethod

4.53. PaymentMethodContains payment method details.

Name Schema

paymentCardoptional

PaymentCreditCard

paymentCashoptional

PaymentCash

4.54. PhoneContains telephone contact information.


cityCodeoptional

The three-letter IATA city code city code.Example : "DFW"

string

33



countryCodeoptional

The numeric telephone dialing prefixes for the membercountries of the International Telecommunication Union(ITU).Example : "44"

string

idoptional

The unique identifier assigned to the phone.Example : "4d6a453d"

string

labeloptional

The label is used to differentiate multiple phone numbers ofone contact.Example : "Agency, Business, Home, Mobile, Cell, Fax,Hotel"

string

numberoptional

The phone number.Example : "+1123456789"

string

4.55. PhoneAddContains telephone contact information.


cityCodeoptional

The three-letter IATA city code city code.Example : "DFW"

string

countryCodeoptional

The numeric telephone dialing prefixes for the membercountries of the International Telecommunication Union(ITU).Example : "44"

string

labeloptional

The label is used to differentiate multiple Phone numbers ofone contact.Example : "Agency, Business, Home, Mobile, Cell, Fax,Hotel"

string

numberoptional

The phone number.Example : "+1123456789"

string

4.56. PriceContains the amount of money expected, required, or given in payment.

Name Schema

baseAmountoptional

AmountCurrency

34


Name Schema

taxBreakdownsoptional

< Tax > array

totalAmountoptional

AmountCurrency

totalTaxAmountoptional

AmountCurrency

4.57. PriceClassContains special brand pricing information.


codeoptional

The ID of the price class.Example : "SS"

string

idoptional

The unique identifier of the price class.Example : "PC-SS-1"

string

nameoptional

The marketing name of the price class.Example : "SuperSaver"

string

4.58. ProductContains the product associated with a given segment.


airSegmentoptional

AirSegment

idoptional

The unique identifier of the product.Example : "4d54453d"

string

4.59. RemarkContains additional, supplementary information about the document or service.


idoptional

The unique identifier of the remark.Example : "RM-1"

string

35


textoptional

The free text describing the remark.Example : "DELADR REMARK"

string

4.60. RequestTypeThe specification of the type of request, if it is STATEFUL or STATELESS.

Type : enum (STATELESS, STATEFUL)

4.61. SeatAddContains information required to book a seat.


columnoptional

The column letter of the seat to book.Example : "F"

string

offerItemIdoptional

The seat availability offer item ID.Example : "dx71wzhgpjxpvmuy80-1"

string

passengerRefsoptional

The sequential reference number of the passenger.Example : "ABC_X1CB508E0-D65F-4F8E-82E7_pax_0"

string

rowoptional

The row number of the seat to book.Example : "33"

string

segmentRefIdoptional

Segment ID for the seat selection.Example :"SGMIDWUY150NAAIUM4O3BCHTCYUEPBE0YLU2LVHB01BL03FUWBF2KWYJ"

string

4.62. SeatDeleteContains information required to remove booked seat.


orderItemIdoptional

The id of the order item with seat to be deleted.Example : "2"

string

4.63. SegmentContains a list of flight segments.

36


arnkIndoptional

If true, indicates an ARNK (Arrival Unknown) condition. Thisis a gap between a current segment departure and previoussegment arrival location, implying unknown passengermovement.Example : false

boolean

arrivaloptional

Transport

cabinTypeCodeoptional

The single-letter cabin code. Can be one of Y, S, C, J, F, P.Example : "Y"

string

departureoptional

Transport

idoptional

The unique identifier of the passenger segment within thecontent of a message.Example :"SGMIDLGOKQDDCABNVDY2CEZKGQ0IN5MFKAO2QDAMZAMB0CNBRAUD2RMCC"

string


CarrierFlightInfo


CarrierFlightInfo

referencesoptional

< ExternalReference> array

4.64. SelectedOfferItemContains the offerItem selected by the passenger for inclusion in the requested Order. Repeats (onceper passenger), if different passengers want to select different service options, different quantities of a-la-carte items, or different seat locations.


idrequired

The unique identifier of the selected Offer (either a standardoffer or an a-la-carte Offer) returned in a previous shoppingresponse.Example : "dx369rfr7jt8dnd2i0-1-1"

string

37

4.65. SelectedSeatContains information about a booked seat.


characteristicsoptional

Lists all characteristic codes associated with the seat. < string > array

columnoptional

The column where the booked seat is located.Example : "C"

string

rowoptional

The row where the booked seat is located.Example : "2"

string


The passenger segment ID of the selected seat.Example :"SGMIDWUY150NAAIUM4O3BCHTCYUEPBE0YLU2LVHB01BL03FUWBF2KWYJ"

string

4.66. ServiceContains services, or ancillaries, included in an offer or order, pertaining to a given flight.


externalIdoptional

The unique identifier of a service in an external system.Example : "SVC-1"

string

idoptional

The unique identifier of the service.Example : "SVC-1"

string

passengerRefIdoptional

The passenger’s identifier in a data list.Example : "ABC_X1CB508E0-D65F-4F8E-82E7_pax_0"

string

pnrSegmentNumberoptional

Identifies the segment number in a PNR booked for thepassenger and service.Example : 1

integer(int32)


The reference to the Passenger Segment id within a message.Example :"SGMIDWUY150NAAIUM4O3BCHTCYUEPBE0YLU2LVHB01BL03FUWBF2KWYJ"

string

selectedSeatoptional

SelectedSeat

statusCodeoptional

The status of the service instance.Example : "Confirmed"

string

38

4.67. TaxContains tax summary information, including total tax amount.


amountoptional

AmountCurrency

countryCodeoptional

The two-letter ISO 3166-1 country code.Example : "US"

string

descriptionoptional

The tax description used for fulfillment.Example : "airport tax"

string

taxCodeoptional

The tax code.Example : "GB"

string

taxTypeoptional

The tax type. Can be F-fixed, or P-percent.Example : "F"

string

4.68. TicketingDocumentContains details of the ticketing document.


couponsoptional

<TicketingDocumentCoupon > array

inConnectionDocumentNumberoptional

The connected document number.Example : "1231234567890"

string

issueDateTimeoptional

The date and time of documentation issuance in the ticketinglocation’s time zone.Example : "2018-05-26T15:48:17Z"

string(date-time)

numberoptional

The ticket document number.Example : "1231234567890"

string

numberOfBookletsoptional

Number of booklets issued.Example : 1

integer

primaryDocumentIndoptional

If true, indicates that the document is a primary document.Example : true

boolean

39



reportingTypeoptional

The document reconciliation method. Can be BSP, ARC, ordirectly via ORA.Example : "ORA"

string

routingCodeoptional

The code that determines if the route is domestic orinternational. Can be D-Domestic, I-International.Example : "D"

string

ticketingLocationoptional

The three-letter ticketing location code.Example : "LON"

string

typeoptional

The document Type. IATA PADIS Codeset 1001.Example : "T"

string

4.69. TicketingDocumentCouponContains coupon information.


consumedAtIssuanceIndoptional

If true, the coupon is consumed at issuance.Example : false

boolean

inConnectionCouponNumberoptional

The connected document coupon number.Example : "2"

string

inConnectionDocumentNumberoptional

The connected document number.Example : "1231234567890"

string

numberoptional

The coupon number.Example : 1

integer

presentAtoptional

The location of the provider of the service.Example : "JFK"

string

presentTooptional

The name of the provider of the service.Example : "XX"

string

reasonForIssuanceCodeoptional

The ancillary service RFCI, follows IATA PADIS Codeset 4183.Example : "C"

string

40




reasonForIssuanceSubCodeoptional

The ancillary service code based on Reason For Issuance SubCodes (RFISC).Example : "99"

string

serviceCodeoptional

The ancillary service code.Example : "EBAG"

string

serviceRefIdoptional

The reference to the Service, the coupon is associated with.Example : "SVC-1"

string

settlementAuthCodeoptional

The settlement authorization code is generated by thevalidating carrier authorizing settlement of the coupon.Example : "AUTH123"

string

statusoptional

The current coupon status code based on IATA PADIS Codeset4405.Example : "I"

string

4.70. TicketingDocumentInfo


documentoptional

TicketingDocument

paxRefIdoptional

The reference to the passenger.Example : "ABC_X1CB508E0-D65F-4F8E-82E7_pax_0"

string

priceoptional

Price

4.71. TransactionOptions


commitTransactionoptional

If true, transaction is committed at the end of requestprocessing. This option is ignored in STATELESS mode.Default : trueExample : false

boolean

initialIgnoreoptional

If true, current session should be ignored before processingthe request. This option is ignored in STATELESS mode.Default : falseExample : true

boolean

41



movePassengerDetailsoptional

If true, passenger data should be moved to PNR. By default,this option is set to true in STATELESS mode.Default : trueExample : false

boolean

requestTypeoptional

RequestType

4.72. TransportContains location, terminal, gate, and time information.


gateIdoptional

The identifier of the airport gate.Example : "D40"

string

locationCodeoptional

The three-letter IATA city or airport code.Example : "DFW"

string

scheduledDateTimeoptional

The Scheduled date and time of the aircraft at the terminal orgate at an airport.Example : "2018-03-28T09:30:00"

string(date-time)

stationNameoptional

The formal name of the airport.Example : "Dallas International Airport"

string

terminalNameoptional

The name of the airport terminal.Example : "D"

string

4.73. Warning


codeoptional

The code corresponding to the processing warning.Example : "WR-1"

string

messageoptional

The free text description of the provided warning.Example : "Incorrect field value."

string

42
