方法名称
hotel.order.detail
使用说明
根据订单id获取单个订单的详细信息,可以传入艺龙订单号或分销商自己的订单号。仅能搜索半年内的订单。用于向用户展示订单状态。
须使用https访问本接口。
输入参数
节点 | 名称 | 类型 | 可为空 | 说明 |
---|---|---|---|---|
OrderId | 订单编号 | long | N | 如果OrderId不为0,以OrderId为主 |
AffiliateConfirmationId | 联盟的订单编号 | String | Y | 当OrderId=0的时候,则按AffiliateConfirmationId查询 |
Options | 其他条件 | String | Y | 多个英文逗号分隔 1、返回SpecialCancelApply |
响应结果
根节点
节点 | 名称 | 类型 | 可为空 | 说明 |
---|---|---|---|---|
OrderId | 订单编号 | Long | N | |
HotelId | 酒店编号 | String(8) | N | |
HotelName | 酒店名称 | String(200) | Y | V1.03新增 |
RoomId | 房型编号 | String(8) | Y | v1.36新增 |
RoomName | 房型名称 | String(50) | N | 展示给客人的房型名称 |
RoomTypeId | 销售房型编号 | String(8) | N | |
RoomTypeName | 销售房型名称 | String(50) | Y | V1.03新增,此名称仅作为参考,不应展示给客人 |
RatePlanId | 产品编号 | Int | N | |
RatePlanName | 产品名称 | String(100) | Y | V1.05新增 |
ArrivalDate | 入住日期 | Date | N | |
DepartureDate | 离店日期 | Date | N | |
Status | 订单状态 | String(2) | N | A-已确认 B-NO SHOW B1-有预定未查到 B2-待查 B3-暂不确定 C-已结帐 D-删除 E-取消 G-变价 H-变更 N-新单 O-满房 S-特殊 U-特殊满房 V-已审 Z-删除,另换酒店 状态流转过程请参考国内酒店:订单流程 |
ShowStatus | 对用户展示的订单状态 | Long | Y | V1.12新增。请将这个状态展示给客人;某些状态下的详细信息会出现在NoteToGuest。 ShowStatus和Status及信用卡之间的状态关系请见关系对照表 ShowStatus属于功能增强的属性,不要根据此字段做系统判定,仅用于对用户展示使用,与Status有冲突时以Status为准。 |
ConfirmPoint | 下一次确认反馈时间点 | DateTime | Y | V1.12新增。当ShowStatus=4等待确认的时候,系统会在这个时间点前更新确认相关的内容.如果感觉这个时间点太长,可以调用hotel.order.promote进行催确认 |
CustomerType | 客人类型 | Enum | N | All=统一价; Chinese =内宾价,需提示客人“须持大陆身份证入住”; OtherForeign =外宾价,需提示客人“须持国外护照入住”; HongKong =港澳台客人价,需提示客人“须持港澳台身份证入住”; ChinaGuest =中宾价,需提示客人“须持中国身份证、护照入住”; |
PaymentType | 付款类型 | Enum | N | SelfPay-前台现付、Prepay-预付 |
NumberOfRooms | 房间数量 | Int | N | |
NumberOfCustomers | 客人数量 | Int | N | |
EarliestArrivalTime | 最早到店时间 | DateTime | N | |
LatestArrivalTime | 最晚到店时间 | DateTime | N | |
CurrencyCode | 货币类型 | Enum | N | RMB, HKD, MOP, TWD,USD |
TotalPrice | 总价 | Decimal | N | 货币类型查看CurrencyCode字段 |
ElongCardNo | 艺龙会员卡号 | String(20) | Y | 版本V1.01新增 |
ConfirmationType | 确认类型 | Enum | N | NotAllowedConfirm 不允许确认(合作伙伴自查订单状态后自行联系客人) SMS_cn ----艺龙发短信给客人,出现订单问题的时候会主动联系 NoNeed -- 艺龙发短信给客人,出现订单问题的时候不主动联系 注:除了NotAllowedConfirm,其余的选项艺龙都会发送短信,下单时如果输入了邮箱那么都会发送邮件 |
NoteToHotel | 给酒店备注 | String(500) | Y | |
NoteToElong | 给艺龙备注 | String(500) | Y | |
NoteToGuest | 给客人的备注 | String(500) | Y | 版本V1.06新增。V1.12后能展示更多信息。 |
PenaltyToCustomer | 订单产生的罚金 | Decimal | Y | 货币类型查看PenaltyCurrencyCode字段 |
PenaltyCurrencyCode | 罚金货币类型 | Enum | Y | |
IsRefund | 是否可退款 | Boolean | Y | 版本V1.35新增 在E状态吐出该字段,标识E状态代理是否可以退款给客人,为false时需要等到订单状态变为删除才可退款 |
CreationDate | 预订时间 | DateTime | Y | 版本V1.08新增 |
IsCancelable | 当前是否可以取消 | Boolean | Y | 版本V1.07新增,当为true,且CancelTime大于当前时间时,才对用户展示CancelTime。 |
CancelTime | 最晚取消时间 | DateTime | N | CancelTime指最晚可以取消的时间,有时会返回一些很久远的时间,比如1970-01-01或者2001-01-01之类的时间,这种情况就是不可取消,正常判断即可,当前时间肯定大于这个。这个不一定是免费取消的时间,具体免费取消时间要看预付规则。 |
HasInvoice | 是否有发票信息 | Boolean | Y | |
SupportAnticipation | 产品是否支持开专票 | String | Y | 0:产品不支持开专票;1:产品支持开专票 |
Invoice | 发票 | Invoice | Y | 参考Invoice节点 |
DayPromotions | 臻选特惠促销信息 | DayPromotion[] | Y | 参考DayPromotion节点 |
UsedPromotionDayRoomValues | 同程促销促销信息 | OrderDetailDayRoomPromotion[] | Y | 参考OrderDetailDayRoomPromotion节点 |
Contact | 联系人 | Contact | N | 参考Contact节点 |
CreditCard | 信用卡 | CreditCard | Y | 参考CreditCard节点 |
NightlyRates | 每夜价格 | NightlyRate[] | Y | 参考NightlyRate节点 |
ExtendInfo | 扩展信息 | ExtendInfo | Y | 参考ExtendInfo节点 |
OrderRooms | 房间信息 | OrderRoom[] | N | 参考OrderRoom节点 |
GuaranteeRule | 担保规则 | GuaranteeRule | Y | 参考GuaranteeRule节点 |
PrepayRule | 预付规则 | PrepayRule | Y | 参考PrepayRule节点 |
PrepayResult | 预付结果 | PrepayResult | Y | 参考PrepayResult节点 |
GuaranteeResult | 担保结果 | GuaranteeResult | Y | 参考GuaranteeResult节点 |
refundDetail | 多次退款详情 | RefundDetail | Y | 参考RefundDetail节点 |
ValueAdds | 增值服务 | String[] | Y | |
GiftPackages | 礼包套餐 | GiftPackage[] | Y | 参考GiftPackage节点,使用说明参考下方文末礼包套餐(GiftPackage节点)使用说明 |
InvoiceMode | 预付订单的发票开具模式 | Enum | Y | 版本v1.11新增。 Elong-艺龙开发票、Hotel-酒店开发票 前台自付产品都是酒店开发票,这里的过滤是针对预付产品。 如果结果中的InvoiceMode为空表示不开发票。 需要注意Elong-艺龙开发票其实是艺龙可以提供代开发票服务,如果需要开通,请联系商务。 |
TotalPriceExchanged | 换算为人民币的订单总卖价 | Decimal | Y | V1.28新增 |
TotalCostPriceExchanged | 换算为人民币的订单总底价 | Decimal | Y | V1.28新增 |
IsInstantConfirm | 是否及时确认 | Boolean | Y | V1.28新增 |
AffiliateConfirmationId | 代理自己的订单号 | String(50) | Y | V1.28新增 |
OrderHotel | 订单关联的酒店信息 | OrderHotel | Y | V1.28新增,参考OrderHotel节点 |
RefundAmount | 预付订单线下退款金额 | Decimal | Y | V1.29新增 人民币类型(已废弃) https://open.elong.com/faq/detail?id=329&plt=2 |
CustomerPrice | 销售给客人的最终价格 | Decimal | Y | |
payAmount | 实际支付金额 | Decimal | Y | 新增字段,现付非担保订单不返回 |
HourRoom | 是否为钟点房 | Boolean | Y | v1.55新增,小时房产品返回true |
HourRoomStartTime | 钟点房入住开始时间 | DateTime | Y | 当HourRoom=true时返回,字段值为成单时传入且校验通过的客人入住开始及结束时间,格式为yyyy-MM-dd HH:mm:ss ;可见:http://open.elong.com/faq/detail?id=318&plt=2 |
HourRoomEndTime | 钟点房入住结束时间 | |||
Meals | 餐食信息 | DayMeal[] | N | 参考DayMeal节点 |
SpecialCancelApply | 特殊取消申请 | Boolean | N | 当为true时表示此时订单可以发起工单特殊取消,可见:https://open.elong.com/faq/detail?id=335&plt=2 |
Breakfast | 早餐 | String | Y | 国际特有字段 |
BasePrepayRule | 基础预付规则 | Element | Y | 国际特有字段 |
SupplierId | 供应商id | String | Y | 国际特有字段 |
SubSupplierId | 二级供应商id | String | Y | 国际特有字段 |
SpecificRemark | 特殊要求 | String | Y | 国际特有字段 |
TaxAndService | 税和服务费原币种 | Decimal | Y | 国际特有字段 |
TaxAndServiceRMB | 税和服务费人民币币种 | Decimal | Y | 国际特有字段 |
ExtraPersonFeeRMB | 额外人员费用(附加费人民币) | Decimal | Y | 国际特有字段 |
CheckInInstructions | 入住需知 | String | Y | 国际特有字段 |
BedDescription | 床型描述 | String | Y | 国际特有字段 |
BoardInfo | 膳食信息 | Element | Y | 国际特有字段 |
OccupancyPerRoom | 房间最大可住成人数 | Int | Y | 国际特有字段 |
ChildrenOccupancyPerRoom | 房间最大可住儿童数 | Int | Y | 国际特有字段 |
NumberOfAdults | 成人数 | Int | Y | 国际特有字段 |
ChildAges | 儿童年龄 | Int[] | Y | 国际特有字段 |
IsCancelBeforeConfirmation | 是否经历过确认前取消 | Boolean | Y | 国际特有字段 |
InternetType | 网络类型 | String | Y | 国际特有字段 |
InternetDesc | 上网描述 | String | Y | 国际特有字段 |
BedTypeId | 床型id | String | Y | 国际特有字段 |
Internet | 网络 | String | Y | 国际特有字段 |
AdditionalTax | 另付税和服务费 | AdditionalTax | Y | 参考AdditionalTax节点 国际特有字段 |
GuaranteeRule节点
节点 | 名称 | 类型 | 可为空 | 说明 | |
---|---|---|---|---|---|
GuranteeRuleId | 担保规则编号 | Int | N | ||
Description | 描述 | String(255) | N | 如果担保规则存在,将此字段展示给用户 | |
DateType | 日期类型 | Enum | N | BookDay-预定日期 CheckInDay-入住日期 StayDay-在店日期 | |
StartDate | 开始日期 | date | N | ||
EndDate | 结束日期 | date | N | ||
WeekSet | 周有效天数 | String(20) | Y | ||
IsTimeGuarantee | 是否到店时间担保 | Boolean | N | False:为不校验到店时间 True:为需要校验到店时间 | |
StartTime | 到店担保开始时间 | Time | Y | 用于IsTimeGuarantee ==true进行检查。 | |
EndTime | 到店担保结束时间 | Time | Y | [补充]当EndTime小于StartTime的时候,默认从StartTime到次日6点都需要担保。 | |
IsTomorrow | 到店担保的结束时间是否为第二天 | Boolean | Y | false为当天,true为次日 | |
IsAmountGuarantee | 是否房量担保 | Boolean | N | False:为不校验房量条件 True:为校验房量条件 如果IsTimeGuarantee和IsAmountGuarantee都为false则为强制担保 | |
Amount | 担保的房间数,预定几间房及以上要担保 | Int | Y | 用于IsAmountGuarantee==true进行检查 | |
GuaranteeType | 担保类型 | String | Y | FirstNightCost为首晚房费担保 FullNightCost为全额房费担保 | |
ChangeRule | 变更规则 | Enum | Y | 担保规则取消变更规则: NoChange、不允许变更取消 NeedSomeDay、允许变更/取消,需在XX日YY时之前通知 NeedCheckinTime、允许变更/取消,需在最早到店时间之前几小时通知 NeedCheckin24hour、允许变更/取消,需在到店日期的24点之前几小时通知 | |
Day | 日期参数 | Date | Y | ChangeRule= NeedSomeDay时,对应规则2描述中 “允许变更/取消,需在XX日YY时之前通知” 中的XX日,YY时 | |
Time | 时间参数 | Time | Y | ||
Hour | 小时参数 | Int | Y | ChangeRule= NeedCheckinTime时,对应规则3描述中 “ 允许变更/取消,需在最早到店时间之前几小时通知” 中的几小时 ChangeRule= NeedCheckin24hour时,对应规则4描述中“ 允许变更/取消,需在到店日期的24点之前几小时通知” 中的几小时 |
PrepayRule节点
节点 | 名称 | 类型 | 可为空 | 说明 | |
---|---|---|---|---|---|
PrepayRuleId | 规则编号 | Int | N | ||
Description | 描述 | String(255) | N | ||
DateType | 日期类型 | Enum | N | BookDay:预定日期 CheckInDay:入住日期 StayDay:在店日期 | |
StartDate | 开始日期 | Date | Y | ||
EndDate | 结束日期 | Date | Y | ||
WeekSet | 周有效设置 | String(20) | Y | ||
ChangeRule | 变更规则 | Enum | N | PrepayNoChange:不允许变更取消; PrepayNeedSomeDay:在到店当日24点前Hour小时前按规则看是否可以免费变更取消(一般是不收罚金),在Hour和Hour2之间按规则存在罚金,Hour2之后不能变更取消; PrepayNeedOneTime:在约定日期时间点(DateNum + Time)前可以免费变更取消 | |
Hour | 第一阶段提前的几小时 | Int | Y | 用于PrepayNeedSomeDay | |
Hour2 | 第二阶段提前的几小时 | Int | Y | ||
DateNum | 具体取消时间日期部分 | Date | Y | 用于PrepayNeedOneTime | |
Time | 具体取消时间小时部分 | Time | Y | ||
DeductFeesBefore | 在变更时间点前是否扣费 | Int | Y | 用于 PrepayNeedSomeDay的Hour前扣款类型(一般不收罚金)。DeductFeesBefore为1表示扣费,0表示不扣费。 | |
DeductNumBefore | 时间点前扣费的金额或比例 | Decimal | Y | ||
CashScaleFirstAfter | 时间点后扣款类型 | Enum | Y | Money:金额 Percent:比例 FristNight:首晚 用于PrepayNeedOneTime | |
DeductFeesAfter | 在变更时间点后是否扣费 | Int | Y | 用于 PrepayNeedSomeDay的Hour到Hour2之间的扣款类型。DeductFeesAfter为1表示扣费,0表示不扣费。 | |
DeductNumAfter | 时间点后扣费的金额或比例 | Decimal | Y | ||
CashScaleFirstBefore | 时间点前扣款类型 | Enum | Y | Money:金额 Percent:比例 FristNight:首晚 |
PrepayResult节点
节点 | 名称 | 类型 | 可为空 | 说明 |
---|---|---|---|---|
CancelDescription | 取消规则 | String | N | |
LadderParseList | 取消规则明细 | LadderParse[] | N | 参考LadderParse节点 |
GuaranteeResult节点
节点 | 名称 | 类型 | 可为空 | 说明 |
---|---|---|---|---|
CancelDescription | 取消规则 | String | N | |
NeedGuarantee | 是否需要担保 | Boolean | N | |
GuaranteeMoney | 担保的金额 | Double | Y | |
LadderParseList | 取消规则明细 | LadderParse[] | Y | 参考LadderParse节点 |
Invoice节点
节点 | 名称 | 类型 | 可为空 | 说明 |
---|---|---|---|---|
InvoiceType | 发票类型 | Enum | N | v1.31新增。Paper-纸质发票,Electronic-电子发票,SpecialPaper-专用发票。 |
TitleType | 抬头类型 | Enum | N | Personally-个人,Enterprise- 企业,Government-政府机关行政单位,默认为企业; Personally时,不需填写抬头Title(抬头默认为个人)和纳税人识别号/统一社会信用代码ITIN Enterprise时,必须填写抬头Title和纳税人识别号/统一社会信用代码ITIN Government时,必须填写抬头Title |
Title | 抬头 | String(200) | N | |
ITIN | 纳税人识别号/统一社会信用代码 | String(20) | N | 字符长度是15、18或20位,是数字和字母的组合或纯数字 |
ItemName | 发票内容 | String(100) | N | 代订房费或代订住宿费 |
Amount | 金额 | Decimal | N | |
Recipient | 收件人 | Recipient | N | 参考Recipient节点 |
IsNeedRelationOrder | 是否添加发票备注 | boolean | Y | true-在发票备注栏中添加酒店预订信息(酒店名称、入住日期、离店日期、房间数) false-不添加,默认值 |
MemoInfo | 发票备注内容 | String(200) | Y | 添加在发票上面的备注内容 |
Status | 纸质发票状态 | Boolean | N | false--未处理、true--已开票 |
DeliveryStatus | 纸质发票邮寄状态 | Boolean | N | false--未邮寄、true--已邮寄 |
ProcessType | 电子发票处理类型 | Integer | Y | v1.31新增。0 开票,1 红冲,2 修改 |
ProcessStatus | 电子发票处理状态 | Integer | Y | v1.31新增。0 未处理,1 处理中,2 成功,3 失败 |
UrlForPDF | 电子发票pdf下载url | String(500) | Y | v1.31新增。 |
UrlForWeixinCard | 电子发票加入微信卡券的链接url | String(2000) | Y | v1.31新增。可将改链接转为二维码供用户扫码,扫描后自动将该电子发票添加至微信卡包。 |
InvCode | 电子发票发票代码 | String(50) | Y | v1.31新增。 |
InvNumber | 电子发票发票号 | String(50) | Y | v1.31新增。 |
BillNumber | 电子发票单据号 | String(50) | Y | v1.31新增。 |
TaxPayerNum | 纳税人识别号 | String | Y | 专票必传 |
TaxRegisterBank | 开户银行 | String | Y | 专票必传 |
RegisterBankNum | 银行账号 | String | Y | 专票必传 |
RegisterAddress | 注册地址 | String | Y | 专票必传 |
RegisterPhoneNum | 电话 | String | Y | 专票必传 |
Recipient节点
节点 | 名称 | 类型 | 可为空 | 说明 |
---|---|---|---|---|
Province | 省份 | String(20) | N | |
City | 城市 | String(20) | N | |
District | 行政区 | String(50) | N | |
Street | 街道 | String(200) | N | |
PostalCode | 邮编 | String(10) | Y | |
Name | 收件人姓名 | String(50) | N | |
Phone | 电话 | String(50) | N | |
String(50) | Y |
DayPromotion节点
节点 | 名称 | 类型 | 可为空 | 说明 |
---|---|---|---|---|
Date | 日期 | String | N | |
Promotions | 促销信息 | Promotion[] | N | 参考Promotion节点 |
Promotion节点
节点 | 名称 | 类型 | 可为空 | 说明 |
---|---|---|---|---|
PriceDiscountValue | 卖价优惠的金额 | Decimal | Y | |
PromotionTag | 促销名称 | String | Y | |
PromotionId | ID | Long | Y | |
PromotionType | 促销类型 | Integer | Y | 0:未定义 1:天天特价 2:门店新客 3:优享会 4其他促销 5:权益云 |
OrderDetailDayRoomPromotion节点
节点 | 名称 | 类型 | 可为空 | 说明 |
---|---|---|---|---|
StayDate | 促销日期 | String | N | 格式为yyyy-MM-dd |
PromotionDayRoom | 促销日明细 | PromotionDayRoom[] | N |
PromotionDayRoom节点
节点 | 名称 | 类型 | 可为空 | 说明 |
---|---|---|---|---|
RoomNumber | 房间编号 | String | N | 房间编号 |
PromotionDetailList | 促销明细 | PromotionDayRoomItem[] | N | 促销明细 |
PromotionDayRoomItem节点
节点 | 名称 | 类型 | 可为空 | 说明 |
---|---|---|---|---|
Amount | 促销金额 | Decimal | N | 促销金额 |
PromotionType | 促销类型 | Integer | N | 促销类型 9-立减 11- 红包 |
Contact节点
节点 | 名称 | 类型 | 可为空 | 说明 |
---|---|---|---|---|
Name | 姓名 | String(50) | N | |
String(50) | Y | |||
MobileAreaCode | 区号 | String(10) | Y | 手机号区号 |
Mobile | 手机 | String(50) | Y | |
Phone | 电话 | String(50) | Y | |
Fax | 传真 | String(50) | Y | |
Gender | 性别 | Enum | Y | Female 女,Maile 男, Unknown 保密 |
IdType | 证件类型 | Enum | Y | 身份证 IdentityCard, 护照 Passport, 其他 Other |
IdNo | 证件号码 | String(20) | Y | |
FirstName | 名 | String | N | 国际特有字段 |
LastName | 姓 | String | N | 国际特有字段 |
CreditCard节点
节点 | 名称 | 类型 | 可为空 | 说明 |
---|---|---|---|---|
ProcessType | 交易类型 | Enum | Y | Auth—授权 CancelAuth-取消授权 Charge-授权后扣款 Refund-退款 DirectCharge-直接扣款 |
Status | 交易状态 | Enum | Y | UnProcess-未处理 Succeed-成功 Processing-处理中 Fail-失败 |
Amount | 交易金额 | Decimal | Y | v1.07新增,注意预付订单在ProcessType为Refund时,此处金额不一定是实际退款金额,还需要结合RefundAmount字段查看,具体逻辑查看:http://open.elong.com/faq/detail?plt=2&id=122。 |
Notes | 备注或失败原因 | String | Y | v1.19新增(仅订单创建的是使用新支付流程) |
IsPayable | 是否可以继续支付 | Boolean | Y | v1.19新增(仅订单创建的是使用新支付流程)。如果可以继续支付,请使用hotel.order.pay 继续完成支付 |
LatestPayTime | 最晚支付时间 | DateTime | Y | v1.19新增(仅订单创建的是使用新支付流程)。过了最晚支付时间订单将自动取消 |
ExpirationYear | 有效年份 | Int | Y | 已弃用,仅有默认值0 |
ExpirationMonth | 有效月份 | Int | Y | 已弃用,仅有默认值0 |
IdType | 证件类型 | String | Y | 已弃用,仅有默认值IdentifyCard |
NightlyRate节点
节点 | 名称 | 类型 | 可为空 | 说明 |
---|---|---|---|---|
Date | 日期 | Date | N | |
Member | 会员卖价 | Decimal | N | |
Cost | 结算价 | Decimal | Y | 仅结算价模式下有值 |
BreakfastCount | 早餐数量 | Int | Y | V1.24版本新增 |
AddBed | 加床价 | Decimal | Y | 已弃用,仅有默认值0 |
Status | 状态 | Boolean | N | 已弃用,仅有默认值false |
TaxAndServiceFee | 税和服务费原币种 | Decimal | Y | 国际特有字段 |
TaxAndServiceFeeRMB | 税和服务费人民币币种 | Decimal | Y | 国际特有字段 |
roomRate | 房价 | Decimal | Y | 国际特有字段 |
ExtendInfo节点
节点 | 名称 | 类型 | 可为空 | 说明 |
---|---|---|---|---|
String1 | String(200) | Y | 可以存放合作伙伴自己的一些信息(Api不会改变这里的信息),有利于获取订单后进行一些渠道分析等 | |
String2 | String(200) | Y | ||
String3 | String(200) | Y | ||
Int1 | Int | Y | ||
Int2 | Int | Y | ||
Int3 | Int | Y | ||
PartnerParameter | String(200) | Y | V1.13新增:Web传入的参数 |
OrderRoom节点
节点 | 名称 | 类型 | 可为空 | 说明 |
---|---|---|---|---|
Customers | 客人信息 | Customer[] | N | 参考Customer节点 |
RoomNo | 入住房间号 | string | Y | v1.20新增 |
Customer节点
节点 | 名称 | 类型 | 可为空 | 说明 |
---|---|---|---|---|
Name | 姓名 | String(50) | N | |
String(50) | Y | 已不再使用 | ||
Mobile | 手机 | String(50) | Y | 已不再使用 |
Phone | 电话 | String(50) | Y | 已不再使用 |
Fax | 传真 | String(50) | Y | 已不再使用 |
Gender | 性别 | Enum | Y | |
IdType | 证件类型 | Int | Y | 已不再使用 |
IdNo | 证件号码 | String(50) | Y | 已不再使用 |
Nationality | 国籍 | String(50) | Y | |
ConfirmationNumber | 酒店确认号 | String(50) | Y | 酒店自己的订单号 |
OrderHotel节点
节点 | 名称 | 类型 | 可为空 | 说明 |
---|---|---|---|---|
HotelId | 酒店ID | String(8) | N | |
Name | 酒店名称 | String(100) | N | |
Address | 酒店地址 | String(100) | N | |
Phone | 酒店电话 | String(20) | Y | |
CityName | 城市名称 | String(10) | N | |
HotelEnglishName | 酒店英文名 | String | N | 国际特有字段 |
HotelCountryName | 国家名称 | String | Y | 国际特有字段 |
HotelLatitude | 维度 | Decimal | Y | 国际特有字段 |
HotelLongitude | 经度 | Decimal | Y | 国际特有字段 |
BoardInfo节点
节点 | 名称 | 类型 | 可为空 | 说明 |
---|---|---|---|---|
IsBreakfastIncluded | 是否包含早餐 | Boolean | Y | 国际特有字段 |
halfBoardIncluded | 是否半膳 | Boolean | Y | 国际特有字段 |
fullBoardIncluded | 是否全膳 | Boolean | Y | 国际特有字段 |
BoardDesc | 膳食描述 | String | Y | 国际特有字段 |
boardDetails | 膳食明细 | BoardDetail[] | Y | 参考BoardDetail节点 国际特有字段 |
BasePrepayRule节点
节点 | 名称 | 类型 | 可为空 | 说明 |
---|---|---|---|---|
Description | 描述 | String | Y | 国际特有字段 |
BoardDetail节点
节点 | 名称 | 类型 | 可为空 | 说明 |
---|---|---|---|---|
Description | 描述 | String | Y | 国际特有字段 |
Count | 膳食数量 | Int | Y | 国际特有字段 |
type | 膳食类型 | Int | Y | 膳食类型 1:早餐;2:午餐;3:晚餐;0:未知餐型; 国际特有字段 |
GiftPackage节点
节点 | 名称 | 类型 | 可为空 | 说明 |
---|---|---|---|---|
PkgProductId | 礼包套餐ID | Long | N | 关联RatePlan.PkgProductids |
PkgType | 礼包套餐类型 | Int | N | 0:礼包,1:套餐 |
PkgProductName | 礼包套餐名字 | String | Y | |
RuleDescriptionAdditional | 礼包套餐特别说明 | String | Y | |
Pictures | 礼包套餐图片 | Picture[] | Y | 参考Picture节点 |
XProducts | X产品列表 | XProduct[] | Y | 参考XProduct节点 |
XProduct节点
节点 | 名称 | 类型 | 可为空 | 说明 |
---|---|---|---|---|
XProductId | X产品ID | Long | N | X产品即一个具体的礼包 |
XProductName | X产品名字 | String | N | |
TypeName | X产品类型 | String | Y | |
Quantity | X产品数量 | String | Y | |
ReceptionTimes | X产品接待时间 | String | Y | |
Capacity | X产品适用人数 | String | Y | |
BookingPhone | X产品预订电话 | String | Y | |
AppointPolicy | X产品预订规则 | String | Y |
Picture节点
节点 | 名称 | 类型 | 可为空 | 说明 |
---|---|---|---|---|
ImgIndex | 礼包图片顺序 | Int | N | |
ImgUrl | 礼包图片链接 | String | N |
DayMeal节点
节点 | 名称 | 类型 | 可为空 | 说明 |
---|---|---|---|---|
date | 餐食的日期 | String | N | yyyy-MM-dd格式,例如2021-08-12 |
useDynamicMeal | 是否使用动态餐食 | Boolean | N | 为true取dynamicMealDesc; 为false取breakfastDesc、lunchDesc、dinnerDesc; |
dynamicMealDesc | 动态餐食描述 | String | Y | 例如:3种餐食(3选2) |
breakfastShare | 早餐数量 | Int | N | 例如:0 |
breakfastDesc | 早餐描述 | String | Y | |
lunchShare | 午餐数量 | Int | N | 例如:1 |
lunchDesc | 午餐描述 | String | Y | 例如:1份午餐 |
dinnerShare | 晚餐数量 | Int | N | 例如:2 |
dinnerDesc | 晚餐描述 | String | Y | 例如:2份晚餐 |
dayMealDesc | 到天餐食描述 | String | Y | 例如:2份早餐/间 |
RefundDetail节点
节点 | 名称 | 类型 | 可为空 | 说明 |
---|---|---|---|---|
refundAmount | 总的退款金额 | Double | N | |
refundDetails | 每笔退款明细 | Refund[] | N | 参考 Refund节点 |
Refund节点
节点 | 名称 | 类型 | 可为空 | 说明 |
---|---|---|---|---|
refundAmount | 每笔退款金额 | Double | N | |
refundTime | 每笔退款的时间 | Date | N |
输入参数示例
https://api-test.elong.com/rest?timestamp=1489648630&format=json &method=hotel.order.detail&signature=759daf8670f20ac4a274f7981264765d &user={userid}&data={"Version":"1.28","Local":"zh_CN","Request":{"OrderId":"400002545"}}
输出参数示例
{ "Code":"0", "Result":{ "ElongCardNo":"190000002101111111", "Contact":{ "Name":"李海", "Email":"", "Mobile":"13800138000", "Phone":"", "Fax":"", "Gender":"Unknown" }, "NightlyRates":[ { "Member":179.0, "Cost":-1.0, "Status":false, "AddBed":0.0, "Date":"2016-01-26T00:00:00 08:00", "BreakfastCount":0 } ], "OrderRooms":[ { "Customers":[ { "Name":"李海", "Email":"", "Mobile":"", "Phone":"", "Fax":"", "Gender":"Unknown" } ] }, { "Customers":[ { "Name":"张江", "Email":"", "Mobile":"", "Phone":"", "Fax":"", "Gender":"Unknown" } ] } ], "refundDetail": { "refundAmount": 720.0, "refundDetails": [ { "refundAmount": 700.0, "refundTime": "2022-03-29T17:04:43+08:00" }, { "refundAmount": 10.0, "refundTime": "2022-03-29T15:06:42+08:00" }, { "refundAmount": 10.0, "refundTime": "2022-03-29T15:05:23+08:00" } ] }, "OrderId":400002545, "Status":"V", "ShowStatus":4, "PenaltyToCustomer":0.0000, "PenaltyCurrencyCode":"RMB", "CancelTime":"2016-01-27T00:00:00 08:00", "HasInvoice":false, "InvoiceMode":"Hotel", "ValueAdds":[ "不含早餐" ], "HotelName":"海友酒店(北京苹果园店)", "RoomTypeName":"高级大床房", "RatePlanName":"不含早", "IsCancelable":true, "CreationDate":"2014-02-07T00:00:00 08:00", "TotalPriceExchanged":358.0, "TotalCostPriceExchanged":-2.0, "OrderHotel":{ "HotelId":"90209610", "Name":"海友酒店(北京苹果园店)", "Address":"北京市石景山区西井路19号院1号楼", "Phone":"0780-6354396", "CityName":"北京" }, "IsInstantConfirm":false, "HotelId":"90209610", "RoomTypeId":"0003", "RatePlanId":448254, "ArrivalDate":"2016-01-26T00:00:00 08:00", "DepartureDate":"2016-01-27T00:00:00 08:00", "CustomerType":"All", "PaymentType":"SelfPay", "NumberOfRooms":2, "NumberOfCustomers":2, "EarliestArrivalTime":"2016-01-26T12:00:00 08:00", "LatestArrivalTime":"2016-01-26T15:00:00 08:00", "CurrencyCode":"RMB", "TotalPrice":358.0, "CustomerPrice":0.0, "ConfirmationType":"SMS_cn", "NoteToHotel":"" } "Guid":"196d84d9-19b1-4aa2-8891-1c699e806a3c" }
注意事项
预付订单罚金和退款金额说明:
当客人还没有入住这个订单需要进行取消的时候,根据规则需要产生罚金,则订单将取消变成删除状态,并将罚金设置到PenaltyToCustomer属性中;
当客人已经入住了这个订单,但入住的间夜需要减少,酒店同意退款的情况(如果不同意那就是没必要进行操作),订单将保持“已结账”状态,订单总金额不变化,并将退款的金额写入到RefundAmount属性中。
臻选特惠和同程促销的差别说明:
“同程促销”是我们同程供应商的促销 , “臻选特惠”是酒店自己的促销活动,同程作为参与方的促销。
礼包套餐(GiftPackage节点)使用说明:
- 在房型产品中取GiftPackage.PkgProductname作为礼包套餐标题展示,在礼包套餐标题前取PkgType字段展示类型(如0,展示为礼包)。在礼包套餐详情页中,按类别(TypeName)分别展示每个类别中X产品(XProduct)具体信息:取该类型中的每个X产品的XProductName+Qunatity进行拼接作为该类别X产品标题,如"X产品A 1份/天+X产品B 1份一天";在X产品标题前可展示X产品类型(TypeName)。在该类别X产品标题分别展示所含X产品信息,取"XProductName使用说明"作为每个X产品的副标题,如"X产品A使用说明",在每个X产品的副标题下展示其具体内容:"预约规则:AppointPolicy 预约时间: ReceptionTimes 适用人数:Capacity 预约电话:BookingPhone"等内容。如果这些字段返回都为空,则无需展示该X产品
- 在X产品展示完之后可取礼包套餐的特别说明(GiftPackage.RuleDescriptionAdditional)进行展示,标题为"特别说明",取图片GiftPackage.Pictures中的ImgUrl字段展示图片,标题为"图文说明",图片按Picture.ImgIndex的大小按顺序展示。
常见错误码
错误码 | 解释 | 解决方案 |
---|---|---|
H000997 | 未知异常 | 重试,反复出现请联系技术支持人员 |