search

查询订单

hashtag
Retrieve Booking

post

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

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

Order number of the order you want to retrieve

pnrCodestring · nullableOptional

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

Responses
chevron-right
200Success
application/json
statusinteger · enumRequired
  • 800: Order not exists
  • 701: Multi-order are identified, please request again with extra parameters added
  • 702: airlinePNR and carrier are mandatory to fill in for order retrieval, please check and request again
  • 703: No order found, please check the parameter
  • 704: Parameters don't match, please check and retry
  • 705: Timeout
Possible values:
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.

orderNostringRequired

Order number

pnrCodestringRequired

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

orderStatusstringRequired

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

ticketStatusstringRequired

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

totalPricenumberRequired

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

currencystringRequired

The currency TheAtlas settled with you.

tktLimitTimestringRequired

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

vendorTotalPricenumber · nullableOptional

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 · nullableOptional

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 · nullableOptional

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 · nullableOptional

Vendor's currency.

adultTotalFarenumberRequired

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

childTotalFarenumberRequired

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

infantTotalFarenumber · nullableOptional

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

totalAncillaryPricenumber · nullableOptional

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

totalTransactionFeenumberRequired

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

supportPaymentMethodnumberRequiredDeprecated

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.

paymentMethodinteger · enum · nullableOptional

This is the mode of payment used to pay for the booking. If the order is not paid, this field will benull.

Possible values:
itineraryDownloadstringRequired

The link to download the itinerary of the trip.

errorCodestring · enumRequired

An error code used to indicate the specific reason for ticket issuance failure. Note that this error code will only be displayed when the order is canceled due to ticket issuance failure.

Possible values:
errorMessagestringOptional

A brief message used to explain theerrorCode.

airlineMessagestringOptional

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

ifSeatOccupiedstring · enum · nullableOptional

Configuration of ordering when the seat is occupied.

Possible values:
paymentAttemptedboolean · nullableOptional

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)

post
/queryOrderDetails.do
200Success
Previous支付与出票Next智能搜索

Last updated

Was this helpful?