OrderCancel 17.2
Endpoint: https://test.api.iberia.com/iberia/beta/ndc/OrderCancel/17.2/v1
Functional Description
OrderCancel API allows an existing Order, with no services consumed, to be cancelled. Any applicable refundable fare and taxes will be refunded. Any applicable refundable EMD will be refunded too.
It is assumed that the ItinReshop API (with action type "Cancel") will be called prior to this to know the amount that will be refunded.
When an Order with seats or baggages is cancelled on the same day that it was payed for and issued, all issued documents are voided for Cash FOP or reverse payment service is called for tokenized CC FOP, if flight is not NO SHOW and total refund is applicable.
Allowed private fare, resident and large family orders refund.
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 Alpha |
|
|
| Version | The IATA version of the message | Numeric | Any | Schema |
| <PointOfSale> | ||||
| 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 | Schema | |||
| 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 | Name of the Sender / 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 Numerics | 7 Numbers | Mandatory for schema if 'Participants' tag is indicated. |
| <ExpectedRefundAmount> | ||||
|
Total Attribute Code |
Currency code | 3 Alphabetical | Any | |
| Total | Total expected refund amount | Numeric | Any | |
| <Query> | Schema | |||
|
Order Attribute OrderID |
Id of the order | Alphanumeric | Any | |
Response Body
|
NAME |
DESCRIPTION |
FORMAT | ALLOWED VALUES | Nullable |
|---|---|---|---|---|
| <Document> | ||||
| ReferenceVersion | The IATA version of the message | Numeric | Any | False |
| <Response> | ||||
| OrderCancelProcessing / MarketingMessages / MarketingMessage / Text | Additional text for asociated services | Alphabetical | Any | False |
| OrderCancelProcessing / Remarks / Remark | Additional remark.
Only shown when it was refunded
|
Alphanumeric | Any | True |
| OrderReference | Order reference | Alphanumeric | Any | False |