Order

POST

/order.do

Request

Header Params

string

required

Example:

application/json

Content-Type

string

required

Example:

application/json

Accept-Encoding

string

required

Example:

gzip

x-atlas-client-id

string

required

Example:

<YOUR_CLIENT_ID>

x-atlas-client-secret

string

required

Example:

<YOUR_CLIENT_SECRET>

Body Params application/json

sessionId

string | null

optional

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

offerId

string | null

optional

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

passengers

array[object (OrderPax) {12}]

required

Passengers' information

name

string

required

The passenger's name. Please send it in the following format: Family Name/Given Name

passengerType

enum<integer>

required

Type of passenger

Allowed values:

012

gender

string

required

The passenger's gender.

M: Male

F: Female

birthday

string | null

optional

The passenger's date of birth. Format:YYYYMMDD. Please fill in according to the passenger information requirements(bookingRequirement) returned by the Verification / Get Offer API.

cardType

optional

The type of the identity document

cardNum

string | null

optional

The unique identifier of the identity document. e.g. the passport number. Please fill in according to the passenger information requirements(bookingRequirement) returned by the Verification / Get Offer API.

cardIssuePlace

string | null

optional

The ISO 3166-1 alpha-2 code for the country where the identity document is issued. Please fill in according to the passenger information requirements(bookingRequirement) returned by the Verification / Get Offer API.

cardExpired

string | null

optional

The date on which the identity document expires. Format:YYYYMMDD.Please fill in according to the passenger information requirements(bookingRequirement) returned by the Verification / Get Offer API.

nationality

string | null

optional

The ISO 3166-1 alpha-2 code for the nationality of passenger. Please fill in according to the passenger information requirements(bookingRequirement) returned by the Verification / Get Offer API.

ffpCardNo

string | null

optional

The passenger's account number for this frequent flyer account

ffpCarrier

string | null

optional

The IATA code for the airline that this frequent flyer account belongs to

ancillaries

array [object {2}] | null

optional

Ancillaries selection for the specific passenger

contact

object

required

name

string

required

Contact name, please follow this format: Family Name/Given Name. The contact name can only accept Latin letters, /, and spaces.

address

string | null

optional

Contact address.

postcode

string | null

optional

Contact post code.

string | null

optional

Contact email.

mobile

string | null

optional

Contact mobile, please follow this format : XXXX(digital country code)-XXXXXXXX(phone number), here're the examples: 0001-87291810, 0086-13928109091, 0971-19201998

clientContact

object

required

Customer's contact. Currently only required in FR.

string | null

optional

Contact email.

companyName

string | null

optional

Company name

useAtlasMailForContact

boolean | null

optional

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.

Default:

false

requestSource

optional

Any of

RequestSource

null

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

ifSeatOccupied

optional

Configuration of ordering when the seat is occupied.

Any of

If-Seat-Occupied

null

Allowed values:

SIMILAR_SEATSTOP_SEATSTOP_TICKET

payment

object (OrderPayment) | null

optional

Payment information

cardType

enum<string>

required

The card type you wish to use for payment. Send this information when generating an order can be used to calculate the payment handling fee. This parameter is only effective and required in the MoR payment scenario.

Allowed values:

AmexVisaMasterCardJCBDiscoverDinersClub

locale

string | null

optional

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

Example

{
    "sessionId": "cc576b96-5dbc-41af-a3fa-7bb662f801ec",
    "offerId": "",
    "passengers": [
        {
            "name": "aaaaa/aaaaaabs",
            "passengerType": 0,
            "birthday": "19900101",
            "gender": "M",
            "cardNum": "636940383",
            "cardType": "NATIONAL_ID_CARD",
            "cardIssuePlace": "PT",
            "cardExpired": "20250101",
            "nationality": "US",
            "ffpCardNo": null,
            "ffpCarrier": null,
            "ancillaries": [
                {
                    "productCode": "",
                    "segmentIndex": 1
                }
            ]
        }
    ],
    "contact": {
        "name": "Smith/Jane",
        "address": "189, Sky Garden Walk/London/US/US",
        "postcode": "EC3M 8AF",
        "email": "jane.smith@example.com",
        "mobile": "0001-982736245"
    },
    "useAtlasMailForContact": false,
    "locale": "",
    "requestSource": "CtripNew",
    "ifSeatOccupied": "",
    "payment": {
        "cardType": ""
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://sandbox.atriptech.com/order.do' \
--header 'Accept: application/json' \
--header 'Accept;' \
--header 'Accept-Encoding: gzip' \
--header 'Accept-Encoding;' \
--header 'x-atlas-client-id: <YOUR_CLIENT_ID>' \
--header 'x-atlas-client-id;' \
--header 'x-atlas-client-secret: <YOUR_CLIENT_SECRET>' \
--header 'x-atlas-client-secret;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "sessionId": "cc576b96-5dbc-41af-a3fa-7bb662f801ec",
    "offerId": "",
    "passengers": [
        {
            "name": "aaaaa/aaaaaabs",
            "passengerType": 0,
            "birthday": "19900101",
            "gender": "M",
            "cardNum": "636940383",
            "cardType": "NATIONAL_ID_CARD",
            "cardIssuePlace": "PT",
            "cardExpired": "20250101",
            "nationality": "US",
            "ffpCardNo": null,
            "ffpCarrier": null,
            "ancillaries": [
                {
                    "productCode": "",
                    "segmentIndex": 1
                }
            ]
        }
    ],
    "contact": {
        "name": "Smith/Jane",
        "address": "189, Sky Garden Walk/London/US/US",
        "postcode": "EC3M 8AF",
        "email": "jane.smith@example.com",
        "mobile": "0001-982736245"
    },
    "useAtlasMailForContact": false,
    "locale": "",
    "requestSource": "CtripNew",
    "ifSeatOccupied": "",
    "payment": {
        "cardType": ""
    }
}'

Responses

🟢200Success

application/json

Body

status

enum<integer>

required

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

Allowed values:

301302303304305307308309310312313315316317318319320321322323324325326327328329330

msg

string

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.

sessionId

string

required

Echo thesessionIdin the request parameters.

offerId

string | null

optional

Echo theofferIdin the request parameters.

orderNo

string

required

Order number of the created order.

pnrCode

string

required

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

totalPrice

number

required

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

totalTransactionFee

number

required

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

currency

string

required

The currency TheAtlas settled with you.

vendorTotalPrice

number | null

optional

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

vendorCurrency

string | null

optional

Vendor's currency.

tktLimitTime

string

required

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

paxTicketInfos

array [object {12}]

required

Ticket information for passengers. The number of elements is the same as the number of passengers, with each passenger corresponding to one element.

name

string

required

Echo the passenger's name, in the format of last name/first name

passengerType

enum<integer>

required

Echo the passenger's type

Allowed values:

012

birthday

string

required

Echo the passenger's birthday

gender

string

required

Echo the passenger's gender

cardNum

string | null

optional

Echo the passenger's identity document number

cardType

string | null

optional

Echo the passenger's identity document type

cardIssuePlace

string | null

optional

Echo the country where the passenger's identification document was issued.

cardExpired

string | null

optional

Echo the expiration date of the passenger's identification document.

nationality

string | null

optional

Echo the passenger's nationality

ticketNos

array[string]

required

Ticket numbers. Since the ticket hasn't been issued at this moment, the array will be empty([]).

airlinePNRs

array[string]

required

Since the airline side hasn't generated the order yet, the array is empty([]).

ancillaries

array [object {10}] | null

optional

Ancillaries selection for the specific passenger

routing

object (Routing)

required

routingIdentifier

string

required

This unique string identifier is used to verify requests for a particular route.
Note:
Has a certain validity period (generally not exceeding 6 hours).

supportCreditTransPayment

enum<string>

deprecated

This tag is used to identify if the fare is support to be paid using the client's credit card(known as vcc passthrough). This field has been deprecated, please use supportPaymentMethods instead.

Allowed values:

Example:

supportPaymentMethods

array[integer]

required

Support payment methods for this fare. If payment is not supported in any way, this will be nullor[]. Each item in this array is one of the following:

1: deposit

3: vcc passthrough

4: BYOA(Bring Your Own Account)

5: MoR

Allowed values:

1345

currency

string

required

The currency in which Atlas settles transactions with you.

adultPrice

number

required

Adult fare per passenger.

adultTax

number

required

Adult tax per passenger.

adultDetails

array[object (Price-Item) {4}] | null

optional

Details of the adult price composition.

childPrice

number

required

Child fare per passenger.

childTax

number

required

Child tax per passenger.

childDetails

array[object (Price-Item) {4}] | null

optional

Details of the child price composition.

infantPrice

number

required

Infant fare per passenger.

infantTax

integer

required

Infant tax per passenger.

infantDetails

array[object (Price-Item) {4}] | null

optional

Details of the child infant composition.

infantAllowed

boolean

required

Since infantPrice and infantTax will never be null, when the fare does not support infants or is free for infants, both infantPrice and infantTax display 0. In this case, you need this field to distinguish which situation it is.
Scenario description:

true: infants is supported by this fare, infantPrice and infantTax will >= 0

false: infants is not supported by this fare, infantPrice and infantTaxwill be displayed as 0

childMandatorySeatingFee

number | null

optional

Only valid for FR integration.

FR Seat Selection Rules:

Children under 12 years old are provided with free seats.

Children must be seated in the same row as an adult.

Each adult may accompany up to 4 children.

For fare families that do not include seat selection fees (e.g., Basic or Family Plus), FR offers discounted seat selection fees for adults traveling with children. ThechildMandatorySeatingFeefield displays this discounted fee.
For fare families that already include seat selection fees, this field will be null.

Handling by Atlas for Fare Families Without Seat Selection Fees:

The number of children cannot exceed 4.

Customers cannot select seats manually.

Atlas will automatically assign seats randomly to one adult and all children according to FR's rules. The adult will be charged the childMandatorySeatingFee for their seat.

For Fare Families That Include Seat Selection Fees:

Seat selection is free.

Users may call the seat map API to select seats; otherwise, Atlas will automatically assign seats.

transactionFeePerPax

number

deprecated

Technical service fee per passenger. This field has been deprecated and final total transaction fee will calculated based on transactionFee and transactionFeeMode.

transactionFee

number

required

Technical service fee as per transactionFeeMode. The following lists the calculation methods for the final technical service fee in various situations.

transactionFeeMode=PER_SEGMENT:transactionFee * number of passengers * number of segments.

transactionFeeMode=PER_TICKET:transactionFee * number of passengers * number of orders on airline side.

transactionFeeMode=PER_PAX:transactionFee * number of passengers.

transactionFeeMode=PER_BOOKING:transactionFee.

transactionFeeMode

enum<string>

required

Calculation method for technical service fee.

Allowed values:

PER_SEGMENTPER_TICKETPER_PAXPER_BOOKING

Example:

PER_PAX

fromSegments

array[object (Routing-Segment) {19}]

required

For outbound segments.

retSegments

array[object (Routing-Segment) {19}] | null

optional

For inbound segments. For one-way, this field will be null or [].

rule

object

required

ancillaryProductElements

array[object (AncillaryProduct) {14}] | null

optional

vendorFare

object

required

To identify the vendor’s fare with vendor’s currency. It is only available whensupportPaymentMethodscontains3or4.

links

object (T-And-C-Link)

required

The terms and conditions links of the airlines. Will only return in verify response.

separateBookings

boolean

required

When the outbound and inbound of round trip need to be booked separately, it will be true.

refreshTime

string

required

If the fare is from the cache of Atlas, this field is used to indicate the refresh time of the cache. The time is a certain moment in the past (UTC), and the format is:yyyy-MM-dd'T'HH:mm:ss'Z'.

expireTime

string

required

If the current fare comes from the cache of Atlas, this field is used to indicate the estimated expiration time of the cache. This time is a certain moment in the future (UTC), and the format is:yyyy-MM-dd'T'HH:mm:ss'Z'.
Note:
This time is estimated, which means Atlas may refresh the cache before or after that time.

displayFare

object | null

optional

To identify the display fare with display currency. If the request parameterdisplayCurrencyfor the search or verify is not specified, then this node will benull.

ancillarySupported

array[string]

required

A list of ancillary service types that the fare allows for additional purchase. Possible value contains:

luggage

seat: You can carry out the subsequent seat selection process through our seat map interface.

cardChargeList

array[object (CardCharge) {4}] | null

optional

Payment handling fee for MoR/VCC

duplicateOrders

array[string] | null

optional

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

paymentOptions

array [object {5}]

required

paymentMethod

integer

required

serviceFee

object (PaymentOption)

required

ticketFare

object (PaymentOption)

required

paymentFee

object (PaymentOption)

required

cardType

string | null

required

Example

{
   "sessionId": "ac6e1697-6cae-4f2c-800d-6522fea63361",
   "offerId": "",
   "orderNo": "TESTA20250512180633328",
   "originalOrderNo": null,
   "ticketOrderNo": null,
   "totalPrice": 71.83,
   "totalTransactionFee": 5.00,
   "currency": "USD",
   "vendorTotalPrice": 97543.24,
   "vendorCurrency": "KRW",
   "tktLimitTime": "2025-05-12 18:56:33",
   "pnrCode": "BXD990",
   "includeExtraBaggage": 0,
   "paxTicketInfos": [
       {
           "name": "aaaaa/aaaaaabs",
           "passengerType": 0,
           "birthday": "19900101",
           "gender": "M",
           "cardNum": "636940383",
           "cardType": "NATIONAL_ID_CARD",
           "cardIssuePlace": "PT",
           "cardExpired": "20250101",
           "nationality": "US",
           "ticketNos": [],
           "airlinePNRs": [],
           "contactEmails": [
               "jane.smith@example.com"
           ],
           "contactPhones": [
               "0001-982736245"
           ],
           "ancillaries": [
               {
                   "productCode": "SCI_BAG_5KG",
                   "segmentIndex": 1,
                   "offerId": null,
                   "buyMethod": "0",
                   "ancillaryPrice": 4.40,
                   "currency": "USD",
                   "vendorPrice": null,
                   "vendorCurrency": null,
                   "productType": "1",
                   "displayCurrency": "EUR",
                   "displayPrice": 3.93,
                   "auxBaggageElement": {
                       "piece": 0,
                       "weight": 5,
                       "isAllWeight": true,
                       "size": ""
                   },
                   "auxSeatElement": null
               }
           ]
       }
   ],
   "routing": null,
   "duplicateOrders": null,
   "paymentOptions": [
       {
           "paymentMethod": 1,
           "serviceFee": {
               "amount": 5.00,
               "currency": "USD",
               "deductFrom": "DEPOSIT",
               "displayAmount": null,
               "displayCurrency": null
           },
           "ticketFare": {
               "amount": 71.83,
               "currency": "USD",
               "deductFrom": "DEPOSIT",
               "displayAmount": null,
               "displayCurrency": null
           },
           "paymentFee": null,
           "cardType": null
       },
       {
           "paymentMethod": 5,
           "serviceFee": {
               "amount": 5.00,
               "currency": "USD",
               "deductFrom": "DEPOSIT",
               "displayAmount": null,
               "displayCurrency": null
           },
           "ticketFare": {
               "amount": 71.83,
               "currency": "USD",
               "deductFrom": "CARD",
               "displayAmount": null,
               "displayCurrency": null
           },
           "paymentFee": {
               "amount": 3.59,
               "currency": "USD",
               "deductFrom": "CARD",
               "displayAmount": 3.21,
               "displayCurrency": "EUR"
           },
           "cardType": ""
       }
   ],
   "status": 0,
   "msg": null
}

Modified at 2025-07-18 07:38:07

Verify

Order Commit