Sign in
latestOpenAPI 3.0.12026-08-102668257.3 KB

8e9a8f8010ab

Other Functions

Order List

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

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

post/orderList.do

Headers

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

Request body

orderNostring nullable

Atlas order number. Accurate matching

airlinePNRsstring[] nullable

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

paxNamestring nullable

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

contactEmailstring nullable

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

fromCitystring nullable

IATA code of the departure city

toCitystring nullable

IATA code of the arrival city

depDatestring nullable

Date of departure. The format is:yyyyMMdd

createTimeRangeFromstring nullable

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

createTimeRangeTostring nullable

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

orderStatusOrderStatus[] nullable

If the status of the order matches any of the given values, it will be returned

airlinesstring[] nullable

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

pagestring nullable

Start from: 1

pageSizestring nullable

Number of records to be displayed on each page.

Response

statusinteger 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.

pagestring required
pageSizestring required
totalRecordsstring required