国内/国际用车
国内/国际用车
打车订单详情查询
通过该接口查询打车订单详情。
接口URL
/car/order_detail/query
请求参数定义
参数名 | 参数说明 | 必填 | 参数类型 | 长度 | 值举例 | 备注 |
---|---|---|---|---|---|---|
corpCode | 企业账号 | Y | String | 1000 | 系统提供的企业账号 | |
timestamp | 时间戳 | Y | String | 14 | 20180811113019 | 服务方仅允许20分钟内的时间误差。 |
version | 版本号 | Y | String | 3.0 | 固定为3.0。 | |
loginName | 操作人帐号 | Y | String | HW_000001 | 1、如本次操作为系统相关,则该字段为固定字符串值:"sysadmin";2、如操作为指定普通员工信息维护或修改,则该字符串为:“<员工登录账户名称>"。 | |
msgId | 唯一标识 | Y | String | 1000020150511190411000001 | 企业账号+消息方向+YYYYMMDDHHMMSS+NNNNNN | |
orderId | 订单ID | Y | String | U1234567 | 打车订单号 | |
needLocation | 是否需要地点坐标 | N | Boolean | true | 默认不传 |
响应参数定义
参数名 | 参数说明 | 必填 | 参数类型 | 长度 | 值举例 | 备注 |
---|---|---|---|---|---|---|
orderId | 订单id | Y | String | U1234567 | 系统侧的订单主键id | |
travelType | 出行类型 | Y | String | 0:因公出行,1:个人出行 | 默认返回因公出行订单 | |
orderStatus | 订单状态 | Y | String | 订单状态枚举 | ||
orderStatusShow | 订单状态 | Y | String | IN_QUEUE:派单中,DRIVER_RECEIVED:司机已接单,TRIP_START:行程已开始,WAIT_PAY:待支付,WAIT_CONFIRM:待确认,QUEUE_FAILED:派单失败,DRIVER_DEPART:司机已出发,DRIVER_ARRIVE:司机已到达,CANCEL_WAIT_PAY:取消待支付,CANCEL_WAIT_CONFIRM:取消待确认,COMPLETE:已完成,CANCELED:已取消,CHANGING_QUEUE:改派中 | 订单状态中文枚举 | |
createTime | 预定时间 | N | String | 2022-10-01 10:01 | yyyy-MM-dd HH:mm | |
travelNo | TR | N | String | TR-202210001 | 差旅审批单号 | |
saleApp | 订单来源 | N | String | H5 | 订单来源 | |
saleChannel | 预定渠道 | N | String | android | 预定渠道 | |
carUseScene | 用车场景 | Y | String | PERSONAL:个人用车,COMMON:普通打车,OVERTIME:加班打车,BUSINESS_TRIP:差旅用车 | 预定用车的场景 | |
entId | 企业主键 | Y | String | 1 | 企业id | |
entName | 企业名称 | N | String | 华为技术有限公司 | 企业的名称 | |
belongDept | 预定人所属部门 | N | String | XXX部门 | 预定人所属部门 | |
staffNo | 预定人工号 | N | String | 123456 | ||
userName | 预定人姓名 | N | String | 张三 | ||
memberId | 预定人memberId | Y | String | ID123456789 | ||
loginName | 登录人账号 | Y | String | 18012345678 | ||
payType | 支付方式 | N | String | 0:员工电子流,5:关联月结,10:外部月结,3:现金,4:POS,11:转账,1:在线支付,2:IVR,6:因公欠款,7:VIP欠款,8:担保欠款,10:外部月结,11:转帐,12:互抵,13:预收帐款,14:到店付款 | ||
totalPrice | 订单总价 | N | String | 123.01 | ||
serviceFee | 服务费 | N | String | 123.01 | ||
supplierOrderId | 供应商Id | N | String | SL2017122100029 | ||
supplierType | 供应商类型 | N | String | CAOCAO | ||
supplierName | 供应商名称 | N | String | 曹操 | ||
bizType | 业务类型 | N | String | 业务类型 CAR:国内用车 ICAR:国际用车 | ||
contactList | 联系人列表 | N | List<OpenApiContact> | |||
travelerList | 乘车人列表 | N | List<OpenApiTraveler> | |||
virtualTripInfo | 预估行程信息 | N | OpenApiTripInfo | |||
actualTripInfo | 实际行程信息 | N | OpenApiTripInfo |
OpenApiContact联系人
参数名 | 参数说明 | 必填 | 参数类型 | 长度 | 值举例 | 备注 |
---|---|---|---|---|---|---|
contactId | 联系人Id | N | String | 123456 | ||
contactName | 联系人姓名 | N | String | 张三 | ||
contactMobile | 联系人手机号 | N | String | 18012345678 | ||
mobileCountryCode | 手机号国家码 | N | String | 86 | ||
virtualMobile | 联系人虚拟手机号 | N | String | 78946123 | ||
virtualMobileValid | 虚拟号码有效性 | N | String | 0:无效,1:有效 |
OpenApiTraveler乘车人
参数名 | 参数说明 | 必填 | 参数类型 | 长度 | 值举例 | 备注 |
---|---|---|---|---|---|---|
passgId | 乘客id | N | String | 123456 | ||
memberId | 会员Id | N | String | ID123465 | ||
travelerName | 乘客姓名 | N | String | 张三 | ||
travelerMobile | 乘客手机号 | N | String | 18012345678 | ||
mobileCountryCode | 手机号国家码 | N | String | 86 |
OpenApiTripInfo行程信息
参数名 | 参数说明 | 必填 | 参数类型 | 长度 | 值举例 | 备注 |
---|---|---|---|---|---|---|
serviceType | 服务类型 | N | String | 实时单,预约单,接送机 | 用车服务类型 | |
departAddr | 出发地点 | N | String | 南京市雨花台区华为云楼 | ||
departureLongitude | 出发地点经度 | N | String | 118.771705 | 百度坐标系 | |
departureLatitude | 出发地点纬度 | N | String | 31.991354 | 百度坐标系 | |
departCityId | 出发城市id | N | String | 156320100 | 城市id | |
arrivalCityId | 到达城市id | N | String | 156320100 | 城市id | |
departTime | 出发时间 | N | LocalDateTime | yyyyMMddHHmmss | ||
departCityName | 出发城市名称 | N | String | 南京 | ||
arrivalAddr | 到达地点 | N | String | 南京大学鼓楼校区 | ||
arrivalLongitude | 到达地点经度 | N | String | 118.771705 | 百度坐标系 | |
arrivalLatitude | 到达地点纬度 | N | String | 31.991354 | 百度坐标系 | |
arrivalTime | 到达时间 | N | LocalDateTime | yyyyMMddHHmmss | ||
arrivalCityName | 到达城市名称 | N | String | 南京 | ||
countryId | 国家/地区id | N | String | 156 | 国家/地区id | |
countryName | 国家/地区名 | N | String | 中国 | 国家/地区名 | |
driverName | 司机姓名 | N | String | 李师傅 | ||
driverMobile | 司机手机号 | N | String | 13012345678 | ||
licensePlate | 车牌号 | N | String | 苏AD8888 | ||
carType | 车辆型号 | N | String | 天籁 | ||
carColor | 车辆颜色 | N | String | 黑色 | ||
ActualsupplierName | 实际供应商名称 | N | String | 首约出行 | ||
mileage | 总里程展示(千米) | N | BigDecimal | 15 | ||
duration | 总时长展示(分钟) | N | BigDecimal | 30 | ||
rideType | 运力类型 | N | String | 经济型,舒适型,商务型,豪华型 | ||
totalPrice | 总金额 | N | BigDecimal | 35.59 | ||
carUseType | 用车类型 | N | String | NORMAL:普通打车,AIRPORT_PICKUP:接机,AIRPORT_DROP_OFF:送机 | ||
chargeItemList | 费用明细集合 | N | List<OpenApiChargeItemInfo> | |||
tripAttachInfo | 附加信息json | N | String | |||
flightDepartureAirport3code | 航班出发机场3字码 | N | String | NKG | ||
flightArrivalAirport3code | 航班到达机场3字码 | N | String | SZX | ||
flightDepartureDate | 航班出发日期 | N | LocalDate | yyyyMMdd | ||
flightNo | 航班号 | N | String | MU1234 |
费用项信息OpenApiChargeItemInfo
参数名 | 参数说明 | 必填 | 参数类型 | 长度 | 值举例 | 备注 |
---|---|---|---|---|---|---|
type | 费用类型名称 | N | String | 起步费 | ||
amount | 费用项金额(元) | N | String | 10 |
样例
请求示例
{
"corpCode": "1000",
"timestamp": "20110811113019",
"version": "2.0",
"loginName": "HW_000001",
"msgId": "1000020150511190411000001",
"orderId": "U123456789"
}
响应示例
{
"entId": "1",
"entName": "华为技术有限公司",
"belongDept": "部门",
"staffNo": "001234",
"userName": "张三",
"memberId": "ID777777",
"loginName": "8888",
"orderId": "U123456789",
"travelType": "0",
"orderStatus": "COMPLETE",
"orderStatusShow": "已完成",
"createTime": "2022-10-01 14:00",
"travelNo": "TA20221001",
"saleApp": "H5",
"saleChannel": "ios",
"carUseScene": "PERSONAL",
"resultCode": "0",
"description": "success",
"payType": "0",
"totalPrice": "13.01",
"serviceFee": "5.01",
"supplierOrderId": "T12121111",
"supplierType": "AMAP",
"supplierName": "高德打车",
"bizType": "CAR",
"contactList": [
{
"contactId": "799756",
"contactName": "张三",
"contactMobile": "13012345678",
"mobileCountryCode": "86",
"virtualMobile": "05682245",
"virtualMobileValid": "0:无效"
}
],
"travelerList": [
{
"passgId": "799256",
"TrpassgId": "963258",
"travelerName": "张三",
"memberId": "ID123456",
"travelerMobile": "13012345678",
"mobileCountryCode": "86"
}
],
"virtualTripInfo": {
"serviceType": "实时单",
"departAddr": "华为南京研究所A区",
"departureLongitude": null,
"departureLatitude": null
"departCityId": "156320100",
"arrivalCityId": "156320100",
"departTime": "20221028070640",
"departCityName": "南京",
"arrivalAddr": "南京大学鼓楼校区",
"arrivalLongitude": null,
"arrivalLatitude": null,
"arrivalTime": "20221028070640",
"arrivalCityName": "南京",
"countryId": "156",
"countryName": "中国",
"driverName": "李师傅",
"driverMobile": "15012345678",
"licensePlate": "苏AD8888",
"carType": "天籁",
"carColor": "黑色",
"ActualsupplierName": "曹操",
"mileage": 11,
"duration": 30,
"rideType": "舒适型",
"totalPrice": 10,
"carUseType": "NORMAL",
"chargeItemList": [
{
"type": "起步费",
"amount": "10"
}
],
"tripAttachInfo": "string",
"flightDepartureAirport3code": "NKG",
"flightArrivalAirport3code": "SZX",
"flightDepartureDate": "2022-10-28",
"flightNo": "MU1234"
},
"actualTripInfo": {
"serviceType": "实时单",
"departAddr": "华为南京研究所A区",
"departCityId": "156320100",
"arrivalCityId": "156320100",
"departTime": "20221028070640",
"departCityName": "南京",
"arrivalAddr": "南京大学鼓楼校区",
"arrivalTime": "20221028070640",
"arrivalCityName": "南京",
"countryId": "156",
"countryName": "中国",
"driverName": "李师傅",
"driverMobile": "15012345678",
"licensePlate": "苏AD8888",
"carType": "天籁",
"carColor": "黑色",
"ActualsupplierName": "曹操",
"mileage": 11,
"duration": 30,
"rideType": "舒适型",
"totalPrice": 10,
"carUseType": "NORMAL",
"chargeItemList": [
{
"type": "起步费",
"amount": "10"
}
],
"tripAttachInfo": "string",
"flightDepartureAirport3code": "NKG",
"flightArrivalAirport3code": "SZX",
"flightDepartureDate": "20221028",
"flightNo": "MU1234"
}
}
打车订单增量查询
企业可调用此接口获取打车订单增量数据。
遵循GDPR要求,默认只返回因公出行的订单。
订单相关数据的任何变更,都会将订单输出至增量列表中,不仅仅是订单状态变化。
如果收到相同状态的更新,可以是状态的内部变化或者订单其他数据发生了变化,通过调用订单详情接口获取详细变更信息。
接口URL
/car/increment_order/list
请求参数定义
参数名 | 参数说明 | 必填 | 参数类型 | 长度 | 值举例 | 备注 |
---|---|---|---|---|---|---|
corpCode | 企业账号 | Y | String | 1000 | 系统提供的企业账号 | |
timestamp | 时间戳 | Y | String | 14 | 20180811113019 | 服务方仅允许20分钟内的时间误差。 |
version | 版本号 | Y | String | 3.3 | 固定为3.3。 | |
msgId | 唯一标识 | Y | String | 1000020150511190411000001 | 企业账号+消息方向+YYYYMMDDHHMMSS+NNNNNN | |
loginName | 操作人帐号 | Y | String | zhangsan@huawei.com | 1、如果是系统维护,写“sysadmin”查询企业下全量数据,用此账号2、 如果是普通员工维护,写员工登录名。查询员工名下订单,用此账号 | |
orderId | 打车订单号 | N | String | 根据订单号查询,有orderId的前提下不考虑startTime和endTime | ||
startTime | 开始更新时间 | N | String | 20180811113019 | yyyyMMddHHmmss包含当前时间 | |
endTime | 截止更新时间 | N | String | 20180811113019 | yyyyMMddHHmmss不包含当前时间查询跨度不超过24小时 | |
bizType | 业务类型 | N | String | CAR | ICAR:国际用车 CAR:国内用车 不传默认国内用车 | |
pageIndex | 查询的页码 | Y | String | |||
size | 每页条数 | Y | String | 建议20,上限50 |
响应参数定义
参数名 | 参数说明 | 必填 | 参数类型 | 长度 | 值举例 | 备注 |
---|---|---|---|---|---|---|
resultCode | 返回码 | Y | String | 0 | 0表示成功,其他值为失败。 | |
description | 描述 | Y | String | Success | 描述信息,出错时为错误信息即错误原因。 | |
pageIndex | 当前的页码 | N | String | |||
size | 每页条数 | N | String | |||
total | 总记录数 | N | String | |||
orderList | 打车订单集合 | N | List<OpenApiIncreOrderInfo> |
增量打车单信息OpenApiIncreOrderInfo
参数名 | 参数说明 | 必填 | 参数类型 | 长度 | 值举例 | 备注 |
---|---|---|---|---|---|---|
changeTime | 变更时间 | N | String | yyyy-MM-dd HH:mm | ||
orderId | 订单Id | N | String | U123456789 | 系统订单id | |
supplierOrderId | 供应商订单号 | N | String | B20221001 | 用车供应商订单号 | |
createTime | 订单创建时间 | N | String | yyyy-MM-dd HH:mm | ||
entName | 企业名称 | N | String | |||
travelType | 出行类型 | N | String | 0:因公出行,1:个人出行 | ||
serviceType | 服务类型 | N | String | 实时单,预约单,接送机 | ||
orderStatus | 订单状态 | N | String | IN_QUEUE:派单中,DRIVER_RECEIVED:司机已接单,TRIP_START:行程已开始,WAIT_PAY:待支付,WAIT_CONFIRM:待确认,QUEUE_FAILED:派单失败,DRIVER_DEPART:司机已出发,DRIVER_ARRIVE:司机已到达,CANCEL_WAIT_PAY:取消待支付,CANCEL_WAIT_CONFIRM:取消待确认,COMPLETE:已完成,CANCELED:已取消,CHANGING_QUEUE:改派中 | ||
totalPrice | 总价 | N | String | 123.01 | ||
departAddr | 出发地址 | N | String | 南京市雨花台区华为云楼 | ||
arrivalAddr | 到达地址 | N | String | 南京大学鼓楼校区 | ||
rideType | 运气类型 | N | String | 经济型,舒适型,商务型,豪华型 | ||
mileage | 总里程(千米) | N | String | 15 | ||
duration | 总时长(分钟) | N | String | 30 |
样例
请求示例
{
"corpCode": "1000",
"timestamp": "20110811113019",
"version": "2.0",
"loginName": "HW_000001",
"msgId": "1000020150511190411000001",
"startTime": "yyyyMMddHHmmss",
"endTime": "yyyyMMddHHmmss",
"pageIndex": "1",
"size": "20",
"orderId": "",
"bizType": "CAR"
}
响应示例
{
"resultCode": "0",
"description": "success",
"pageIndex": "1",
"size": "1",
"total": "1",
"orderList": [
{
"departAddr": "南京市雨花台区华为云楼",
"arrivalAddr": "南京大学鼓楼校区",
"rideType": "舒适型",
"mileage": "11",
"duration": "30",
"orderId": "U1234567789",
"supplierOrderId": "LS20221001",
"createTime": "2022-10-01 14:00",
"entName": "华为技术有限公司",
"travelType": "0",
"serviceType": "实时单",
"orderStatus": "已完成",
"totalPrice": "30.00",
"changeTime": "2022-10-01 14:00"
}
]
}
错误码
错误码 | 错误描述 | 解决方案 |
---|---|---|
3003 | 未知错误,请稍后重试 | 联系技术支持人 |
3010 | 用户不存在 | 检查账号或者联系技术支持人员 |
3404 | 时间戳信息错误,请确认后重试 | 检查入参 |
3401 | 企业账号不存在,请确认后重试 | 检查账号或者联系技术支持人员 |
400 | 参数错误 | 根据描述信息检查入参 |
4000 | 系统繁忙,请稍后重试 | 未知错误,联系技术支持人员 |
4001 | 系统繁忙,请稍后重试 | 数据库错误,联系技术支持人员 |
4002 | 参数错误 | 根据描述信息检查入参 |
10002 | 无访问权限 | 根据描述信息检查入参或联系技术支持人员 |
10011 | 公司编号不能为空 | 检查入参 |
10012 | 操作人帐号不能为空 | 检查入参 |
10013 | 操作人帐号不合法 | 检查账号或者联系技术支持人员 |
10109 | 页码设置错误,请确认后重试 | 检查入参 |
10110 | 每页条数需要在1~50之间 | 检查入参 |
10511 | 开始时间不能为空 | 检查入参 |
10512 | 结束时间不能为空 | 检查入参 |
10513 | 开始时间格式错误 | 检查入参 |
10514 | 结束时间格式错误 | 检查入参 |
10515 | 结束时间不能大于当前时间 | 检查入参 |
10516 | 结束时间距离开始时间不能超过24小时 | 检查入参 |
10518 | 该集团下无对应公司 | 检查是否集团查询 |
10519 | 集团编号不存在,请确认后重试 | 检查账号或者联系技术支持人员 |
432000100 | 未知错误,请稍后重试 | 联系技术支持人 |