OrderList 17.2
Functional Description
OrderList API returns a list of the live orders owned by the sender. Today the list can be filtered by creation date range.
| Basic | The OrderList service returns a list of the live orders owned by the sender. |
Legend
New or modify field
HTTP Headers
| api_key | Your unique key used to authorise access to the API. | Mandatory:Yes |
Request Body
| NAME | DESCRIPTION | FORMAT | ALLOWED VALUES | MANDATORY FOR |
| PrimaryLangID | Two character ISO Language Code, for the agent’s preferred language. This is for error messages and some other data such as legal waivers. | 2 Alphabetical |
|
|
| Version | The IATA version of the message | Numeric | Any | Schema |
| <Point of Sale> | ||||
| Location / CountryCode | Country Code | 2 Alphabetical | List of Countries | If toggle feature for market validation is activated. |
| <Document> | Schema | |||
| ReferenceVersion | The IATA Schema Version | Numeric | Any | |
| <Party / Sender> Only for Real IATA | Schema | |||
| TravelAgencySender / IATA_Number |
Sender unique identifier such as: IATA number (if you have one) TIDs number (recommended if you do not have an IATA) |
Numeric | 7/8 Numbers | NDC Mandatory |
| <Party / Sender> Only for Pseudo IATA | ||||
| TravelAgencySender / OtherIDs / OtherID | Pseudo IATA (assigned by Iberia) | Numeric | 7/8 Numbers | NDC Mandatory |
| <Party> | Schema | |||
| Sender / TravelAgencySender / Name | Agency Name | Alphanumeric | Any | |
| Sender / TravelAgencySender / Contacts / Contact / EmailContact / Address | Email to contact the Agency | Alphanumeric | Any | Mandatory for schema if 'EmailContact' tag is indicated. |
| Sender / TravelAgencySender / Contacts / Contact / PhoneContact / Application | Agency phone type | Alphabetical |
|
|
| Sender / TravelAgencySender / Contacts / Contact / PhoneContact / Number | Phone number to contact the Agency | Numeric | Any | |
| Sender / TravelAgencySender / Contacts / Contact / Name / Surname | Reference Agency contact surname | Alphanumeric | Any | |
| Sender / TravelAgencySender / Contacts / Contact / Name / Given | Reference Agency contact name | Alphanumeric | Any | Mandatory for schema if 'Name' tag is indicated. |
| Sender / TravelAgencySender / AgencyID | Id for the Agency | Alphanumeric | Any | Schema |
| Participants / Participant / AggregatorParticipant / AggregatorID |
Participant / Aggregator unique identifier: IATA number (if you have one) TIDs number (recommended if you do not have an IATA) Pseudo IATA(assigned by Iberia) |
7 Numeric | 7 Numbers | Mandatory for schema if 'Participants' tag is indicated. |
| <Query> | Schema | |||
| Filters / CreateDateRange / Effective | Start date to search | Date | Any | |
| Filters / CreateDateRange / Expiration | Expiration date to search | Date | Any | |
Response Body
| NAME | DESCRIPTION | FORMAT | ALLOWED VALUES | Nullable |
| <Document> | ||||
|---|---|---|---|---|
| ReferenceVersion | The IATA version of the message | Numeric | Any | False |
| <Response / Orders> | ||||
| Order / CreationDate | Date of order creation | Date | yyyy-MM-dd | False |
| Order / Departure / AirportCode | IATA 3 character code for the departure city/airport/station | 3 Alphanumeric | Any | False |
| Order / Departure / Date | Date of departure | Date | yyyy-MM-dd | False |
| Order / Arrival / AirportCode | IATA 3 character code for the arrival city/airport/station | 3 Alphanumeric | Any | False |
| Order / Arrival / Date | Date of arrival | Date | yyyy-MM-dd | False |
| Order / Passengers / FullName | Full name of passenger | Alphanumeric | Any | False |
| Order / OrderID | Id of the order | Alphanumeric | Any | False |