Order List - Atlas API-Sabre

Request

Header Params

Accept

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

A series of conditions for matching orders

orderNo

string | null

optional

Atlas order number. Accurate matching

Example:

TESTA20241122090710695

airlinePNRs

array[string] | null

optional

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

paxName

string | null

optional

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

contactEmail

string | null

optional

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

fromCity

string | null

optional

IATA code of the departure city

toCity

string | null

optional

IATA code of the arrival city

depDate

string | null

optional

Date of departure. The format is:yyyyMMdd

createTimeRangeFrom

string | null

optional

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

createTimeRangeTo

string | null

optional

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

orderStatus

array[integer] | null

optional

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

Allowed values:

012-3

airlines

array[string] | null

optional

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

page

string | null

optional

Start from: 1

Default:

1

pageSize

string | null

optional

Number of records to be displayed on each page.

<= 100 characters

Default:

20

Example

{
    "orderNo": "TESTA20241122090710695",
    "airlinePNRs": [
        "string"
    ],
    "paxName": "string",
    "contactEmail": "string",
    "fromCity": "string",
    "toCity": "string",
    "depDate": "string",
    "createTimeRangeFrom": "string",
    "createTimeRangeTo": "string",
    "orderStatus": [
        0
    ],
    "airlines": [
        "string"
    ],
    "page": "1",
    "pageSize": "20"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://sandbox.atriptech.com/orderList.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 '{
    "orderNo": "TESTA20241122090710695",
    "airlinePNRs": [
        "string"
    ],
    "paxName": "string",
    "contactEmail": "string",
    "fromCity": "string",
    "toCity": "string",
    "depDate": "string",
    "createTimeRangeFrom": "string",
    "createTimeRangeTo": "string",
    "orderStatus": [
        0
    ],
    "airlines": [
        "string"
    ],
    "page": "1",
    "pageSize": "20"
}'

Responses

🟢200Success

application/json

Body

status

integer

required

msg

optional

Any of

ResponseMessage

null

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.

page

string

required

pageSize

string

required

totalRecords

string

required

orders

array [object {14}]

required

orderNo

string

required

Atlas order number

pnrCode

string

required

Atlas internal reference code

airlinePNRs

array[string] | null

optional

Airline PNRs in the order

orderStatus

enum<integer>

required

Order status

Allowed values:

012-3

depDate

string

required

Date of departure. The format is:YYYYMMDD

airlines

array[string]

required

The IATA codes of all airlines in the order

orderCreateTimestamp

string

required

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

paymentTimestamp

string

required

The time payment was made. This is in UTC. Format:yyyy-MM-dd'T'HH:mm:ss'Z'

paxNames

array[string]

required

The names of all passengers in the order

contactEmail

string

required

Contact email provided by the customer

fromCity

string

required

IATA code of departure city

toCity

string

required

IATA code of arrival city

errorCode

string | null

optional

The error code returned for a cancelled order. This will only be displayed for cancelled orders.

errorMessage

string | null

optional

The error description.

Example

{
    "status": 0,
    "msg": "string",
    "page": "string",
    "pageSize": "string",
    "totalRecords": "string",
    "orders": [
        {
            "orderNo": "string",
            "pnrCode": "string",
            "airlinePNRs": [
                "string"
            ],
            "orderStatus": 0,
            "depDate": "string",
            "airlines": [
                "string"
            ],
            "orderCreateTimestamp": "string",
            "paymentTimestamp": "string",
            "paxNames": [
                "string"
            ],
            "contactEmail": "string",
            "fromCity": "string",
            "toCity": "string",
            "errorCode": "string",
            "errorMessage": "string"
        }
    ]
}