国内/国际用车
国内/国际用车
打车订单详情查询
通过该接口查询打车订单详情。
接口URL
/napi/enterprise/car/order/detail
请求参数定义
| 参数名 | 参数说明 | 必填 | 参数类型 | 长度 | 值举例 | 备注 |
|---|---|---|---|---|---|---|
| corpCode | 企业账号 | Y | String | 1000 | 系统提供的企业账号 | |
| tenantUserId | 操作人帐号 | Y | String | HW_000001 | 1、如本次操作为系统相关,则该字段为固定字符串值:"sysadmin";2、如操作为指定普通员工信息维护或修改,则该字符串为:“<员工登录账户名称>"。 | |
| msgId | 唯一标识 | Y | String | 1000020150511190411000001 | 企业账号+消息方向+YYYYMMDDHHMMSS+NNNNNN | |
| orderId | 订单ID | Y | String | U1234567 | 打车订单号 | |
| needLocation | 是否需要地点坐标 | N | Boolean | true | 默认不传 |
响应参数定义
| 参数名 | 参数说明 | 必填 | 参数类型 | 长度 | 值举例 | 备注 |
|---|---|---|---|---|---|---|
| resultCode | 返回码 | Y | String | 0 | 0表示成功,其他值为失败。 | |
| description | 描述 | Y | String | Success | 描述信息,出错时为错误信息即错误原因。 | |
| orderId | 订单id | Y | String | U1234567 | 系统侧的订单主键id | |
| travelType | 出行类型 | Y | String | 0:因公出行,1:个人出行 | 默认返回因公出行订单 | |
| orderStatus | 订单状态 | 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 | 订单状态枚举 | |
| orderStatusShow | 订单状态 | Y | String | 派单中,司机已接单,行程已开始,待支付,待确认,派单失败,司机已出发,司机已到达,取消待支付,取消待确认,已完成,已取消,改派中 | 订单状态中文枚举 | |
| 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部门 | 预定人所属部门 | |
| bookingUserStaffNo | 预定人工号 | N | String | 123456 | ||
| deptName | 预订人所在部门名称 | N | String | XXX部门 | 预订人所在部门名称 | |
| deptNum | 预订人所在部门编号 | N | String | 123456 | ||
| bookingUserName | 预定人姓名 | N | String | 张三 | ||
| bookingMemberId | 预定人memberId | Y | String | ID123456789 | ||
| loginName | 登录人账号 | Y | String | 18012345678 | ||
| tenantUserId | 登录人账号 | Y | String | 18012345678 | ||
| payType | 支付方式 | N | String | 0:员工电子流,1:在线支付,2:IVR,3:现金,4:POS,5:关联月结,6:因公欠款,7:VIP欠款,8:担保欠款,10:外部月结,11:转帐,12:互抵,13:预收帐款,14:到店付款 | ||
| totalPrice | 订单总价 | N | String | 123.01 | 单位:元 | |
| serviceFee | 服务费 | N | String | 123.01 | 单位:元 | |
| selfPayAmount | 个人支付金额 | N | String | 123.01 | 单位:元 | |
| supplierOrderId | 供应商Id | N | String | SL2017122100029 | ||
| supplierType | 供应商类型 | N | String | SHOUYUE,RUQI,T3,AMAP,PETAL,DIDICHUXING,XIANGDAO,YUEXING,GADOE | ||
| supplierName | 供应商名称 | N | String | 首约,如祺,T3,高德,PETAL,滴滴出行,享道出行,悦行出行,高德出行 | ||
| 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 | 180****5678 | 手机号打码 | |
| mobileCountryCode | 手机号国家码 | N | String | 86 | ||
| virtualMobile | 联系人虚拟手机号 | N | String | 78946123 | ||
| virtualMobileValid | 虚拟号码有效性 | N | String | 0:无效,1:有效 |
OpenApiTraveler乘车人
| 参数名 | 参数说明 | 必填 | 参数类型 | 长度 | 值举例 | 备注 |
|---|---|---|---|---|---|---|
| passengerId | 乘客id | N | String | 123456 | ||
| trPassengerId | tr乘客ID | N | String | 123456 | ||
| memberId | 会员Id | N | String | ID123465 | ||
| travelerName | 乘客姓名 | N | String | 张三 | ||
| travelerMobile | 乘客手机号 | N | String | 180****5678 | 手机号打码 | |
| 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 | ||
| itemType | 标准费用项类型 | N | String | START_FEE | START_FEE,BASIC_FEE,DISTANCE_FEE,HIGH_DISTANCE_FEE,OVER_DISTANCE_FEE,DURATION_FEE,HIGH_DURATION_FEE,OVER_DURATION_FEE,FAR_FEE,SLOW_FEE,OUT_CITY_FEE,WAIT_FEE,DYNAMIC_FEE,DISCOUNT_FEE,DEDUCTION_FEE,METER_FEE,NIGHT_FEE,PACKAGE_FEE,TOTAL_FEE,MESSAGE_FEE,HOLIDAY_FEE,CANCEL,HIGHWAY,HIGHWAY_PRE,HIGHWAY_ESTIMATE,BRIDGE,PARK,CLEAN_FEE,OTHER,OTHER_FEE,ENT_SERVICE_FEE,SUPPLIER_SERVICE_FEE | |
| itemTypeName | 标准费用项名称 | N | String | 起步费 | 起步费,基础费,里程费,高峰里程费,超里程费,时长费,高峰时长费,超时长费,远途费,低速费,跨城费,等待费,动态调价,优惠金额,减免金额,打表计价,夜间服务费,套餐价,一口价,信息费,节假日服务费,取消费,高速费,预估高速费,高速费预估价,路桥费,停车费,清洁费,其他附加费,其他费用,企业服务费2,企业服务费1 |
样例
请求示例
{
"corpCode": "1000",
"tenantUserId": "HW_000001",
"msgId": "1000020150511190411000001",
"orderId": "U123456789"
}
响应示例
{
"entId": "1",
"entName": "华为技术有限公司",
"belongDept": "部门",
"bookingUserStaffNo": "001234",
"bookingUserName": "张三",
"bookingMemberId": "ID777777",
"loginName": "8888",
"tenantUserId": "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": "130****5678",
"mobileCountryCode": "86",
"virtualMobile": "05682245",
"virtualMobileValid": "0:无效"
}
],
"travelerList": [
{
"passengerId": "799256",
"trPassengerId": "963258",
"travelerName": "张三",
"memberId": "ID123456",
"travelerMobile": "130****5678",
"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": "START_FEE",
"itemType": "10",
"itemTypeName": "起步费"
}
],
"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": "START_FEE",
"itemType": "10",
"itemTypeName": "起步费"
}
],
"tripAttachInfo": "string",
"flightDepartureAirport3code": "NKG",
"flightArrivalAirport3code": "SZX",
"flightDepartureDate": "20221028",
"flightNo": "MU1234"
}
}
打车订单列表查询
企业可调用此接口获取打车订单列表数据。
遵循GDPR要求,默认只返回因公出行的订单。
订单相关数据的任何变更,都会将订单输出至列表中,不仅仅是订单状态变化。
如果收到相同状态的更新,可以是状态的内部变化或者订单其他数据发生了变化,通过调用订单详情接口获取详细变更信息。
接口URL
/napi/enterprise/car/order/list
请求参数定义
| 参数名 | 参数说明 | 必填 | 参数类型 | 长度 | 值举例 | 备注 |
|---|---|---|---|---|---|---|
| corpCode | 企业账号 | Y | String | 1000 | 系统提供的企业账号 | |
| msgId | 唯一标识 | Y | String | 1000020150511190411000001 | 企业账号+消息方向+YYYYMMDDHHMMSS+NNNNNN | |
| tenantUserId | 操作人帐号 | Y | String | zhangsan@huawei.com | 1、如果是系统维护,写“sysadmin”查询企业下全量数据,用此账号2、 如果是普通员工维护,写员工登录名。查询员工名下订单,用此账号 | |
| orderId | 打车订单号 | N | String | 根据订单号查询,有orderId的前提下不考虑startTime和endTime | ||
| startTime | 开始更新时间 | N | String | 20180811113019 | yyyyMMddHHmmss包含当前时间,不填默认截止更新时间前24小时 | |
| 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 | 派单中,司机已接单,行程已开始,待支付,待确认,派单失败,司机已出发,司机已到达,取消待支付,取消待确认,已完成,已取消,改派中 | ||
| totalPrice | 总价 | N | String | 123.01 | 单位:元 | |
| departAddr | 出发地址 | N | String | 南京市雨花台区华为云楼 | ||
| arrivalAddr | 到达地址 | N | String | 南京大学鼓楼校区 | ||
| rideType | 运气类型 | N | String | 经济型,舒适型,商务型,豪华型 | ||
| mileage | 总里程(千米) | N | String | 15 | ||
| duration | 总时长(分钟) | N | String | 30 |
样例
请求示例
{
"corpCode": "1000",
"tenantUserId": "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"
}
]
}
错误码
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| 10000 | 未知错误,请稍后重试 | 联系技术支持人 |
| 10001 | 该用户不属于该企业,无接口调用权限 | 检查账号权限或联系技术支持人员 |
| 10002 | 该订单不属于该企业,无权查看 | 检查账号权限或联系技术支持人员 |
| 10003 | 该订单不属于该用户,无权查看 | 检查账号权限或联系技术支持人员 |
| 10010 | 消息ID校验失败,请确认后重试 | 检查入参 |
| 10011 | 公司编号不能为空 | 检查入参 |
| 10012 | 操作人帐号不能为空 | 检查入参 |
| 10101 | CorpCode不存在 | 检查入参 |
| 10102 | 订单号不能为空 | 检查入参 |
| 10109 | 页码设置错误,请确认后重试 | 检查入参 |
| 10110 | 每页条数需要在1~50之间 | 检查入参 |
| 10513 | 开始时间格式错误 | 检查入参 |
| 10514 | 结束时间格式错误 | 检查入参 |
| 10515 | 结束时间不能大于开始时间 | 检查入参 |
| 10516 | 结束时间距离开始时间不能超过24小时 | 检查入参 |
| 10600 | 不存在对应订单 | 检查订单号 |