查询商旅订单号
请求地址
https://api.es.xiaojukeji.com/api-gateway/order/getIdList
返回数据格式
JSON
请求方式
GET
是否需要登录
是 关于登录授权,参见 如何登录授权
访问授权限制
暂无
请求参数
名称 | 类型 | 必选 | 描述 |
client_id | string | yes | 申请应用时分配的AppKey |
access_token | string | yes | 授权后的access token |
company_id | string | yes | 企业ID |
timestamp | bigint | yes | 当前时间戳(精确到秒级) |
sign | string | yes | 签名 |
order_type | int | yes | 订单类型,1酒店,2机票,3火车票 |
start_date | string | no | 开始日期(如:2015-05-01) |
end_date | string | no | 结束日期(如:2015-05-28) |
employee_number | string | no | 预订人工号 |
contact_phone | string | no | 联系人手机号 |
passenger_phone | string | no | 乘机人/入住人/乘火车人手机号 |
approval_id | string | no | 差旅申请单id |
start_time | string | no | 开始时间(如:2018-12-12 20:00:00) |
end_time | string | no | 结束时间(如:2018-12-12 21:00:00) |
cur_page | int | yes | 当前页,从1开始 |
limit | int | yes | 每页查询多少条(限制100) |
注意事项
1、查询条件优先级 审批单号 > 日期,即传了审批单号,其他查询条件失效
2、查询日期定义 酒店:订单的已提交、已提交预定、预定成功、已入住、已完成(离店)、取消订单、取消预定、预定未到时间在start_date和end_date之间可以查到(左闭右开) 机票:订单的下单、支付、发起审批、审批成功、审批驳回、审批超时、取消、关闭、出票、发起改签、改签成功、发起退票、退票成功时间在start_date和end_date之间可以查到(左闭右开) 火车票:订单的下单、支付、取消、出票、发起改签、改签成功、发起退票、退票成功时间在start_date和end_date之间可以查到(左闭右开)
3、日期查询规则如下: 开始日期、结束日期均填写,在开始结束日期范围必须在7天内 只填写开始日期,则查询日期范围为开始时间往后7天,如start_date = 2021-12-01,则可以查询到2021-12-01 ~ 2021-12-08(包含12.01不包含12.08)的订单 只填写结束日期,则查询日期范围为结束时间往前7天,如end_date = 2021-12-10, 则可以查询到2021-12-03 ~ 2021-12-10(包含12.03不包含12.10)的订单 开始日期结束日期未填写,则查询当前日期前7天的订单,如今天是2021-12-28,则可以查询到2021-12-21 ~ 2021-12-28(包含12.21不包含12.28)的订单
请求示例
curl -X GET -H "Content-Type: application/x-www-form-urlencoded" https://api.es.xiaojukeji.com/api-gateway/order/getIdList?client_id=client_id_test&access_token=141ea31466478eab2f1c1ddcca2675b989a16552×tamp=1566764837&company_id=12345678980&length=100&sign=091cf244ad5ab16935cfe44fc698bc58
请求返回参数
字段名称 | 字段类型 | 字段说明 |
---|---|---|
errno | int | 错误,0表示成功,非0表示失败 |
errmsg | string | 成功返回"SUCCESS",失败返回对应的错误信息 |
data | object | 数据 |
data.flight_data | object | 机票订单信息 |
data.flight_data.order_ids | string | 机票订单号,以英文逗号连接 |
data.flight_data.page.cur_page | int | 查询页 |
data.flight_data.page.limit | int | 页大小 |
data.flight_data.page.total | int | 符号条件的数据总条数 |
data.hotel_data | object | 酒店订单信息 |
data.hotel_data.order_ids | string | 酒店订单号,以英文逗号连接 |
data.hotel_data.page.cur_page | int | 查询页 |
data.hotel_data.page.limit | int | 页大小 |
data.hotel_data.page.total | int | 符号条件的数据总条数 |
data.train_data | object | 火车票订单信息 |
data.train_data.order_ids | string | 火车票订单号,以英文逗号连接 |
data.train_data.page.cur_page | int | 查询页 |
data.train_data.page.limit | int | 页大小 |
data.train_data.page.total | int | 符号条件的数据总条数 |
返回示例
{
"errno":0,
"errmsg":"SUCCESS",
"data":{
"flight_data":{
"order_ids":"1125914408770788,1125914409333663",
"page":{
"cur_page":1,
"limit":10,
"total":2
}
},
"hotel_data":{
"order_ids":"1125912935497544,1125912907158542,1125914483907102",
"page":{
"cur_page":1,
"limit":10,
"total":3
}
},
"train_data":{
"order_ids":"1125912935497544,1125912907158542,1125914483907102",
"page":{
"cur_page":1,
"limit":10,
"total":3
}
}
},
"request_id":"202211091126120ab78e04636b1dd494f71ed806864702"
}