latestOpenAPI 3.0.12026-08-102668257.3 KB

8e9a8f8010ab

Shopping and Ticketing

Retrieve Booking

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

Please refer to the below information for the usage of the queryOrderDetails.do API.

  1. All the parameters can be used together, if required.
  2. “OrderNo” is “required” if “airlinePNR” and “carrier” cannot be provided upon calling the API. Inversely, “airlinePNR” and “carrier” are “required” if “OrderNo” cannot be provided. All remaining fields in the request are optional.
  3. The PNR (Passenger Name Record) for an airline ticket order or a luggage purchase order must be kept consistent, as per airline regulations.
  4. The input parameters orderNo, airlinePNR, carrier, and other optional fields will be validated together to ensure they belong to the same order data source. If any of these input parameters do not match with others, the API will return an error.
  5. Airline ticket orders and associated post-booking ancillary orders can be retrieved using the following methods: (airline ticket orders + post-booking ancillary orders):
    • orderNo
    • airlinePNR + carrier
    • orderNo + airlinePNR + carrier
    • orderNo + airlinePNR + carrier + other optional parameters
  6. In case the parameters of “airlinePNR” and “carrier” cannot identify an unique order (e.g BC - PNR is made up with 4 number), customer needs to enter additional parameters such as "name" for identification. In such scenarios, API will respond with error msg ”Multi-orderNos are identified, please request again with extra parameters added.”

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

post/queryOrderDetails.do

Headers

Acceptstring required
Content-Typestring required
Accept-Encodingstring required
x-atlas-client-idstring required
x-atlas-client-secretstring required

Request body

orderNostring nullable

Order number of the order you want to retrieve

pnrCodestring nullable

The pnrCode is the single reference for the booking. This is the Atlas PNR.

Response

status800 | 701 | 702 | 703 | 704 | 705 required
msgstring

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.

orderNostring required

Order number

pnrCodestring required

The pnrCode is the single reference for the booking. This is the Atlas PNR.

orderStatusstring required

Order status -0: Unpaid -1: Ticketing-in-Process -2: Ticketed --3: Cancelled

ticketStatusstring required

Ticket status -0: Ticket not issued -1: Ticket issued

totalPricenumber required

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

currencystring required

The currency TheAtlas settled with you.

tktLimitTimestring required

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

vendorTotalPricenumber nullable

Total price of this order in the vendor's currency, reference for you to generate the specific credit card. If the order does not support VCC passthrough or BYOA, this fare will not be displayed.

vendorCostnumber nullable

The actual price charged by the airline, which is denominated in the airline's currency(vendorCurrency). We will only display the actual amount charged by the airline if the order supports VCC passthrough or BYOA, otherwise, this field will benull.

vendorTotalAncillaryPricenumber nullable

Total ancillary price of this order in the vendor's currency. If the order does not support VCC passthrough or BYOA, this fare will not be displayed.

vendorCurrencystring nullable

Vendor's currency.

adultTotalFarenumber required

Total adult price of this order in the currency TheAtlas settled with you.

childTotalFarenumber required

Total child price of this order in the currency TheAtlas settled with you.

infantTotalFarenumber nullable

Total infant price of this order in the currency TheAtlas settled with you.

totalAncillaryPricenumber nullable

Total ancillary price of this order in the currency TheAtlas settled with you.

totalTransactionFeenumber required

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

supportPaymentMethodnumber required

This tag shows which payment method is supported for that particular booking. -1: Prepayment Only -3: Both Credit Card Payment and Prepayment Available

This field has been deprecated, pls usesupportPaymentMethods instead.

supportPaymentMethodsPaymentMethod[] required

The payment methods supported by the order.

paymentMethod1 | 3 | 4 | 5
itineraryDownloadstring required

The link to download the itinerary of the trip.

errorCode'601' | '602' | '603' | '604' | '605' | '6051' | '606' | '607' | '608' | '609' | '611' | '613' | '614' | '615' | '616' | '617' | '618' | '619' | '620' | '621' | '623' | '624' | '625' | '626' | '627' | '628' | '629' | '630' | '631' | '632' | '633' | '634' | '698' | '699' required
errorMessagestring

A brief message used to explain theerrorCode.

airlineMessagestring

A piece of error message on the airline side that is used to explain theerrorCode.

ifSeatOccupied'SIMILAR_SEAT' | 'STOP_SEAT' | 'STOP_TICKET'
paymentAttemptedboolean nullable

Only used for VCC transparent transmission, indicating whether Atlas has initiated payment operations with the airline using your VCC. true/false/null (meaningless). -true: Atlas has previously initiated a payment operation with the airline. -false: Atlas has not initiated a payment operation with the airline. -null: meaningless Note: true only indicates that Atlas has previously initiated a payment operation with the airline, and does not represent the payment result (successful or failed)