接口说明
该接口用于查询机票,酒店,火车票,用车订单号的查询,明细的信息需要使用订单号在对应的品类的订单详情查询接口中获取
- out_approval_id/approval_id有值时(approval_id优先级最高),其他查询条件不生效(时间除外)。查询所有品类时,返回所有的品类信息,时间条件按照查询所有的品类的条件,即更新时间查询。具体参考时间查询条件说明。注意查询结束时间不是等于当前时间
- start_time,end_time成对出现,查询时间起止都包含在条件内。其他查询条件依赖时间查询存在,不可以单独使用。时间范围:30天
基本信息
|
HTTP URL |
/open-apis/v1/order/list |
|---|---|
|
HTTP Method |
POST |
|
权限要求 |
|
请求头
|
参数名称 |
参数值 |
|---|---|
|
Content-Type |
application/json |
请求参数
|
字段名 |
字段说明 |
字段类型 |
必填 |
备注 |
|---|---|---|---|---|
|
client_id |
申请应用时分配的AppKey |
string |
Y |
|
|
access_token |
授权后的access token |
string |
Y |
|
|
company_id |
企业ID |
string |
Y |
|
|
timestamp |
当前时间戳(精确到秒级) |
int |
Y |
|
|
sign |
签名 |
string |
Y |
|
|
param_json |
查询信息 |
json |
Y |
|
param_json
|
字段名 |
字段说明 |
字段类型 |
必填 |
备注 |
|---|---|---|---|---|
|
order_type |
订单类型 |
string |
Y |
枚举值英文code: |
|
search_time |
时间传参 |
object |
N |
当approval对象有值时,时间可以不传,不传时间默认查询时间范围为距今2年。且其他除时间和申请单对象之外的查询参数不生效。除approval查询参数外,时间传参必填 |
|
approval |
申请单信息 |
object |
N |
|
|
booker |
预订人信息 |
object |
N |
|
|
passenger |
出行人信息 |
object |
N |
|
|
budget_center |
成本中心信息 |
object |
N |
|
|
pay_info |
支付信息 |
object |
N |
|
|
invoice_info |
发票信息 |
object |
N |
|
|
cur_page |
当前页 |
int |
Y |
当前页,从1开始 |
|
limit |
每页条数 |
int |
Y |
每页查询多少条(限制100) |
search_time
|
字段名 |
字段说明 |
字段类型 |
必填 |
备注 |
|---|---|---|---|---|
|
type |
时间类型 |
string |
Y |
枚举值英文code, |
|
start_time |
开始时间 |
string |
Y |
格式:yyyy-MM-dd HH:mm:ss 时间范围最大30天 最早时间距今不超过两年时间跨度 |
|
end_time |
结束时间 |
string |
Y |
格式:yyyy-MM-dd HH:mm:ss 可查询的最早时间范围截止为当前时间往前300秒 |
approval
|
字段名 |
字段说明 |
字段类型 |
必填 |
备注 |
|---|---|---|---|---|
|
type |
申请单号类型 |
int |
N |
枚举值数字, |
|
value |
单号信息 |
string |
N |
|
booker
|
字段名 |
字段说明 |
字段类型 |
必填 |
备注 |
|---|---|---|---|---|
|
type |
预订人主键类型 |
string |
N |
枚举值英文,employee_number ,email ,phone |
|
value |
查询主键信息 |
string |
N |
|
passenger
|
字段名 |
字段说明 |
字段类型 |
必填 |
备注 |
|---|---|---|---|---|
|
type |
出行人主键类型 |
string |
N |
枚举值英文,employee_number ,email ,phone |
|
value |
查询主键信息 |
string |
N |
外部出行人只能使用手机号 |
budget_center
|
字段名 |
字段说明 |
字段类型 |
必填 |
备注 |
|---|---|---|---|---|
|
type |
成本中心类型 |
int |
N |
枚举值数字 , |
|
code |
成本中心code |
string |
N |
|
|
name |
成本中心名称 |
string |
N |
|
pay_info
|
字段名 |
字段说明 |
字段类型 |
必填 |
备注 |
|---|---|---|---|---|
|
pay_type |
支付方式 |
int |
N |
枚举值数字: |
invoice_info
|
字段名 |
字段说明 |
字段类型 |
必填 |
备注 |
|---|---|---|---|---|
|
is_invoice |
开票状态 |
int |
N |
枚举值数字:1:开过 0:未开 仅用车生效 |
请求示例
{
"access_token": "445d2d33084a0b4282d8edbb1fdf448e003b9276",
"company_id": "1125915646167936",
"param_json": "{\"order_type\":\"all\",\"invoice_info\":{\"is_invoice\":0},\"pay_info\":{\"pay_type\":0},\"search_time\":{\"type\":\"all\",\"start_time\":\"2024-03-01 00:00:00\",\"end_time\":\"2024-03-04 18:59:00\"},\"booker\":{\"type\":\"phone\",\"value\":\"11100011245\"},\"approval\":{\"type\":2,\"value\":\"1125929449637328\"},\"cur_page\":1,\"limit\":100}",
"sign": "6328e199667f4277b71b5bd6870fb876",
"client_id": "87fca1dc60c9de0a96c20fccf2ccaa40_test",
"sign_key": "f86b6735313052FD7d0f",
"timestamp": 1711701223
}
展示需要,去除转义:
{
"client_id": "123",
"client_secret": "123456",
"company_id": "123456",
"timestamp": "123456789",
"sign": "123456789",
"param_json": {
"order_type": "car",
"invoice_info": {
"is_invoice": 1
},
"pay_info": {
"pay_type": 1
},
"search_time": {
"type": "pay_time",// change_time book_time exchange_time refund_time pay_time all
"start_time": "2023-11-01 00:00:00",
"end_time": "2023-11-28 19:50:00"
},
"booker": {
"type": "phone",// 预订人类型 employee_number email phone
"value": "11100011245"
},
"passenger": {
"type": "phone",
"value": "11100011245"
},
"approval": {
"type": 1,
"value": "out_approval_id"
},
"budget_center": {
"type": 1,
"code": "testid",
"name": "项目01"
},
"cur_page": 1,
"limit": 100
}
}
响应参数
|
字段名称 |
字段类型 |
字段说明 |
|---|---|---|
|
errno |
int |
错误,0表示成功,非0表示失败 |
|
errmsg |
string |
成功返回"SUCCESS",失败返回对应的错误信息 |
|
data |
object |
数据 |
|
|
|
|
|
data.domesticflight_data |
object |
国内机票订单信息 |
|
data.domesticflight_data.order_ids |
string |
国内机票订单号,以英文逗号连接 |
|
data.domesticflight_data.page.cur_page |
int |
查询页 |
|
data.domesticflight_data.page.limit |
int |
页大小 |
|
data.domesticflight_data.page.total |
int |
符合条件的数据总条数 |
|
|
|
|
|
data.internationalflight_data |
object |
国际机票订单信息 |
|
data.internationalflight_data.order_ids |
string |
国际机票订单号,以英文逗号连接 |
|
data.internationalflight_data.page.cur_page |
int |
查询页 |
|
data.internationalflight_data.page.limit |
int |
页大小 |
|
data.internationalflight_data.page.total |
int |
符合条件的数据总条数 |
|
|
|
|
|
data.domestichotel_data |
object |
国内酒店订单信息 |
|
data.domestichotel_data.order_ids |
string |
国内酒店订单号,以英文逗号连接 |
|
data.domestichotel_data.page.cur_page |
int |
查询页 |
|
data.domestichotel_data.page.limit |
int |
页大小 |
|
data.domestichotel_data.page.total |
int |
符号条件的数据总条数 |
|
|
|
|
|
data.internationalhotel_data |
object |
国际酒店订单信息 |
|
data.internationalhotel_data.order_ids |
string |
国际酒店订单号,以英文逗号连接 |
|
data.internationalhotel_data.page.cur_page |
int |
查询页 |
|
data.internationalhotel_data.page.limit |
int |
页大小 |
|
data.internationalhotel_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 |
符号条件的数据总条数 |
|
|
|
|
|
data.car_data |
object |
用车订单信息 |
|
data.car_data.order_ids |
string |
用车订单号,以英文逗号连接 |
|
data.car_data.page.cur_page |
int |
查询页 |
|
data.car_data.page.limit |
int |
页大小 |
|
data.car_data.page.total |
int |
符号条件的数据总条数 |
响应示例
正常示例
{
"errno": 0,
"errmsg": "SUCCESS",
"data": {
"car_data": {
"order_ids": "1125928329077368,1125928328923206,1125928328542990,1125928328249300",
"page": {
"cur_page": 1,
"limit": 100,
"total": 4
}
},
"domesticflight_data": {
"order_ids": "1125928330619394,1125928328403583,1125928323083257,1125924693491763,1125924684850983,1125924683325400,1125924680155669,1125924640287982,1125919852499532,1125919801577657,1125919798881744,1125919794968263",
"page": {
"cur_page": 1,
"limit": 100,
"total": 12
}
},
"domestichotel_data": {
"order_ids": "1125928364794689,1125928364511375,1125928364445978,1125928364252297,1125928360272044,1125928358764212,1125928338140022,1125928331112600,1125928330430989,1125928329142507",
"page": {
"cur_page": 1,
"limit": 100,
"total": 10
}
},
"internationalflight_data": {
"order_ids": "",
"page": {
"cur_page": 1,
"limit": 100,
"total": 0
}
},
"internationalhotel_data": {
"order_ids": "",
"page": {
"cur_page": 1,
"limit": 100,
"total": 0
}
},
"train_data": {
"order_ids": "1125928295360249,1125928296669327,1125928298581947,1125928330344364",
"page": {
"cur_page": 1,
"limit": 100,
"total": 4
}
}
},
"request_id": "+xvHWIzBGl0A3OPgqT1LZGHP7V0RgrOeMZmkTPOof9y0syZFBmnBmT2EClL6sbSu"
}{
"errno": 0,
"errmsg": "SUCCESS",
"data": {
"car_data": {
"order_ids": "1125928329077368,1125928328923206,1125928328542990,1125928328249300",
"page": {
"cur_page": 1,
"limit": 100,
"total": 4
}
},
"domesticflight_data": {
"order_ids": "1125928330619394,1125928328403583,1125928323083257,1125924693491763,1125924684850983,1125924683325400,1125924680155669,1125924640287982,1125919852499532,1125919801577657,1125919798881744,1125919794968263",
"page": {
"cur_page": 1,
"limit": 100,
"total": 12
}
},
"domestichotel_data": {
"order_ids": "1125928364794689,1125928364511375,1125928364445978,1125928364252297,1125928360272044,1125928358764212,1125928338140022,1125928331112600,1125928330430989,1125928329142507",
"page": {
"cur_page": 1,
"limit": 100,
"total": 10
}
},
"internationalflight_data": {
"order_ids": "",
"page": {
"cur_page": 1,
"limit": 100,
"total": 0
}
},
"internationalhotel_data": {
"order_ids": "",
"page": {
"cur_page": 1,
"limit": 100,
"total": 0
}
},
"train_data": {
"order_ids": "1125928295360249,1125928296669327,1125928298581947,1125928330344364",
"page": {
"cur_page": 1,
"limit": 100,
"total": 4
}
}
},
"request_id": "+xvHWIzBGl0A3OPgqT1LZGHP7V0RgrOeMZmkTPOof9y0syZFBmnBmT2EClL6sbSu"
}
异常示例
错误码
版本记录
|
日期 |
更新人 |
更新内容 |
上线时间 |
|---|---|---|---|
|
2023.11.02 |
陈继诗 |
新建文档 |
2024.03.07 |
|
2024.04.08 |
陈继诗 |
时间查询参数在approval有值时不必传 |
2024.04.08 |