Production(3.1.0)
- Overview
- Release Notes
- Get Started
- Airline Integration Guide
- PolarHub API
- Support & Contact
- PolarHub Errors&Troubleshooting
- Schemas
- PolarHub Schema 2025.6
- PolarHub Schema 2025.3
- PolarHub Schema 2025.7
OrderCreate
POST
https://hub.halo-platform.net/hub/polarpie/v2/order
PolarHub API
Last modified:2025-10-13 05:02:20
Overview#
Usage Guidelines#
Form of Payment#
Using Individual, IdentityDoc, ContactInfo#
Using APIS-DOCS / DOCA mandatory (BA only)#
OrderCreateRQ/Query/PaxList/IdentityDocOrderCreateRQ/Query/ContactInfoList/PostalAddressBA Booking Error Response Case#
50202"Your booking has been created successfully. Please retrieve it using the OrderID [Order_ID](BA)"OrderRetrieveRQ.Young Adult (YADT) Booking (BA only)#
Travel Agency Contact Info Required#
OrderCreateRQ/Sender/TravelAgency/ContactInfoRefIDOrderCreateRQ/Query/ContactInfoList/EmailAddressOrderCreateRQ/Query/ContactInfoList/PhoneOrderCreateRQ/Query/ContactInfoList/PostalAddressPassport Issuing Country / Citizenship Country Code Required#
OrderCreateRQ/Query/PaxList/IdentityDoc/IssuingCountryCodeOrderCreateRQ/Query/PaxList/IdentityDoc/CitizenshipCountryCodeFFN (Loyalty program)#
Request
Header Params
Body Params application/json
Examples
{
"Sender": {
"TravelAgency": {
"AgencyID": "TSDV001",
"ContactInfoRefID": [
"CTC_TA1"
]
}
},
"PointOfSale": "KR",
"TransactionID": "d84d2a2430334fd0869f9e599f18b154",
"Query": {
"Order": [
{
"OfferID": "dc1fa40b4e79469bb7187e0f58469a2a21.3-1",
"Owner": "SQ",
"ResponseID": "d84d2a2430334fd0869f9e599f18b154",
"OfferItems": [
{
"OfferItemID": "dc1fa40b4e79469bb7187e0f58469a2a21.3-1-1",
"Owner": "SQ",
"PaxRefID": [
"PAX1",
"PAX2",
"PAX3"
]
}
]
}
],
"PaxList": [
{
"PaxID": "PAX1",
"Ptc": "ADT",
"Individual": {
"Surname": "FEIL",
"GivenName": [
"PATSY"
],
"NameTitle": "MS",
"Gender": "FEMALE",
"Birthdate": "1927-08-14"
},
"Gender": "FEMALE",
"ContactInfoRefID": [
"CI0"
],
"IdentityDoc": [
{
"IdentityDocumentNumber": "M92802556",
"IdentityDocumentType": "PT",
"IssuingCountryCode": "KR",
"ExpiryDate": "2028-05-03",
"Gender": "FEMALE",
"CitizenshipCountryCode": "KR",
"ResidenceCountryCode": "KR"
}
],
"LoyaltyProgramAccount": []
},
{
"PaxID": "PAX2",
"Ptc": "ADT",
"Individual": {
"Surname": "LOWE",
"GivenName": [
"YOLANDA"
],
"NameTitle": "MS",
"Gender": "FEMALE",
"Birthdate": "1927-06-28"
},
"Gender": "FEMALE",
"ContactInfoRefID": [
"CI1"
],
"IdentityDoc": [
{
"IdentityDocumentNumber": "M37574615",
"IdentityDocumentType": "PT",
"IssuingCountryCode": "KR",
"ExpiryDate": "2030-03-24",
"Gender": "FEMALE",
"CitizenshipCountryCode": "KR",
"ResidenceCountryCode": "KR"
}
],
"LoyaltyProgramAccount": []
},
{
"PaxID": "PAX3",
"Ptc": "CHD",
"Individual": {
"Surname": "STOKE",
"GivenName": [
"WENDY"
],
"NameTitle": "MISS",
"Gender": "FEMALE",
"Birthdate": "2013-12-15"
},
"Gender": "FEMALE",
"ContactInfoRefID": [
"CI2"
],
"IdentityDoc": [
{
"IdentityDocumentNumber": "M81330849",
"IdentityDocumentType": "PT",
"IssuingCountryCode": "KR",
"ExpiryDate": "2028-12-03",
"Gender": "FEMALE",
"CitizenshipCountryCode": "KR",
"ResidenceCountryCode": "KR"
}
],
"LoyaltyProgramAccount": []
}
],
"PaymentList": [
{
"Type": "Cash",
"Amount": 1884900,
"CurCode": "KRW",
"PaxRefID": [],
"OrderItemID": [],
"OfferItemID": [
"a682f22d25ba4603ac280a01decb1f1f21.3-1-1"
]
}
],
"ContactInfoList": [
{
"ContactInfoID": "CI0",
"EmailAddress": [
"halo_dev@tidesquare.com"
],
"Phone": [
{
"Label": "Mobile",
"CountryDialingCode": "82",
"AreaCode": "",
"PhoneNumber": "1046900081"
}
],
"ContactRefusedInd": false
},
{
"ContactInfoID": "CI1",
"EmailAddress": [
"halo_dev@tidesquare.com"
],
"Phone": [
{
"Label": "Mobile",
"CountryDialingCode": "82",
"AreaCode": "",
"PhoneNumber": "1046900081"
}
],
"ContactRefusedInd": false
},
{
"ContactInfoID": "CI2",
"EmailAddress": [
"halo_dev@tidesquare.com"
],
"Phone": [
{
"Label": "Mobile",
"CountryDialingCode": "82",
"AreaCode": "",
"PhoneNumber": "1046900081"
}
],
"ContactRefusedInd": false
},
{
"ContactInfoID": "CTC_TA1",
"EmailAddress": [
"halo_dev@tidesquare.com"
],
"Phone": [
{
"CountryDialingCode": "82",
"PhoneNumber": "234486101"
}
],
"PostalAddress": [
{
"Street": [
"8F 9F, 78, Namdaemun-ro, Jung-gu"
],
"PostalCode": "04534",
"CountryCode": "KR",
"CityName": "Seoul"
}
]
}
]
}
}Request Code Samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location --request POST 'https://hub.halo-platform.net/hub/polarpie/v2/order' \
--header 'x-date: {{Header Construction - Step 1: Date Header}}' \
--header 'digest: SHA-512={{Header Construction - Step 2: Digest Header}}' \
--header 'authorization: hmac username={{TenantID}}, algorithm="hmac-sha512", headers="x-date digest", signature={{Header Construction - Step 3: Authorization Header}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"Sender": {
"TravelAgency": {
"AgencyID": "TSDV001",
"ContactInfoRefID": [
"CTC_TA1"
]
}
},
"PointOfSale": "KR",
"TransactionID": "d84d2a2430334fd0869f9e599f18b154",
"Query": {
"Order": [
{
"OfferID": "dc1fa40b4e79469bb7187e0f58469a2a21.3-1",
"Owner": "SQ",
"ResponseID": "d84d2a2430334fd0869f9e599f18b154",
"OfferItems": [
{
"OfferItemID": "dc1fa40b4e79469bb7187e0f58469a2a21.3-1-1",
"Owner": "SQ",
"PaxRefID": [
"PAX1",
"PAX2",
"PAX3"
]
}
]
}
],
"PaxList": [
{
"PaxID": "PAX1",
"Ptc": "ADT",
"Individual": {
"Surname": "FEIL",
"GivenName": [
"PATSY"
],
"NameTitle": "MS",
"Gender": "FEMALE",
"Birthdate": "1927-08-14"
},
"Gender": "FEMALE",
"ContactInfoRefID": [
"CI0"
],
"IdentityDoc": [
{
"IdentityDocumentNumber": "M92802556",
"IdentityDocumentType": "PT",
"IssuingCountryCode": "KR",
"ExpiryDate": "2028-05-03",
"Gender": "FEMALE",
"CitizenshipCountryCode": "KR",
"ResidenceCountryCode": "KR"
}
],
"LoyaltyProgramAccount": []
},
{
"PaxID": "PAX2",
"Ptc": "ADT",
"Individual": {
"Surname": "LOWE",
"GivenName": [
"YOLANDA"
],
"NameTitle": "MS",
"Gender": "FEMALE",
"Birthdate": "1927-06-28"
},
"Gender": "FEMALE",
"ContactInfoRefID": [
"CI1"
],
"IdentityDoc": [
{
"IdentityDocumentNumber": "M37574615",
"IdentityDocumentType": "PT",
"IssuingCountryCode": "KR",
"ExpiryDate": "2030-03-24",
"Gender": "FEMALE",
"CitizenshipCountryCode": "KR",
"ResidenceCountryCode": "KR"
}
],
"LoyaltyProgramAccount": []
},
{
"PaxID": "PAX3",
"Ptc": "CHD",
"Individual": {
"Surname": "STOKE",
"GivenName": [
"WENDY"
],
"NameTitle": "MISS",
"Gender": "FEMALE",
"Birthdate": "2013-12-15"
},
"Gender": "FEMALE",
"ContactInfoRefID": [
"CI2"
],
"IdentityDoc": [
{
"IdentityDocumentNumber": "M81330849",
"IdentityDocumentType": "PT",
"IssuingCountryCode": "KR",
"ExpiryDate": "2028-12-03",
"Gender": "FEMALE",
"CitizenshipCountryCode": "KR",
"ResidenceCountryCode": "KR"
}
],
"LoyaltyProgramAccount": []
}
],
"PaymentList": [
{
"Type": "Cash",
"Amount": 1884900,
"CurCode": "KRW",
"PaxRefID": [],
"OrderItemID": [],
"OfferItemID": [
"a682f22d25ba4603ac280a01decb1f1f21.3-1-1"
]
}
],
"ContactInfoList": [
{
"ContactInfoID": "CI0",
"EmailAddress": [
"halo_dev@tidesquare.com"
],
"Phone": [
{
"Label": "Mobile",
"CountryDialingCode": "82",
"AreaCode": "",
"PhoneNumber": "1046900081"
}
],
"ContactRefusedInd": false
},
{
"ContactInfoID": "CI1",
"EmailAddress": [
"halo_dev@tidesquare.com"
],
"Phone": [
{
"Label": "Mobile",
"CountryDialingCode": "82",
"AreaCode": "",
"PhoneNumber": "1046900081"
}
],
"ContactRefusedInd": false
},
{
"ContactInfoID": "CI2",
"EmailAddress": [
"halo_dev@tidesquare.com"
],
"Phone": [
{
"Label": "Mobile",
"CountryDialingCode": "82",
"AreaCode": "",
"PhoneNumber": "1046900081"
}
],
"ContactRefusedInd": false
},
{
"ContactInfoID": "CTC_TA1",
"EmailAddress": [
"halo_dev@tidesquare.com"
],
"Phone": [
{
"CountryDialingCode": "82",
"PhoneNumber": "234486101"
}
],
"PostalAddress": [
{
"Street": [
"8F 9F, 78, Namdaemun-ro, Jung-gu"
],
"PostalCode": "04534",
"CountryCode": "KR",
"CityName": "Seoul"
}
]
}
]
}
}'Responses
🟢200Success
application/json
Body
Example
{
"OrderViewRS": {
"ResultMessage": {
"Code": "string",
"Message": "string",
"MessageDetail": {
"Errors": [
{
"Owner": "string",
"Message": "string",
"Code": "string",
"Status": "string",
"ShortText": "string",
"Type": "string"
}
],
"Warnings": [
{
"Owner": "string",
"Message": "string",
"Code": "string",
"Status": "string",
"ShortText": "string",
"Type": "string"
}
]
}
},
"Recipient": {
"TravelAgency": {
"AgencyID": "string",
"SiteCode": "string",
"AgencyName": "string",
"ContactInfoRefID": [
"string"
]
}
},
"PointOfSale": "string",
"TransactionID": "string",
"Order": {
"OrderID": "string",
"OrderStatus": "string",
"TotalPrice": {
"TotalAmount": {
"Amount": 0,
"CurCode": "string"
},
"TravelAgencyServiceFee": [
{
"Ptc": "string",
"Fee": {
"Amount": 0,
"CurCode": "string"
}
}
],
"TotalBaseAmount": {
"Amount": 0,
"CurCode": "string"
},
"TotalTaxAmount": {
"Amount": 0,
"CurCode": "string"
},
"AgencyPromotion": {
"PromotionCode": "string",
"TotalPromotionAmount": {
"Amount": 0,
"CurCode": "string"
},
"PtcPromotionAmount": [
{
"Ptc": "string",
"Amount": {
"Amount": 0,
"CurCode": "string"
}
}
]
},
"FopPromotion": [
{
"PromotionCode": "string",
"PaymentType": "string",
"TotalPromotionAmount": {
"Amount": 0,
"CurCode": "string"
},
"PtcPromotionAmount": [
{
"Ptc": "string",
"Amount": {
"Amount": 0,
"CurCode": "string"
}
}
],
"CardCode": "string",
"CardName": "string"
}
]
},
"BookingReference": [
{
"Id": "string",
"AirlineID": "string",
"AirlineName": "string",
"OtherID": "string",
"Type": "string"
}
],
"JourneyOverview": [
{
"PaxJourneyRefID": "string",
"PriceClassInfo": {
"PriceClass": "string",
"Code": "string",
"Name": "string",
"Descriptions": [
{
"DescID": "string",
"Text": "string",
"Application": "string"
}
]
}
}
],
"OrderItem": [
{
"OrderItemID": "string",
"Owner": "string",
"PaxJourneyRefID": [
"string"
],
"PaxRefID": [
"string"
],
"Service": [
{
"ServiceID": "string",
"PaxRefID": "string",
"PaxJourneyRefID": "string",
"PaxSegmentRefID": "string",
"Status": "string",
"SelectedSeat": {
"Column": "string",
"Row": "string"
},
"Definition": {
"Name": "string",
"Desc": [
{
"DescID": "string",
"Text": "string",
"Application": "string"
}
],
"Rfic": "string",
"Rfisc": "string",
"ServiceCode": "string",
"BookingInstructions": {
"SsrCode": [
"string"
],
"OsiText": [
"string"
],
"Text": [
"string"
],
"UpgradeMethod": "string",
"Method": "string",
"Equipment": "string"
}
}
}
],
"FareDetail": [
{
"BaseAmount": {
"Amount": 0,
"CurCode": "string"
},
"TaxTotal": {
"Amount": 0,
"CurCode": "string"
},
"Tax": [
{
"Amount": {
"Amount": 0,
"CurCode": "string"
},
"TaxCode": "string",
"LocalAmount": {
"Amount": 0,
"CurCode": "string"
},
"Desc": "string",
"Nation": "string"
}
],
"FareComponent": [
{
"PaxSegmentRefID": [
"string"
],
"Penalty": {
"Change": "string",
"Refund": "string",
"NoShow": "string",
"Detail": [
{
"Type": "string",
"Amounts": [
{
"CurrencyAmountValue": 0,
"Code": "string",
"AmountApplication": "string"
}
],
"Application": {
"Code": "string"
}
}
],
"Description": [
{
"DescID": "string",
"Text": "string",
"Application": "string"
}
]
},
"FareBasis": {
"FareBasisCode": "string",
"FareCode": "string",
"CabinType": [
{
"PaxSegmentRefID": "string",
"CabinCode": "string",
"CabinName": "string",
"Rbd": "string"
}
]
},
"Remarks": [
"string"
]
}
],
"PaxRefID": [
"string"
]
}
],
"FlightMileage": 0,
"Commission": {
"Amount": {
"Amount": 0,
"CurrencyCode": "string",
"Taxable": true
},
"Percentage": 0,
"Code": "string",
"Remarks": [
{
"Remark": "string"
}
]
},
"PaymentTimeLimit": "string",
"PriceGuaranteeTimeLimit": "string",
"TicketTimeLimit": "string"
}
],
"BaggageAllowance": [
{
"PaxJourneyRefID": "string",
"PaxSegmentRefID": "string",
"PaxRefID": [
"string"
],
"TypeCode": "string",
"ApplicableBagType": "string",
"Desc": [
"string"
],
"PieceAllowance": "1PC",
"DimensionAllowance": {
"Length": {
"Value": 0,
"UnitCode": "string"
},
"Width": {
"Value": 0,
"UnitCode": "string"
},
"Height": {
"Value": 0,
"UnitCode": "string"
}
},
"MaximumWeightAllowance": {
"Value": 0,
"UnitCode": "string"
}
}
]
},
"DataLists": {
"OriginDestList": [
{
"OriginCode": "string",
"DestCode": "string",
"OriginDestID": "string",
"PaxJourneyRefID": [
"string"
]
}
],
"PaxJourneyList": [
{
"PaxJourneyID": "string",
"FlightTime": "string",
"OnPoint": "string",
"OffPoint": "string",
"PaxSegmentRefID": [
"string"
]
}
],
"PaxSegmentList": [
{
"PaxSegmentID": "string",
"ArnkInd": true,
"Departure": {
"AirportCode": "string",
"Date": "string",
"Time": "string",
"AirportName": "string",
"Terminal": {
"Name": "string"
}
},
"Arrival": {
"AirportCode": "string",
"Date": "string",
"Time": "string",
"AirportName": "string",
"Terminal": {
"Name": "string"
}
},
"FlightDuration": "string",
"Equipment": {
"AircraftCode": "string",
"Name": "string"
},
"MarketingCarrier": {
"AirlineID": "string",
"Name": "string",
"FlightNumber": "string"
},
"OperatingCarrier": {
"AirlineID": "string",
"Name": "string",
"FlightNumber": "string"
},
"Status": "string",
"Legs": [
{
"Departure": {
"AirportCode": "string",
"Date": "string",
"Time": "string",
"AirportName": "string",
"Terminal": {
"Name": "string"
}
},
"Arrival": {
"AirportCode": "string",
"Date": "string",
"Time": "string",
"AirportName": "string",
"Terminal": {
"Name": "string"
}
},
"ChangeofGaugeInd": true,
"Equipment": {
"AircraftCode": "string",
"Name": "string"
},
"OnGroundDuration": "string",
"TicketlessInd": true
}
]
}
],
"PaxList": [
{
"PaxID": "string",
"Ptc": "string",
"Individual": {
"IndividualID": "string",
"Birthdate": "string",
"Birthplace": "string",
"Gender": "Female",
"NameTitle": "string",
"GivenName": [
"string"
],
"MiddleName": [
"string"
],
"Surname": "string",
"SurnameSuffix": "string"
},
"ContactInfoRefID": [
"string"
],
"Gender": "Female",
"ResidenceCountryCode": "string",
"CitizenshipCountryCode": "string",
"PaxRefID": "string",
"IdentityDoc": [
{
"IdentityDocumentNumber": "string",
"IdentityDocumentType": "string",
"IssuingCountryCode": "string",
"CitizenshipCountryCode": "string",
"ResidenceCountryCode": "string",
"IssueDate": "string",
"ExpiryDate": "string",
"Birthdate": "string",
"Birthplace": "string",
"Gender": "Female",
"NameTitle": "string",
"GivenName": [
"string"
],
"MiddleName": [
"string"
],
"Surname": "string",
"SurnameSuffix": "string",
"Visa": [
{
"VisaNumber": "string",
"VisaType": "string",
"VisaHostCountryCode": "string",
"EnterBeforeDate": "string",
"DurationOfStay": 0,
"NumberOfEntries": 0
}
]
}
],
"LoyaltyProgramAccount": [
{
"Alliance": {
"Name": "string",
"Code": "string",
"Url": "http://example.com",
"Airline": [
{
"AirlineName": "string",
"AirlineDesignator": "string"
}
]
},
"Airline": {
"AirlineName": "string",
"AirlineDesignator": "string"
},
"ProviderName": "string",
"ProgramName": "string",
"ProgramCode": "string",
"AccountNumber": "string",
"Url": "http://example.com",
"SignInID": "string",
"TierCode": "string",
"TierName": "string",
"TierPriority": "string"
}
]
}
],
"CurrencyDecimalPlaceList": [
{
"CurCode": "string",
"DecimalPlace": 0
}
],
"TicketDocList": [
{
"TicketDocument": [
{
"TicketDocNbr": "string",
"Type": "string",
"NumberofBooklets": 0,
"IssueDate": "string",
"IssueTime": "string",
"ReportingType": "string",
"Status": "string",
"VoidLimit": "string",
"CouponInfos": [
{
"CouponNumber": "string",
"FareBasisCode": "string",
"PaxSegmentRefID": "string",
"Status": "string",
"InConnectionWithInfo": {
"InConnectionDocNbr": "string",
"InConnectionCpnNbr": "string"
},
"ServiceRefID": [
"string"
]
}
],
"InConnectionDocNbr": "string"
}
],
"PaxRefID": "string",
"AgentIDs": {
"Type": "string",
"Id": "string"
},
"IssuingAirlineInfo": {
"AirlineName": "string"
},
"FareDetail": [
{
"BaseAmount": {
"Amount": 0,
"CurCode": "string"
},
"TaxTotal": {
"Amount": 0,
"CurCode": "string"
},
"Tax": [
{
"Amount": {
"Amount": 0,
"CurCode": "string"
},
"TaxCode": "string",
"LocalAmount": {
"Amount": 0,
"CurCode": "string"
},
"Desc": "string",
"Nation": "string"
}
],
"FareComponent": [
{
"PaxSegmentRefID": [
"string"
],
"Penalty": {
"Change": "string",
"Refund": "string",
"NoShow": "string",
"Detail": [
{
"Type": "string",
"Amounts": [
{
"CurrencyAmountValue": 0,
"Code": "string",
"AmountApplication": "string"
}
],
"Application": {
"Code": "string"
}
}
],
"Description": [
{
"DescID": "string",
"Text": "string",
"Application": "string"
}
]
},
"FareBasis": {
"FareBasisCode": "string",
"FareCode": "string",
"CabinType": [
{
"PaxSegmentRefID": "string",
"CabinCode": "string",
"CabinName": "string",
"Rbd": "string"
}
]
},
"Remarks": [
"string"
]
}
],
"PaxRefID": [
"string"
]
}
]
}
],
"PaymentList": [
{
"Type": "CA",
"Amount": 1474000,
"CurCode": "KRW",
"Status": "395",
"PaxRefID": [],
"OrderItemID": [
"PoIP676BC2CD-86EA-4E50-97C6-1-1"
]
}
],
"ContactInfoList": [
{
"ContactInfoID": "CI1",
"EmailAddress": [
"user@example.com"
],
"Phone": [
{
"Label": "Mobile",
"CountryDialingCode": "82",
"AreaCode": "2",
"PhoneNumber": "12345678",
"Extension": "1234"
}
],
"ContactRefusedInd": false,
"PostalAddress": [
{
"Label": "HOME",
"Street": [
"201 W 79th St"
],
"CityName": "Seoul",
"CountryCode": "KR"
}
]
}
]
},
"AugmentationPoint": {
"Any": [
{}
]
}
}
}Modified at 2025-10-13 05:02:20