Hotel Reservation Cancel

POST 
/v1/api/Pull/SendHotelResCancel

Allow cancellation of a given hotel reservation.

Request

application/json

Body

PrimaryLangID LanguageCodeEnum

Possible values: [8, 4, 3, 1, 2, 5, 6, 7]

Default value: 8

LanguageCodeEnum: 8=br | 4=pt | 3=es | 1=en | 2=fr | 5=da | 6=it | 7=de

EchoToken stringnullable

An arbitrary string returned in the response for tracking/debugging.

TimeStamp stringrequired

The date and time (ISO format) just before the request is sent.

Target TargetEnumrequired

Possible values: [0, 1]

The target environment for this request. TargetEnum: 0=Test | 1=Production

Version number

Default value: 1

The version number of this request format.

CancelType TransactionActionTypeEnumnullable

Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8]

The type of cancellation request ('VerifyPrice' or 'CancelRoom'). TransactionActionTypeEnum: 0=Book | 1=Commit | 2=Hold | 3=Ignore | 4=Initiate | 5=Modify | 6=VerifyPrice | 7=CancelRoom | 8=CancelRoomVerifyPrice

Segment object[]nullable
A list of segments to cancel.
Array [
ItinSegNbr stringrequired
The itinerary segment number.
Status StatusTypeEnum
Possible values: [0, 1]
The status of the segment. Always 'Cancelled' in this context. StatusTypeEnum: 0=Cancelled | 1=Unchanged
]
UniqueID object[]
A list of unique identifiers for the reservations to be canceled.
Array [
ID stringrequired
Unique identifier.
Type UniqueIDCodeEnumrequired
Possible values: [14, 25]
Type of the identifier. UniqueIDCodeEnum: 14=Reservation | 25=AssociatedReservation
Reason stringnullable
Reason or context for the identifier, if any.
]
Verification objectnullable

Email stringnullable

The email address associated with the reservation.

HotelRef objectrequired

Reference information for the hotel where the reservation was made.

BrandName object nullable

The brand of the hotel (if applicable).

oneOf

MOD1

integer

MOD2

string

ChainCode object nullable

The code of the hotel chain (if applicable).

oneOf

MOD1

integer

MOD2

string

ChainName stringnullable

The name of the hotel chain (if applicable).

HotelCode object required

The unique code of the hotel.

oneOf

MOD1

integer

MOD2

string

HotelName stringnullable

The name of the hotel.

ReservationTimeSpan objectrequired

The check-in and check-out dates for the reservation.

Start stringrequired

Check-in date in ISO format.

End stringrequired

Check-out date in ISO format.

Responses

200

application/json

Schema

Schema

EchoToken stringnullable

The same token received in the request.

ErrorsType objectnullable
Errors object[]
Array [
Code integerrequired
Error code associated with the warning.
Language LanguageCodeEnumrequired
Possible values: [8, 4, 3, 1, 2, 5, 6, 7]
Language of the warning message. LanguageCodeEnum: 8=br | 4=pt | 3=es | 1=en | 2=fr | 5=da | 6=it | 7=de
ShortText stringrequired
Short description or summary of the warning.
]
PrimaryLangID LanguageCodeEnum

Possible values: [8, 4, 3, 1, 2, 5, 6, 7]

Default value: 8

LanguageCodeEnum: 8=br | 4=pt | 3=es | 1=en | 2=fr | 5=da | 6=it | 7=de

Success objectnullable
property name* string
Target TargetEnumrequired

Possible values: [0, 1]

The environment target. The same value received in the request. TargetEnum: 0=Test | 1=Production

TimeStamp stringrequired

The date in ISO format right before the response is sent.

Version numberrequired

Version of the API being used. The same value received in the request.

WarningsType objectnullable
Warnings object[]
Array [
Code integerrequired
Error code associated with the warning.
Language LanguageCodeEnumrequired
Possible values: [8, 4, 3, 1, 2, 5, 6, 7]
Language of the warning message. LanguageCodeEnum: 8=br | 4=pt | 3=es | 1=en | 2=fr | 5=da | 6=it | 7=de
ShortText stringrequired
Short description or summary of the warning.
]
Comment objectnullable

Name stringnullable

Name in plain text format.

Language LanguageCodeEnum

Possible values: [8, 4, 3, 1, 2, 5, 6, 7]

Default value: 8

LanguageCodeEnum: 8=br | 4=pt | 3=es | 1=en | 2=fr | 5=da | 6=it | 7=de

Description stringrequired

Description in plain text format.

Segment object[]nullable
A list of segments that were canceled.
Array [
ItinSegNbr stringrequired
The itinerary segment number.
Status StatusTypeEnum
Possible values: [0, 1]
The status of the segment. Always 'Cancelled' in this context. StatusTypeEnum: 0=Cancelled | 1=Unchanged
]
CancelInfoRS objectnullable
CancelRules object[]
A list of rules that determine cancellation fees.
Array [
Amount number
The amount of the cancellation fee.
CurrencyCode CurrencyCodeEnumrequired
Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 43, 44, 46, 47, 50, 52, 56, 59, 62, 64, 66, 72, 76, 82, 83, 85, 86, 91, 94, 97, 98, 102, 104, 108, 109, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238]
The currency code (e.g., 'USD', 'EUR') for the cancellation fee. CurrencyCodeEnum: 1=ALL | 2=AFN | 3=ARS | 4=AWG | 5=AUD | 6=AZN | 7=BSD | 8=BBD | 9=BYR | 10=BZD | 11=BMD | 12=BOB | 13=BAM | 14=BWP | 15=BGN | 16=BRL | 17=BND | 18=KHR | 19=CAD | 20=KYD | 21=CLP | 22=CNY | 23=COP | 24=CRC | 25=HRK | 26=CUP | 27=CZK | 28=DKK | 29=DOP | 30=XCD | 31=EGP | 32=SVC | 33=EEK | 34=EUR | 43=HKD | 44=HUF | 46=INR | 47=IDR | 50=ILS | 52=JPY | 56=KRW | 59=LVL | 62=LTL | 64=MYR | 66=MXN | 72=NZD | 76=NOK | 82=PHP | 83=PLN | 85=RON | 86=RUB | 91=SGD | 94=ZAR | 97=SEK | 98=CHF | 102=THB | 104=TRY | 108=GBP | 109=USD | 117=MAD | 118=MZN | 119=VEF | 120=PEN | 121=AED | 122=AMD | 123=ANG | 124=AOA | 125=BDT | 126=BHD | 127=BIF | 128=BOV | 129=BTN | 130=CDF | 131=CHE | 132=CHW | 133=CLF | 134=COU | 135=CUC | 136=CVE | 137=DJF | 138=DZD | 139=ERN | 140=ETB | 141=FJD | 142=FKP | 143=GEL | 144=GHS | 145=GIP | 146=GMD | 147=GNF | 148=GTQ | 149=GYD | 150=HNL | 151=HTG | 152=IQD | 153=IRR | 154=ISK | 155=JMD | 156=JOD | 157=KES | 158=KGS | 159=KMF | 160=KPW | 161=KWD | 162=KZT | 163=LAK | 164=LBP | 165=LKR | 166=LRD | 167=LSL | 168=LYD | 169=MDL | 170=MGA | 171=MKD | 172=MMK | 173=MNT | 174=MOP | 175=MRO | 176=MUR | 177=MVR | 178=MWK | 179=MXV | 180=NAD | 181=NGN | 182=NIO | 183=NPR | 184=OMR | 185=PAB | 186=PGK | 187=PKR | 188=PYG | 189=QAR | 190=RSD | 191=RWF | 192=SAR | 193=SBD | 194=SCR | 195=SDG | 196=SHP | 197=SLL | 198=SOS | 199=SRD | 200=SSP | 201=STD | 202=SYP | 203=SZL | 204=TJS | 205=TMT | 206=TND | 207=TOP | 208=TTD | 209=TWD | 210=TZS | 211=UAH | 212=UGX | 213=USN | 214=UYI | 215=UYU | 216=UZS | 217=VND | 218=VUV | 219=WST | 220=XAF | 221=XAG | 222=XAU | 223=XBA | 224=XBB | 225=XBC | 226=XBD | 227=XDR | 228=XOF | 229=XPD | 230=XPF | 231=XPT | 232=XSU | 233=XTS | 234=XUA | 235=XXX | 236=YER | 237=ZMW | 238=ZWL
]
Status StatusTypeEnumrequired

Possible values: [0, 1]

The status of the cancellation (e.g., 'Unchanged', 'Cancelled'). StatusTypeEnum: 0=Cancelled | 1=Unchanged

UniqueID object[]
A list of unique identifiers for the reservations to be canceled.
Array [
ID stringrequired
Unique identifier.
Type UniqueIDCodeEnumrequired
Possible values: [14, 25]
Type of the identifier. UniqueIDCodeEnum: 14=Reservation | 25=AssociatedReservation
Reason stringnullable
Reason or context for the identifier, if any.
]
RetransmissionIndicator stringnullable

Indicator for retransmission, if applicable.

TransactionIdentifier stringnullable

Identifier for the transaction, if any.

Example (from schema)

{
  "EchoToken": "string",
  "ErrorsType": {
    "Errors": [
      {
        "Code": 0,
        "Language": 8,
        "ShortText": "string"
      }
    ]
  },
  "PrimaryLangID": 8,
  "Success": {},
  "Target": 0,
  "TimeStamp": "string",
  "Version": 0,
  "WarningsType": {
    "Warnings": [
      {
        "Code": 0,
        "Language": 8,
        "ShortText": "string"
      }
    ]
  },
  "Comment": {
    "Name": "string",
    "Language": 8,
    "Description": "string"
  },
  "Segment": [
    {
      "ItinSegNbr": "string",
      "Status": 0
    }
  ],
  "CancelInfoRS": {
    "CancelRules": [
      {
        "Amount": 0,
        "CurrencyCode": 1
      }
    ]
  },
  "Status": 0,
  "UniqueID": [
    {
      "ID": "string",
      "Type": 14,
      "Reason": "string"
    }
  ],
  "RetransmissionIndicator": "string",
  "TransactionIdentifier": "string"
}

Loading...