擷取現有行程的狀態和詳細資料、確認過去要求的訂房狀態,或自指定的時間範圍擷取行程清單。

使用此要求即可確認與「CF」以外的狀態一起傳回的訂房狀態,以避免發生重複訂房的可能性。

要求格式
XML/REST URL: GET http://api.ean.com/ean-services/rs/hotel/v3/itin?
XML 父項目: <HotelItineraryRequest>

要求參數

基本參數
名稱 必要 說明
itineraryId 長整數 no 自過去的訂房要求傳回的值。請勿與 affiliateConfirmationId 一起傳送
affiliateConfirmationId 字串 no 與訂房相關聯的值 (如果此元素於訂房要求中使用)。當 itineraryId 無法使用時 (例如逾時訂房回傳後) 當作替代品使用。不得一起傳送: itineraryId
email 字串 yes (如果使用 itineraryId) 訂房使用的電子郵件地址。
lastName 字串 yes (如果使用 creditCardNumber) 訂房使用的姓氏
creditCardNumber 字串 no 訂房時使用的信用卡號。必須與 lastName一起傳送。
confirmationExtras 陣列 no 表示要在傳回的記錄中辨識的特定追蹤資料元素。除非有指定,否則根據預設系統會傳回 additionalData1additionalData2
如果要求超過一個以上的額外資料元素,便會得到以逗號分隔的清單。參考追蹤訂房頁面以取得在訂房要求中傳送 追蹤資料 的詳細資訊。
resendConfirmationEmail 布林值 no true 傳送,以觸發原始確認電子郵件重新傳送。目前限 XML - REST 和 SOAP 要求將無法使用,但未來將新增以便使用。
ItineraryQuery 物件 no 使用此物件即可根據資料範圍要求行程清單。您可以透過行程建立日期或退房日期搜尋
ItineraryQuery.creationDateStart 字串 no 透過建立日期搜尋時使用的開始日期。搜尋最長 30 天以前訂房的行程。
ItineraryQuery.creationDateEnd 字串 yes (如果已指定開始日期) 透過建立日期搜尋時使用的結束日期。使用一天的日期範圍傳回今天的訂房。較長的日期範圍會排除今天的訂房。
ItineraryQuery.departureDateStart 字串 no 透過退房日期搜尋時使用的開始日期。搜尋住宿結束後最多 30 天以內的行程。
ItineraryQuery.departureDateEnd 字串 yes (如果已指定開始日期) 透過退房日期搜尋時使用的結束日期。
ItineraryQuery.includeChildAffiliates 布林值 no

true 傳送以傳回屬於要求中傳送的 cid 所有兒童帳戶。

行程回應
系統會傳回個別行程的所有詳細資料,包括飯店和訂房的客房、訂房時使用的旅客詳細資料以及訂房的狀態。

此回傳也會根據出發日期範圍,或是在要求中指定的建立日期傳回行程清單。

使用此資訊即可在旅客的要求中提供額外的確認資訊,以在一開始傳回錯誤或在使用其中一個日期範圍選項時確認現有訂房的狀態,藉以編譯內部銷售統計資料。

因為此回傳會傳回旅客資訊,所以會透過 HTTPS 遞送所有與使用者互動的資料。
回應內容
父項目: HotelItineraryResponse
陣列元素: Itinerary


行程回應包含 HotelItineraryResponse 父項元素內的 Itinerary 陣列。單一行程只會以 Itinerary 的單一執行個體傳回。

父項元素具有一個 size 屬性,該屬性表示回應所包含的行程數量。

Itinerary 元素

名稱 說明
itineraryId 長整數 與訂房相關聯的 ID只有在使用 EAN 支援 (您沒有自己的支援代理商) 時才提供給客戶。
affiliateId 長整數 獲得訂房的 cid 折讓
creationDate 字串 訂房的日期
itineraryStartDate 字串 入住日期
itineraryEndDate 字串 退房日期
affiliateCustomerId 字串 訂房時使用的值 (如果可用)
Customer 物件 包含所有與訂房相關聯的旅客資訊。如果是這種情況,旅客就是建立訂房時使用的付款卡片持卡人。
Customer.email 字串 旅客的電子郵件地址
Customer.firstName 字串 旅客的名字
Customer.lastName 字串 旅客的姓氏
Customer.homePhone 字串 旅客的住家電話
Customer.workPhone 字串 旅客的公司電話 (如果有提供)
Customer.extension 字串 旅客的電話分機 (如果有提供)
Customer.faxPhone 字串 旅客的傳真電話 (如果有提供)
Customer.CustomerAddresses 陣列 包含旅客的地址資訊
CustomerAddresses.address1 字串 旅客的街道地址
CustomerAddresses.address2 字串 第二地址行 (如果提供)
CustomerAddresses.address3 字串 第三地址行 (如果提供)
CustomerAddresses.city 字串 旅客的居住城市
CustomerAddresses.stateProvinceCode 字串 包含指定城市的州/省代碼 (兩個字元)。只傳回 US、CA 和 AU 國家節點。

參考資料:
美國代碼
加拿大省份 / 領土代碼
澳洲省份 / 領土代碼
  • 澳洲首都 - AC
  • 新南威爾斯 - NW
  • 北領地 - NO
  • 昆士蘭 - QL
  • 南澳洲 - SA
  • 塔斯馬尼亞 - TS
  • 維多利亞 - VC
  • 西澳洲 - WT
CustomerAddresses.countryCode 字串 旅客的居住國家 ISO-3166 代碼 (兩個字元)。
CustomerAddresses.postalCode 字串 旅客的郵遞區號
CustomerAddresses.isPrimary 布林值 表示此為旅客的主要已知地址
CustomerAddresses.type 整數 1 的值表示帳單地址, 2 的值表示運送地址。
HotelConfirmation 陣列 包含訂房的客房和飯店資訊,以及行程的目前狀態。
HotelConfirmation.supplierId 長整數 飯店訂房時使用的合約飯店。
值:
2:Expedia Collect 飯店
9:Expedia Collect 渡假公寓
13:Expedia.com 飯店
HotelConfirmation.chainCode 字串 連鎖飯店代碼
HotelConfirmation.creditCardType 字串 建立訂房時使用的信用卡類型
HotelConfirmation.arrivalDate 字串 入住日期
HotelConfirmation.departureDate 字串 退房日期
HotelConfirmation.confirmationNumber 字串 訂房時,訂房回傳中傳回的確認編號只有在使用 EAN 支援 (您沒有自己的支援代理商) 時才提供給客戶。
HotelConfirmation.cancellationNumber 字串 取消行程後,取消回傳中傳回的取消編號
HotelConfirmation.numberOfAdults 整數 訂房的已確認成人人數
HotelConfirmation.numberOfChildren 整數 訂房的已確認兒童人數
HotelConfirmation.affiliateConfirmationId 字串 針對訂房傳送的值 (如果有的話)
HotelConfirmation.smokingPreference 字串 吸菸偏好 (如果在原始訂房中表示)
HotelConfirmation.supplierPropertyId 字串 合約飯店 ID,與空房情況回傳中的 propertyId 相同
HotelConfirmation.roomType 字串 客房訂房的房型代碼。
HotelConfirmation.rateType 字串 客房訂房的房價類型
HotelConfirmation.rateDescription 字串 客房價格的價格說明。
HotelConfirmation.roomDescription 字串 簡短客房說明,限 minorRev=10 以上使用。
HotelConfirmation.status 字串 表示訂房時合約飯店系統中的訂房狀態。預期所有未確認值的合適旅客訊息。
CF 已確認
CX 已取消
UC 未確認。
PS 待處理的供應商。代理商將於取得確認編號時,為旅客追蹤訂房。
ER 錯誤。需要代理商注意。代理商將追蹤此訂房。
DT 已刪除的行程 (通常是測試或已失敗的訂房)
HotelConfirmation.locale 字串 訂房使用的地區設定
HotelConfirmation.nights 整數 訂房的住宿天數
HotelConfirmation.GenericRefund 物件 包含因旅客投訴而發出的部分折讓,或根據要求行程計算退款的貨幣類型和金額 (完成取消則無退款)。minorRev=26 和以上時可使用。
GenericRefund.refundAmount 整數 根據行程計算發出的折讓/退款值。minorRev=26 和以上時可使用。
GenericRefund.currencyCode 字串 提供的折讓/退款金額貨幣代碼。minorRev=26 和以上時可使用。
HotelConfirmation.RateInfos 物件

包含原始訂房要求中使用的 RateInfo 物件。如為 minorRev=20 以上,在 RateInfo 中傳回 nonRefundablecancellationPolicy

HotelConfirmation.ReservationGuest 物件/陣列 包含訂房時使用的房客姓名。

JSON 回應會以陣列將房客姓名成對傳回,而不會以 statusDTCXPSER 的多間客房訂房物件傳回。
ReservationGuest.firstName 字串 房客的名字
ReservationGuest.lastName 字串 房客的姓氏
HotelConfirmation.Hotel 物件 訂房的飯店資訊
Hotel.hotelId 長整數 訂房時與飯店相關聯的 ID
Hotel.statusCode 字串 要求行程時 EAN 資料庫中的飯店目前狀態。除 A 以外,所有無法重新訂房的狀態。
值:
A:已啟用
I:未啟用
D:已刪除
R:已移除
C:已確定
Hotel.name 字串 飯店名稱
Hotel.address1 字串 飯店街道地址
Hotel.address2 字串 第二地址行 (如果提供)
Hotel.address3 字串 第三地址行 (如果提供)
Hotel.city 字串 飯店所在城市
Hotel.stateProvinceCode 字串 包含指定城市的州/省代碼 (兩個字元)。只傳回 US、CA 和 AU 國家節點。

參考資料:
美國代碼
加拿大省份 / 領土代碼
澳洲省份 / 領土代碼
Hotel.countryCode 字串 旅客的居住國家 ISO-3166 代碼 (兩個字元)。
Hotel.postalCode 字串 飯店郵遞區號
Hotel.phone 長整數 飯店電話號碼。
避免直接提供給旅客,以免旅客直接向飯店而不是透過 EAN 或您自己的客戶服務部門做變更或取消,因而導致客戶服務問題的產生。
鼓勵旅客在有任何訂房相關問題時回覆他們的確認電子郵件,和/或撥打客戶服務電話。
Hotel.fax 字串 飯店的傳真號碼
Hotel.latitude 浮點數 飯店的緯度座標
Hotel.longitude 浮點數 飯店的經度座標
Hotel.coordinateAccuracyCode 字串 提供的座標精準度代碼
Hotel.lowRate 浮點數 飯店的統計最低價格
Hotel.highRate 浮點數 飯店的統計最高價格
Hotel.hotelRating 浮點數 飯店的星級評等
Hotel.market 字串 訂房適用的市場,例如台北。
minorRev=13 以上一起傳回
Hotel.region 字串 訂房適用的地區市場,例如加州。
minorRev=13 以上一起傳回
Hotel.superRegion 字串 訂房適用的超級地區市場,例如 AMER。
minorRev=13 以上一起傳回
Hotel.theme 字串 訂房的飯店主題,例如海灘飯店、Spa 飯店等。
minorRev=13 以上一起傳回
HotelConfirmation.ConfirmationExtras ConfirmationExtra 陣列適用的容器應用程式 傳回所有與訂房一起送出的要求 追蹤 資訊。有 size 屬性以表示與訂房相關聯的值數目。必須在要求中指定所有自訂值,系統才能傳回值。
ConfirmationExtras.name 字串 additionalData 項目名稱
ConfirmationExtras.value 字串 已送出的追蹤資料值
HotelConfirmation.ValueAdds ValueAdd 適用的容器應用程式 包括所有此訂房所包含的新增值有 size 屬性以表是傳回的新增值數。

minorRev=28 以上參數時即可使用。
ValueAdds.ValueAdd 陣列

包括 description 元素以敘述由提供的客房及價格所供應的免費服務,例如早餐或無線網際網路。

minorRev=28 或以上時可使用。