查询订单
请求方式:http,返回json格式。
接口地址
名称 | 请求格式 | 测试地址 |
---|---|---|
查询订单 | GET | http://58.250.56.5:8158/api/order/queryOrderDetail.json?reqData=xxx |
系统输入参数
名称 | 编码 | 类型 | 示例值 | 描述 |
---|---|---|---|---|
客户编号 | appKey | String | SZ28276 | 捷旅提供 |
时间戳 | timestamp | String | 1516816895000 | Unix时间戳 |
数字签名 | sign | String | 063cae11a00896187f80eecbf922364a | 签名方法:md5(md5(secretKey+appKey)+timestamp)md5采用32位小写。 |
版本 | version | String | 3.0.1 | 版本信息,请参考版本说明 |
系统输出参数
名称 | 编码 | 类型 | 示例值 | 描述 |
---|---|---|---|---|
结果代码 | code | Integer | 0 | 0表示请求成功;非0表示存在业务异常。 |
结果描述 | errorMsg | String | 错误描述 | |
版本 | version | String | 3.0.1 | |
结果对象 | result | String | 不同的请求是不同的对象,错误的请求一般返回为空 | |
响应码 | respId | String | 单次响应的唯一编码,业务问题排查请提供编码 |
输入参数
名称 | 编码 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|---|
订单编号 | orderCode | String | 特殊可选 | JLA20118010965193 | 捷旅订单号 |
客户订单号 | customerOrderCode | String | 特殊可选 | R15644321361 | 客户订单号 |
下单时间开始 | createBegin | String | 特殊可选 | yyyy-MM-dd hh:mm:ss | |
下单时间结束 | createEnd | String | 特殊可选 | yyyy-MM-dd hh:mm:ss时间范围不能超过1天 |
输入示例
{"head": {"appKey": "SZ28276","timestamp": "1516816895000","sign": "063cae11a00896187f80eecbf922364a","version":"3.0.1"},"data":{"orderCode":"P17122700035","customerOrderCode": "R15644321361"}}
返回参数
名称 | 编码 | 类型 | 示例值 | 描述 |
---|---|---|---|---|
订单列表 | orderDetailList | OrderDetail[] |
OrderDetail
对象包括订单信息。
属性
名称 | 编码 | 类型 | 示例值 | 描述 |
---|---|---|---|---|
订单编号 | orderCode | String | JLA20118010965193 | 捷旅唯一订单编号 |
客户订单号 | customerOrderCode | String | R15644321361 | |
酒店编号 | hotelId | Integer | 15 | |
酒店名称 | hotelNameCn | String | 巴厘岛硬石酒店 | |
房型编号 | roomTypeId | String | 187 | |
房型名称 | roomTypeCn | String | 阁楼房 | |
价格类型编号 | rateTypeId | String | 4 | |
价格类型名称 | rateTypeCn | String | 床位早 | |
产品编号 | keyId | String | SF#S6#S8G#4#A | |
入住日期 | checkInDate | String | 2017-12-28 | yyyy-MM-dd |
离店日期 | checkOutDate | String | 2017-12-29 | yyyy-MM-dd |
付款类型 | paymentType | Integer | 0 | 0:预付、1:现付 |
房间信息 | roomGroups | RoomGroup[] | 无 | |
币种 | currency | String | CNY | |
给酒店备注 | hotelRemark | String | 尽量安排高层 | |
预订时间 | createTime | String | 2017-12-27 18:26:14 | yyyy-MM-dd hh:mm:ss |
订单金额 | totalPrice | Double | 677 | |
订单确认号 | confirmNo | String | ||
订单状态 | orderStatus | Integer | 2 | 1:待确认、2:已确认、3:已拒单、4:已取消、5:已入住 |
取消条款 | refundRules | RefundRule[] | 无 | refundRules定义见下表 |
RefundRule
对象包括取消条款信息,为空默认是为1不可退。
属性
名称 | 编码 | 类型 | 示例值 | 描述 |
---|---|---|---|---|
取消条款规则 | refundRuleType | Integer | 无 | 订单状态接口返回的取消条款为下单时的取消条款。当返回数据为空时,默认不可取消;1:不可退、2:限时取消 |
支持30分钟免费取消 | thirtyMinFreeCancelPolicy | boolean | 无 | 是否支持确认后30分钟免费取消。True表示支持,False表示不支持(不填默认为不支持30分钟免费取消) |
入住前n小时 | refundRuleHours | Integer | 无 | 30 |
取消客人罚金 | deductType | Integer | 无 | 1扣全额、0扣首晚房费 |
返回示例
{"code":0,"errorMsg":"","result":{"orderDetailList":[{"orderCode":"P17122700035","customerOrderCode":"R15644321361","hotelId":15,"hotelNameCn":"巴厘岛硬石酒店","roomTypeId":"187","roomTypeCn":"阁楼房","rateTypeId":"4","rateTypeCn":"床位早","checkInDate":"2017-12-28","checkOutDate":"2017-12-29","paymentType":0,"roomGroups":[{"adults":2,"checkInPersions":[{"lastName":"姓名","firstName":"test"}]}],"currency":"CNY","hotelRemark":"酒店备注","createTime":"2017-12-27 18:26:14","totalPrice":677,"orderStatus":2,"keyId":"SF#S6#S8G#4#A"}]},"respId":"eca58d83-db5f-4147-9abc-565aea97a47d"}