Other Functions

Regenerate Order

post

Dependency: Order function should be called in prior to this call.

Endpoint: https://sandbox.atriptech.com/regenerateOrder.do

Header parameters
AcceptstringRequiredExample: application/json
Content-TypestringRequiredExample: application/json
Accept-EncodingstringRequiredExample: gzip
x-atlas-client-idstringRequiredExample: <YOUR_CLIENT_ID>
x-atlas-client-secretstringRequiredExample: <YOUR_CLIENT_SECRET>
Body
originalOrderNostringRequired

The order number of the original ticket order you want to regenerate

Example: ACFIO20231207174449854
Responses
chevron-right
200Success
application/json
statusinteger · enumRequired
  • 301: Session does not exist or timed out. Description: The "sessionID" has a validity of 2 hrs. If the “sessionID” is used after this time period, then this error is displayed
  • 302: The target flight is no longer available. Description: In the period between verify and book, the flight has been sold out. This can also be due to the number of passengers booked. The number of pax when booking and the number of pax when verifying may be different. When create a booking, the price is verified based on the actual number of pax booked
  • 303: Airline closed. Description: Airline has either ceased to exist or not operational.
  • 304: Verify failed. Description: In some uncontrollable situations, such as network issues, upgrades, and restarts, 304 error may occur, but not many. If there are many 304 errors, it is possible that the airline is not available or some technical issue at Atlas' end. Contact your account manager if this error keeps on repeating.
  • 305: Invalid routing. Description: When generating an order, the system found that the flight was no longer sold for various reasons, such as 1) L2B 2) The system has identified that there may be a risk of the flight being sold out 3) The airline's sales have been closed
  • 307: Illegal booking request parameters. Description: Some request parameters have problem. Please check the message.
  • 308: Price changed. Description: The price has changed between the price verification and order. Please verify the price again and generate the order.
  • 309: Ancillary not found. Description: Incorrect ancillary product code has been entered. Check and enter the correct ancillary product code.
  • 310: Infant not allowed. Description: The offer does not support infant. Create a new booking without infant passenger type.
  • 312: Too many seats booked. Description: The number of pax booked exceeds the remaining (or allowed) seats on the current flight.
  • 313: Fare family sold out. Description: Selected offer is no longer available. Conduct the search again and rebook.
  • 315: Not enough seats. Description: Seats have been sold out
  • 316: Timed out. Description: There is a time-out error at the airline’s end
  • 317: Booking unsuccessful with Airline. Description: An error has happened at the airline’s end.
  • 318: Check if a booking with the same passenger details and flight numbers exists. After confirming, ignore this booking.
  • 319: Flight information has changed. Description: Re-verify the price (query the latest flight information) and generate the order.
  • 320: The requested seats were not found or they are already occupied. Description: Rebook seats and submit a new order.
  • 321:
  • 322: Seat price changed. Description: Seat price changed. Re-query the seat map and select seats
  • 323: The format of the e-mail in the contact information is incorrect
  • 324: Airline system issues. Description: Retry after some time. If the issue persists, please contact our operations team.
  • 325: The airline has deemed the passenger unserviceable
  • 326: Your account balance on the airline side is insufficient(BYOA scenario)
  • 327: Passenger information does not meet the requirements. Description: Check and correct the passenger information according to the error message
  • 328: Selected seat is no longer available. Description: The selected seat has been occupied.
  • 329: No payment method is available. Description: No payment method is available. Please check whether the quotation currency or account configuration is correct.
  • 330: operation is in progress. Description: operation is in progress
Possible values:
msgstringRequired

It serves as an additional description of the response result. Especially when the interface reports an error (status !=0), it is usually a human-readable error message. Note: Do not use this field in any programming scenarios. For example, do not judge whether the interface responds successfully based on this field. Instead, you should only determine it by checking whether the status is equal to0at any time.

sessionIdstringRequired
orderNostringRequired

Order number of the created order.

pnrCodestringRequired

The pnrCode is the single reference for the booking. This is the Atlas PNR, not airline's.

totalPricenumberRequired

Total price(not including service fee) of this order in the currency TheAtlas settled with you

totalTransactionFeenumberRequired

Total technical fees for this order in the currency TheAtlas settled with you.

currencystringRequired

The currency TheAtlas settled with you.

vendorTotalPricenumber · nullableOptional

Total price of this order in the vendor's currency, reference for you to generate the specific credit card.

vendorCurrencystring · nullableOptional

Vendor's currency.

tktLimitTimestringRequired

Payment deadline for this order. This time will be displayed in SGT (GMT +8). The fromat is:yyyy-MM-dd HH:mm:ss.

duplicateOrdersstring[] · nullableOptional

If the api returns error code318(duplicate booking), then the list will contain duplicate order numbers.

post
/regenerateOrder.do
200Success

Stop Ticket Issuance

post

Dependency: Payment function should be called in prior to this call.

Endpoint: https://sandbox.atriptech.com/stopTicket.do

Header parameters
AcceptstringRequiredExample: application/json
Content-TypestringRequiredExample: application/json
Accept-EncodingstringRequiredExample: gzip
x-atlas-client-idstringRequiredExample: <YOUR_CLIENT_ID>
x-atlas-client-secretstringRequiredExample: <YOUR_CLIENT_SECRET>
Body
orderNostringRequired

The order number of the ticket order you want to stop ticket issuance.

Responses
chevron-right
200Success
application/json
statusintegerRequired

-0: success -other: fail

msgstring · nullableOptional

It serves as an additional description of the response result. Especially when the interface reports an error (status !=0), it is usually a human-readable error message. Note: Do not use this field in any programming scenarios. For example, do not judge whether the interface responds successfully based on this field. Instead, you should only determine it by checking whether the status is equal to0at any time.

post
/stopTicket.do
200Success

Order List

post

Dependency: No preceding function needs to be called before 'orderList' API.

Endpoint: https://sandbox.atriptech.com/orderList.do

Header parameters
AcceptstringRequiredExample: application/json
Content-TypestringRequiredExample: application/json
Accept-EncodingstringRequiredExample: gzip
x-atlas-client-idstringRequiredExample: <YOUR_CLIENT_ID>
x-atlas-client-secretstringRequiredExample: <YOUR_CLIENT_SECRET>
Body

A series of conditions for matching orders

orderNostring · nullableOptional

Atlas order number. Accurate matching

Example: TESTA20241122090710695
airlinePNRsstring[] · nullableOptional

The airline PNR(not Atlas's). If the airline pnr of the order contains any of the given values, it will be returned.

paxNamestring · nullableOptional

The name of the passenger(last name/first name). If the passenger in the order includes the given value, it will be returned.

contactEmailstring · nullableOptional

Accurate matching,match based on the contact email provided by the customer

fromCitystring · nullableOptional

IATA code of the departure city

toCitystring · nullableOptional

IATA code of the arrival city

depDatestring · nullableOptional

Date of departure. The format is:yyyyMMdd

createTimeRangeFromstring · nullableOptional

The start time of order creation. This is in UTC. The format is:yyyy-MM-dd'T'HH:mm:ss'Z'.

createTimeRangeTostring · nullableOptional

The end time of order creation. This is in UTC. The format isyyyy-MM-dd'T'HH:mm:ss'Z'

airlinesstring[] · nullableOptional

If the airlines of the order contains any of the given values, it will be returned

pagestring · nullableOptional

Start from: 1

Default: 1
pageSizestring · max: 100 · nullableOptional

Number of records to be displayed on each page.

Default: 20
Responses
chevron-right
200Success
application/json
statusintegerRequired
msgstring · nullableOptional

It serves as an additional description of the response result. Especially when the interface reports an error (status !=0), it is usually a human-readable error message. Note: Do not use this field in any programming scenarios. For example, do not judge whether the interface responds successfully based on this field. Instead, you should only determine it by checking whether the status is equal to0at any time.

pagestringRequired
pageSizestringRequired
totalRecordsstringRequired
post
/orderList.do
200Success

PNR Claim

post

Dependency No preceding function needs to be carried out.

Endpoint: https://sandbox.atriptech.com/pnr/claim.do

Header parameters
AcceptstringRequiredExample: application/json
Content-TypestringRequiredExample: application/json
Accept-EncodingstringRequiredExample: gzip
x-atlas-client-idstringRequiredExample: <YOUR_CLIENT_ID>
x-atlas-client-secretstringRequiredExample: <YOUR_CLIENT_SECRET>
Body
Responses
chevron-right
200Success
application/json
statusstringRequired
msgstring · nullableOptional
orderNostringRequired

Atlas order number

post
/pnr/claim.do
200Success

Get Balance

post

Dependency No preceding function needs to be carried out.

Endpoint: https://sandbox.atriptech.com/balance.do

Header parameters
AcceptstringRequiredExample: application/json
Content-TypestringRequiredExample: application/json
Accept-EncodingstringRequiredExample: gzip
x-atlas-client-idstringRequiredExample: <YOUR_CLIENT_ID>
x-atlas-client-secretstringRequiredExample: <YOUR_CLIENT_SECRET>
Body
currencystringRequired

The currency of your balance account

Responses
chevron-right
200Success
application/json
statusintegerRequired
msgstring · nullableOptional
post
/balance.do
200Success

City Pairs API

post

The "City pairs API" can be used to download the city pairs supported by Atlas as well as by the airlines. The customer can use this structured data and transfer the city pair information into their mid-back office systems.

This API is only available in the production environment.

Dependency There is no dependency for this call.

Endpoint: https://sandbox.atriptech.com/route/export.do

Header parameters
AcceptstringRequiredExample: application/json
Content-TypestringRequiredExample: application/json
Accept-EncodingstringRequiredExample: gzip
x-atlas-client-idstringOptionalExample: <YOUR_CLIENT_ID>
x-atlas-client-secretstringOptionalExample: <YOUR_CLIENT_SECRET>
Body
routeTypeintegerRequired

-1: Airline routes -2: Atlas routes

fromCitystring · nullableOptional

IATA Code of departure city.

fromCountrystring · nullableOptional

IATA Code of departure country.

toCitystring · nullableOptional

IATA Code of arrival city or airport

toCountrystring · nullableOptional

IATA Code of arrival country.

airlinesstring[] · nullableOptional

An array of IATA Codes of airlines. The routes within the airlines will be returned.

pageSizeinteger · nullableOptionalDefault: 10000
pageNumberinteger · nullableOptionalDefault: 1
Responses
chevron-right
200Success
application/json
statusintegerRequired
msgstring · nullableOptional
post
/route/export.do
200Success

Email List

post

Dependency No preceding function needs to be carried out.

Endpoint: https://sandbox.atriptech.com/queryMail.do

Header parameters
AcceptstringRequiredExample: application/json
Content-TypestringRequiredExample: application/json
Accept-EncodingstringRequiredExample: gzip
x-atlas-client-idstringRequiredExample: <YOUR_CLIENT_ID>
x-atlas-client-secretstringRequiredExample: <YOUR_CLIENT_SECRET>
Body
orderNostring · nullableOptional

Order number. At least one of the order number, receiving time and/or creation time must be specified for querying.

emailReceivingDateStartstring · nullableOptional

Start of the receiving time. The time Atlas received the airline's email. Format: yyyy-MM-dd hh:mm:ss UTC+08:00

emailReceivingDateEndstring · nullableOptional

End of the receiving time. The time Atlas received the airline's email. Format: yyyy-mm-dd hh:mm:ss UTC+08:00. You can only query data for up to one month at a time

createTimeStartstring · nullableOptional

Start of creation time. Create Time is the time when Atlas created this email record in the Email list. Generally, it will be later than the receiving time. Format: yyyy-mm-dd hh:mm:ss UTC+08:00

createTimeEndstring · nullableOptional

End of creation time. Create Time is the time when Atlas created this email record in the Email list. Generally, it will be later than the receiving time. Format: yyyy-MM-dd hh:mm:ss UTC+08:00 You can only query data for up to one month at a time.

emailCategoriesstring · nullableOptional

Atlas email categories. Atlas categorizes emails but does not guarantee accuracy in classification. -Travel Itinerary -Schedule Change -Payment Due -Payment Success -Receipt -Trip Reminder -PNR Cancellation Success -Advertisement -Duplicated Schedule Change -Verification -Unaccounted Cancellation -Promo code

pageIndexstring · nullableOptionalDefault: 1
pageSizestring · nullableOptionalDefault: 100
Responses
chevron-right
200Success
application/json
statusintegerRequired
msgstring · nullableOptional
hasNextbooleanRequired

-true: There is also the next page -false: There is not the next page

post
/queryMail.do
200Success

Extract PNR

post

This API is used to directly connect to airlines and extract PNR information. The content displayed by this API reflects the current PNR information on the airline side, such as flight schedule and ticket status. Atlas extracts airline information truthfully and will not do any modification.

Endpoint: https://sandbox.atriptech.com/extractPnr.do

Header parameters
AcceptstringRequiredExample: application/json
Content-TypestringRequiredExample: application/json
Accept-EncodingstringRequiredDefault: gzipExample: gzip
x-atlas-client-idstringRequiredDefault: <YOUR_CLIENT_ID>Example: <YOUR_CLIENT_ID>
x-atlas-client-secretstringRequiredDefault: <YOUR_CLIENT_SECRET>Example: <YOUR_CLIENT_SECRET>
Body
airlinePnrstringRequired

The airline PNR

carrierstringRequired

2-letter IATA code for the airline

timeoutinteger · nullableOptional

The maximum response duration, in milliseconds. Note: This time is estimated due to the impact of network transmission.

Default: 15000
Responses
chevron-right
200Success
application/json
statusinteger · enumRequiredPossible values:
msgstring · nullableOptional
airlinePnrstringRequired

Airline PNR(not Atlas)

Example: BSG768
pnrStatusstring · enumRequiredExample: TicketedPossible values:
pnrUsedstring · enum · nullableRequired

pnr usage status

Possible values:
currencystring · nullableOptional

The currency of fare

Example: USD
totalPricestring · nullableOptional
post
/extractPnr.do
200Success

getAtripToken

post

Dependency No preceding function needs to be carried out.

Header parameters
AcceptstringRequiredExample: application/json
Content-TypestringRequiredExample: application/json
Accept-EncodingstringRequiredDefault: gzipExample: gzip
x-atlas-client-idstringRequiredDefault: <YOUR_CLIENT_ID>Example: <YOUR_CLIENT_ID>
x-atlas-client-secretstringRequiredDefault: <YOUR_CLIENT_SECRET>Example: <YOUR_CLIENT_SECRET>
Body
orderNostringRequired

Order number. It can be an order for ticketing, or an order for add bags. The format of each kind of order is different.

userNamestringRequired

This is to identifier the operator's name in client's system, Atlas will grant access to this operator and track his/her actions in Atlas customer service portal.

rolestringRequired

This is to identify the operator's role. Atlas will grant access to this operator according to the role assigned. Here are the acceptable options:

Customer service : Access to manage orders and request post ticketing services

Finance : Access to manage the balance and check statements

Developer : Access to manage the system configurations

Admin : Full access

Responses
chevron-right
200Success
application/json
urlstringRequired

A url with token to access to Atlas customer service portal.

statusintegerRequired

0: success

2: System error

3: unauthorized access

msgstring · nullableOptional

Error message.

The 'msg' element is for description of the results. Please DO NOT use this field to check the success or failure of the request. Only use the 'status' code to check the result.

post
/getAtripToken.do
200Success

Last updated

Was this helpful?