Order Cancel
Order Cancel
The Order Cancel API allows an existing Order to be cancelled. Any refundable fare and taxes will be refunded.
The service uses IATA NDC OrderCancelRQ & OrderCancelRS v16.1 schema
You can try this live service using I/O docs if you Register or Sign in with your Mashery ID.
Version Information
The most recent version of the Order Cancel API is version 2. Previous versions are shown below.
| Version | Status | End-of-life date |
|---|---|---|
| v01 | Still supported | to be advised |
API Endpoints
Order Cancel has a SOAP API endpoint.
The endpoints available are:
| Endpoint | URL |
|---|---|
| Live | n/a |
| Test | https://test.api.ba.com/selling-distribution/OrderCancel/V2 |
API Methods
| Method | URL | Description |
|---|---|---|
| POST | /selling-distribution/OrderCancel/V2 | changes an existing order |
HTTP Headers
| Header Name | Description | Mandatory? | Example |
|---|---|---|---|
| client-key | Your unique key used to authorise access to the API. | Yes | n/a |
Search parameters
The various search parameters are described below:
>>>>>
| Name | Description | Format | Mandatory / optional | Example | Allowed values |
|---|---|---|---|---|---|
| OrderCancelRQ | |||||
| @Version | message version | m | 2.0 | any | |
| @PrimaryLangID | O | EN | any | ||
| @AltLangID | O | EN | any | ||
| Party/Sender/TravelAgencySender | |||||
| Name | Sender name | alphabetic | m | Travel Agent plc | any |
| Name/ Contacts/ Contact/ EmailContact/ Address | Travel agency email address | email address | optional | anagent@travelagent.com | any valid email address |
| IATA_Number | IATA number of the agent that created the order | numeric | mandatory (either) | use your own IATA or non-IATA number | any |
| OtherIDs/OtherID | non-IATA number of the agent that created the order | ||||
| AgencyID | Agency ID | alphanumeric | mandatory | this can be the same as Name | any |
| Party/Participants/Participant | |||||
| @SequenceNumber attribute | sequence number of this participant in the message flow | numeric | mandatory | 1 | add 1 to the highest Participant@SequenceNumber |
| Name | Participant name | alphabetic | optional | aggregator plc | any |
| ID | Participant ID | alphanumeric | mandatory | this can be the same as Name | any |
| Query/ExpectedRefundAmount | |||||
| Total | the total amount to be refunded (from previous ItinReShopRS) | currency value | mandatory | 100.00 | |
| Total @Code attribute | the currency code | currency code | mandatory | GBP | |
| Query/OrderID | |||||
| OrderID | the OrderID to be cancelled | mandatory | ABC123 | any | |
| OrderID @Owner attribute | mandatory | BA | any | ||
Search parameters may be submitted in any order and are case insensitive.
Response elements
Please see the Interface Spec for details about the response elements
The following error codes may be returned by the service
| OrderViewRS/InfoGroup/Error/Code | Meaning | Description |
|---|---|---|
| 200 | Ok | The request was successful and at least 1 item is being returned |
| 400 | Bad Request | Sent when the consumer sends a malformed request to the service. The actual error message is returned in the response body |
| 401 | Unauthorised | Returned when the consumer is not authenticated to use the REST API |
| 403 | Forbidden | Returned when the consumer is authenticated but does not have permission to access the Resource |
| 406 | Not Acceptable | Returned when the Accept header contains version / mime type info which we don't support |
| 500 | Internal Server Error | Something has gone wrong - please raise this as a bug with us |
| 503 | Service Unavailable | Returned when the server is temporarily unable to handle the request |
Supported Status Codes
You can view the standard status codes returned by our APIs here.