> For the complete documentation index, see [llms.txt](https://resources.atriptech.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://resources.atriptech.com/api-wen-dang/api-can-kao/yu-ding-hou-api/ding-dan-lie-biao.md).

# 订单列表

{% hint style="info" %}
遇到 API 接入问题时，可登录 [Eva](https://www.atriptech.com/) 寻求帮助。
{% endhint %}

## Order List

> \*\*Dependency:\*\*\
> No preceding function needs to be called before 'orderList' API.\
> \
> \*\*Endpoint:\*\*\
> <https://sandbox.atriptech.com/orderList.do>

```json
{"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"security":[],"paths":{"/orderList.do":{"post":{"summary":"Order List","deprecated":false,"description":"**Dependency:**\nNo preceding function needs to be called before 'orderList' API.\n\n**Endpoint:**\nhttps://sandbox.atriptech.com/orderList.do","tags":[],"parameters":[{"name":"Accept","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"Content-Type","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"x-atlas-client-id","in":"header","description":"","required":true,"schema":{"type":"string"}},{"name":"x-atlas-client-secret","in":"header","description":"","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"orderNo":{"type":"string","description":"Atlas order number. Accurate matching","nullable":true},"airlinePNRs":{"type":"array","items":{"type":"string"},"description":"The airline PNR(not Atlas's).  If the airline pnr of the order contains any of the given values, it will be returned.","nullable":true},"paxName":{"type":"string","description":"The name of the passenger(last name/first name). If the passenger in the order includes the given value, it will be returned.","nullable":true},"contactEmail":{"type":"string","description":"Accurate matching，match based on the contact email provided by the customer","nullable":true},"fromCity":{"type":"string","description":"IATA code of the departure city","nullable":true},"toCity":{"type":"string","description":"IATA code of the arrival city","nullable":true},"depDate":{"type":"string","description":"Date of departure. The format is:`yyyyMMdd`","nullable":true},"createTimeRangeFrom":{"type":"string","description":"The start time of order creation. This is in UTC. The format is:`yyyy-MM-dd'T'HH:mm:ss'Z'`.","nullable":true},"createTimeRangeTo":{"type":"string","description":"The end time of order creation. This is in UTC. The format is`yyyy-MM-dd'T'HH:mm:ss'Z'`","nullable":true},"orderStatus":{"type":"array","items":{"$ref":"#/components/schemas/OrderStatus"},"description":"If the status of the order matches any of the given values, it will be returned","nullable":true},"airlines":{"type":"array","items":{"type":"string"},"description":"If the airlines of the order contains any of the given values, it will be returned","nullable":true},"page":{"type":"string","description":"Start from: 1","default":"1","nullable":true},"pageSize":{"type":"string","description":"Number of records to be displayed on each page. ","default":"20","maxLength":100,"nullable":true}},"description":"A series of conditions for matching orders"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer"},"msg":{"$ref":"#/components/schemas/ResponseMessage","nullable":true},"page":{"type":"string"},"pageSize":{"type":"string"},"totalRecords":{"type":"string"},"orders":{"type":"array","items":{"type":"object","properties":{"orderNo":{"type":"string","description":"Atlas order number"},"pnrCode":{"type":"string","description":"Atlas internal reference code"},"airlinePNRs":{"type":"array","items":{"type":"string"},"description":"Airline PNRs in the order","nullable":true},"orderStatus":{"$ref":"#/components/schemas/OrderStatus","description":"Order status"},"depDate":{"type":"string","description":"Date of departure. The format is:`YYYYMMDD`"},"airlines":{"type":"array","items":{"type":"string"},"description":"The IATA codes of all airlines in the order"},"orderCreateTimestamp":{"type":"string","description":"The time of order creation. This is in UTC. Format:`yyyy-MM-dd'T'HH:mm:ss'Z'`"},"paymentTimestamp":{"type":"string","description":"The time payment was made. This is in UTC. Format:`yyyy-MM-dd'T'HH:mm:ss'Z'`"},"paxNames":{"type":"array","items":{"type":"string"},"description":"The names of all passengers in the order"},"contactEmail":{"type":"string","description":"Contact email provided by the customer"},"fromCity":{"type":"string","description":"IATA code of departure city"},"toCity":{"type":"string","description":"IATA code of arrival city"},"errorCode":{"type":"string","description":"The error code returned for a cancelled order. This will only be displayed for cancelled orders.","nullable":true},"errorMessage":{"type":"string","description":"The error description.","nullable":true}},"required":["orderNo","pnrCode","orderStatus","depDate","airlines","orderCreateTimestamp","paymentTimestamp","paxNames","contactEmail","fromCity","toCity"]}}},"required":["status","page","pageSize","totalRecords","orders"]}}},"headers":{}}}}}},"components":{"schemas":{"OrderStatus":{"type":"integer","enum":[0,1,2,-3]},"ResponseMessage":{"type":"string","description":"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 to`0`at any time."}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://resources.atriptech.com/api-wen-dang/api-can-kao/yu-ding-hou-api/ding-dan-lie-biao.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
