latestOpenAPI 3.0.12026-08-102668257.3 KB

8e9a8f8010ab

Shopping and Ticketing

Order

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

The booking requirements need to be read from the "bookingRequirement" array in the "verify.do" response. The "Booking Requirements" can be different at the route level. Alternatively, you can add all the details but please note that all the fields should have actual data and not fictitious information. Please follow this approach.

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

OTA Baggage: Optionally provide passengerBaggages when the client has already sold baggage to the passenger. Atlas uses the submitted baggage specification and sale price for fulfillment; it does not replace the request with an internal Atlas baggage product.

The baggage is matched to the booked passenger by passengerName and to the flight segment by flight. Do not submit OTA baggage when one order contains multiple segments with the same flight number.

post/order.do

Headers

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

Request body

sessionIdstring nullable

sessionIdreturned by verify response. If you got offer by verify api, then this parameter is required.

offerIdstring nullable

offerIDreturned by get offer response. If you got offer by "get offer" api, then this parameter is required.

useAtlasMailForContactboolean nullable

The tag denoting whether to use Atlas email id for contact information.

  • true: Use Atlas email as contact email.
  • false: It is determined according to the strategy agreed upon with the customer or the default strategy of the system.

Please refer to the terms and conditions for usage of Atlas email.

requestSourcestring

The tag to identify which channel does this traffic come from. For example: SkyScanner,Google,Oganic search,etc…

ifSeatOccupied'SIMILAR_SEAT' | 'STOP_SEAT' | 'STOP_TICKET'
localestring nullable

The country and language environment preferences of the ticket purchaser/contact person. This information may be useful for certain airlines. For example, airlines will use this information to communicate with users in appropriate languages (e.g., via emails). We have prepared the language environments supported by each airline for your reference: Locale

Response

status301 | 302 | 303 | 304 | 305 | 307 | 308 | 309 | 310 | 312 | 313 | 315 | 316 | 317 | 318 | 319 | 320 | 321 | 322 | 323 | 324 | 325 | 326 | 327 | 328 | 329 | 330 | 407 | 408 | 409 | 410 required
msgstring required

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.

sessionIdstring required

Echo thesessionIdin the request parameters.

offerIdstring nullable

Echo theofferIdin the request parameters.

orderNostring required

Order number of the created order.

pnrCodestring required

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

totalPricenumber required

Total price(not including service fee) 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.

currencystring required

The currency TheAtlas settled with you.

vendorTotalPricenumber nullable

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

vendorCurrencystring nullable

Vendor's currency.

tktLimitTimestring required

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

duplicateOrdersstring[] nullable

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