开放平台
导航
首页
H5接入
API接入
API手册
常见问题
联系我们
应用管理
退出
登录
注册
## 接入新计价规则常见问题 > <span style="color:red;">2021-09-14起,优驾舒享车型更名为经济车型,仅做名称的变更</span> <a href='doc?r=faq/content#新计价规则相关'>新计价规则FAQ</a><br> ## 基础信息 ### 产品总类 #### 权限范围 > 基础信息(product)--客户端或授权码模式或密码模式 #### 请求地址 /v1/resource/common/getCityService #### 请求方式 HTTP/GET #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | slat | double | 否 | 出发地纬度 | slng | double | 否 | 出发地经度 #### 注意事项 不同城市支持的服务类型可能不一样 #### 响应数据 > 数据仅供参考 ``` { busiCode: "BASE000", code: 1, content: { cityId: 1, cityName: "北京", services: { 7 : { id: 7, name: "接机" }, 8 : { id: 8, name: "送机" }, 11 : { id: 11, name: "包车(4小时)" }, 13 : { id: 13, name: "预约用车" }, 14 : { id: 14, name: "立即叫车" } }, priceStrategyFlag: 0 }, msg: "成功", status: "SUCCESS", uid: "1e4e49a6-5cf2-4900-bc0d-bd8077d10ce11455413029357", version: "001" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | cityId| integer | 否 | 城市id | cityName | string | 否 | 城市名称 | services | json | 是 | 服务类型列表 | services.[key].name | string | 否 | 服务类型名称 | services.[key].id | integer | 否 | 服务类型id | <font color='blue'> priceStrategyFlag </font> | integer | 否 | 使用新旧价格体系标识, 0:使用旧价格体系,1:使用新价格体系(老接口默认值为0) ### 产品总类 -- 适用新报价体系 #### 权限范围 > 基础信息(product)--客户端或授权码模式或密码模式 #### 请求地址 /v1/resource/common/getCityService #### 请求方式 HTTP/GET #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | slat | double | 否 | 出发地纬度 | slng | double | 否 | 出发地经度 #### 注意事项 不同城市支持的服务类型可能不一样<br> 每种服务类型在某段有效时期内,只对应一个基础价格方案,且基础价格方案跟城市无关。 #### 响应数据 > 数据仅供参考 ``` { busiCode: "BASE000", code: 1, content: { cityId: 1, cityName: "北京", services: { 7 : { id: 7, name: "接机", basePriceSchemeId: 1 }, 8 : { id: 8, name: "送机", basePriceSchemeId: 2 }, 11 : { id: 11, name: "包车(4小时)", basePriceSchemeId: 3 }, 13 : { id: 13, name: "预约用车", basePriceSchemeId: 4 }, 14 : { id: 14, name: "立即叫车", basePriceSchemeId: 5 } }, priceStrategyFlag: 1 }, msg: "成功", status: "SUCCESS", uid: "1e4e49a6-5cf2-4900-bc0d-bd8077d10ce11455413029357", version: "001" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | cityId| integer | 否 | 城市id | cityName | string | 否 | 城市名称 | services | json | 是 | 服务类型列表 | services.[key].name | string | 否 | 服务类型名称 | services.[key].id | integer | 否 | 服务类型id | <font color='blue'> services.[key].basePriceSchemeId </font> | integer | 否 | 基础价格方案id -- 适用新报价体系 | <font color='blue'> priceStrategyFlag </font> | integer | 否 | 使用新旧价格体系标识, 0:使用旧价格体系,1:使用新价格体系(老接口默认值为0) ### 产品信息 #### 权限范围 > 基础信息(product)--客户端或授权码模式或密码模式 #### 请求地址 /v1/resource/common/getCityServiceDetail #### 请求方式 HTTP/GET #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access toke | slat | double | 是 | 出发地纬度(cityId和出发地经纬度有一个必填,且cityId优先级高) | slng | double | 是 | 出发地经度(cityId和出发地经纬度有一个必填,且cityId优先级高) | serviceId | integer | 否 | 服务id(<a href="doc?r=api/content#产品总类">从产品总类接口中获取</a>) | cityId | integer | 是 | 城市id(cityId和出发地经纬度有一个必填,且cityId优先级高) #### 注意事项 计价方式分时租和套餐。套餐包括一定免费时长和距离,如果超出会收取相应时长费和里程费<br> <font color='red'>响应数据说明中,标红的字段,会在新报价体系适用的接口中去除</font> #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": { "carGroups": { "1": { "desc": "大众", "freeDistance": "0.0", "freeTime": "0.0", "id": 1, "image": "https://s.10101111cdn.com/ucarcdnstore/image/app/lianjia.png", "kilometreUnitPrice": "2.5", "longDistanceUnitPrice": "3.0", "name": "经济车型", "outCityUnitPrice": "3.0", "sort": 1, "startPrice": "10.0", "timeUnitPrice": "0.5", "waitTimeUnitPrice": "1.0" }, "2": { "desc": "大众帕萨特 丰田凯美瑞或类似5座车型", "freeDistance": "0.0", "freeTime": "0.0", "id": 2, "kilometreUnitPrice": "2.8", "longDistanceUnitPrice": "0.0", "name": "公务轿车", "outCityUnitPrice": "3.0", "startPrice": "15.0", "timeUnitPrice": "0.5", "image":"https://s.10101111cdn.com/ucarcdnstore/image/app/gongwu.png", "sort": 2, "waitTimeUnitPrice": "1.0" }, "3": { "desc": "别克GL8或类似7座车型", "freeDistance": "0.0", "freeTime": "0.0", "id": 3, "kilometreUnitPrice": "4.5", "longDistanceUnitPrice": "0.0", "name": "商务7座", "outCityUnitPrice": "0.0", "startPrice": "20.0", "timeUnitPrice": "0.7", "image":"https://s.10101111cdn.com/ucarcdnstore/image/app/shangwu.png", "sort": 3, "waitTimeUnitPrice": "1.0" }, "4": { "desc": "奥迪A6 宝马5系或类似5座车型", "freeDistance": "0.0", "freeTime": "0.0", "id": 4, "kilometreUnitPrice": "4.6", "longDistanceUnitPrice": "0.0", "name": "豪华轿车", "outCityUnitPrice": "0.0", "startPrice": "23.0", "timeUnitPrice": "0.8", "image":"https://s.10101111cdn.com/ucarcdnstore/image/app/haohua.png", "sort": 4, "waitTimeUnitPrice": "1.0" } }, "cityId": 1, "cityName": "北京", "serviceId": 13, "serviceName": "预约用车", "priceStrategyFlag": 0 }, "msg": "成功", "status": "SUCCESS", "uid": "f9db4b9e-4003-4bc9-a747-9117c61b1d2e1483603467089", "version": "002" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | cityName| string | 否 | 城市名称 | cityId | integer | 否 | 城市id | serviceName | string | 否 | 服务类型名称 | serviceId | integer | 否 | 服务类型id | carGroups | json | 是 | 车组信息列表 | carGroups.[key].desc | String | 否 | 车组简单描述 | carGroups.[key].id | integer | 否 | 车组id | carGroups.[key].name | string | 否 | 车组名称 | <font color='red'>carGroups.[key].startPrice</font> | float | 否 | 起步价格或套餐价 | <font color='red'>carGroups.[key].timeUnitPrice</font> | float | 否 | 时长费(每分钟价钱) | <font color='red'>carGroups.[key].kilometreUnitPrice</font> | float | 否 | 里程费(每公里价钱) | <font color='red'>carGroups.[key].freeTime</font> | string | 是 | 免费时长(分钟)<br/> 时租时为0 | <font color='red'>carGroups.[key].freeDistance</font> | string | 是 | 免费距离(公里)<br/>时租时为0 | <font color='red'>carGroups.[key].longDistanceUnitPrice</font> | string | 是 | 远途费(每公里价钱) | <font color='red'>carGroups.[key].outCityUnitPrice</font> | string | 是 | 出城费(每公里价钱) | <font color='blue'> carGroups.[key].waitTimeUnitPrice </font> | float | 否 | 等待时长费(每分钟价钱) | carGroups.[key].sort | integer | 否 | 显示顺序 | <font color='blue'> priceStrategyFlag </font> | integer | 否 | 使用新旧价格体系标识, 0:使用旧价格体系,1:使用新价格体系(老接口默认值为0) ### 产品信息 -- 适用新报价体系 #### 权限范围 > 基础信息(product)--客户端或授权码模式或密码模式 #### 请求地址 /v1/resource/common/getCityServiceDetail #### 请求方式 HTTP/GET #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | slat | double | 是 | 出发地纬度(cityId和出发地经纬度有一个必填,且cityId优先级高) | slng | double | 是 | 出发地经度(cityId和出发地经纬度有一个必填,且cityId优先级高) | serviceId | integer | 否 | 服务id(<a href="doc?r=api/content#产品总类-–-适用新报价体系">从产品总类接口中获取</a>) | cityId | integer | 是 | 城市id(cityId和出发地经纬度有一个必填,且cityId优先级高) | <font color='blue'> departureTime </font> | long | 是 | 出发时间(unix时间戳) | <font color='blue'> basePriceSchemeId </font> | integer | 是 | 基础价格方案id(<a href="doc?r=api/content#产品总类-–-适用新报价体系">从产品总类接口中获取</a>) #### 注意事项 <font color='blue'>响应数据说明中,蓝色标注字段为新报价体系新增的字段</font><br> departureTime 和 basePriceSchemeId入参二选一,如果都传,以basePriceSchemeId为准。<br> 新报价体系分为休息日跟平日,根据传入的出发时间决定是休息日还是平日的报价体系<br> 计价方式分时租和套餐。套餐包括一定免费时长和距离,如果超出会收取相应时长费和里程费</br> #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": { "carGroups": { "1": { "desc": "大众", "id": 1, "image": "https://s.10101111cdn.com/ucarcdnstore/image/app/lianjia.png", "name": "经济车型", "sort": 2, "basePrices":[ {"name":"普通时段","startPrice":"10.0","freeTimes":"0.0","freeDistances":"0.0"}, {"name":"12:00-24:00","startPrice":"15.0","freeTimes":"0.0","freeDistances":"0.0"} ], "timeUnitPrices":[ {"name":"普通时段","unitPrice":"0.5"}, {"name":"12:00-24:00","unitPrice":"0.6"} ], "kilometreUnitPrices":[ {"name":"普通时段","unitPrice":"2.8"}, {"name":"12:00-24:00","unitPrice":"2.9"} ], "longKilometers":[ {"name":"普通时段","longKilometerSegmentInfos":[ {"name":"超过10-15公里部分","unitPrice":"3.5"}, {"name":"超过15公里部分","unitPrice":"4.0"}] }, {"name":"12:00-24:00","longKilometerSegmentInfos":[ {"name":"超过10-15公里部分","unitPrice":"3.6"}, {"name":"超过15公里部分","unitPrice":"4.2"}] } ], "farKilometers":[ {"name":"普通时段","farKilometerSegmentInfos":[ {"name":"超过10-15公里部分","unitPrice":"3.5"}, {"name":"超过15公里部分","unitPrice":"4.0"}] }, {"name":"12:00-24:00","farKilometerSegmentInfos":[ {"name":"超过10-15公里部分","unitPrice":"3.6"}, {"name":"超过15公里部分","unitPrice":"4.2"}] } ], "outCityUnitPrice":[ { "name":"普通时段", "unitPrice": "41.0" }, { "name":"12:00-13:00", "unitPrice": "42.0" } ], "waitTimeUnitPrice":[ { "name":"普通时段", "unitPrice":"0.5" }, { "name":"12:00-24:00", "unitPrice":"0.6" } ] }, "2": { "desc": "大众帕萨特 丰田凯美瑞或类似5座车型", "id": 2, "name": "公务轿车", "image":"https://s.10101111cdn.com/ucarcdnstore/image/app/gongwu.png", "sort": 3, "basePrices":[ {"name":"普通时段","startPrice":"15.0","freeTimes":"0.0","freeDistances":"0.0"}, {"name":"12:00-24:00","startPrice":"17.0","freeTimes":"0.0","freeDistances":"0.0"} ], "timeUnitPrices":[ {"name":"普通时段","unitPrice":"0.5"}, {"name":"12:00-24:00","unitPrice":"0.6"} ], "kilometreUnitPrices":[ {"name":"普通时段","unitPrice":"2.8"}, {"name":"12:00-24:00","unitPrice":"2.9"} ], "longKilometers":[ {"name":"普通时段","longKilometerSegmentInfos":[ {"name":"超过10-15公里部分","unitPrice":"3.5"}, {"name":"超过15公里部分","unitPrice":"4.0"}] }, {"name":"12:00-24:00","longKilometerSegmentInfos":[ {"name":"超过10-15公里部分","unitPrice":"3.6"}, {"name":"超过15公里部分","unitPrice":"4.2"}] } ], "farKilometers":[ {"name":"普通时段","farKilometerSegmentInfos":[ {"name":"超过10-15公里部分","unitPrice":"3.5"}, {"name":"超过15公里部分","unitPrice":"4.0"}] }, {"name":"12:00-24:00","farKilometerSegmentInfos":[ {"name":"超过10-15公里部分","unitPrice":"3.6"}, {"name":"超过15公里部分","unitPrice":"4.2"}] } ], "outCityUnitPrice":[ { "name":"普通时段", "unitPrice": "41.0" }, { "name":"12:00-13:00", "unitPrice": "42.0" } ], "waitTimeUnitPrice":[ { "name":"普通时段", "unitPrice":"0.5" }, { "name":"12:00-24:00", "unitPrice":"0.6" } ] }, "3": { "desc": "别克GL8或类似7座车型", "id": 3, "name": "商务7座", "image":"https://s.10101111cdn.com/ucarcdnstore/image/app/shangwu.png", "sort": 4, "basePrices":[ {"name":"普通时段","startPrice":"20.0","freeTimes":"0.0","freeDistances":"0.0"}, {"name":"12:00-24:00","startPrice":"22.0","freeTimes":"0.0","freeDistances":"0.0"} ], "timeUnitPrices":[ {"name":"普通时段","unitPrice":"0.7"}, {"name":"12:00-24:00","unitPrice":"0.8"} ], "kilometreUnitPrices":[ {"name":"普通时段","unitPrice":"4.5"}, {"name":"12:00-24:00","unitPrice":"4.6"} ], "longKilometers":[ {"name":"普通时段","longKilometerSegmentInfos":[ {"name":"超过10-15公里部分","unitPrice":"5.0"}, {"name":"超过15公里部分","unitPrice":"5.5"}] }, {"name":"12:00-24:00","longKilometerSegmentInfos":[ {"name":"超过10-15公里部分","unitPrice":"5.1"}, {"name":"超过15公里部分","unitPrice":"5.2"}] } ], "farKilometers":[ {"name":"普通时段","farKilometerSegmentInfos":[ {"name":"超过10-15公里部分","unitPrice":"3.5"}, {"name":"超过15公里部分","unitPrice":"4.0"}] }, {"name":"12:00-24:00","farKilometerSegmentInfos":[ {"name":"超过10-15公里部分","unitPrice":"3.6"}, {"name":"超过15公里部分","unitPrice":"4.2"}] } ], "outCityUnitPrice":[ { "name":"普通时段", "unitPrice": "41.0" }, { "name":"12:00-13:00", "unitPrice": "42.0" } ], "waitTimeUnitPrice":[ { "name":"普通时段", "unitPrice":"0.5" }, { "name":"12:00-24:00", "unitPrice":"0.6" } ] }, "4": { "desc": "奥迪A6 宝马5系或类似5座车型", "id": 4, "name": "豪华轿车", "image":"https://s.10101111cdn.com/ucarcdnstore/image/app/haohua.png", "sort": 5, "basePrices":[ {"name":"普通时段","startPrice":"23.0","freeTimes":"0.0","freeDistances":"0.0"}, {"name":"12:00-24:00","startPrice":"25.0","freeTimes":"0.0","freeDistances":"0.0"} ], "timeUnitPrices":[ {"name":"普通时段","unitPrice":"0.8"}, {"name":"12:00-24:00","unitPrice":"0.9"} ], "kilometreUnitPrices":[ {"name":"普通时段","unitPrice":"4.6"}, {"name":"12:00-24:00","unitPrice":"4.7"} ], "longKilometers":[ {"name":"普通时段","longKilometerSegmentInfos":[ {"name":"超过10-15公里部分","unitPrice":"5.5"}, {"name":"超过15公里部分","unitPrice":"5.7"}] }, {"name":"12:00-24:00","longKilometerSegmentInfos":[ {"name":"超过10-15公里部分","unitPrice":"5.6"}, {"name":"超过15公里部分","unitPrice":"5.8"}] } ], "farKilometers":[ {"name":"普通时段","farKilometerSegmentInfos":[ {"name":"超过10-15公里部分","unitPrice":"3.5"}, {"name":"超过15公里部分","unitPrice":"4.0"}] }, {"name":"12:00-24:00","farKilometerSegmentInfos":[ {"name":"超过10-15公里部分","unitPrice":"3.6"}, {"name":"超过15公里部分","unitPrice":"4.2"}] } ], "outCityUnitPrice":[ { "name":"普通时段", "unitPrice": "41.0" }, { "name":"12:00-13:00", "unitPrice": "42.0" } ], "waitTimeUnitPrice":[ { "name":"普通时段", "unitPrice":"0.5" }, { "name":"12:00-24:00", "unitPrice":"0.6" } ] } }, "cityId": 1, "cityName": "北京", "serviceId": 13, "serviceName": "预约用车", "priceStrategyFlag": 1, "priceDateType": 0 }, "msg": "成功", "status": "SUCCESS", "uid": "f9db4b9e-4003-4bc9-a747-9117c61b1d2e1483603467089", "version": "002" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | cityName| string | 否 | 城市名称 | cityId | integer | 否 | 城市id | serviceName | string | 否 | 服务类型名称 | serviceId | integer | 否 | 服务类型id | carGroups | json | 是 | 车组信息列表 | carGroups.[key].desc | String | 否 | 车组简单描述 | carGroups.[key].id | integer | 否 | 车组id | carGroups.[key].name | string | 否 | 车组名称 | carGroups.[key].sort | integer | 否 | 显示顺序 | <font color='blue'>carGroups.[key].basePrices[].name</font> | string | 否 | 时段 | <font color='blue'>carGroups.[key].basePrices[].startPrice</font> | float | 否 | 起步价格或套餐价 | <font color='blue'>carGroups.[key].basePrices[].freeTimes</font> | float | 否 | 免费时长(分钟)<br/> 时租时为0 | <font color='blue'>carGroups.[key].basePrices[].freeDistances</font> | float | 否 | 免费距离(公里)<br/>时租时为0 | <font color='blue'>carGroups.[key].timeUnitPrices[].name</font> | string | 否 | 时段 | <font color='blue'>carGroups.[key].timeUnitPrices[].unitPrice</font> | float | 否 | 时长费(每分钟价钱) | <font color='blue'>carGroups.[key].kilometreUnitPrices[].name</font> | string | 否 | 时段 | <font color='blue'>carGroups.[key].kilometreUnitPrices[].unitPrice</font> | float | 否 | 里程费(每公里价钱) | <font color='blue'>carGroups.[key].longKilometers[].name</font> | string | 否 | 时段 | <font color='blue'>carGroups.[key].longKilometers[].<br> longKilometerSegmentInfos[].name</font> | string | 否 | 产生远程费区间 | <font color='blue'>carGroups.[key].longKilometers[].<br> longKilometerSegmentInfos[].unitPrice</font> | float | 否 | 该区间单价(每公里价钱) | <font color='blue'>carGroups.[key].farKilometers[].name</font> | string | 否 | 时段 | <font color='blue'>carGroups.[key].farKilometers[].<br> farKilometerSegmentInfos[].name</font> | string | 否 | 产生远途费区间 | <font color='blue'>carGroups.[key].farKilometers[].<br> farKilometerSegmentInfos[].unitPrice</font> | float | 否 | 该区间单价(每公里价钱) | <font color='blue'>carGroups.[key].outCityUnitPrice[].name</font> | string | 否 | 时段 | <font color='blue'>carGroups.[key].outCityUnitPrice[].unitPrice</font> | float | 否 | 出城费(每公里价钱) | <font color='blue'>carGroups.[key].waitTimeUnitPrice[].name</font> | string | 否 | 时段 | <font color='blue'>carGroups.[key].waitTimeUnitPrice[].unitPrice</font> | float | 否 | 等待时长费(每分钟价钱) | <font color='blue'> priceStrategyFlag </font> | integer | 否 | 使用新旧价格体系标识, 0:使用旧价格体系,1:使用新价格体系(老接口默认值为0) | <font color='blue'> priceDateType </font> | integer | 否 | 定价日期类型:1-休息日,2-平日 ### 附近车辆 #### 权限范围 > 基础信息(product)--客户端或授权码模式或密码模式 #### 请求地址 /v1/resource/common/getNearbyCarInfo #### 请求方式 HTTP/GET #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | slat | double | 否 | 出发地纬度 | slng | double | 否 | 出发地经度 #### 注意事项 服务类型为立即叫车(sericeId=14)时,需要调用该接口查看附近是否有车辆。附近有车辆时可以下单。如果附近没有车辆,请提示用户附近暂无空驶车辆,稍后再试。 #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": { "carList": [{ "lat": "39.159693", "lng": "117.393305" }, { "lat": "39.159971", "lng": "117.392022" }], "number": 2, "shortestTimeOfArrival": 4 }, "msg": "成功", "status": "SUCCESS", "uid": "420e963c-929d-4036-8ff7-e98ca0e1edd61453192842113", "version": "001" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | number| integer | 否 | 附近车数量 | shortestTimeOfArrival | integer | 否 | 最快到达时间(分) | carList | array | 是 | 附近车辆位置信息 | carList[].lng | string | 否 | 经度 | carList[].lat | string | 否 | 纬度 ### 费用预估(无优惠券) #### 权限范围 > 基础信息(product)--客户端或授权码模式或密码模式 #### 请求地址 /v1/resource/common/estimate/price #### 请求方式 HTTP/POST #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | slat | double | 是 | 出发地纬度(服务类型为“接机”时可为空) | slng | double | 是 | 出发地经度(服务类型为“接机”时可为空) | elat | double | 是 | 目的地纬度(服务类型为“包车(8小时)”或"包车(4小时)"时为空) | elng | double | 是 | 目的地经度(服务类型为“包车(8小时)”或"包车(4小时)"时为空) | serviceId | integer | 否 | 服务类型id(7:接机 8:送机 11:包车(4小时) 12:包车(8小时) 13:预约用车 14:立即叫车) | cityId | integer | 是 | 出发城市id(如果为空,则根据出发地经纬度定位城市) | departureTime | long | 是 | <p>出发时间(unix时间戳,服务类型为"立即叫车"或“接机”时可为空)<p/><p>时间范围:立即叫车为当前日期,预约用车/包车(8小时)/包车(4小时)为当前日期 至 当前日期+30天<p/><p>例如:当前日期为2016-3-4 10:00,则日期范围:2016-3-4 10:00(含) 至 2016-4-3 23:59(含)</p> | flt | string | 是 | 航班号 | flightDate | long | 是 | <p>航班起飞日期(unix时间戳)</p><p>日期范围:当前日期-3天 至 当前日期+30天<p/><p>例如:当前日期为2016-3-4,则日期范围:2016-3-1(含) 至 2016-4-3(含)</p> | flightDelayTime | integer | 是 | <p>航班到达后,延时N分钟后用车</p><p>时间范围:10(含) 至 90(含)</p> | airCode | string | 是 | 接机机场三字码 | isPickupVip | boolean | 是 | 是否使用接机礼宾服务(服务类型为接机时有效) #### 注意事项 <font color='red'>响应数据说明中,标红的字段,会在新报价体系适用的接口中去除</font><br> 不支持代金券<br> 服务类型为“接机”时,以下两组参数(航班信息和出发地信息)2选1,如果两组参数全部填写则按照第1组参数(航班信息)为准: 1. 航班信息: flt(航班号),flightDate(航班起飞日期),flightDelayTime(航班到达后,延时N分钟后用车),airCode(接机机场三字码) 2. 出发地信息:slat(出发地纬度),slng(出发地经度),departureTime(出发时间) #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": { "distance": 224090, "duration": 158, "thirdWithholdRate": 1, "estimateId": "cbb9b9ab7b465d32bbcb3ba0f4a95131", "prices": [ { "carGroupId": 1, "companyDiscountAmount": 0, "floatFactor": 1, "kilometrePrice": 375.9, "longDistancePrice": 0, "longDistancePriceLimit": 0, "name": "经济车型", "outCityPrice": 0, "perKilometrePrice": 2.2, "perLongDistancePrice": 0, "perTimePrice": 0.8, "price": 470.9, "priceType": 1, "productKilometre": 0, "productTime": 0, "startPrice": 25, "timePrice": 70, "pickupServicePrice":0, "possibleGenerateOutCityPrice":0 }, { "carGroupId": 4, "companyDiscountAmount": 0, "floatFactor": 1, "kilometrePrice": 1030.81, "longDistancePrice": 0, "longDistancePriceLimit": 0, "name": "豪华轿车", "outCityPrice": 0, "perKilometrePrice": 4.6, "perLongDistancePrice": 0, "perTimePrice": 0.8, "price": 1203, "priceType": 1, "productKilometre": 0, "productTime": 0, "startPrice": 46, "timePrice": 126.4, "pickupServicePrice":0, "possibleGenerateOutCityPrice":0 }, { "carGroupId": 2, "companyDiscountAmount": 0, "floatFactor": 1, "kilometrePrice": 627.45, "longDistancePrice": 0, "longDistancePriceLimit": 0, "name": "公务轿车", "outCityPrice": 0, "perKilometrePrice": 2.8, "perLongDistancePrice": 0, "perTimePrice": 0.5, "price": 734, "priceType": 1, "productKilometre": 0, "productTime": 0, "startPrice": 28, "timePrice": 79, "pickupServicePrice":0, "possibleGenerateOutCityPrice":0 }, { "carGroupId": 3, "companyDiscountAmount": 0, "floatFactor": 1, "kilometrePrice": 1008.4, "longDistancePrice": 0, "longDistancePriceLimit": 0, "name": "商务7座", "outCityPrice": 0, "perKilometrePrice": 4.5, "perLongDistancePrice": 0, "perTimePrice": 0.7, "price": 1159, "priceType": 1, "productKilometre": 0, "productTime": 0, "startPrice": 40, "timePrice": 110.6, "pickupServicePrice":0, "possibleGenerateOutCityPrice":0 } ], "priceStrategyFlag": 0 }, "handler": "CLIENT", "msg": "成功", "status": "SUCCESS", "uid": "4f750aa2-598b-44cd-9b16-d3cebe285820", "version": "" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | distance | float | 否 | 预估距离(米)。如果服务类型为包车(8小时)或包车(4小时),该字段没有参考意义 | duration | float | 否 | 预估时长(分)。如果服务类型为包车(8小时)或包车(4小时),该字段没有参考意义 | thirdWithholdRate | float | 否 | 第三方代缴费率,行驶过程中产生的任何第三方费用(如路桥费,停车费等),第三方费用需要用户另行现金支付,如果选择线上支付(如账户余额,信用卡等),则支付金额为实际金额乘以代缴费率 | estimateId | string | 否 | 预估标识,创建订单时使用,有效期20分钟(保证预估和下单时价格一致) | prices| array | 否 | 各种车型预估详情 | prices[].name| string | 否 | 车组名称 | prices[].carGroupId | integer | 否 | 车组id | prices[].priceType | integer | 否 | 价格类型<ul><li>1:时租(立即叫车,接机,送机)</li><li>2:套餐(包车(4小时),包车(8小时),预约用车)</li><li>10:一口价</li><ul></p> | | prices[].price | float | 否 | 时租预估价格 / 套餐价格 / 一口价价格,结果已经乘以浮动系数 | prices[].timePrice | float | 否 | 时租时长费 / 套餐超出包含时长的费用,结果已经乘以浮动系数 | prices[].kilometrePrice | float | 否 | 时租里程费 / 套餐超出包含里程的费用,结果已经乘以浮动系数 | prices[].startPrice | float | 是 | 时租起步价/套餐起步价,结果已经乘以浮动系数 | <font color='red'>prices[].longDistancePrice</font> | float | 是 | 时租远途费,结果已经乘以浮动系数(价格类型为时租时使用) | <font color='red'>prices[].outCityPrice</font> | float | 是 | 时租出城费(价格类型为时租时使用) | <font color='red'>prices[].possibleGenerateOutCityPrice</font> | float | 是 | 当行程处于出城边缘时,可能产生出城费。用于提醒用户该行程可能产生出城费,以免造成用户投诉,该费用不计入总价中。注意:outCityPrice大于0时该字段一定大于0,outCityPrice等于0时该字段可能大于0。 | prices[].floatFactor | float | 是 | 时租价格浮动系数(价格类型为时租时使用) | prices[].productKilometre | float | 是 | 套餐包含的里程(公里)(价格类型为套餐时使用) | prices[].productTime | float | 是 | 套餐包含的时长(分钟)(价格类型为套餐时使用) | <font color='red'>prices[].perTimePrice</font> | float | 是 | 时租的时长单价 / 套餐超出包含时长的时长单价(N元/分钟),结果已经乘以浮动系数 | <font color='red'>prices[].perKilometrePrice</font> | float | 是 | 时租的里程单价 / 套餐超出包含里程的里程单价(N元/公里),结果已经乘以浮动系数 | <font color='red'>prices[].perLongDistancePrice</font> | float | 是 | 时租的远途费单价(N元/公里),结果已经乘以浮动系数 | <font color='red'>prices[].longDistancePriceLimit</font> | float | 是 | 时租的远途费距离界限(公里),超出此界限的距离计算远途费 | prices[].companyDiscountAmount | float | 是 | 企业折扣金额, 企业优惠。进行<a href="doc?r=api/content#企业鉴权">企业鉴权</a>后该值才有意义 | prices[].pickupServicePrice | float | 是 | 接机礼宾费(接机礼宾订单时有效) | <font color='blue'> priceStrategyFlag </font> | integer | 否 | 使用新旧价格体系标识, 0:使用旧价格体系,1:使用新价格体系(老接口默认值为0) ### 费用预估(无优惠券)-- 适用新报价体系 #### 权限范围 > 基础信息(product)--客户端或授权码模式或密码模式 #### 请求地址 /v1/resource/common/estimate/price #### 请求方式 HTTP/POST #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | slat | double | 是 | 出发地纬度(服务类型为“接机”时可为空) | slng | double | 是 | 出发地经度(服务类型为“接机”时可为空) | elat | double | 是 | 目的地纬度(服务类型为“包车(8小时)”或"包车(4小时)"时为空) | elng | double | 是 | 目的地经度(服务类型为“包车(8小时)”或"包车(4小时)"时为空) | serviceId | integer | 否 | 服务类型id(7:接机 8:送机 11:包车(4小时) 12:包车(8小时) 13:预约用车 14:立即叫车) | cityId | integer | 是 | 出发城市id(如果为空,则根据出发地经纬度定位城市) | departureTime | long | 是 | <p>出发时间(unix时间戳,服务类型为"立即叫车"或“接机”时可为空)<p/><p>时间范围:立即叫车为当前日期,预约用车/包车(8小时)/包车(4小时)为当前日期 至 当前日期+30天<p/><p>例如:当前日期为2016-3-4 10:00,则日期范围:2016-3-4 10:00(含) 至 2016-4-3 23:59(含)</p> | flt | string | 是 | 航班号 | flightDate | long | 是 | <p>航班起飞日期(unix时间戳)</p><p>日期范围:当前日期-3天 至 当前日期+30天<p/><p>例如:当前日期为2016-3-4,则日期范围:2016-3-1(含) 至 2016-4-3(含)</p> | flightDelayTime | integer | 是 | <p>航班到达后,延时N分钟后用车</p><p>时间范围:10(含) 至 90(含)</p> | airCode | string | 是 | 接机机场三字码 | isPickupVip | boolean | 是 | 是否使用接机礼宾服务(服务类型为接机时有效) | <font color='blue'>basePriceSchemeId</font> | integer | 是 | 基础价格方案id(<a href="doc?r=api/content#产品总类-–-适用新报价体系">从产品总类接口中获取</a>),不传则以出发时间匹配计价规则。 #### 注意事项 <font color='blue'>该接口为新报价体系适用的接口,蓝色标注字段为新增字段</font><br> 如果入参传入basePriceSchemeId,可能会返回“该基础价格方案过期”提示信息,此时判断返回数据中 busiCode 值是否为schemeIdInvalid, 如果为true,重新调用<a href="doc?r=api/content#产品总类-–-适用新报价体系">产品总类接口</a>,获取最新的basePriceSchemeId<br><br> 不支持代金券<br> 服务类型为“接机”时,以下两组参数(航班信息和出发地信息)2选1,如果两组参数全部填写则按照第1组参数(航班信息)为准: 1. 航班信息: flt(航班号),flightDate(航班起飞日期),flightDelayTime(航班到达后,延时N分钟后用车),airCode(接机机场三字码) 2. 出发地信息:slat(出发地纬度),slng(出发地经度),departureTime(出发时间) #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": { "distance": 224090, "duration": 158, "thirdWithholdRate": 1, "estimateId": "cbb9b9ab7b465d32bbcb3ba0f4a95131", "prices": [ { "carGroupId": 1, "companyDiscountAmount": 0, "floatFactor": 1, "kilometrePrice": 475.9, "name": "经济车型", "price": 470.9, "priceType": 1, "productKilometre": 0, "productTime": 0, "startPrice": 25, "timePrice": 70, "pickupServicePrice":0, "longKilometerPrice":0, "outCityPrice":0, "farKilometer":0, "farKilometerPrice":0, "kilometrePriceDetails":[ {"name":"普通时段","distanceOrDuration":"112.05","unitPrice":"4.6","amount":"515.40"}, {"name":"12:00-24:00","distanceOrDuration":"112.05","unitPrice":"4.7","amount":"526.61"} ], "timePriceDetails":[ {"name":"普通时段","distanceOrDuration":"100","unitPrice":"0.8","amount":"80.0"}, {"name":"12:00-24:00","distanceOrDuration":"58","unitPrice":"0.9","amount":"52.2"} ], "longKilometerDetails":[ {"name":"00:00-12:00","longKilometerSegmentInfos":[ {"name":"超过15-25公里部分","distanceOrDuration":"10.0", "unitPrice":"1.5","amount":"15.0"}, {"name":"超过25公里部分","distanceOrDuration":"5.0", "unitPrice":"1.6","amount":"8.0"}] } ], "farKilometerDetails":[ {"name":"00:00-12:00","farKilometerSegmentInfos":[ {"name":"超过15-25公里部分","distanceOrDuration":"10.0", "unitPrice":"1.5","amount":"15.0"}, {"name":"超过25公里部分","distanceOrDuration":"5.0", "unitPrice":"1.6","amount":"8.0"}] } ] }, { "carGroupId": 4, "companyDiscountAmount": 0, "floatFactor": 1, "kilometrePrice": 1030.81, "name": "豪华轿车", "price": 1203, "priceType": 1, "productKilometre": 0, "productTime": 0, "startPrice": 46, "timePrice": 126.4, "pickupServicePrice":0, "longKilometerPrice":0, "outCityPrice":0, "farKilometer":0, "farKilometerPrice":0, "kilometrePriceDetails":[ {"name":"普通时段","distanceOrDuration":"112.05","unitPrice":"4.6","amount":"515.40"}, {"name":"12:00-24:00","distanceOrDuration":"112.05","unitPrice":"4.7","amount":"526.61"} ], "timePriceDetails":[ {"name":"普通时段","distanceOrDuration":"100","unitPrice":"0.8","amount":"80.0"}, {"name":"12:00-24:00","distanceOrDuration":"58","unitPrice":"0.9","amount":"52.2"} ], "longKilometerDetails":[ {"name":"00:00-12:00","longKilometerSegmentInfos":[ {"name":"超过15-25公里部分","distanceOrDuration":"10.0", "unitPrice":"1.5","amount":"15.0"}, {"name":"超过25公里部分","distanceOrDuration":"5.0", "unitPrice":"1.6","amount":"8.0"}] } ], "farKilometerDetails":[ {"name":"00:00-12:00","farKilometerSegmentInfos":[ {"name":"超过15-25公里部分","distanceOrDuration":"10.0", "unitPrice":"1.5","amount":"15.0"}, {"name":"超过25公里部分","distanceOrDuration":"5.0", "unitPrice":"1.6","amount":"8.0"}] } ] }, { "carGroupId": 2, "companyDiscountAmount": 0, "floatFactor": 1, "kilometrePrice": 627.45, "name": "公务轿车", "price": 734, "priceType": 1, "productKilometre": 0, "productTime": 0, "startPrice": 28, "timePrice": 79, "pickupServicePrice":0, "longKilometerPrice":0, "outCityPrice":0, "farKilometer":0, "farKilometerPrice":0, "kilometrePriceDetail":[ {"name":"普通时段","distanceOrDuration":"112.05","unitPrice":"2.8","amount":"313.73"}, {"name":"12:00-24:00","distanceOrDuration":"112.05","unitPrice":"2.9","amount":"324.93"} ], "timePriceDetail":[ {"name":"普通时段","distanceOrDuration":"100","unitPrice":"0.5","amount":"50.0"}, {"name":"12:00-24:00","distanceOrDuration":"58","unitPrice":"0.6","amount":"34.8"} ], "longKilometerDetails":[ {"name":"00:00-12:00","longKilometerSegmentInfos":[ {"name":"超过15-25公里部分","distanceOrDuration":"10.0", "unitPrice":"1.5","amount":"15.0"}, {"name":"超过25公里部分","distanceOrDuration":"5.0", "unitPrice":"1.6","amount":"8.0"}] } ], "farKilometerDetails":[ {"name":"00:00-12:00","farKilometerSegmentInfos":[ {"name":"超过15-25公里部分","distanceOrDuration":"10.0", "unitPrice":"1.5","amount":"15.0"}, {"name":"超过25公里部分","distanceOrDuration":"5.0", "unitPrice":"1.6","amount":"8.0"}] } ] }, { "carGroupId": 3, "companyDiscountAmount": 0, "floatFactor": 1, "kilometrePrice": 1008.4, "name": "商务7座", "price": 1159, "priceType": 1, "productKilometre": 0, "productTime": 0, "startPrice": 40, "timePrice": 110.6, "pickupServicePrice":0, "longKilometerPrice":0, "outCityPrice":0, "farKilometer":0, "farKilometerPrice":0, "kilometrePriceDetails":[ {"name":"普通时段","distanceOrDuration":"112045","unitPrice":"4.5","amount":"504.2"}, {"name":"12:00-24:00","distanceOrDuration":"112045","unitPrice":"4.6","amount":"515.4"} ], "timePriceDetails":[ {"name":"普通时段","duration":"100","unitPrice":"0.7","amount":"70.0"}, {"name":"12:00-24:00","duration":"58","unitPrice":"0.8","amount":"46.4"} ], "longKilometerDetails":[ {"name":"00:00-12:00","longKilometerSegmentInfos":[ {"name":"超过15-25公里部分","distanceOrDuration":"10000", "unitPrice":"1.5","amount":"15.0"}, {"name":"超过25公里部分","distanceOrDuration":"5000", "unitPrice":"1.6","amount":"8.0"}] } ], "farKilometerDetails":[ {"name":"00:00-12:00","farKilometerSegmentInfos":[ {"name":"超过15-25公里部分","distanceOrDuration":"10.0", "unitPrice":"1.5","amount":"15.0"}, {"name":"超过25公里部分","distanceOrDuration":"5.0", "unitPrice":"1.6","amount":"8.0"}] } ] } ], "priceStrategyFlag": 1 }, "handler": "CLIENT", "msg": "成功", "status": "SUCCESS", "uid": "4f750aa2-598b-44cd-9b16-d3cebe285820", "version": "" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | distance | float | 否 | 预估距离(米)。如果服务类型为包车(8小时)或包车(4小时),该字段没有参考意义 | duration | float | 否 | 预估时长(分)。如果服务类型为包车(8小时)或包车(4小时),该字段没有参考意义 | thirdWithholdRate | float | 否 | 第三方代缴费率,行驶过程中产生的任何第三方费用(如路桥费,停车费等),第三方费用需要用户另行现金支付,如果选择线上支付(如账户余额,信用卡等),则支付金额为实际金额乘以代缴费率 | estimateId | string | 否 | 预估标识,创建订单时使用,有效期20分钟(保证预估和下单时价格一致) | prices| array | 否 | 各种车型预估详情 | prices[].name| string | 否 | 车组名称 | prices[].carGroupId | integer | 否 | 车组id | prices[].priceType | integer | 否 | 价格类型<ul><li>1:时租(立即叫车,接机,送机)</li><li>2:套餐(包车(4小时),包车(8小时),预约用车)</li><li>10:一口价</li><ul></p> | | prices[].price | float | 否 | 时租预估价格 / 套餐价格 / 一口价价格,结果已经乘以浮动系数 | prices[].timePrice | float | 否 | 时租时长费 / 套餐超出包含时长的费用,结果已经乘以浮动系数 | prices[].kilometrePrice | float | 否 | 时租里程费 / 套餐超出包含里程的费用,结果已经乘以浮动系数 | prices[].startPrice | float | 是 | 时租起步价/套餐起步价,结果已经乘以浮动系数 | prices[].floatFactor | float | 是 | 时租价格浮动系数(价格类型为时租时使用) | prices[].productKilometre | float | 是 | 套餐包含的里程(公里)(价格类型为套餐时使用) | prices[].productTime | float | 是 | 套餐包含的时长(分钟)(价格类型为套餐时使用) | prices[].companyDiscountAmount | float | 是 | 企业折扣金额, 企业优惠。进行<a href="doc?r=api/content#企业鉴权">企业鉴权</a>后该值才有意义 | prices[].pickupServicePrice | float | 是 | 接机礼宾费(接机礼宾订单时有效) | <font color='blue'>prices[].longKilometerPrice</font> | float | 是 | 远程费 | <font color='blue'>prices[].outCityPrice</font> | float | 是 | 出城费 | <font color='blue'>prices[].farKilometer</font> | float | 是 | 远途距离 | <font color='blue'>prices[].farKilometerPrice</font> | float | 是 | 远途费 | <font color='blue'>prices[].kilometrePriceDetails[].name</font> | string | 是 | 时间段 | <font color='blue'>prices[].kilometrePriceDetails[].distanceOrDuration</font> | float | 是 | 该时间段走的里程 | <font color='blue'>prices[].kilometrePriceDetails[].unitPrice</font> | float | 是 | 里程费(每公里价格) | <font color='blue'>prices[].kilometrePriceDetails[].amount</font> | float | 是 | 该时间段总费用 | <font color='blue'>prices[].timePriceDetails[].name</font> | string | 是 | 时间段 | <font color='blue'>prices[].timePriceDetails[].distanceOrDuration</font> | float | 是 | 该时间段走的时长 | <font color='blue'>prices[].timePriceDetails[].unitPrice</font> | float | 是 | 时长费(每分钟价格) | <font color='blue'>prices[].timePriceDetails[].amount</font> | float | 是 | 该时间段总费用 | <font color='blue'>prices[].longKilometerDetails[].name</font> | string | 是 | 时间段 | <font color='blue'>prices[].longKilometerDetails[].<br> longDistanceSegmentInfo[].name</font> | string | 是 | 产生远程费的区间 | <font color='blue'>prices[].longKilometerDetails[].<br> longDistanceSegmentInfo[].distanceOrDuration</font> | float | 是 | 该区间的远程里程数 | <font color='blue'>prices[].longKilometerDetails[].<br> longDistanceSegmentInfo[].unitPrice</font> | float | 是 | 远程费(每公里价格) | <font color='blue'>prices[].longKilometerDetails[].<br> longDistanceSegmentInfo[].amount</font> | float | 是 | 该区间的远程费用 | <font color='blue'>prices[].farKilometerDetails[].name</font> | string | 是 | 时间段 | <font color='blue'>prices[].farKilometerDetails[].<br> farDistanceSegmentInfo[].name</font> | string | 是 | 产生远途费的区间 | <font color='blue'>prices[].farKilometerDetails[].<br> farDistanceSegmentInfo[].distanceOrDuration</font> | float | 是 | 该区间的远途里程数 | <font color='blue'>prices[].farKilometerDetails[].<br> farDistanceSegmentInfo[].unitPrice</font> | float | 是 | 远途费(每公里价格) | <font color='blue'>prices[].farKilometerDetails[].<br> farDistanceSegmentInfo[].amount</font> | float | 是 | 该区间的远途费用 | <font color='blue'> priceStrategyFlag </font> | integer | 否 | 使用新旧价格体系标识, 0:使用旧价格体系,1:使用新价格体系(老接口默认值为0) ### 费用预估(有优惠券) #### 权限范围 > 基础信息(product)--客户端或授权码模式或密码模式 #### 请求地址 /v1/resource/common/estimate/priceWithCoupon #### 请求方式 HTTP/POST #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | slat | double | 是 | 出发地纬度(服务类型为“接机”时可为空) | slng | double | 是 | 出发地经度(服务类型为“接机”时可为空) | elat | double | 是 | 目的地纬度(服务类型为“包车(8小时)”或"包车(4小时)"时为空) | elng | double | 是 | 目的地经度(服务类型为“包车(8小时)”或"包车(4小时)"时为空) | serviceId | integer | 否 | 服务类型id(7:接机 8:送机 11:包车(4小时) 12:包车(8小时) 13:预约用车 14:立即叫车) | cityId | integer | 是 | 出发城市id(如果为空,则根据出发地经纬度定位城市) | departureTime | long | 是 | <p>出发时间(unix时间戳,服务类型为"立即叫车"或“接机”时可为空)<p/><p>时间范围:立即叫车为当前日期,预约用车/包车(8小时)/包车(4小时)为当前日期 至 当前日期+30天<p/><p>例如:当前日期为2016-3-4 10:00,则日期范围:2016-3-4 10:00(含) 至 2016-4-3 23:59(含)</p> | flt | string | 是 | 航班号 | flightDate | long | 是 | <p>航班起飞日期(unix时间戳)</p><p>日期范围:当前日期-3天 至 当前日期+30天<p/><p>例如:当前日期为2016-3-4,则日期范围:2016-3-1(含) 至 2016-4-3(含)</p> | flightDelayTime | integer | 是 | <p>航班到达后,延时N分钟后用车</p><p>时间范围:10(含) 至 90(含)</p> | airCode | string | 是 | 接机机场三字码 | isUseCoupon | integer | 是 | 是否使用代金券(1:使用 2:不使用) | passengerMobile | string | 是 | 乘客手机号(是否使用代金券为“1”时必填) | isPickupVip | boolean | 是 | 是否使用接机礼宾服务(服务类型为接机时有效) #### 注意事项 <font color='red'>响应数据说明中,标红的字段,会在新报价体系适用的接口中去除</font><br> 授权码模式(或密码模式)时支持代金券。订车人如果存在符合条件的代金券,预估返回结果中将自动推荐一张合适的代金券<br> 客户端模式时同/v1/resource/common/estimate/price<br> 服务类型为“接机”时,以下两组参数(航班信息和出发地信息)2选1,如果两组参数全部填写则按照第1组参数(航班信息)为准: 1. 航班信息: flt(航班号),flightDate(航班起飞日期),flightDelayTime(航班到达后,延时N分钟后用车),airCode(接机机场三字码) 2. 出发地信息:slat(出发地纬度),slng(出发地经度),departureTime(出发时间) #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": { "distance": 224090, "duration": 155, "thirdWithholdRate": 1.1, "estimateId": "cbb9b9ab7b465d32bbcb3ba0f4a95131", "prices": [ { "carGroupId": 1, "companyDiscountAmount": 0, "couponAmount": 0, "couponId": "", "couponKind": 0, "couponTitle": "", "floatFactor": 1, "kilometrePrice": 375.9, "longDistancePrice": 0, "longDistancePriceLimit": 0, "name": "经济车型", "outCityPrice": 0, "perKilometrePrice": 2.2, "perLongDistancePrice": 0, "perTimePrice": 0.8, "price": 470.9, "priceType": 1, "productKilometre": 0, "productTime": 0, "startPrice": 25, "timePrice": 70, "pickupServicePrice":0, "possibleGenerateOutCityPrice":0 }, { "carGroupId": 4, "companyDiscountAmount": 0, "couponAmount": 0, "couponId": "", "couponKind": 0, "couponTitle": "", "floatFactor": 1, "kilometrePrice": 1030.81, "longDistancePrice": 0, "longDistancePriceLimit": 0, "name": "豪华轿车", "outCityPrice": 0, "perKilometrePrice": 4.6, "perLongDistancePrice": 0, "perTimePrice": 0.8, "price": 1200, "priceType": 1, "productKilometre": 0, "productTime": 0, "startPrice": 46, "timePrice": 124, "pickupServicePrice":0, "possibleGenerateOutCityPrice":0 }, { "carGroupId": 2, "companyDiscountAmount": 0, "couponAmount": 0, "couponId": "", "couponKind": 0, "couponTitle": "", "floatFactor": 1, "kilometrePrice": 627.45, "longDistancePrice": 0, "longDistancePriceLimit": 0, "name": "公务轿车", "outCityPrice": 0, "perKilometrePrice": 2.8, "perLongDistancePrice": 0, "perTimePrice": 0.5, "price": 732, "priceType": 1, "productKilometre": 0, "productTime": 0, "startPrice": 28, "timePrice": 77.5, "pickupServicePrice":0, "possibleGenerateOutCityPrice":0 }, { "carGroupId": 3, "companyDiscountAmount": 0, "couponAmount": 0, "couponId": "", "couponKind": 0, "couponTitle": "", "floatFactor": 1, "kilometrePrice": 1008.4, "longDistancePrice": 0, "longDistancePriceLimit": 0, "name": "商务7座", "outCityPrice": 0, "perKilometrePrice": 4.5, "perLongDistancePrice": 0, "perTimePrice": 0.7, "price": 1156, "priceType": 1, "productKilometre": 0, "productTime": 0, "startPrice": 40, "timePrice": 108.5 "pickupServicePrice":0, "possibleGenerateOutCityPrice":0 } ] }, "handler": "CLIENT", "msg": "成功", "status": "SUCCESS", "uid": "4f750aa2-598b-44cd-9b16-d3cebe285820", "version": "" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | distance | float | 否 | 预估距离(米)。如果服务类型为包车(8小时)或包车(4小时),该字段没有参考意义 | duration | float | 否 | 预估时长(分)。如果服务类型为包车(8小时)或包车(4小时),该字段没有参考意义 | thirdWithholdRate | float | 否 | 第三方代缴费率,行驶过程中产生的任何第三方费用(如路桥费,停车费等),第三方费用需要用户另行现金支付,如果选择线上支付(如账户余额,信用卡等),则支付金额为实际金额乘以代缴费率 | estimateId | string | 否 | 预估标识,创建订单时使用,有效期20分钟(保证预估和下单时价格一致) | prices| array | 否 | 各种车型预估详情 | prices[].name| string | 否 | 车组名称 | prices[].carGroupId | integer | 否 | 车组id | prices[].priceType | integer | 否 | 价格类型<ul><li>1:时租(立即叫车,预约用车,接机,送机)</li><li>2:套餐(包车(4小时),包车(8小时))</li><li>10:一口价</li><ul></p> | | prices[].price | float | 否 | 未使用代金券的时租预估价格 / 产品包价格 / 一口价价格,结果已经乘以浮动系数 | prices[].timePrice | float | 否 | 时租时长费 / 套餐超出包含时长的费用,结果已经乘以浮动系数 | prices[].kilometrePrice | float | 否 | 时租里程费 / 套餐超出包含里程的费用,结果已经乘以浮动系数 | prices[].startPrice | float | 是 | 时租起步价/套餐起步价,结果已经乘以浮动系数 | <font color='red'>prices[].longDistancePrice</font> | float | 是 | 时租远途费,结果已经乘以浮动系数(价格类型为时租时使用) | <font color='red'>prices[].outCityPrice</font> | float | 是 | 时租出城费(价格类型为时租时使用) | <font color='red'>prices[].possibleGenerateOutCityPrice</font> | float | 是 | 当行程处于出城边缘时,可能产生出城费。用于提醒用户该行程可能产生出城费,以免造成用户投诉,该费用不计入总价中。注意:outCityPrice大于0时该字段一定大于0,outCityPrice等于0时该字段可能大于0。 | prices[].floatFactor | float | 是 | 时租价格浮动系数(价格类型为时租时使用) | prices[].productKilometre | float | 是 | 套餐包含的里程(公里)(价格类型为套餐时使用) | prices[].productTime | float | 是 | 套餐包含的时长(分钟)(价格类型为套餐时使用) | <font color='red'>prices[].perTimePrice</font> | float | 是 | 时租的时长单价 / 套餐超出包含时长的时长单价(N元/分钟),结果已经乘以浮动系数 | <font color='red'>prices[].perKilometrePrice</font> | float | 是 | 时租的里程单价 / 套餐超出包含里程的里程单价(N元/公里),结果已经乘以浮动系数 | <font color='red'>prices[].perLongDistancePrice</font> | float | 是 | 时租的远途费单价(N元/公里),结果已经乘以浮动系数 | <font color='red'>prices[].longDistancePriceLimit</font> | float | 是 | 时租的远途费距离界限(公里),超出此界限的距离计算远途费 | prices[].companyDiscountAmount | float | 是 | 企业折扣金额, 企业优惠。进行<a href="doc?r=api/content#企业鉴权">企业鉴权</a>后该值才有意义 | prices[].couponId | string | 是 | 符合这次预估价的推荐代金券Id | prices[].couponAmount | float | 是 | 符合这次预估价的推荐代金券金额 | prices[].couponTitle | string | 是 | 预估代金券标题(例如:金额抵扣卷;8.5折抵扣卷) | prices[].couponKind | integer | 是 | 代金券类型(1:金额 2:折扣) | prices[].pickupServicePrice | float | 是 | 接机礼宾费(接机礼宾订单时有效) | <font color='blue'> priceStrategyFlag </font> | integer | 否 | 使用新旧价格体系标识, 0:使用旧价格体系,1:使用新价格体系(老接口默认值为0) ### 费用预估(有优惠券) -- 适用新报价体系 #### 权限范围 > 基础信息(product)--客户端或授权码模式或密码模式 #### 请求地址 /v1/resource/common/estimate/priceWithCoupon #### 请求方式 HTTP/POST #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | slat | double | 是 | 出发地纬度(服务类型为“接机”时可为空) | slng | double | 是 | 出发地经度(服务类型为“接机”时可为空) | elat | double | 是 | 目的地纬度(服务类型为“包车(8小时)”或"包车(4小时)"时为空) | elng | double | 是 | 目的地经度(服务类型为“包车(8小时)”或"包车(4小时)"时为空) | serviceId | integer | 否 | 服务类型id(7:接机 8:送机 11:包车(4小时) 12:包车(8小时) 13:预约用车 14:立即叫车) | cityId | integer | 是 | 出发城市id(如果为空,则根据出发地经纬度定位城市) | departureTime | long | 是 | <p>出发时间(unix时间戳,服务类型为"立即叫车"或“接机”时可为空)<p/><p>时间范围:立即叫车为当前日期,预约用车/包车(8小时)/包车(4小时)为当前日期 至 当前日期+30天<p/><p>例如:当前日期为2016-3-4 10:00,则日期范围:2016-3-4 10:00(含) 至 2016-4-3 23:59(含)</p> | flt | string | 是 | 航班号 | flightDate | long | 是 | <p>航班起飞日期(unix时间戳)</p><p>日期范围:当前日期-3天 至 当前日期+30天<p/><p>例如:当前日期为2016-3-4,则日期范围:2016-3-1(含) 至 2016-4-3(含)</p> | flightDelayTime | integer | 是 | <p>航班到达后,延时N分钟后用车</p><p>时间范围:10(含) 至 90(含)</p> | airCode | string | 是 | 接机机场三字码 | isUseCoupon | integer | 是 | 是否使用代金券(1:使用 2:不使用) | passengerMobile | string | 是 | 乘客手机号(是否使用代金券为“1”时必填) | isPickupVip | boolean | 是 | 是否使用接机礼宾服务(服务类型为接机时有效) | <font color='blue'>basePriceSchemeId</font> | integer | 是 | 基础价格方案id(<a href="doc?r=api/content#产品总类-–-适用新报价体系">从产品总类接口中获取</a>),不传则以出发时间匹配计价规则。 #### 注意事项 <font color='blue'>该接口为新报价体系适用的接口,蓝色标注字段为新增字段</font><br> 如果入参传入basePriceSchemeId,可能会返回“该基础价格方案过期”提示信息,此时判断返回数据中 busiCode 值是否为schemeIdInvalid, 如果为true,重新调用<a href="doc?r=api/content#产品总类-–-适用新报价体系">产品总类接口</a>,获取最新的basePriceSchemeId<br><br> 授权码模式(或密码模式)时支持代金券。订车人如果存在符合条件的代金券,预估返回结果中将自动推荐一张合适的代金券<br> 客户端模式时同/v1/resource/common/estimate/price<br> 服务类型为“接机”时,以下两组参数(航班信息和出发地信息)2选1,如果两组参数全部填写则按照第1组参数(航班信息)为准: 1. 航班信息: flt(航班号),flightDate(航班起飞日期),flightDelayTime(航班到达后,延时N分钟后用车),airCode(接机机场三字码) 2. 出发地信息:slat(出发地纬度),slng(出发地经度),departureTime(出发时间) #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": { "distance": 224090, "duration": 155, "thirdWithholdRate": 1.1, "estimateId": "cbb9b9ab7b465d32bbcb3ba0f4a95131", "prices": [ { "carGroupId": 1, "companyDiscountAmount": 0, "couponAmount": 0, "couponId": "", "couponKind": 0, "couponTitle": "", "floatFactor": 1, "kilometrePrice": 475.9, "name": "经济车型", "price": 470.9, "priceType": 1, "productKilometre": 0, "productTime": 0, "startPrice": 25, "timePrice": 70, "pickupServicePrice":0, "longKilometerPrice":0, "outCityPrice":0, "farKilometer":0, "farKilometerPrice":0, "kilometrePriceDetails":[ {"name":"普通时段","distanceOrDuration":"112.05","unitPrice":"4.6","amount":"515.40"}, {"name":"12:00-24:00","distanceOrDuration":"112.05","unitPrice":"4.7","amount":"526.61"} ], "timePriceDetails":[ {"name":"普通时段","distanceOrDuration":"100","unitPrice":"0.8","amount":"80.0"}, {"name":"12:00-24:00","distanceOrDuration":"58","unitPrice":"0.9","amount":"52.2"} ], "longKilometerDetails":[ {"name":"00:00-12:00","longKilometerSegmentInfos":[ {"name":"超过15-25公里部分","distanceOrDuration":"10.0", "unitPrice":"1.5","amount":"15.0"}, {"name":"超过25公里部分","distanceOrDuration":"5.0", "unitPrice":"1.6","amount":"8.0"}] } ], "farKilometerDetails":[ {"name":"00:00-12:00","farKilometerSegmentInfos":[ {"name":"超过15-25公里部分","distanceOrDuration":"10.0", "unitPrice":"1.5","amount":"15.0"}, {"name":"超过25公里部分","distanceOrDuration":"5.0", "unitPrice":"1.6","amount":"8.0"}] } ] }, { "carGroupId": 4, "companyDiscountAmount": 0, "couponAmount": 0, "couponId": "", "couponKind": 0, "couponTitle": "", "floatFactor": 1, "kilometrePrice": 1030.81, "name": "豪华轿车", "price": 1200, "priceType": 1, "productKilometre": 0, "productTime": 0, "startPrice": 46, "timePrice": 124, "pickupServicePrice":0, "longKilometerPrice":0, "outCityPrice":0, "farKilometer":0, "farKilometerPrice":0, "kilometrePriceDetails":[ {"name":"普通时段","distanceOrDuration":"112.05","unitPrice":"4.6","amount":"515.40"}, {"name":"12:00-24:00","distanceOrDuration":"112.05","unitPrice":"4.7","amount":"526.61"} ], "timePriceDetails":[ {"name":"普通时段","distanceOrDuration":"100","unitPrice":"0.8","amount":"80.0"}, {"name":"12:00-24:00","distanceOrDuration":"58","unitPrice":"0.9","amount":"52.2"} ], "longKilometerDetails":[ {"name":"00:00-12:00","longKilometerSegmentInfos":[ {"name":"超过15-25公里部分","distanceOrDuration":"10.0", "unitPrice":"1.5","amount":"15.0"}, {"name":"超过25公里部分","distanceOrDuration":"5.0", "unitPrice":"1.6","amount":"8.0"}] } ], "farKilometerDetails":[ {"name":"00:00-12:00","farKilometerSegmentInfos":[ {"name":"超过15-25公里部分","distanceOrDuration":"10.0", "unitPrice":"1.5","amount":"15.0"}, {"name":"超过25公里部分","distanceOrDuration":"5.0", "unitPrice":"1.6","amount":"8.0"}] } ] }, { "carGroupId": 2, "companyDiscountAmount": 0, "couponAmount": 0, "couponId": "", "couponKind": 0, "couponTitle": "", "floatFactor": 1, "kilometrePrice": 627.45, "name": "公务轿车", "price": 732, "priceType": 1, "productKilometre": 0, "productTime": 0, "startPrice": 28, "timePrice": 77.5, "pickupServicePrice":0, "longKilometerPrice":0, "outCityPrice":0, "farKilometer":0, "farKilometerPrice":0, "kilometrePriceDetail":[ {"name":"普通时段","distanceOrDuration":"112.05","unitPrice":"2.8","amount":"313.73"}, {"name":"12:00-24:00","distanceOrDuration":"112.05","unitPrice":"2.9","amount":"324.93"} ], "timePriceDetail":[ {"name":"普通时段","distanceOrDuration":"100","unitPrice":"0.5","amount":"50.0"}, {"name":"12:00-24:00","distanceOrDuration":"58","unitPrice":"0.6","amount":"34.8"} ], "longKilometerDetails":[ {"name":"00:00-12:00","longKilometerSegmentInfos":[ {"name":"超过15-25公里部分","distanceOrDuration":"10.0", "unitPrice":"1.5","amount":"15.0"}, {"name":"超过25公里部分","distanceOrDuration":"5.0", "unitPrice":"1.6","amount":"8.0"}] } ], "farKilometerDetails":[ {"name":"00:00-12:00","farKilometerSegmentInfos":[ {"name":"超过15-25公里部分","distanceOrDuration":"10.0", "unitPrice":"1.5","amount":"15.0"}, {"name":"超过25公里部分","distanceOrDuration":"5.0", "unitPrice":"1.6","amount":"8.0"}] } ] }, { "carGroupId": 3, "companyDiscountAmount": 0, "couponAmount": 0, "couponId": "", "couponKind": 0, "couponTitle": "", "floatFactor": 1, "kilometrePrice": 1008.4, "name": "商务7座", "price": 1156, "priceType": 1, "productKilometre": 0, "productTime": 0, "startPrice": 40, "timePrice": 108.5 "pickupServicePrice":0, "longKilometerPrice":0, "outCityPrice":0, "farKilometer":0, "farKilometerPrice":0, "kilometrePriceDetails":[ {"name":"普通时段","distanceOrDuration":"112045","unitPrice":"4.5","amount":"504.2"}, {"name":"12:00-24:00","distanceOrDuration":"112045","unitPrice":"4.6","amount":"515.4"} ], "timePriceDetails":[ {"name":"普通时段","duration":"100","unitPrice":"0.7","amount":"70.0"}, {"name":"12:00-24:00","duration":"58","unitPrice":"0.8","amount":"46.4"} ], "longKilometerDetails":[ {"name":"00:00-12:00","longKilometerSegmentInfos":[ {"name":"超过15-25公里部分","distanceOrDuration":"10000", "unitPrice":"1.5","amount":"15.0"}, {"name":"超过25公里部分","distanceOrDuration":"5000", "unitPrice":"1.6","amount":"8.0"}] } ], "farKilometerDetails":[ {"name":"00:00-12:00","farKilometerSegmentInfos":[ {"name":"超过15-25公里部分","distanceOrDuration":"10000", "unitPrice":"1.5","amount":"15.0"}, {"name":"超过25公里部分","distanceOrDuration":"5000", "unitPrice":"1.6","amount":"8.0"}] } ] } ], "priceStrategyFlag": 1 }, "handler": "CLIENT", "msg": "成功", "status": "SUCCESS", "uid": "4f750aa2-598b-44cd-9b16-d3cebe285820", "version": "" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | distance | float | 否 | 预估距离(米)。如果服务类型为包车(8小时)或包车(4小时),该字段没有参考意义 | duration | float | 否 | 预估时长(分)。如果服务类型为包车(8小时)或包车(4小时),该字段没有参考意义 | thirdWithholdRate | float | 否 | 第三方代缴费率,行驶过程中产生的任何第三方费用(如路桥费,停车费等),第三方费用需要用户另行现金支付,如果选择线上支付(如账户余额,信用卡等),则支付金额为实际金额乘以代缴费率 | estimateId | string | 否 | 预估标识,创建订单时使用,有效期20分钟(保证预估和下单时价格一致) | prices| array | 否 | 各种车型预估详情 | prices[].name| string | 否 | 车组名称 | prices[].carGroupId | integer | 否 | 车组id | prices[].priceType | integer | 否 | 价格类型<ul><li>1:时租(立即叫车,预约用车,接机,送机)</li><li>2:套餐(包车(4小时),包车(8小时))</li><li>10:一口价</li><ul></p> | | prices[].price | float | 否 | 未使用代金券的时租预估价格 / 产品包价格 / 一口价价格,结果已经乘以浮动系数 | prices[].timePrice | float | 否 | 时租时长费 / 套餐超出包含时长的费用,结果已经乘以浮动系数 | prices[].kilometrePrice | float | 否 | 时租里程费 / 套餐超出包含里程的费用,结果已经乘以浮动系数 | prices[].startPrice | float | 是 | 时租起步价/套餐起步价,结果已经乘以浮动系数 | prices[].floatFactor | float | 是 | 时租价格浮动系数(价格类型为时租时使用) | prices[].productKilometre | float | 是 | 套餐包含的里程(公里)(价格类型为套餐时使用) | prices[].productTime | float | 是 | 套餐包含的时长(分钟)(价格类型为套餐时使用) | prices[].companyDiscountAmount | float | 是 | 企业折扣金额, 企业优惠。进行<a href="doc?r=api/content#企业鉴权">企业鉴权</a>后该值才有意义 | prices[].couponId | string | 是 | 符合这次预估价的推荐代金券Id | prices[].couponAmount | float | 是 | 符合这次预估价的推荐代金券金额 | prices[].couponTitle | string | 是 | 预估代金券标题(例如:金额抵扣卷;8.5折抵扣卷) | prices[].couponKind | integer | 是 | 代金券类型(1:金额 2:折扣) | prices[].pickupServicePrice | float | 是 | 接机礼宾费(接机礼宾订单时有效) | <font color='blue'>prices[].longKilometerPrice</font> | float | 是 | 远程费 | <font color='blue'>prices[].outCityPrice</font> | float | 是 | 出城费 | <font color='blue'>prices[].farKilometer</font> | float | 是 | 远途距离 | <font color='blue'>prices[].farKilometerPrice</font> | float | 是 | 远途费 | <font color='blue'>prices[].kilometrePriceDetails[].name</font> | string | 是 | 时间段 | <font color='blue'>prices[].kilometrePriceDetails[].distanceOrDuration</font> | float | 是 | 该时间段走的里程 | <font color='blue'>prices[].kilometrePriceDetails[].unitPrice</font> | float | 是 | 里程费(每公里价格) | <font color='blue'>prices[].kilometrePriceDetails[].amount</font> | float | 是 | 该时间段总费用 | <font color='blue'>prices[].timePriceDetails[].name</font> | string | 是 | 时间段 | <font color='blue'>prices[].timePriceDetails[].distanceOrDuration</font> | float | 是 | 该时间段走的时长 | <font color='blue'>prices[].timePriceDetails[].unitPrice</font> | float | 是 | 时长费(每分钟价格) | <font color='blue'>prices[].timePriceDetails[].amount</font> | float | 是 | 该时间段总费用 | <font color='blue'>prices[].longKilometerDetails[].name</font> | string | 是 | 时间段 | <font color='blue'>prices[].longKilometerDetails[].<br> longDistanceSegmentInfo[].name</font> | string | 是 | 产生远程费的区间 | <font color='blue'>prices[].longKilometerDetails[].<br> longDistanceSegmentInfo[].distanceOrDuration</font> | float | 是 | 该区间的远程里程数 | <font color='blue'>prices[].longKilometerDetails[].<br> longDistanceSegmentInfo[].unitPrice</font> | float | 是 | 远程费(每公里价格) | <font color='blue'>prices[].longKilometerDetails[].<br> longDistanceSegmentInfo[].amount</font> | float | 是 | 该区间的远程费用 | <font color='blue'>prices[].farKilometerDetails[].name</font> | string | 是 | 时间段 | <font color='blue'>prices[].farKilometerDetails[].<br> farDistanceSegmentInfo[].name</font> | string | 是 | 产生远途费的区间 | <font color='blue'>prices[].farKilometerDetails[].<br> farDistanceSegmentInfo[].distanceOrDuration</font> | float | 是 | 该区间的远途里程数 | <font color='blue'>prices[].farKilometerDetails[].<br> farDistanceSegmentInfo[].unitPrice</font> | float | 是 | 远途费(每公里价格) | <font color='blue'>prices[].farKilometerDetails[].<br> farDistanceSegmentInfo[].amount</font> | float | 是 | 该区间的远途费用 | <font color='blue'> priceStrategyFlag </font> | integer | 否 | 使用新旧价格体系标识, 0:使用旧价格体系,1:使用新价格体系(老接口默认值为0) ### 订单取消原因 #### 权限范围 > 基础信息(product)--客户端或授权码模式或密码模式 #### 请求地址 /v1/resource/common/getCancelReason #### 请求方式 HTTP/GET #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token #### 注意事项 取消原因分司机到达前和司机到达后<br> #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": [{ "id": 31, "value": "我的行程改变了,暂时不需要用车", "arrival": false }, { "id": 32, "value": "司机态度差", "arrival": true }, { "id": 33, "value": "车内环境差", "arrival": true }, { "id": 34, "value": "我选择了别的出行方式", "arrival": false }], "msg": "成功", "status": "SUCCESS", "uid": "1bbd7033-8487-4fd5-bc5a-a31fc06974b91435284666082", "version": "001" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | id| integer | 否 | 原因ID | value | string | 否 | 原因 | arrival | boolean | 否 | 司机是否已到达,司机未到达和已到达取消原因不同。 ### 城市列表 #### 权限范围 > 基础信息(product)--客户端或授权码模式或密码模式 #### 请求地址 /v1/resource/common/getCityList #### 请求方式 HTTP/GET #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | type | string | 否 | start:上车城市列表 <br/> end:下车城市列表 | serviceId | integer | 是 | 服务类型id(上车城市列表时该参数必填) #### 注意事项 上车城市列表和下车城市列表不同。返回的列表已经排好序,热门城市排在前面,然后按照城市名称字母自然排序 #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": [{ "cityId": 6, "cityName": "上海", "citySpell": "sh", "isHot": true, "lat": 31.231706, "lng": 121.472644 }, { "cityId": 1, "cityName": "北京", "citySpell": "bj", "isHot": true, "lat": 39.904987, "lng": 116.405281 }, { "cityId": 2, "cityName": "天津", "citySpell": "tj", "isHot": false, "lat": 39.125595, "lng": 117.190186 }, { "cityId": 40, "cityName": "唐山", "citySpell": "ts", "isHot": false, "lat": 39.635113, "lng": 118.175392 }, { "cityId": 20, "cityName": "武汉", "citySpell": "wh", "isHot": false, "lat": 30.584355, "lng": 114.298572 }, { "cityId": 435, "cityName": "乌兰浩特", "citySpell": "wlht", "isHot": false, "lat": 46.072732, "lng": 122.093123 }, { "cityId": 329, "cityName": "乌鲁木齐", "citySpell": "wlmq", "isHot": false, "lat": 43.792818, "lng": 87.617733 }, { "cityId": 116, "cityName": "无锡", "citySpell": "wx", "isHot": false, "lat": 31.574729, "lng": 120.301663 }, { "cityId": 127, "cityName": "温州", "citySpell": "wz", "isHot": false, "lat": 28.000575, "lng": 120.672111 }], "msg": "成功", "status": "SUCCESS", "uid": "f6ac1dbe-0003-427b-a231-344b320729b61467776213673", "version": "002" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | [].cityId | integer | 否 | 城市id | [].citySpell | string | 否 | 城市名称拼音简写 | [].cityName | string | 否 | 城市名称 | [].lat | double | 否 | 城市中心纬度 | [].lng | double | 否 | 城市中心经度 | [].isHot | boolean | 否 | 热门城市 ### 城市机场列表 #### 权限范围 > 基础信息(product)--客户端或授权码模式或密码模式 #### 请求地址 /v1/resource/common/getCityAirport #### 请求方式 HTTP/GET #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | cityId | integer | 否 | 城市ID #### 注意事项 送机服务时用于乘客选择下车地点 #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": [{ "code": "PEK", "lat": "40.08029", "lng": "116.587970", "name": "北京首都机场1号航站楼", "terminalCode": "T1", "isOpenPickupService":"false" }, { "code": "PEK", "lat": "40.07958", "lng": "116.593480", "name": "北京首都机场2号航站楼", "terminalCode": "T2", "isOpenPickupService":"false" }, { "code": "PEK", "lat": "40.05446", "lng": "116.616200", "name": "北京首都机场3号航站楼", "terminalCode": "T3", "isOpenPickupService":"false" }], "msg": "成功", "status": "SUCCESS", "uid": "6393b60a-d9ab-4160-9306-b5376d5583fa1467854675616", "version": "002" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | [].code | string | 否 | 机场三字码 | [].name | string | 否 | 名称 | [].terminalCode | string | 否 | 航站楼编码 | [].lat | double | 否 | 纬度 | [].lng | double | 否 | 经度 | [].isOpenPickupService | boolean | 否 | 是否开通接机礼宾服务 ### 优惠信息 #### 权限范围 > 基础信息(product)--客户端或授权码模式或密码模式 #### 请求地址 /v1/resource/common/getPromotion #### 请求方式 HTTP/GET #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | cityId | integer | 是 | 城市Id,不传入则返回通用广告,全国适用 #### 注意事项 返回充赠信息。实时获取,不同城市优惠信息可能不同 #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": { "rechargePromotion": "冲100送500多充多送", "rechargePromotions": [ { "giftAmount": 0, "giftPercent": 0.5, "lowerLimit": 2, "type": 1, "upperLimit": 0 } ] }, "msg": "成功", "status": "SUCCESS", "uid": "beb4b033-bf26-4d04-a8b5-7f26d81824c31473213119380", "version": "002" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | rechargePromotion | string | 否 | 充值优惠信息 | rechargePromotions | array | 是 | | upperLimit | integer | 否 | 参加活动金额上限<p>如果为0标识无上限</p> | lowerLimit | integer | 否 | 参加活动金额下限 | type | integer | 否 | 优惠类型<p>1.百分比</p><p>2.固定金额</p> | giftAmount | integer | 是 | 赠送的固定金额<p>type为2时有意义</p> | giftPercent | float | 是 | 赠送百分比<p>type为1时有意义</p> ### 获得所有订单数据 #### 权限范围 > 基础信息(product)--客户端或授权码模式或密码模式 #### 请求地址 /v1/resource/order/sync #### 请求方式 HTTP/GET #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | offset | integer | 是 | 开始索引位置 默认:0 | limit | integer | 是 | 返回数量(默认50,最大200) | orderStatus | string | 是 |查询<a href="doc?r=base/statusInfo#order_status">订单状态</a> 不填查所有状态 | startTime | long | 否 | 起始时间(unix时间戳) | endTime | long | 否 | 结束时间(unix时间戳) | timeType | integer | 是 | 查询时间类型。1:创建订单时间,2:用车时间。默认:1 | callMobile | string | 是 | 订车人电话 | passengerMobile | string | 是 | 乘车人电话 #### 注意事项 查询clientId账户下所有的订单,用于数据同步等。只能查最近半年的数据。严格限制<a href="doc?r=faq/content#q:开放平台接口有请求频率限制吗?" target='_blank'>查询频率</a> #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": { "limit": 5, "list": [{ "carGroupId": 2, "realCarGroupId": 2, "cityId": 2, "companyId": 0, "createTime": 1489564725, "customData" : {"dOrderId":"35456983384","dCouponId":"5462395218","dCouponAmount":20} "departureTime": 1489566696, "dispatchedTime": 1489566267, "endAddress": "东丽区", "endCityId": 2, "endName": "空港商务区东区", "finishedTime": 1489566714, "id": "6397631779667771395", "isDisagree": false, "isFixedPrice": false, "number": "30621351513605", "orderStatus": "paid", "paymentStatus": "paid", "isPickupVip":false, "price": { "arrearsPrice": "0", "couponDeductibleAmount": 100.00, "couponId": "6397627875542499329", "detail": [{ "amount": "600", "name": "套餐价" }, { "amount": "500", "name": "机场服务费" }, { "amount": "18", "name": "路桥费" }, { "amount": "500", "name": "清洁费" }, { "amount": "-100", "name": "7.0折券抵扣" }], "distance": 1000, "duration": 1, "equivalentPrice": 759, "totalPrice": "1518" }, "realEndAddress": "天津市东丽区保税区空港国际物流经济区", "realEndName": "天津市东丽区东二道", "realStartAddress": "天津市东丽区保税区空港国际物流经济区", "realStartName": "天津市东丽区东二道", "serviceId": 12, "startAddress": "东丽区", "startName": "空港商务区东区" }], "offset": 0 }, "msg": "成功", "status": "SUCCESS", "uid": "9e236c3a-265f-4672-9da6-f81508c1f0381473324011530", "version": "001" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | offset | integer | 否 | 开始索引位置 | limit | integer | 否 | 每页数量 | list | array | 否 | 历史列表 | list[].id | string | 否 | 订单id | list[].number | string | 否 | 订单号(用于客户展示) | list[].serviceId | integer | 否 | 服务类型id | list[].carGroupId | integer | 否 | 预计车组类型(车辆类型) | list[].realCarGroupId | integer | 否 | 实际车组类型(车辆类型),订单未分配时值为0<br/>如果下单车型没有空闲车辆,会免费升级车组类型 | list[].orderStatus | string | 否 | 订单状态 | list[].paymentStatus | string | 否 | 支付状态 | list[].createTime| long | 否 | 订单创建时间(unix时间戳) | list[].customData.dOrderId | string | 是 | 第三方自定义订单号 | list[].customData.dCouponId | string | 是 | 第三方自定义优惠券号 | list[].customData.dCouponAmount | integer | 是 | 第三方自定义优惠券金额 | list[].departureTime | long | 否 | 用车时间(unix时间戳) | list[].finishedTime | long | 是 | 订单完成时间(unix时间戳)<br/>订单未完成时值为0 | list[].dispatchedTime | long | 是 | 派单时间(unix时间戳) | list[].isDisagree | boolean | 否 | 是否有异议 | list[].isFixedPrice | boolean | 否 | 是否是一口价订单 | list[].companyId | long | 是 | 企业id(订单为企业单时该字段才有意义) | list[].cityId | integer | 否 |出发城市ID | list[].startName | string | 否 | 预计出发地名称 | list[].startAddress | string | 否 | 预计出发地地址 | list[].realStartName | string | 否 | 实际出发地名称 | list[].realStartAddress | string | 否 | 实际出发地地址 | list[].endCityId | integer | 否 | 下车城市ID | list[].endName | string | 否 | 预计目的地名称 | list[].endAddress | string | 否 | 预计目的地地址 | list[].realEndName | string | 否 | 实际目的地名称 | list[].realEndAddress | string | 否 | 实际目的地地址 | list[].isPickupVip | boolean | 是 | 是否使用接机礼宾服务 | list[].price.totalPrice | string | 否 | 司机提交费用前:预估费用 <br/>司机提交费用后:实际应支付费用 | list[].price.arrearsPrice | string | 否 | 本单欠费金额<br/>如果此字段不为0,且订单处于新建或已派单状态,需要用户在已派单(立即派单)或创建订单(非立即派)后五分钟内进行充值,否则订单自动取消 | list[].price.distance | float | 否 | 本单里程(米) | list[].price.duration | float | 否 | 本单时长(分) | list[].price.equivalentPrice | integer | 否 | 充值用户余额支付费用相当于的价格 | list[].price.couponId | string | 否 | 代金券id | list[].price.couponDeductibleAmount | float | 否 | 代金券最终抵扣金额 | list[].price.detail | array | 否 | 实际费用明细 | list[].price.detail[].name | string | 否 | 明细名称 | list[].price.detail[].amount | string | 否 | 金额 ### 开通城市服务查询 #### 权限范围 > 基础信息(product)–客户端或授权码模式或密码模式 #### 请求地址 /v1/resource/common/getCityServiceCarTypeList #### 请求方式 HTTP/GET #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token #### 注意事项 用于渠道获取当前渠道下已开通城市的服务类型和对应车组列表<br> 响应数据内容与渠道是否新旧报价体系有关<br> #### 响应数据 ``` { "busiCode": "BASE000", "code": 1, "content": [ { "cityId": 1, "cityName": "北京", "services": [ { "comfortable": 1, "commercial": 1, "economic": 1, "luxurious": 1, "serviceName": "接机", "serviceType": 7 }, { "comfortable": 1, "commercial": 1, "economic": 0, "luxurious": 1, "serviceName": "送机", "serviceType": 8 }, { "comfortable": 1, "commercial": 1, "economic": 0, "luxurious": 1, "serviceName": "半日租", "serviceType": 11 }, { "comfortable": 1, "commercial": 1, "economic": 0, "luxurious": 1, "serviceName": "日租", "serviceType": 12 }, { "comfortable": 1, "commercial": 1, "economic": 0, "luxurious": 1, "serviceName": "预约用车", "serviceType": 13 }, { "comfortable": 1, "commercial": 1, "economic": 0, "luxurious": 1, "serviceName": "立即叫车", "serviceType": 14 } ] }, { "cityId": 2, "cityName": "天津", "services": [ { "comfortable": 1, "commercial": 1, "economic": 1, "luxurious": 1, "serviceName": "接机", "serviceType": 7 }, { "comfortable": 1, "commercial": 1, "economic": 0, "luxurious": 1, "serviceName": "送机", "serviceType": 8 }, { "comfortable": 1, "commercial": 1, "economic": 0, "luxurious": 1, "serviceName": "半日租", "serviceType": 11 }, { "comfortable": 1, "commercial": 1, "economic": 0, "luxurious": 1, "serviceName": "日租", "serviceType": 12 }, { "comfortable": 1, "commercial": 1, "economic": 0, "luxurious": 1, "serviceName": "预约用车", "serviceType": 13 }, { "comfortable": 1, "commercial": 1, "economic": 0, "luxurious": 1, "serviceName": "立即叫车", "serviceType": 14 } ] }, { "cityId": 18, "cityName": "厦门", "services": [ { "comfortable": 1, "commercial": 1, "economic": 1, "luxurious": 1, "serviceName": "接机", "serviceType": 7 }, { "comfortable": 1, "commercial": 1, "economic": 0, "luxurious": 1, "serviceName": "送机", "serviceType": 8 }, { "comfortable": 1, "commercial": 1, "economic": 0, "luxurious": 1, "serviceName": "半日租", "serviceType": 11 }, { "comfortable": 1, "commercial": 1, "economic": 0, "luxurious": 1, "serviceName": "日租", "serviceType": 12 }, { "comfortable": 1, "commercial": 1, "economic": 0, "luxurious": 1, "serviceName": "预约用车", "serviceType": 13 }, { "comfortable": 1, "commercial": 1, "economic": 0, "luxurious": 1, "serviceName": "立即叫车", "serviceType": 14 } ] } ], "handler": "CLIENT", "msg": "成功", "status": "SUCCESS", "uid": "7d13d86e-4761-4557-9db3-44a99c2f0f2f", "version": "001" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | cityName| string | 否 | 城市名称,例如:北京 | cityId| integer | 否 | 城市id | services| Array | 否 | | services[].economic| integer | 否 | 经济型,0为未开通,1为已开通 | services[].comfortable| integer | 否 | 公务车,0为未开通,1为已开通 | services[].commercial| integer | 否 | 商务6座,0为未开通,1为已开通 | services[].luxurious| integer | 否 | 豪华车,0为未开通,1为已开通 | services[].serviceType| integer | 否 | 服务类型id | services[].serviceName| string | 否 | 服务类型名 ## 接机礼宾 ### 接机礼宾服务是否开通 #### 权限范围 > 接机礼宾--客户端或授权码模式或密码模式 #### 请求地址 /v1/resource/pickup/isOpen #### 请求方式 HTTP/GET #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | airCode | string | 否 | 机场三字码 | departureTime | long | 是 | 出发时间(unix时间戳) #### 注意事项 用于创建接机礼宾订单时判断是否开通接机礼宾服务,即使某个机场开通接机礼宾服务,但是某个时间段可能就没有开通 #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": { "isOpen": true, "remark": "" }, "handler": "CLIENT", "msg": "成功", "status": "SUCCESS", "uid": "8959f1ee-ab13-41f4-a6f3-4478e3fdcc641549932990583", "version": "001" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | isOpen | boolean | 否 | 是否开通 | remark | string | 否 | 未开通原因说明 ### 接机礼宾订单取消原因列表 #### 权限范围 > 接机礼宾--客户端或授权码模式或密码模式 #### 请求地址 /v1/resource/pickup/getCancelReason #### 请求方式 HTTP/GET #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token #### 注意事项 #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": [ { "id": 1, "value": "无法和礼宾员取得联系" }, { "id": 2, "value": "礼宾员服务态度差" }, { "id": 3, "value": "礼宾员要求我取消" }, { "id": 4, "value": "信息有误,重新下单" }, { "id": 5, "value": "暂不需要礼宾服务了" } ], "handler": "CLIENT", "msg": "成功", "status": "SUCCESS", "uid": "0dca5752-d263-4db6-ba14-d8ca791c3eea1549933367664", "version": "001" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | id | integer | 否 | 原因ID | value | string | 否 | 原因 ### 取消接机礼宾订单 #### 权限范围 > 接机礼宾--授权码模式或密码模式 #### 请求地址 /v1/action/pickup/cancel #### 请求方式 HTTP/POST #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | orderId | string | 否 | 订单id | force | boolean | 是 | 是否强制取消(true 或 false)默认false | reasonId | integer | 是,与resionId必须选其一 | 取消订单原因 | reason | string | 是,与resionId必须选其一 | 取消订单原因id(取消订单原因列表获取) | cost | string | 是 | 扣费金额(保留两位小数),与实际扣费金额对比,一致时才会取消,为空时不判断 #### 注意事项 force传值为false不会真正取消礼宾订单,该特性用来判断订单是否收取取消费。force必须传true才会取消订单(取消礼宾订单不会关联取消用车订单)。<br> #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": { "cost": 9.6, "isCanceled": false, "needPay": true }, "handler": "CLIENT", "msg": "成功", "status": "SUCCESS", "uid": "b0e3bc83-da12-4a7d-b484-098db90a94001549933654477", "version": "001" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | needPay| boolean | 否 | 是否需要扣费 | cost | float | 否 | <p>扣费金额,如果传force=false,返回是否需要扣费(此礼宾订单未被取消,有可能产生扣费,需要确认),</p><p>这时如果要强制取消订单,需要再次请求此接口且传force=true,这时此订单会发生扣款(此订单强制取消)。 | isCanceled | boolean | 否 | 取消是否成功 ### 评价接机礼宾服务 #### 权限范围 > 接机礼宾--授权码模式或密码模式 #### 请求地址 /v1/action/pickup/comment #### 请求方式 HTTP/POST #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | orderId | string | 否 | 待评价订单id | score | integer | 否 | 评分。5分为最高分 1,2,3,4,5 | remark | string | 是 | 评论内容。5分时可以不填。 #### 注意事项 该接口不是必须接口。 #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": "SUCCESS", "handler": "CLIENT", "msg": "成功", "status": "SUCCESS", "uid": "b0e3bc83-da12-4a7d-b484-098db90a94001549933654477", "version": "001" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | content| string | 否 | 返回SUCCESS表示评价成功 ## 订单 ### 创建订单 #### 权限范围--授权码模式或密码模式 > 订单(order) #### 请求地址 /v1/action/order/create #### 请求方式 HTTP/POST #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | serviceId | integer | 否 | 服务类型id(7:接机 8:送机 11:包车(4小时) 12:包车(8小时) 13:预约用车 14:立即叫车) | carGroupId | integer | 否 | 车组id | cityId | integer | 是 | 出发城市id(如果为空,则根据出发地经纬度定位城市) | passengerMobile | string | 否 | 乘客手机号 | passengerName | string | 否 | 乘客姓名(不能超过50个字符) | passengerCountryCode | string | 是 | 乘客国家代码(默认为86) | spCallMobile | string | 是 | 渠道订车人手机号 | isVirtual4SP | boolean | 是 | 是否虚拟号,默认false | spCallMobileCountryCode | string | 是 | 渠道订车人手机号国家代码(默认为86) | slat | double | 是 | 出发地纬度(服务类型为“接机”时可为空) | slng | double | 是 | 出发地经度(服务类型为“接机”时可为空) | startName | string | 是 | 出发地名称(服务类型为“接机”时可为空) | startAddress | string | 是 | 出发地详细地址(服务类型为“接机”时可为空) | elat | double | 是 | 目的地纬度(服务类型为“包车(8小时)”或"包车(4小时)"时为空) | elng | double | 是 | 目的地经度(服务类型为“包车(8小时)”或"包车(4小时)"时为空) | endName | string | 是 | 目的地名称(服务类型为“包车(8小时)”或"包车(4小时)"时为空) | endAddress | string | 是 | 目的地详细地址(服务类型为“包车(8小时)”或"包车(4小时)"时为空) | departureTime | long | 是 | <p>出发时间(unix时间戳)(服务类型为"立即叫车"或“接机”时可为空)</p><p>时间范围:立即叫车为当前日期,预约用车/包车(8小时)/包车(4小时)为当前日期 至 当前日期+30天</p><p>例如:当前日期为2016-3-4 10:00,则日期范围:2016-3-4 10:00(含) 至 2016-4-3 23:59(含)</p> | flt | string | 是 | 航班号 | flightDate | long | 是 | <p>航班起飞日期(unix时间戳)<p>日期范围:当前日期-3天 至 当前日期+30天</p><p>例如:当前日期为2016-3-4,则日期范围:2016-3-1(含) 至 2016-4-3(含)</p> | flightDelayTime | integer | 是 | <p>航班到达后,延迟N分钟后用车(下飞机、拿行李、走出航站楼需要时间)</p><p>时间范围:10(含) 至 90(含)</p> | airCode | string | 是 | 接机机场三字码 | isPassengerSms | integer | 是 | 替他人叫车时短信通知乘车人,默认通知(0:不通知 1:通知) | isCallSms | integer | 是 | 是否给订车人发送短信,默认发送(0:表示不发,1:表示发) | isSPCallSms | integer | 是 | 是否给渠道订车人发送短信,默认不发送(0:表示不发,1:表示发)当渠道订车人非虚拟号情况下,本参数才生效 | driverMessage | string | 是 | 给司机留言的内容,留言内容通过base64编码以后字符数不超过500个字符 | isIncludeUPlus | integer | 是 | 是否包含U+平台车辆。默认包括(0:不包括,1:包括) | estimateId | string | 否 | 预估标识,预估接口返回。 | customData | string | 是 |<p>订单号及优惠券信息等个性化自定义字段(Json字符串)如:</p> <p>{"dOrderId":"35456983384","dCouponId":"5462395218",</br>"dCouponAmount":20,"dEntProjectCode":"1001","dPurposeName":"加班","customfield1":"customValue1", "dDistanceExchangeOrder":"true", "dEstimateDistance":"120"}</p><p>其中dOrderId、dCouponId、dCouponAmount,dEntProjectCode,dPurposeName,dDistanceExchangeOrder,dEstimateDistance分别代表渠道订单id、渠道优惠券id、渠道优惠券金额、项目编号、用车目的、里程兑换订单标识、预估里程若使用这几个字段则必须使用规定的key值,其他字段无限制要求</p> | isPickupVip | boolean | 是 | 是否使用接机礼宾服务(服务类型为接机时有效) #### 注意事项 测试环境创建的订单要跑完完整的流程,至少将订单状态流转到已提交费用状态 如果下企业单请先进行<a href="doc?r=api/content#企业鉴权">企业鉴权</a>,不进行鉴权为个人用车。企业用车将扣除企业账户的余额且可以享受特殊优惠(<a href="?r=faq/contact" target="_blank">需商务合作</a>),企业订单不支持代金券 服务类型为“接机”时,以下两组参数(航班信息和出发地信息)2选1,强烈建议使用第1组参数,如果两组参数全部填写则按照第1组参数(航班信息)为准: 1. 航班信息: flt(航班号),flightDate(航班起飞日期),flightDelayTime(航班到达后,延时N分钟后用车),airCode(接机机场三字码)。`注意:使用该组参数时,飞机晚点或提前到达,接机时间也会自动做出相应调整` 2. 出发地信息:slat(出发地纬度),slng(出发地经度),startName(出发地名称),startAddress(出发地详细地址),departureTime(出发时间)。 #### 响应数据 > 数据仅供参考 ``` 创建订单成功返回信息 { "busiCode": "BASE000", "code": 1, "content": { "createStatus": "createSuccess", "orderId": "6438718716671623171", "orderNumber": "30656340644037", "isDispatchedImmediately":true, "orderType": 1 }, "msg": "成功", "status": "SUCCESS", "uid": "c9874a85-04c7-4fd2-b58b-6e304f8af7ff1432016014489", "version": "001" } 创建订单失败返回信息, busiCode, msg和status会根据实际情况返回具体的值 { "busiCode": "passengerMoreThanThreeOrder", "code": 7, "content": null, "msg": "乘车人未结算订单达到三个", "status": "BASE_ERROR", "uid": "c9874a85-04c7-4fd2-b58b-6e304f8af7ff1432016014489", "version": "001" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | orderId| string | 否 | 订单ID,程序之间通信使用 | orderNumber| string | 否 | 订单号,给用户展示、线下对账使用 | createStatus | string | 否 | 订单创建成功 | isDispatchedImmediately | boolean | 否 | 是否立即派单(测试环境该值有可能为null),立即派单订单,创建后120s内,通过回调通知是否有司机接单。非立即派单,订单创建成功就表示会有司机提供服务,120s内不会有司机接单回调。 | orderType | integer | 否 | 订单类型<br/> 1.个人订单<br/>2.企业订单 ### 订单详情 #### 权限范围 > 订单(order)--客户端模式或授权码模式或密码模式 #### 请求地址 /v1/resource/order/getOrderDetail #### 请求方式 HTTP/GET #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | orderId | string | 否 | 订单id #### 注意事项 返回结果根据订单状态变化而不同: 1. 当订单状态为已派单后才会有司机信息,且司机的经纬度根据实际位置实时变化 2. 当订单状态为已提交费用之前费用信息显示为预估费用,已提交费用后显示为真实的费用信息 3. 当订单状态为已提交费用后,如果用户对订单费用有疑议并进行投诉,订单费用仍然有可能变化 4. 当订单状态为已提交费用后,才会显示代金券信息。因为此时费用已经确定,可以判断代金券是否适用本笔订单 5. 当订单状态为已完成时,所有的数据将不再发生变化 客户端模式:调用此接口需要进行企业管理员鉴权,可以查看企业员工下的企业订单详情。<br> 授权码模式(或密码模式):可以查看个人和企业订单详情。 #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": { "dispatchResult": { "dispatchFeeDesc": "", "driverMaxDispatchFee": 0, "showDispatchDialog": false, "userMaxDispatchFee": 0 }, "driver": { "driverLat": 0, "driverLng": 0, "driverName": "敏师傅", "driverPhone": "17192356976", "driverScore": "5.0", "vehicleColor": "白色", "vehicleModel": "凯迪拉克CT6", "vehicleNo": "闽DL0008", "virtualPhone4Passenger": "18400637361", "virtualPhone4Purchaser": "17192356976", "virtualPhone4SPPurchaser": "17081234041" }, "initPrice": null, "order": { "autoPayTime": 0, "canDisagree": true, "carGroupId": 2, "cityId": 18, "companyId": 0, "createTime": 1600312893, "customData": "", "departureTime": 1600312948, "dispatchedTime": 1600312940, "dispatchingCountdown": 0, "elat": 24.434738, "elng": 118.121167, "employeeNumber": "", "endAddress": "龙舟新村2", "endName": "龙舟新村1", "finishedTime": 1600312951, "id": "6873291538806996995", "isDisagree": false, "isDispatchedImmediately": false, "isFixedPrice": false, "isPickupVip": true, "number": "35171367234320", "orderRemark": "", "orderScore": 0, "passengerMobile": "15159416469", "passengerName": "dd", "passengerPhone": "15159416469", "payStatus": "paid", "paymentStatus": "paid", "prePayStatus": 0, "realCarGroupId": 4, "realElat": 24.434738, "realElng": 118.121167, "realEndAddress": "龙舟新村2", "realEndName": "龙舟新村1", "realSlat": 24.474707, "realSlng": 118.189112, "realStartAddress": "展鸿路81-89号", "realStartName": "特房波特曼财富中心", "rechargingCountdown": 0, "serviceId": 7, "slat": 24.544686, "slng": 118.147156, "startAddress": "厦门高崎国际机场T4航站楼", "startName": "厦门高崎国际机场T4航站楼", "status": "paid" }, "pickupOrder": { "status": "canceled", "virtualPhone4Passenger": "", "virtualPhone4Purchaser": "", "waiterName": "", "waiterNo": "" }, "price": { "arrearsPrice": "0", "couponDeductibleAmount": 0, "couponId": "", "couponInvitationCode": "", "detail": [{ "amount": "13", "name": "起租价", "subDetail": [] }, { "amount": "50", "name": "里程费(20公里)", "subDetail": [] }, { "amount": "0.5", "name": "时长费(1分钟)", "subDetail": [] }, { "amount": "6.5", "name": "远途费", "subDetail": [] }, { "amount": "2", "name": "机场服务费", "subDetail": [] }, { "amount": "4.5", "name": "停车费", "subDetail": [] }, { "amount": "1.5", "name": "路桥费", "subDetail": [] }, { "amount": "6", "name": "清洁费", "subDetail": [] }, { "amount": "7.5", "name": "其他费用", "subDetail": [] }, { "amount": "12.0", "name": "等待时长费(1分钟)", "subDetail": [] }], "detailStru": { "airportServicePrice": 2.00, "cancelPrice": 0.00, "cleanPrice": 6.00, "discount": 0.00, "driverOvertimePrice": 0.00, "entDiscount": 0.00, "kilometrePrice": 50.00, "longDistancePrice": 6.50, "otherPrice": 7.50, "outCityPrice": 0.00, "parkingPrice": 4.50, "pickupServiceCancelPrice": 0.00, "pickupServicePrice": 0.00, "startPrice": 13.00, "timePrice": 0.50, "tollPrice": 1.50, "useCarSubsidies": 0.00, "waitTimePrice": 0.50, "driverFreeWaitTime": 1, "driverWaitFeeLimit": 10, "driverWaitUnitPrice": 1 }, "distance": 20000.0, "duration": 1.0, "equivalentPrice": 76, "frezzAmount": "", "totalPrice": "92.0" }, "priceStrategyFlag": 0 }, "handler": "CLIENT", "msg": "成功", "status": "SUCCESS", "uid": "bc03bf00-db9d-46fd-97e4-41dfb876cc21", "version": "001" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | order | json | 否 | 订单 | order.id | string | 否 | 订单id | order.number | string | 否 | 订单号(用于客户展示) | order.cityId | integer | 否 | 出发城市id | order.serviceId | integer | 否 | 服务类型 | order.carGroupId | integer | 否 | 预计车组类型 | order.realCarGroupId | integer | 否 | 实际车组类型(车辆类型),订单未分配时值为0<br/>如果下单车型没有空闲车辆,会免费升级车组类型 | order.status | string | 否 | <a href="doc?r=guide/content#1-订单状态">订单状态</a> | order.paymentStatus | string | 否 | <a href="doc?r=guide/content#4-支付状态">支付状态</a> | order.elng | double | 否 | 预计目的地经度 | order.elat | double | 否 | 预计目的地纬度 | order.slng | double | 否 | 预计出发经度 | order.slat | double | 否 | 预计出发纬度 | order.startName | string | 否 | 预计出发地名称 | order.startAddress | string | 否 | 预计出发地地址 | order.endName | string | 否 | 预计目的地名称 | order.endAddress | string | 否 | 预计目的地地址 | order.realElng | double | 是 | 实际目的地经度(订单状态为serviceFinished及之后才有效) | order.realElat | double | 是 | 实际目的地纬度(订单状态为serviceFinished及之后才有效) | order.realSlng | double | 是 | 实际出发经度(订单状态为serviceStarted及之后才有效) | order.realSlat | double | 是 | 实际出发纬度(订单状态为serviceStarted及之后才有效) | order.realStartName | string | 是 | 实际出发地名称(订单状态为serviceStarted及之后才有效) | order.realStartAddress | string | 是 | 实际出发地地址(订单状态为serviceStarted及之后才有效) | order.realEndName | string | 是 | 实际目的地名称(订单状态为serviceFinished及之后才有效) | order.realEndAddress | string | 是 | 实际目的地地址(订单状态为serviceFinished及之后才有效) | order.createTime | long | 否 | 订单创建时间 | order.customData | json | 是 | 第三方自定义数据 | order.departureTime | long | 否 | 用车时间(unix时间戳) | order.dispatchedTime | long | 否 | 派单时间(unix时间戳) | order.finishedTime | long | 是 | 用户下车时间(unix时间戳)<br/> 未下车时值为0 | order.isDisagree | boolean | 否 | 是否有异议<br/> true:是异议订单<br/> false:不是异议订单 | order.isFixedPrice | boolean | 否 | 是否一口价订单 | order.canDisagree | boolean | 否 | 是否可疑议 | order.passengerMobile | string | 否 |乘客手机号 | order.passengerName | string | 否 |乘客姓名 | order.employeeNumber | string | 是 |员工工号,订单类型为企业单且配置了员工工号,该字段才有值 | order.orderScore | integer | 是 | 订单评分,订单完成时该字段才有意义 | order.orderRemark | string | 是 | 订单评价内容,订单完成时该字段才有意义 | order.isDispatchedImmediately | boolean | 否 | 是否立即派单 | order.companyId | long | 是 | 企业ID,非企业订单返回0 | order.dispatchingCountdown | integer | 是 | 派单倒计时 <br/>倒计时结束仍没有司机接单,那么订单自动被取消<br/> 立即派单且处于created状态的订单该字段才有意义 | order.rechargingCountdown | integer | 是 | 充值倒计时 <br/>倒计时结束仍没有充值,那么订单自动被取消<br/>订单处于created或已派单状态,但余额不足以支付该笔订单时该字段才有意义 | price | json | 是 | 费用描述 | price.totalPrice | string | 否 | 总费用<br/> 订单状态在feeSubmitted之前是预估费用,之后是实际产生的费用 | price.arrearsPrice | string | 否 | <p>本单欠费金额<p>如果此字段不为0,且订单处于新建或已派单状态,需要用户在已派单(立即派单)或创建订单(非立即派)后五分钟内进行充值,否则订单自动取消</p> | price.couponId | string | 是 | 代金券id,如果订单没有使用代金券,值为"" | price.couponDeductibleAmount | float | 是 | 代金券最终抵扣金额,如果订单没有使用代金券,值为0 | price.distance | float | 否 | 本单里程(米) | price.duration | float | 否 | 本单时长(分) | price.equivalentPrice | integer | 否 | 充值用户余额支付费用相当于的价格<br>例如:当前冲100送20,最终需要支付50 <br/>该字段值为40 | price.detail | array | 否 | 费用明细 | price.detail[].name | string | 否 | 明细名称 | price.detail[].amount | string | 否 | 金额 | price.detailStru | json | 否 | 费用明细结构 | price.detailStru.airportServicePrice | float | 是 | 机场服务费 | price.detailStru.cancelPrice | float | 是 | 取消费 | price.detailStru.cleanPrice | float | 是 | 清洁费 | price.detailStru.discount | float | 是 | 减免 | price.detailStru.driverOvertimePrice | float | 是 | 司机加班费 | price.detailStru.entDiscount | float | 是 | 企业优惠 | price.detailStru.kilometrePrice | float | 是 | 超出里程费/里程费 | price.detailStru.longDistancePrice | float | 是 | 远途费 | price.detailStru.otherPrice | float | 是 | 其他费用 | price.detailStru.outCityPrice | float | 是 | 出城费 | price.detailStru.parkingPrice | float | 是 | 停车费 | price.detailStru.pickupServiceCancelPrice | float | 是 | 接机礼宾取消费 | price.detailStru.pickupServicePrice | float | 是 | 接机礼宾费 | price.detailStru.startPrice | float | 是 | 套餐价/起租价 | price.detailStru.timePrice | float | 是 | 超出时长费/时长费 | price.detailStru.tollPrice | float | 是 | 路桥费 | price.detailStru.useCarSubsidies | float | 是 | 用车高峰补贴 | <font color='blue'>price.detailStru.waitTimePrice</font> | float | 是 | 等待时长费 | <font color='blue'>price.detailStru.driverFreeWaitTime</font> | float | 是 | 免费等待时长 | <font color='blue'>price.detailStru.driverWaitFeeLimit</font> | float | 是 | 等待时长费上限 | <font color='blue'>price.detailStru.driverWaitUnitPrice</font> | float | 是 | 等待时长费单价 | driver | json | 是 | 司机车辆信息 | driver.driverName | string | 否 | 司机姓名 | driver.vehicleNo | string | 否 | 车牌号 | driver.virtualPhone4Purchaser | string | 否 | 司机手机号(虚拟号码,给订车人用。当订车人和乘车人不是同一个人时,两个人联系司机的手机号不同) | driver.virtualPhone4Passenger | string | 否 | 司机手机号(虚拟号码,给乘车人用。当订车人和乘车人不是同一个人时,两个人联系司机的手机号不同) | driver.virtualPhone4SPPurchaser | string | 否 | 司机手机号(虚拟号码,给渠道订车人用。当渠道订车人和乘车人不是同一个人时,两个人联系司机的手机号不同) | driver.driverScore | string | 否 | 司机评分 | driver.driverLat | double | 否 |司机纬度 | driver.driverLng | double | 否 |司机经度 | driver.vehicleModel | string | 否 | 车型名称 | driver.vehicleColor | string | 是 | 车辆颜色 | pickupOrder | json | 是 | 接机礼宾订单信息 | pickupOrder.status | string | 是 | <a href="doc?r=guide/content#6-接机礼宾订单状态">接机礼宾订单状态</a> | pickupOrder.waiterName | string | 是 | 礼宾员姓名 | pickupOrder.waiterNo | string | 是 | 礼宾员工号 | pickupOrder.virtualPhone4Purchaser | string | 是 | 礼宾员手机号(虚拟号码,给订车人用,当订车人和乘车人不是同一个人时,两个人联系礼宾员的手机号不同) | pickupOrder.virtualPhone4Passenger | string | 是 | 礼宾员手机号(虚拟号码,给乘车人用,当订车人和乘车人不是同一个人时,两个人联系礼宾员的手机号不同) | <font color='blue'> priceStrategyFlag </font> | integer | 否 | 使用新旧价格体系标识, 0:使用旧价格体系,1:使用新价格体系(老接口默认值为0) ### 订单详情 -- 适用新价格体系 #### 权限范围 > 订单(order)--客户端模式或授权码模式或密码模式 #### 请求地址 /v1/resource/order/getOrderDetail #### 请求方式 HTTP/GET #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | orderId | string | 否 | 订单id #### 注意事项 <font color='blue'>响应数据说明中,蓝色标注字段为新报价体系新增的字段</font><br> 返回结果根据订单状态变化而不同: 1. 当订单状态为已派单后才会有司机信息,且司机的经纬度根据实际位置实时变化 2. 当订单状态为已提交费用之前费用信息显示为预估费用,已提交费用后显示为真实的费用信息 3. 当订单状态为已提交费用后,如果用户对订单费用有疑议并进行投诉,订单费用仍然有可能变化 4. 当订单状态为已提交费用后,才会显示代金券信息。因为此时费用已经确定,可以判断代金券是否适用本笔订单 5. 当订单状态为已完成时,所有的数据将不再发生变化 客户端模式:调用此接口需要进行企业管理员鉴权,可以查看企业员工下的企业订单详情。<br> 授权码模式(或密码模式):可以查看个人和企业订单详情。 #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": { "driver": { "driverLat": 0, "driverLng": 0, "driverName": "李师傅", "virtualPhone4Purchaser": "17081234041", "virtualPhone4Passenger": "17081234041", "virtualPhone4SPPurchaser": "17081234041", "driverScore": "5.0", "vehicleModel": "别克GL8", "vehicleColor": "白色", "vehicleNo": "津**1456" }, "order": { "autoPayTime": 1470711936, "carGroupId": 3, "realCarGroupId": 3, "cityId": 2, "createTime": 1470711184, "customData" : {"dOrderId":"35456983384","dCouponId":"5462395218","dCouponAmount":20} "departureTime": 1470711245, "dispatchedTime": 1470711200, "elat": 39.135483, "elng": 117.209202, "endAddress": "新纬路1号", "endName": "天津站", "employeeNumber" : 070804532, "finishedTime": 1470711276, "id": "6316656437168963587", "isDisagree": false, "isFixedPrice": false, "isDispatchedImmediately": true, "number": "27315150415317", "orderRemark": "", "orderScore": 0, "passengerName": "", "passengerMobile": "13167378647", "paymentStatus": "unpaid", "realElat": 39.159349, "realElng": 117.392584, "realEndAddress": "天津市东丽区保税区空港国际物流经济区漾美家居天津生活美学馆空港商务园东区", "realEndName": "天津市东丽区环河北路84号", "realSlat": 39.159349, "realSlng": 117.392584, "realStartAddress": "天津市东丽区保税区空港国际物流经济区漾美家居天津生活美学馆空港商务园东区", "realStartName": "天津市东丽区环河北路84号", "serviceId": 14, "slat": 39.159014, "slng": 117.393367, "startAddress": "保税区空港国际物流经济区商务园东区e13号", "startName": "奥凯航空有限公司(东二道)", "status": "feeSubmitted", "isPickupVip":false }, "price": { "arrearsPrice": "0", "couponDeductibleAmount": 0.0, "couponId": "", "detail": [{ "amount": "52", "name": "起租价" }, { "amount": "118.92", "name": "里程费(19.82公里)", "subDetail":[ {"name":"00:00-12:00(9.82公里)","amount":"50"}, {"name":"12:00-24:00(10公里)","amount":"68.92"} ] }, { "amount": "35", "name": "时长费(20分钟)", "subDetail":[ {"name":"00:00-12:00(9分钟)","amount":"15"}, {"name":"12:00-24:00(11分钟)","amount":"20"} ] }, { "amount": "19.28", "name": "远程费", "subDetail":[ {"name":"超过15-20公里部分(5公里)","amount":"30"}, {"name":"超过20公里部分(3.5公里)","amount":"20"} ] }, { "amount": "19.28", "name": "远途费", "subDetail":[ {"name":"超过15-20公里部分(5公里)","amount":"30"}, {"name":"超过20公里部分(3.5公里)","amount":"20"} ] }, { "amount": "19.28", "name": "出城费", "subDetail":[ {"name":"普通时段","amount":"30"}, {"name":"00:00-12:00","amount":"20"} ] }, { "amount": "10.0", "name": "等待时长费(10分钟)", "subDetail":[ {"name":"普通时段","amount":"0.8"}, {"name":"12:00-24:00","amount":"1"} ] }], "distance": 19820, "duration": 20, "equivalentPrice": 283, "totalPrice": "351" }, "pickupOrder":{ }, "priceStrategyFlag": 1 }, "msg": "成功", "status": "SUCCESS", "uid": "89e815cc-eec5-4043-80c0-b3c40b5cb83b1470709454232", "version": "002" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | order | json | 否 | 订单 | order.id | string | 否 | 订单id | order.number | string | 否 | 订单号(用于客户展示) | order.cityId | integer | 否 | 出发城市id | order.serviceId | integer | 否 | 服务类型 | order.carGroupId | integer | 否 | 预计车组类型 | order.realCarGroupId | integer | 否 | 实际车组类型(车辆类型),订单未分配时值为0<br/>如果下单车型没有空闲车辆,会免费升级车组类型 | order.status | string | 否 | <a href="doc?r=guide/content#1-订单状态">订单状态</a> | order.paymentStatus | string | 否 | <a href="doc?r=guide/content#4-支付状态">支付状态</a> | order.elng | double | 否 | 预计目的地经度 | order.elat | double | 否 | 预计目的地纬度 | order.slng | double | 否 | 预计出发经度 | order.slat | double | 否 | 预计出发纬度 | order.startName | string | 否 | 预计出发地名称 | order.startAddress | string | 否 | 预计出发地地址 | order.endName | string | 否 | 预计目的地名称 | order.endAddress | string | 否 | 预计目的地地址 | order.realElng | double | 是 | 实际目的地经度(订单状态为serviceFinished及之后才有效) | order.realElat | double | 是 | 实际目的地纬度(订单状态为serviceFinished及之后才有效) | order.realSlng | double | 是 | 实际出发经度(订单状态为serviceStarted及之后才有效) | order.realSlat | double | 是 | 实际出发纬度(订单状态为serviceStarted及之后才有效) | order.realStartName | string | 是 | 实际出发地名称(订单状态为serviceStarted及之后才有效) | order.realStartAddress | string | 是 | 实际出发地地址(订单状态为serviceStarted及之后才有效) | order.realEndName | string | 是 | 实际目的地名称(订单状态为serviceFinished及之后才有效) | order.realEndAddress | string | 是 | 实际目的地地址(订单状态为serviceFinished及之后才有效) | order.createTime | long | 否 | 订单创建时间 | order.customData.dOrderId | string | 是 | 第三方自定义订单号 | order.customData.dCouponId | string | 是 | 第三方自定义优惠券号 | order.customData.dCouponAmount | integer | 是 | 第三方自定义优惠券金额 | order.departureTime | long | 否 | 用车时间(unix时间戳) | order.dispatchedTime | long | 否 | 派单时间(unix时间戳) | order.finishedTime | long | 是 | 用户下车时间(unix时间戳)<br/> 未下车时值为0 | order.isDisagree | boolean | 否 | 是否有异议<br/> true:是异议订单<br/> false:不是异议订单 | order.isFixedPrice | boolean | 否 | 是否一口价订单 | order.canDisagree | boolean | 否 | 是否可疑议 | order.passengerMobile | string | 否 |乘客手机号 | order.passengerName | string | 否 |乘客姓名 | order.employeeNumber | string | 是 |员工工号,订单类型为企业单且配置了员工工号,该字段才有值 | order.orderScore | integer | 是 | 订单评分,订单完成时该字段才有意义 | order.orderRemark | string | 是 | 订单评价内容,订单完成时该字段才有意义 | order.isDispatchedImmediately | boolean | 否 | 是否立即派单 | order.companyId | long | 是 | 企业ID,非企业订单返回0 | order.dispatchingCountdown | integer | 是 | 派单倒计时 <br/>倒计时结束仍没有司机接单,那么订单自动被取消<br/> 立即派单且处于created状态的订单该字段才有意义 | order.rechargingCountdown | integer | 是 | 充值倒计时 <br/>倒计时结束仍没有充值,那么订单自动被取消<br/>订单处于created或已派单状态,但余额不足以支付该笔订单时该字段才有意义 | price | json | 是 | 费用描述 | price.totalPrice | string | 否 | 总费用<br/> 订单状态在feeSubmitted之前是预估费用,之后是实际产生的费用 | price.arrearsPrice | string | 否 | <p>本单欠费金额<p>如果此字段不为0,且订单处于新建或已派单状态,需要用户在已派单(立即派单)或创建订单(非立即派)后五分钟内进行充值,否则订单自动取消</p> | price.couponId | string | 是 | 代金券id,如果订单没有使用代金券,值为"" | price.couponDeductibleAmount | float | 是 | 代金券最终抵扣金额,如果订单没有使用代金券,值为0 | price.distance | float | 否 | 本单里程(米) | price.duration | float | 否 | 本单时长(分) | price.equivalentPrice | integer | 否 | 充值用户余额支付费用相当于的价格<br>例如:当前冲100送20,最终需要支付50 <br/>该字段值为40 | price.detail | array | 否 | 费用明细 | price.detail[].name | string | 否 | 明细名称 | price.detail[].amount | string | 否 | 金额 | <font color='blue'>price.detail[].subDetail | array | 否 | 子费用明细 | <font color='blue'>price.detail[].subDetail[].name</font> | string | 否 | 时间段或远程区间 | <font color='blue'>price.detail[].subDetail[].amount</font> | string | 否 | 子费用明细金额 | driver | json | 是 | 司机车辆信息 | driver.driverName | string | 否 | 司机姓名 | driver.vehicleNo | string | 否 | 车牌号 | driver.virtualPhone4Purchaser | string | 否 | 司机手机号(虚拟号码,给订车人用。当订车人和乘车人不是同一个人时,两个人联系司机的手机号不同) | driver.virtualPhone4Passenger | string | 否 | 司机手机号(虚拟号码,给乘车人用。当订车人和乘车人不是同一个人时,两个人联系司机的手机号不同) | driver.virtualPhone4SPPurchaser | string | 否 | 司机手机号(虚拟号码,给渠道订车人用。当渠道订车人和乘车人不是同一个人时,两个人联系司机的手机号不同) | driver.driverScore | string | 否 | 司机评分 | driver.driverLat | double | 否 |司机纬度 | driver.driverLng | double | 否 |司机经度 | driver.vehicleModel | string | 否 | 车型名称 | driver.vehicleColor | string | 是 | 车辆颜色 | pickupOrder | json | 是 | 接机礼宾订单信息 | pickupOrder.status | string | 是 | <a href="doc?r=guide/content#6-接机礼宾订单状态">接机礼宾订单状态</a> | pickupOrder.waiterName | string | 是 | 礼宾员姓名 | pickupOrder.waiterNo | string | 是 | 礼宾员工号 | pickupOrder.virtualPhone4Purchaser | string | 是 | 礼宾员手机号(虚拟号码,给订车人用,当订车人和乘车人不是同一个人时,两个人联系礼宾员的手机号不同) | pickupOrder.virtualPhone4Passenger | string | 是 | 礼宾员手机号(虚拟号码,给乘车人用,当订车人和乘车人不是同一个人时,两个人联系礼宾员的手机号不同) | <font color='blue'> priceStrategyFlag </font> | integer | 否 | 使用新旧价格体系标识, 0:使用旧价格体系,1:使用新价格体系(老接口默认值为0) ### 取消订单 #### 权限范围 > 订单(order)--客户端模式或授权码模式或密码模式 #### 请求地址 /v1/action/order/cancel #### 请求方式 HTTP/POST #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | orderId | string | 否 | 订单id | force | boolean | 是 | 是否强制取消(true 或 false)默认false | reason | string | 是,与resionId必须选其一 | 取消订单原因 | reasonId | integer | 是,与resion必须选其一 | 取消订单原因id<br>(取消订单原因列表获取) | cost | string | 是 | 扣费金额(保留两位小数),与实际扣费金额对比,一致时才会取消,为空时不判断 | preQueryFee | boolean | 是 | 是否预先查询取消费,传true,则返回取消费,不执行取消订单操作 #### 注意事项 1. 预先查询取消费,不取消订单,则preQueryFee传true,真正取消订单时preQueryFee不传,或传false。<br> 2. 在preQueryFee传false或不传的情况下:<br> 订单状态为已开始服务之前可以取消,取消订单会同步取消接机礼宾订单。<br> 不含接机礼宾服务的订单的订单状态为已到达之前取消订单不会产生任何费用,订单状态为已到达时取消订单可能会收取一定违约金(一般为起步价加上司机等待时长费/超时费)。<br> 参数force传值为false,如果不产生违约金会直接取消订单,如果产生违约金则返回违约金信息且不取消订单;值为true时,即使有违约金也会强制取消订单。<br> 参数cost传值非空时,会与实际计算的扣费金额对比,一致时才进行取消操作,传值为空时不做判断。<br> 首次调用该接口查询取消费金额且未取消订单后(参数force值为false),再次调用该接口取消订单(且cost值不为空)时,若两次调用时间间隔大于180秒,则取消订单失败。<br> 幂等接口,如果订单已经取消了,重复操作结果一致,重复操作以第一次成功执行reasonId与reason为准。<br> 客户端模式:调用此接口需要进行企业管理员鉴权,可以取消企业员工下的企业订单。<br> 授权码模式(或密码模式):可以取消个人和企业订单。 #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": { "needPay": true, "cost": "12.3", "baseCost":9.6, "driverWaitCost":3, "pickupCancelFee":0, "isCanceled": false, "priceStrategyFlag": 0 }, "msg": "成功", "status": "SUCCESS", "uid": "1bbd7033-8487-4fd5-bc5a-a31fc06974b91435284666082", "version": "001" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | needPay| boolean | 否 | 是否需要扣费 | cost | float | 否 | <p>扣费金额,如果传force=false且此订单司机已到达,就需要扣费(此订单未被取消,有可能产生扣费,需要确认),</p><p>这时如果要强制取消订单,需要再次请求此接口且传force=true,这时此订单会发生扣款(此订单强制取消)。</p><p>如果订单已经开始服务,那么该订单无法取消。</p> | baseCost| float | 否 | 基础费用 | driverWaitCost| float | 否 | 司机等待费用 | pickupCancelFee| float | 否 | 接机礼宾单取消费 | isCanceled | boolean | 否 | 取消是否成功 | <font color='blue'> priceStrategyFlag </font> | integer | 否 | 使用新旧价格体系标识, 0:使用旧价格体系,1:使用新价格体系(老接口默认值为0) ### 取消订单 -- 适用新报价体系 #### 权限范围 > 订单(order)--客户端模式或授权码模式或密码模式 #### 请求地址 /v1/action/order/cancel #### 请求方式 HTTP/POST #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | orderId | string | 否 | 订单id | force | boolean | 是 | 是否强制取消(true 或 false)默认false | reason | string | 是,与resionId必须选其一 | 取消订单原因 | reasonId | integer | 是,与resion必须选其一 | 取消订单原因id<br>(取消订单原因列表获取) | cost | string | 是 | 扣费金额(保留两位小数),与实际扣费金额对比,一致时才会取消,为空时不判断 | preQueryFee | boolean | 是 | 是否预先查询取消费,传true,则返回取消费,不执行取消订单操作 #### 注意事项 <font color='blue'>响应数据说明中,蓝色标注字段为新报价体系新增的字段</font><br> 1. 预先查询取消费,不取消订单,则preQueryFee传true,真正取消订单时preQueryFee不传,或传false。<br> 2. 在preQueryFee传false或不传的情况下:<br> 订单状态为已开始服务之前可以取消,取消订单会同步取消接机礼宾订单。<br> 不含接机礼宾服务的订单的订单状态为已到达之前取消订单不会产生任何费用,订单状态为已到达时取消订单可能会收取一定违约金(一般为起步价加上司机等待时长费/超时费)。<br> 参数force传值为false,如果不产生违约金会直接取消订单,如果产生违约金则返回违约金信息且不取消订单;值为true时,即使有违约金也会强制取消订单。<br> 参数cost传值非空时,会与实际计算的扣费金额对比,一致时才进行取消操作,传值为空时不做判断。<br> 首次调用该接口查询取消费金额且未取消订单后(参数force值为false),再次调用该接口取消订单(且cost值不为空)时,若两次调用时间间隔大于180秒,则取消订单失败。<br> 幂等接口,如果订单已经取消了,重复操作结果一致,重复操作以第一次成功执行reasonId与reason为准。<br> 客户端模式:调用此接口需要进行企业管理员鉴权,可以取消企业员工下的企业订单。<br> 授权码模式(或密码模式):可以取消个人和企业订单。 #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": { "needPay": true, "cost": "12.3", "baseCost":9.6, "driverWaitCost":3, "driverWaitCostDetail":[{"name":"00:00-12:00", "cost":1.0},{"name":"12:00-24:00", "cost":2.0}], "pickupCancelFee":0, "isCanceled": false, "priceStrategyFlag": 1 }, "msg": "成功", "status": "SUCCESS", "uid": "1bbd7033-8487-4fd5-bc5a-a31fc06974b91435284666082", "version": "001" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | needPay| boolean | 否 | 是否需要扣费 | cost | float | 否 | <p>扣费金额,如果传force=false且此订单司机已到达,就需要扣费(此订单未被取消,有可能产生扣费,需要确认),</p><p>这时如果要强制取消订单,需要再次请求此接口且传force=true,这时此订单会发生扣款(此订单强制取消)。</p><p>如果订单已经开始服务,那么该订单无法取消。</p> | baseCost| float | 否 | 基础费用 | driverWaitCost| float | 否 | 司机等待费用 | <font color='blue'>driverWaitCostDetail[].name</font>| string | 否 | 时间段 | <font color='blue'>driverWaitCostDetail[].cost| string</font> | 否 | 该时间段产生的等待费 | pickupCancelFee| float | 否 | 接机礼宾单取消费 | isCanceled | boolean | 否 | 取消是否成功 | <font color='blue'> priceStrategyFlag </font> | integer | 否 | 使用新旧价格体系标识, 0:使用旧价格体系,1:使用新价格体系(老接口默认值为0) ### 疑议订单 #### 权限范围 > 订单(order)--授权码模式或密码模式 #### 请求地址 /v1/action/order/doubt #### 请求方式 HTTP/POST #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | orderId | string | 否 | 订单id #### 注意事项 当订单状态为已提交费用及以后,已支付待评价及之前时可以调用该接口<br> 订单疑议后神州客服会主动联系乘客 #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": "SUCCESS", "msg": "成功", "status": "SUCCESS", "uid": "b1d63369-6099-4b40-8aff-c532b0b7a7021432020014134", "version": "001" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | content | string | SUCCESS为成功 | ### 进行中订单 #### 权限范围 > 订单(order)--授权码模式或密码模式 #### 请求地址 /v1/resource/order/current #### 请求方式 HTTP/GET #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token #### 注意事项 进行中订单状态包括:dispatched、arriving、arrived、serviceStarted #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": [{ "elat": 39.135483, "elng": 117.209206, "orderId": "6254394997847949342", "orderNo": "27277261140626", "orderStatus": "dispatched", "slat": 39.15992, "slng": 117.39242 }], "msg": "成功", "status": "SUCCESS", "uid": "b9339eb4-0845-4673-b3ea-2eb2e857b3061455521954623", "version": "001" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | [] | array | 是 | | [].orderId | string | 否 | 订单id | [].orderNo | string | 否 | 订单号(用于客户展示) | [].orderStatus | string | 否 | 订单状态 订单状态描述 | [].slat | double | 否 | 出发地纬度 | [].slng | double | 否 | 出发地经度 | [].elat | double | 否 | 目的地纬度 | [].elng | double | 否 | 目的地经度 ### 订单列表 #### 权限范围 > 往期订单(history)--授权码模式或密码模式 #### 请求地址 /v1/resource/order/history #### 请求方式 HTTP/GET #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | offset | integer | 是 | 开始索引位置 默认:0 | limit | integer | 是 | 返回数量(默认5,最大20) | orderStatus | integer | 是 | 订单状态(默认所有)<p>0 全部</p><p>1 当前订单</p><p>2 历史订单</p><p>3 已取消订单</p> #### 注意事项 只能查最近半年内的数据。 当前订单状态包括:created、dispatched、arriving、arrived、serviceStarted、serviceFinished、feeSubmitted、paid 历史订单状态包括:completed 已取消订单状态包括:canceled 如果进行过<a href="doc?r=api/content#企业鉴权">企业鉴权</a>,那么返回对应企业订单,否则返回个人订单 #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": { "limit": 2, "list": [{ "endCity": { "displayName": "天津站", "lat": 39.135483, "lng": 117.209206 }, "id": "6254394997847949342", "number": "27277261140625", "orderStatus": "canceled", "serviceId": "14", "passengerName": "", "passengerMobile": "13245678976", "paymentStatus": "", "price": "45", "startCity": { "displayName": "创新创业中心", "lat": 39.15992, "lng": 117.39242 }, "createTime": 1456214813, "departureTime": 1467095760, "finishedTime": 1467091884, "isPickupVip":false }], "offset": 0 }, "msg": "成功", "status": "SUCCESS", "uid": "8e9c0915-9b32-4cf1-a501-ce67dced423b1456904850049", "version": "001" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | offset | integer | 否 | 开始索引位置 | limit | integer | 否 | 每页数量 | list | array | 否 | 历史列表 | list[].id | string | 否 | 订单id | list[].number | string | 否 | 订单号(用于客户展示) | list[].serviceId | integer | 否 | 服务类型id | list[].orderStatus | string | 否 | 订单状态 | list[].paymentStatus | string | 否 | 支付状态 | list[].passengerName | string | 是 | 乘客姓名 | list[].passengerMobile | string | 否 | 乘客手机号 | list[].price | string | 否 | 费用 | list[].createTime | long | 否 | 订单创建时间(unix时间戳) | list[].departureTime | long | 否 | 用车时间(unix时间戳) | list[].finishedTime | long | 是 | 订单完成时间(unix时间戳)<br/>订单未完成时值为0 | list[].startCity | json | 否 | 开始城市 | list[].startCity.lat | double | 否 | 纬度 | list[].startCity.lng | double | 否 | 经度 | list[].startCity.displayName | string | 否 | 显示名称 | list[].endCity | json | 否 | 目的地城市 | list[].endCity.lat | double | 否 | 纬度 | list[].endCity.lng | double | 否 | 经度 | list[].endCity.displayName | string | 否 | 显示名称 | list[].isPickupVip | boolean | 是 | 是否使用接机礼宾服务 ### 订单司机位置 #### 权限范围 > 订单(order)--客户端模式或授权码模式或密码模式 #### 请求地址 /v1/resource/driver/getPosition #### 请求方式 HTTP/GET #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | orderId | string | 否 | 订单id #### 注意事项 返回结果根据订单状态变化而不同:<br> 1、当订单状态为已派单(预计上车时间12小时内)、已出发、已到达、已开始服务,才会有司机位置信息,且司机的经纬度根据实际位置实时变化。<br> 2、其他状态,接口会提示:不能获取司机位置。<br> 客户端模式:调用此接口需要进行企业管理员鉴权,可以查看企业员工下的企业订单司机位置。<br> 授权码模式(或密码模式):可查看个人和企业订单司机位置。 #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": { "driverLat":0, "driverLng":0, "driverName":"聂师傅" }, "msg": "成功", "status": "SUCCESS", "uid": "25de7ca9-947f-4c7e-8a1d-566d1cf658211550728336185", "version": "002" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | driverName | string | 否 | 司机姓名 | driverLat | double | 否 |司机纬度 | driverLng | double | 否 |司机经度 ### 根据第三方订单id获取神州订单id #### 权限范围 > 订单(order)--客户端模式或授权码模式或密码模式 #### 请求地址 /v1/resource/order/getOrderIdByDOrderId #### 请求方式 HTTP/GET #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | dOrderId | string | 否 | 第三方订单id #### 注意事项 第三方订单id,是创建订单时,传进来的第三方自定义数据里面的dOrderId字段。如果订单不存在,则返回空的orderId。 #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": { "orderId":"6438718716671623171" }, "msg": "成功", "status": "SUCCESS", "uid": "25de7ca9-947f-4c7e-8a1d-566d1cf658211550728336185", "version": "002" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | orderId | string | 否 | 神州订单id ### 推送订单风险标签 #### 权限范围 > 订单(order)--客户端模式或授权码模式或密码模式 #### 请求地址 /v1/action/order/pushOrderRishTag #### 请求方式 HTTP/POST #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | orderId | string | 否 | 订单id | eventType | string | 否 | 事件类型,固定值 01 :风险类别 | payload | string | 否 | <p>事件负载数据,json格式字符串,通过此事件来告知合作方该订单命中风控识别策略</p> <p>payload:{"riskNo": 风险类别编号 (必填),"riskType": 风险类别 (必填),"riskName":风险类别名称(非必填),"riskMsg": 风险类别说明(非必填)}</p> #### 注意事项 该接口需要先进行企业鉴权才能调用 #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": "SUCCESS", "msg": "成功", "status": "SUCCESS", "uid": "25de7ca9-947f-4c7e-8a1d-566d1cf658211550728336185", "version": "002" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | content | string | 否 | 返回SUCCESS为推送风险标签成功 ### 修改上车地点 #### 权限范围 > 订单(order)--授权码模式或密码模式 #### 请求地址 /v1/action/order/updateStart #### 请求方式 HTTP/POST #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | orderId | string | 否 | 订单id | slng | double | 否 | 出发地经度 | slat | double | 否 | 出发地纬度 | startName | string | 否 | 出发地名称 | startAddress | string | 否 | 出发地详细地址 #### 注意事项 #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": "SUCCESS", "msg": "成功", "status": "SUCCESS", "uid": "25de7ca9-947f-4c7e-8a1d-566d1cf658211550728336185", "version": "002" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | content | string | 否 | 返回SUCCESS为修改上车地点成功 ### 修改下车地点预估价格 -- 适用旧报价体系 #### 权限范围 > 订单(order)--授权码模式或密码模式 #### 请求地址 /v1/resource/common/order/estimateNewDestinationPrice #### 请求方式 HTTP/POST #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | orderId | string | 否 | 订单id | elng | double | 否 | 目的地经度 | elat | double | 否 | 目的地纬度 #### 注意事项 <font color='red'>响应数据说明中,标红的字段,会在新报价体系适用的接口中去除</font><br> <font color='blue'>蓝色标注字段为新增字段</font><br> #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": { "distance": 224090, "duration": 158, "couponAmount":0, "floatFactor": 1, "kilometrePrice": 1008.4, "longDistancePrice": 0, "longDistancePriceLimit": 0, "outCityPrice": 0, "perKilometrePrice": 4.5, "perLongDistancePrice": 0, "perTimePrice": 0.7, "price": 1159, "productKilometre": 0, "productTime": 0, "startPrice": 40, "timePrice": 110.6, "possibleGenerateOutCityPrice":0, "waitTimePrice": 70 }, "msg": "成功", "status": "SUCCESS", "uid": "25de7ca9-947f-4c7e-8a1d-566d1cf658211550728336185", "version": "002" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | distance | float | 否 | 预估距离(米)。如果服务类型为包车(8小时)或包车(4小时),该字段没有参考意义 | duration | float | 否 | 预估时长(分)。如果服务类型为包车(8小时)或包车(4小时),该字段没有参考意义 | price | float | 否 | 时租预估价格 / 套餐价格 / 一口价价格,结果已经乘以浮动系数 | timePrice | float | 否 | 时租时长费 / 套餐超出包含时长的费用,结果已经乘以浮动系数 | kilometrePrice | float | 否 | 时租里程费 / 套餐超出包含里程的费用,结果已经乘以浮动系数 | startPrice | float | 是 | 时租起步价/套餐起步价,结果已经乘以浮动系数 | floatFactor | float | 是 | 时租价格浮动系数(价格类型为时租时使用) | productKilometre | float | 是 | 套餐包含的里程(公里)(价格类型为套餐时使用) | productTime | float | 是 | 套餐包含的时长(分钟)(价格类型为套餐时使用) | couponAmount | float | 是 | 优惠金额 | <font color='red'>longDistancePrice</font> | float | 是 | 时租远途费,结果已经乘以浮动系数(价格类型为时租时使用) | <font color='red'>outCityPrice</font> | float | 是 | 时租出城费(价格类型为时租时使用) | <font color='red'>possibleGenerateOutCityPrice</font> | float | 是 | 当行程处于出城边缘时,可能产生出城费。用于提醒用户该行程可能产生出城费,以免造成用户投诉,该费用不计入总价中。注意:outCityPrice大于0时该字段一定大于0,outCityPrice等于0时该字段可能大于0。 | <font color='red'>perTimePrice</font> | float | 是 | 时租的时长单价 / 套餐超出包含时长的时长单价(N元/分钟),结果已经乘以浮动系数 | <font color='red'>perKilometrePrice</font> | float | 是 | 时租的里程单价 / 套餐超出包含里程的里程单价(N元/公里),结果已经乘以浮动系数 | <font color='red'>perLongDistancePrice</font> | float | 是 | 时租的远途费单价(N元/公里),结果已经乘以浮动系数 | <font color='red'>longDistancePriceLimit</font> | float | 是 | 时租的远途费距离界限(公里),超出此界限的距离计算远途费 | <font color='blue'>waitTimePrice</font> | float | 否 | 等待时长费,结果已经乘以浮动系数 ### 修改下车地点预估价格 -- 适用新报价体系 #### 权限范围 > 订单(order)--授权码模式或密码模式 #### 请求地址 /v1/resource/common/order/estimateNewDestinationPrice #### 请求方式 HTTP/POST #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | orderId | string | 否 | 订单id | elng | double | 否 | 目的地经度 | elat | double | 否 | 目的地纬度 #### 注意事项 <font color='blue'>该接口为新报价体系适用的接口,蓝色标注字段为新增字段</font><br> #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": { "distance": 224090, "duration": 158, "couponAmount":0, "floatFactor": 1, "kilometrePrice": 1008.4, "price": 1159, "productKilometre": 0, "productTime": 0, "startPrice": 40, "timePrice": 110.6, "longKilometerPrice":0, "outCityPrice":0, "farKilometer":0, "farKilometerPrice":0, "kilometrePriceDetails":[ {"name":"普通时段","distanceOrDuration":"112.05","unitPrice":"4.6","amount":"515.40"}, {"name":"12:00-24:00","distanceOrDuration":"112.05","unitPrice":"4.7","amount":"526.61"} ], "timePriceDetails":[ {"name":"普通时段","distanceOrDuration":"100","unitPrice":"0.8","amount":"80.0"}, {"name":"12:00-24:00","distanceOrDuration":"58","unitPrice":"0.9","amount":"52.2"} ], "longKilometerDetails":[ {"name":"00:00-12:00","longKilometerSegmentInfos":[ {"name":"超过15-25公里部分","distanceOrDuration":"10.0", "unitPrice":"1.5","amount":"15.0"}, {"name":"超过25公里部分","distanceOrDuration":"5.0", "unitPrice":"1.6","amount":"8.0"}] } ], "farKilometerDetails":[ {"name":"00:00-12:00","farKilometerSegmentInfos":[ {"name":"超过15-25公里部分","distanceOrDuration":"10.0", "unitPrice":"1.5","amount":"15.0"}, {"name":"超过25公里部分","distanceOrDuration":"5.0", "unitPrice":"1.6","amount":"8.0"}] } ], "waitTimePrices":[ {"name":"普通时段", "distanceOrDuration":"10","unitPrice":"0.8","amount":"8.0"}, {"name":"12:00-24:00", "distanceOrDuration":"10","unitPrice":"1","amount":"10"} ] }, "msg": "成功", "status": "SUCCESS", "uid": "25de7ca9-947f-4c7e-8a1d-566d1cf658211550728336185", "version": "002" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | distance | float | 否 | 预估距离(米)。如果服务类型为包车(8小时)或包车(4小时),该字段没有参考意义 | duration | float | 否 | 预估时长(分)。如果服务类型为包车(8小时)或包车(4小时),该字段没有参考意义 | price | float | 否 | 时租预估价格 / 套餐价格 / 一口价价格,结果已经乘以浮动系数 | timePrice | float | 否 | 时租时长费 / 套餐超出包含时长的费用,结果已经乘以浮动系数 | kilometrePrice | float | 否 | 时租里程费 / 套餐超出包含里程的费用,结果已经乘以浮动系数 | startPrice | float | 是 | 时租起步价/套餐起步价,结果已经乘以浮动系数 | floatFactor | float | 是 | 时租价格浮动系数(价格类型为时租时使用) | productKilometre | float | 是 | 套餐包含的里程(公里)(价格类型为套餐时使用) | productTime | float | 是 | 套餐包含的时长(分钟)(价格类型为套餐时使用) | couponAmount | float | 是 | 优惠金额 | <font color='blue'>prices[].longKilometerPrice</font> | float | 是 | 远程费 | <font color='blue'>prices[].outCityPrice</font> | float | 是 | 出城费 | <font color='blue'>prices[].farKilometer</font> | float | 是 | 远途距离 | <font color='blue'>prices[].farKilometerPrice</font> | float | 是 | 远途费 | <font color='blue'>prices[].kilometrePriceDetails[].name</font> | string | 是 | 时间段 | <font color='blue'>prices[].kilometrePriceDetails[].distanceOrDuration</font> | float | 是 | 该时间段走的里程 | <font color='blue'>prices[].kilometrePriceDetails[].unitPrice</font> | float | 是 | 里程费(每公里价格) | <font color='blue'>prices[].kilometrePriceDetails[].amount</font> | float | 是 | 该时间段总费用 | <font color='blue'>prices[].timePriceDetails[].name</font> | string | 是 | 时间段 | <font color='blue'>prices[].timePriceDetails[].distanceOrDuration</font> | float | 是 | 该时间段走的时长 | <font color='blue'>prices[].timePriceDetails[].unitPrice</font> | float | 是 | 时长费(每分钟价格) | <font color='blue'>prices[].timePriceDetails[].amount</font> | float | 是 | 该时间段总费用 | <font color='blue'>prices[].longKilometerDetails[].name</font> | string | 是 | 时间段 | <font color='blue'>prices[].longKilometerDetails[].<br> longDistanceSegmentInfo[].name</font> | string | 是 | 产生远程费的区间 | <font color='blue'>prices[].longKilometerDetails[].<br> longDistanceSegmentInfo[].distanceOrDuration</font> | float | 是 | 该区间的远程里程数 | <font color='blue'>prices[].longKilometerDetails[].<br> longDistanceSegmentInfo[].unitPrice</font> | float | 是 | 远程费(每公里价格) | <font color='blue'>prices[].longKilometerDetails[].<br> longDistanceSegmentInfo[].amount</font> | float | 是 | 该区间的远程费用 | <font color='blue'>prices[].farKilometerDetails[].name</font> | string | 是 | 时间段 | <font color='blue'>prices[].farKilometerDetails[].<br> farDistanceSegmentInfo[].name</font> | string | 是 | 产生远途费的区间 | <font color='blue'>prices[].farKilometerDetails[].<br> farDistanceSegmentInfo[].distanceOrDuration</font> | float | 是 | 该区间的远途里程数 | <font color='blue'>prices[].farKilometerDetails[].<br> farDistanceSegmentInfo[].unitPrice</font> | float | 是 | 远途费(每公里价格) | <font color='blue'>prices[].farKilometerDetails[].<br> farDistanceSegmentInfo[].amount</font> | float | 是 | 该区间的远途费用 | <font color='blue'>prices[].waitTimePrices[].name</font> | string | 否 | 时间段 | <font color='blue'>prices[].waitTimePrices[].distanceOrDuration</font> | float | 是 | 该时间段等待超时时长 | <font color='blue'>prices[].waitTimePrices[].unitPrice</font> | float | 是 | 等待时长费(每分钟价钱) | <font color='blue'>prices[].waitTimePrices[].amount</font> | float | 是 | 该时间段总费用 ### 修改下车地点 #### 权限范围 > 订单(order)--授权码模式或密码模式 #### 请求地址 /v1/action/order/updateEnd #### 请求方式 HTTP/POST #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | orderId | string | 否 | 订单id | elng | double | 否 | 目的地经度 | elat | double | 否 | 目的地纬度 | endName | string | 否 | 目的地名称 | endAddress | string | 否 | 目的地详细地址 #### 注意事项 #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": "SUCCESS", "msg": "成功", "status": "SUCCESS", "uid": "25de7ca9-947f-4c7e-8a1d-566d1cf658211550728336185", "version": "002" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | content | string | 否 | 返回SUCCESS为修改上车地点成功 ### 竞价成功结果通知 #### 权限范围 > 第三方系统 #### 请求地址 /v1/resource/order/biddingNotice #### 请求方式 HTTP/POST #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | orderId | string | 否 | 订单id #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": { "orderId": "6438718716671623171" }, "msg": "成功", "status": "SUCCESS", "uid": "c9874a85-04c7-4fd2-b58b-6e304f8af7ff1432016014489", "version": "001" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | orderId | string | 否 | 订单id ### 获取订单司机真实号码 #### 权限范围 > 第三方系统 #### 请求地址 /v1/resource/queryDriverPhone #### 请求方式 HTTP/GET #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | orderId | string | 否 | 订单id | ptnOrderId | string | 否 | 第三方订单Id #### 注意事项 获取对应渠道下订单的司机真实号码 #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": { "driverPhone": "18200000011", "driverSalutation": "z师傅" }, "handler": "CLIENT", "msg": "成功", "status": "SUCCESS", "uid": "edab68c4-e9d4-41c3-b924-c82b154c0f64", "version": "001" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | driverPhone | string | 否 | 司机真实手机号 | driverSalutation | string | 否 | 司机称呼 ## 支付 ### 评价订单 #### 权限范围 > 结算(payment)--授权码模式或密码模式 #### 请求地址 /v1/action/order/comment #### 请求方式 HTTP/POST #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | orderId | string | 否 | 待评价订单id | score | integer | 否 | 评分。5分为最高分 1,2,3,4,5 | remark | string | 是 | 评论内容。5分时可以不填。 #### 注意事项 当司机提交完费用后,订单会立即自动支付,这时订单会流转到已支付待评价状态,然后才能调用该接口。评价完成后订单流转到已完成状态<br> 该接口不是必须接口。当订单状态流转到已支付待评价,48小时后订单会被自动评价,默认五星好评 #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": "SUCCESS", "msg": "成功", "status": "SUCCESS", "uid": "89e815cc-eec5-4043-80c0-b3c40b5cb83b1470709454232", "version": "002" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | content | string | 否 | 返回SUCCESS表示评价成功 ### 第三方支付通知 #### 权限范围 > 结算(payment)--客户端或授权码模式或密码模式 #### 请求地址 /v1/action/order/partner/payment/notify #### 请求方式 HTTP/POST #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | orderId | string | 否 | 已支付订单id | channelCouponId | string | 是 | 优惠券id | channelCouponAmount | double | 是 | 优惠金额 #### 注意事项 通知神州,用户已经支付用车费用。订单状态处于feeSubmitted及后续状态方可调用。 幂等接口,若为使用统一企业账号替用户订车模式,强烈建议调用该接口,来降低刷单风险。需要先进行<a href="doc?r=api/content#企业鉴权">企业鉴权</a>。 第三方开发者申请企业账户,用统一的企业帐号替用户订车。用车结束后,神州直接从企业账户中扣除账户余额,进行订单支付。 用户和神州不存在支付关系,用户直接将用车费用支付给第三方开发者。用户支付完费用后,调用该接口,通知神州用户已付款。 优惠金额为神州专车在渠道平台投放的优惠,不含渠道平台自投放的优惠。按行程开票时开票金额不包含该部分优惠金额。 调用该接口需联系<a href="?r=faq/contact" target="_blank">神州技术人员</a> #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": "SUCCESS", "msg": "成功", "status": "SUCCESS", "uid": "89e815cc-eec5-4043-80c0-b3c40b5cb83b1470709454232", "version": "002" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | content | string | 否 | 返回SUCCESS表示评价成功 ## 充值 ### 充值 #### 权限范围 > 充值(recharge_no_pltfm)--客户端或授权码模式或密码模式 #### 请求地址 /v1/action/tradingplatform/recharge #### 请求方式 HTTP/POST #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | payType | integer | 否 | 支付类型<p>1 支付宝-wap<p/><p> 2 微信-sdk<p/><p>3 支付宝-sdk<p/><p>4 京东网银-wap<p/><p>6 充值卡<p/><p>7 苹果支付-sdk<p/><p>12 招行一网通-小程序<p/> | payAmount | integer | 是 | 单位元(充值卡时不用传此参数) | orderId | string | 是 | 订单id<p>充值成功后,自动支付该笔订单<p/> | mobile | string | 否 | 充值用户手机号 | rechargePwd | string | 是 | 充值卡密码(充值卡充值时必填) | successUrl | string | 是 | 充值成功跳转页面(wap版充值时必填) | failedUrl | string | 是 | 充值失败跳转页面(wap版充值时必填) #### 注意事项 第三方开发者没有交易中心时使用该接口,钱直接打到神州账户。该接口不是必须接口 如果已经进行过<a href="doc?r=api/content#企业鉴权">企业鉴权</a>,且企业支付模式为员工垫付,那么给员工企业账户充值,否则给个人账户充值 #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": { "payParams": "partner=\"2088121068507655\"&seller_id=\"guojing@zuche.com\"&out_trade_no=\"01127315677662757\"&subject=\"神州专车产品\"&body=\"神州专车产品\"&total_fee=\"500.0\"¬ify_url=\"http://paytest.10101111.com:9080/cartp/jsp/alipay/alipayNotify.jsp\"&service=\"mobile.securitypay.pay\"&payment_type=\"1\"&_input_charset=\"utf-8\"&it_b_pay=\"30m\"&sign=\"Frxg9RbA%2BMGrR8Vb3fqnpT9989KTwTGKSlqDm8izuzH29%2BJJqebBISpLKm5dd4bbUF7wIH%2BLM0E%2BdiaKfL2UH2ExtlrlNUz%2Bxj3%2Fgu9uvMVzPzqB8H085O6J5ne%2BkAjOGGIgNMskOXkCWQ0DOjsi4KSXE4D5iKs%2B7l%2Bg6Lz9Yi4%3D\"&sign_type=\"RSA\"", "payType": "3", "paymentStatus": "1" }, "msg": "成功", "status": "SUCCESS", "uid": "bd622695-4675-44b5-aa21-5d39bdbec7c81471504651990", "version": "002" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | payParams | string | 否 | 支付宝、微信、apple pay的sdk请求参数 | paymentStatus | string | 否 | 1成功0失败2处理中 | payType | string | 否 | 支付编码 ### 获得交易流水号 #### 权限范围 > 充值(recharge_has_pltfm)--授权码模式或密码模式 #### 请求地址 /v1/action/trading/getTransactionRecord #### 请求方式 HTTP/POST #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | paymentMethod | string | 否 | 支付方式<p>"ALIPAY"-----(支付宝)<p/> | orderId | string | 是 |神州订单号,不传为充值。传为充值并支付订单 | mobile | string | 否 | 充值用户手机号 #### 注意事项 获得交易流水号,通知神州将有一笔充值发生。该接口不是必须接口 第三方开发者有交易中心时使用该接口,钱先打到开发者账户,然后开发者再将钱打入神州对应账户,最后调用<a href="#支付成功通知">支付成功通知接口</a>,通知神州钱已到神州账户 如果已经进行过<a href="doc?r=api/content#企业鉴权">企业鉴权</a>,且企业支付模式为员工垫付,那么给员工企业账户充值,否则给个人账户充值 #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": { "callbackAddress": "http://paypre.10101111.com/cartp/jsp/openAPI/openApiNotify.jsp", "doTime": 1470794079, "recordId": "21127315216530526", "status": 1 }, "msg": "成功", "status": "SUCCESS", "uid": "89e815cc-eec5-4043-80c0-b3c40b5cb83b1470709454232", "version": "002" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | status | integer | 否 | 0失败 1成功 | recordId | string | 否 | 流水号 | callbackAddress | string | 否 | 支付成功回调地址<p>钱被打到神州账户后,通知神州钱已到账<p/> | doTime | long | 否 | 操作时间(unix时间戳) ### 支付成功通知 #### 权限范围 > 不需要任何权限 #### 请求地址 请求地址在接口/v1/action/trading/getTransactionRecord中返回 #### 请求方式 HTTP/POST #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | recordId | string | 否 | 神州返回的交易流水号 | replyId | integer | 否 | 第三方支付交易流水号 | businessMoney | integer | 否 | 交易金额(单位元) | clientId | string | 否 | 开发者id | status | string | 否 | 支付状态(0:失败 1:成功 2:待交易) | errMsg | string | 是 | 异常信息 | sign | string | 否 | 签名串(RSA签名,可以使用openssl工具制作一对公私钥)<p>errMsg、sign 不参与签名。<p/><p>其他参数按照列表顺序签名,空值也参与签名。<p/><p>签名字段拼接方式如下:key=value&key=value<p/> #### 注意事项 通知神州钱已打到神州账户,神州将钱发放到对应充值账户。该接口不是必须接口<br> 调用该接口需重试机制,如果调用接口失败,请重调直至成功,否则钱不会打到用户账户<br> 第三方开发者有交易中心时使用该接口,钱先打到开发者账户,然后开发者再将钱打入神州对应账户 #### 参数签名代码示例 ``` import org.apache.commons.codec.binary.Base64; import java.security.KeyFactory; import java.security.PrivateKey; import java.security.Signature; import java.security.spec.PKCS8EncodedKeySpec; public class TestSign{ public String getSign() throws Exception{ //需要加签的参数串 String data = "recordId=1234&replyId=1234&businessMoney=1.0&clientId=ABCD&status=1"; //私钥 String priKey = "MIICdgIBADANBgkqhkiG9w0BAQEFAASCAmGELHy1kIHpAKiSadMjfEtvSmqoa0oE8g6hkplm9F8p0w=="; PKCS8EncodedKeySpec pkcs8EncodedKeySpec = new PKCS8EncodedKeySpec(Base64.decodeBase64(priKey)); KeyFactory keyFactory = KeyFactory.getInstance("RSA"); PrivateKey privateKey = keyFactory.generatePrivate(pkcs8EncodedKeySpec); Signature signature = Signature.getInstance("SHA1WithRSA"); signature.initSign(privateKey); signature.update(data.getBytes("UTF-8")); byte[] signbyte = signature.sign(); return Base64.encodeBase64String(signbyte); } } ``` #### 响应数据 > 数据仅供参考 ``` success ``` #### 响应数据说明 SUCCESS ----- 成功<br> 回调请求处理成功,会返回success信息,处理失败不做响应,请求会超时,请发起回调重试。 ## 用户 ### 用户信息 #### 权限范围--授权码模式或密码模式 > 用户(profile) #### 请求地址 /v1/resource/user/getUserInfo #### 请求方式 HTTP/GET #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token #### 注意事项 无 #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": { "accountBalance": "10000269", "companyAccountBalance": "-1", "companyPayType": 2, // 待废弃 "companyQuotaType": 1, "companyRemainAmount": "0.0", "payType": 2, "email": "86605@qq.com", "id": "51055", "name": "王二麻", "phone": "13111111111", "picture": "", "sex": 1, "uninvoiceAmount": "10000003" }, "msg": "成功", "status": "SUCCESS", "uid": "700d53bd-4d0a-4096-9bf0-37311a9a4c10", "version": "002" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | name| string | 是 | 名字 | sex | integer | 是 | 性别(1:男,2:女) | phone | string | 否 | 手机号 | picture | string | 是 | 用户图片 | email | string | 是 | 邮箱地址 | accountBalance | string | 否 | 个人账户余额 | payType | integer | 是 | 支付类型,<p>1 个人支付</p><p>2 企业支付(企业鉴权后才有)</p><p>3 员工垫付(企业鉴权后才有)</p> | uninvoiceAmount | string | 否 | 个人账户可开票金额(开发票时使用) | companyAccountBalance | string | 是 | 员工企业账户余额,默认-1(企业鉴权后且员工垫付时才有) | companyRemainAmount | string | 是 | 员工在企业中剩余额度,默认-1(企业鉴权后才有) | companyQuotaType | intger | 是 | 员工用车额度类型,默认-1(企业鉴权后才有)<p>1 是不限<p>2 是月<p>3 是季度<p>4 是年 ### 用户收藏地址 #### 权限范围 > 用户(profile)--授权码模式或密码模式 #### 请求地址 /v1/resource/user/getSavedAddress #### 请求方式 HTTP/GET #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | cityId | integer | 否 | 当前城市id。如果传递此参数,只返回该城市的收藏地址。 #### 注意事项 无 #### 响应数据 > 数据仅供参考 ``` { busiCode: "BASE000", code: 1, content: [{ address: "东丽区东二道", nickname: "空港商务园区", cityId: 2, cityName: "天津", label: "公司", lat: "39.15967900000000000000", lng: "117.39286000000000000000", type: 2 }, { address: "东丽区空港中心大道二道麦当劳旁空港东区商务园(近东二道)", nickname: "奥特莱斯", cityId: 2, cityName: "天津", label: "普通", lat: "39.15909100000000000000", lng: "117.39086100000000000000", type: 3 }], msg: "成功", status: "SUCCESS", uid: "b9339eb4-0845-4673-b3ea-2eb2e857b3061455521954623", version: "200" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | content | array | 否 | 地址数组 | content[].address | string | 否 | 地址 | content[].nickname | string | 否 | 名称 | content[].cityId | integer | 否 | 城市id | content[].cityName | string | 否 | 城市名称 | content[].label | string | 否 | 收藏地址标签 | content[].lat | string | 否 | 纬度 | content[].lng | string | 否 | 经度 | content[].type | integer | 否 | <p>收藏地址类型</p><p>1:家, 2:公司, 3:普通</p> ## 发票 ### 开发票 #### 权限范围 > 发票(invoice)--客户端模式或授权码模式或密码模式 #### 请求地址 /v1/action/receipt/create #### 请求方式 HTTP/POST #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | receiveEmail | String | 是 | 接收电子发票邮箱地址(电子发票必填) | receiptContent | String | 否 | 发票内容,目前发票内容仅限:客运服务费 | receiptHead | String | 否 | 发票头 | receiptType | integer | 否 | 开票类型 1:金额,2:行程 | numOfReceipt | integer | 是 | 发票数量(按金额开票时使用) | amountPerReceipt | double | 是 | 每张发票金额(按金额开票时使用) | isOnePiece | boolean | 是 | 是否只开一张发票,true:所有行程一张发票,false:一个行程一张发票(用于行程开票) | orderIds | String | 是 | 订单id。用,号分开(用于行程开票) | taxpayerIdentiNumber | String | 是 | 纳税人识别号开企业抬头发票或企业鉴权后为必填 | registerAddress | String | 是 | 注册地址 | registerTelphone | String | 是 | 注册手机号 | bankName | String | 是 | 开户银行 | bankAccount | String | 是 | 银行账号 #### 注意事项 3秒内只能调用一次 只能开具电子发票<br> 因存在调账等场景,为防止出现发票金额与接入方订单金额不匹配的情况,强烈建议使用按金额开票<br> 个人订单:按行程开票,一次最多选50条行程;按金额开票,一次最多开10张发票,每张最多99999块。 <br/>企业订单:按行程开票,一次最多选200条行程,按金额开票,一次最多开10张发票,每张最多99999块。 客户端模式,只能开企业订单发票,调用此接口需要进行<a href="doc?r=api/content#企业鉴权">企业管理员鉴权</a>,企业支付管理员可按照行程或金额开取发票;员工垫付管理员只能按照行程开取发票。 授权码模式(或密码模式),可开个人订单发票和企业订单发票。 通过企业鉴权:可开取企业订单发票业务,员工只能按照自己的企业订单行程开发票。 企业未鉴权:可开取个人订单发票业务,可按照行程或金额开取发票。 #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": { "receiptId": "148886" }, "msg": "成功", "status": "SUCCESS", "uid": "5ed3f054-8678-4f80-90d0-e5e9e6bf974e", "version": "001" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | receiptId | string | 否 | 开票记录主键 ### 重发电子发票 #### 权限范围 > 发票(invoice)--客户端模式或授权码模式或密码模式 #### 请求地址 /v1/action/receipt/resendEmail #### 请求方式 HTTP/POST #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | email | string | 是 | 接收电子发票邮箱地址(为空发送到原始邮箱,不为空发送到该邮箱) | receiptId | string | 否 | 开票记录主键 #### 注意事项 客户端模式,调用此接口需要进行<a href="doc?r=api/content#企业鉴权">企业管理员鉴权</a>,可以重发该企业下所有的电子发票。 授权码模式(或密码模式),只可重发自己的电子发票。 #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": "SUCCESS", "msg": "成功", "status": "SUCCESS", "uid": "5ed3f054-8678-4f80-90d0-e5e9e6bf974e", "version": "001" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | content | string | 否 | 返回SUCCESS表示重发成功 ### 可开发票行程 #### 权限范围 > 发票(invoice)--客户端模式与授权码模式与密码模式 #### 请求地址 /v1/resource/receipt/getOrderList #### 请求方式 HTTP/GET #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | offset | integer | 是 | 起始位置 默认:0 | limit | integer | 是 | 返回条数量(默认5,最大30) #### 注意事项 包含当前订单和历史订单,只可查询最近半年内的记录 客户端模式调用此接口需要进行<a href="doc?r=api/content#企业鉴权">企业管理员鉴权</a> #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": { "limit": 5, "list": [{ "endName": "天津站", "orderAmount": "20.0", "orderId": "6254392034320515102", "orderNo": "27277261140626", "orderTime": 1456214123, "passengerName": "成", "passengerMobile": "13102081810", "receiptAmount": "20.0", "startName": "创新创业中心" }, { "endName": "天津站", "orderAmount": "26.0", "orderId": "6254024140306841630", "orderNo": "27277261140628", "orderTime": 1456128466, "passengerName": "成", "passengerMobile": "13102081810", "receiptAmount": "26.0", "startName": "东二道与丰和路交叉口" }, { "endName": "佳喜顺精品超市", "orderAmount": "22.0", "orderId": "6251779942585270302", "orderNo": "27277261140629", "orderTime": 1455605948, "passengerName": "成", "passengerMobile": "13102081810", "receiptAmount": "22.0", "startName": "创新创业中心" }], "offset": 0 }, "msg": "成功", "status": "SUCCESS", "uid": "8e9c0915-9b32-4cf1-a501-ce67dced423b1456904850049", "version": "001" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | offset | integer | 否 | 起始位置 | limit | integer | 否 | 返回条数 | list | array | 否 | 行程列表 | list[].orderAmount | string | 否 | 订单金额 | list[].receiptAmount | string | 否 | 订单可开票金额 | list[].orderTime | long | 否 | 下单时间(unix时间戳) | list[].startName | string | 否 | 出发地名称 | list[].endName | string | 否 | 目的地名称 | list[].orderId | string | 否 | 订单id | list[].orderNo | string | 否 | 订单号(用于客户展示) | list[].passengerMobile | string | 否 | 乘客电话 | list[].passengerName | string | 否 | 乘客名字 | list[].serviceId | integer | 否 | 服务类型id ### 开发票列表 #### 权限范围 > 往期开票(invoice_history)--客户端模式与授权码模式与密码模式 #### 请求地址 /v1/resource/receipt/history #### 请求方式 HTTP/GET #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | offset | integer | 是 | 起始位置 默认:0 | limit | integer | 是 | 返回条数量(默认5,最大30) | receiptId | string | 是 | 开票记录主键 #### 注意事项 只可查询最近半年内的记录 客户端模式调用此接口需要进行<a href="doc?r=api/content#企业鉴权">企业管理员鉴权</a> #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": { "limit": 2, "list": [{ "createTime": 1455870182, 'expressCompany": "顺丰快递", "expressNo": "15246987321214", "numOfReceipt": 2, "receiptAmount": "44.0", "receiptHead": "专车费", "receiptId": "146740", "receiptStatus": "waitInvoice", "receiptStatusDesc": "待开票", "receiptType": 2, "receivePerson": "成", "receiptMode": 1, "receiveEmail": "" }, { "createTime": 1455866527, 'expressCompany": "EMS", "expressNo": "1452486953651489", "numOfReceipt": 1, "receiptAmount": "37.0", "receiptHead": "专车费", "receiptId": "146734", "receiptStatus": "waitInvoice", "receiptStatusDesc": "待开票", "receiptType": 2, "receivePerson": "成", "receiptMode": 1, "receiveEmail": "" }], "offset": 0 }, "msg": "成功", "status": "SUCCESS", "uid": "8e9c0915-9b32-4cf1-a501-ce67dced423b1456904850049", "version": "200" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | offset | integer | 否 | 起始位置 | limit | integer | 否 | 返回条数 | list | array | 否 | 发票列表 | list.[].expressCompany | string | 是 | 快递公司名称 | list.[].expressNo | string | 是 | 快递单号 | list.[].receiptType | integer | 否 | 开票类型 1:金额,2:行程 | list.[].receiptMode | integer | 否 | 发票形式 1:纸质,2:电子 | list.[].receiptAmount | string | 否 | 开票总金额 | list.[].numOfReceipt | integer | 否 | 开票数量 | list.[].receiptStatus | string | 否 | 发票状态 | list.[].receiptStatusDesc | string | 否 | 状态描述 | list.[].createTime | long | 否 | 开票时间(unix时间戳) | list.[].receiptId | string | 否 | 开票记录主键 | list.[].receiptHead | string | 否 | 发票抬头 | list.[].receivePerson | string | 是 | 发票接收人 | list.[].receiveEmail | string | 是 | 接收电子发票邮箱地址 ## 代金券 ### 领取代金券 #### 权限范围 > 领券(get_coupon)--客户端或授权码模式或密码模式 #### 请求地址 /v1/action/coupon/get #### 请求方式 HTTP/GET #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | mobile | string | 否 | 手机号 | unifiedCode | string | 是 | 统一领取编码(神州专车提供) | separateCode | string | 是 | 单独领取编码(神州专车提供) #### 注意事项 该接口不是必须接口,需<a href="?r=faq/contact" target="_blank">商务合作</a> #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": { "message": "领取成功", "money": 50, "status": 1, "coupons": [ { "id": "62342343456242343", "invitationCode": "1241234adf", "couponKind": 1, "discountRate": "", "endTime": 1466697599, "startTime": 1465401600, "amount": 10 } ] }, "msg": "成功", "status": "SUCCESS", "uid": "34e8f92e-5df5-42eb-81b7-e72b462dac311464830391697", "version": "001" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | message | string | 否 | 领取状态描述 | money | double | 否 | 领取代金券金额 | status | integer | 否 | 代金券领取状态<p>1 领取成功</p><p>2 已领取</p><p>3 领取失败</p><p>4 抢光了</p><p>5 活动未开始</p><p>6 活动已结束</p><p>7 未找到配置信息</p><p>8 不符合领取条件</p><p>9 与已领取活动互斥</p><p>10 兑换码活动不能直接领取</p><p>11 兑换码已被领取</p><p>12 兑换码已过期</p><p>13 兑换码已使用</p><p>14 兑换码错误</p> | coupons | array | 否 | | coupons[].id | string | 是 | 代金券id | coupons[].invitationCode | string | 是 | 代金券邀请码 | coupons[].amount | integer | 是 | 代金券金额 | coupons[].startTime | long | 否 | 代金券有效期始(unix时间戳 ) | coupons[].endTime | long | 否 | 代金券有效期止(unix时间戳 ) | coupons[].couponKind | integer | 否 | 代金券类型(1:金额,2:折扣) | coupons[].discountRate | string | 是 | 折扣比例值 ### 个人代金券列表 #### 权限范围 > 代金券(coupon)--授权码模式或密码模式 #### 请求地址 /v1/resource/coupon/getCouponListForMember #### 请求方式 HTTP/GET #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | offset | integer | 是 | 开始索引位置,默认0 | limit | integer | 是 | 返回数量(默认为5,最大20) | queryType | integer | 否 |查询类型(1:未使用 2:已使用/已过期) #### 注意事项 该接口不是必须接口,需<a href="?r=faq/contact" target="_blank">商务合作</a><br> 该接口返回个人拥有的代金券 #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": { "limit": 2, "list": [ { "amount": 20, "carTypeScope": "豪华轿车 商务7座 公务轿车", "count": 2, "couponId": "6308858469185814529", "couponKind": 1, "couponScopeDescList": [ "1、结算时满60元可用", "2、限送机/接机使用", "3、此代金券仅限神州专车渠道使用" ], "discountRate": "", "endTime": 1474127999, "ids": [ "6308858469185814530", "6308858469185814529" ], "invitationCode": "", "startTime": 1468857600, "status": 0, "statusDesc": "未使用", "title": "专车券" } ], "offset": 0 }, "msg": "成功", "status": "SUCCESS", "uid": "bd622695-4675-44b5-aa21-5d39bdbec7c81471504651990", "version": "002" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | offset | integer | 否 | 开始索引位置 | limit | integer | 否 |每页数量 | list | array | 否 | 代金券列表 | list[].couponId | string | 否 | 代金券id | list[].carTypeScope | string | 否 | 车辆适用范围 | list[].status | integer | 否 | 使用状态(0:未使用 1:已冻结 2:已使用) | list[].statusDesc | string | 否 | 使用状态描述 | list[].amount | integer | 否 | 代金券金额 | list[].startTime | long | 否 | 代金券有效期始(unix时间戳 ) | list[].endTime | long | 否 | 代金券有效期止(unix时间戳 ) | list[].couponScopeDescList | array<string> | 否 | 使用规则描述 | list[].title | string | 否 | 代金券标题(通用券,限制使用) | list[].couponKind | integer | 否 | 代金券类型(1:金额,2:折扣) | list[].discountRate | float | 否 | 折扣比例值 | list[].count | integer | 否 | 同类代金券个数 | list[].ids | array<String> | 否 | 同类代金券id集合 ### 下单推荐代金券列表 #### 权限范围 > 代金券(coupon)--授权码模式或密码模式 #### 请求地址 /v1/resource/coupon/getCouponListForOrder #### 请求方式 HTTP/GET #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | offset | integer | 是 | 开始索引位置,默认0 | limit | integer | 是 | 返回数量(默认为5,最大20) | serviceId | integer | 否 | 服务类型id(7:接机 8:送机 11:包车(4小时) 12:包车(8小时) 13:预约用车 14:立即叫车) | carGroupId | integer | 否 | 车组id | cityId | integer | 是 | 出发城市id(如果为空,则根据出发地经纬度定位城市) | passengerMobile | string | 否 | 乘客手机号 | slat | double | 是 | 出发地纬度(服务类型为“接机”时可为空) | slng | double | 是 | 出发地经度(服务类型为“接机”时可为空) | departureTime | long | 是 | <p>出发时间(unix时间戳)(服务类型为"立即叫车"或“接机”时可为空)</p><p>时间范围:立即叫车为当前日期,预约用车/包车(8小时)/包车(4小时)为当前日期 至 当前日期+30天</p><p>例如:当前日期为2016-3-4 10:00,则日期范围:2016-3-4 10:00(含) 至 2016-4-3 23:59(含)</p> | flt | string | 是 | 航班号 | flightDate | long | 是 | <p>航班起飞日期(unix时间戳)<p>日期范围:当前日期-3天 至 当前日期+30天</p><p>例如:当前日期为2016-3-4,则日期范围:2016-3-1(含) 至 2016-4-3(含)</p> | flightDelayTime | integer | 是 | <p>司机在航班到达后,N分钟后到达上车地点</p><p>时间范围:10(含) 至 90(含)</p> | airCode | string | 是 | 接机机场三字码 | estimatePrice | float | 否 | 订单预估金额 #### 注意事项 该接口不是必须接口,需<a href="?r=faq/contact" target="_blank">商务合作</a> #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": { "limit": 10, "list": [ { "carTypeScope": "", "couponId": "6294045049710575617", "couponKind": 1, "couponScopeDescList": [ ], "discountRate": "", "endTime": 1466697599, "startTime": 1465401600, "status": 0, "statusDesc": "未使用" } ], "offset": 0 }, "msg": "成功", "status": "SUCCESS", "uid": "bd3dd566-30e2-48c4-93d7-c472bd9ef9971465446395677", "version": "002" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | offset | integer | 否 | 开始索引位置 | limit | integer | 否 |每页数量 | list | array | 否 | 代金券列表 | list[].couponId | string | 否 | 代金券id | list[].status | integer | 否 | 使用状态(0:未使用 1:已冻结 2:已使用) | list[].statusDesc | string | 否 | 使用状态描述 | list[].amount | integer | 否 | 代金券金额 | list[].startTime | long | 否 | 代金券有效期始(unix时间戳 ) | list[].endTime | long | 否 | 代金券有效期止(unix时间戳 ) | list[].couponScopeDescList | array<string> | 否 | 使用规则描述 | list[].title | string | 否 | 代金券标题(通用券,限制使用) | list[].couponKind | integer | 否 | 代金券类型(1:金额,2:折扣) | list[].discountRate | float | 否 | 折扣比例值 ### 结算推荐代金券列表 #### 权限范围 > 代金券(coupon)--授权码模式或密码模式 #### 请求地址 /v1/resource/coupon/getCouponListForPayOrder #### 请求方式 HTTP/GET #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | offset | integer | 是 | 开始索引位置,默认0 | limit | integer | 是 | 返回数量(默认为5,最大20) | orderId | string | 否 | 订单id #### 注意事项 该接口不是必须接口,需<a href="?r=faq/contact" target="_blank">商务合作</a> #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": { "limit": 10, "list": [ { "carTypeScope": "", "couponId": "6294045049710575617", "couponKind": 1, "couponScopeDescList": [ ], "discountRate": "", "endTime": 1466697599, "startTime": 1465401600, "status": 0, "statusDesc": "未使用" } ], "offset": 0 }, "msg": "成功", "status": "SUCCESS", "uid": "bd3dd566-30e2-48c4-93d7-c472bd9ef9971465446395677", "version": "002" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | offset | integer | 否 | 开始索引位置 | limit | integer | 否 |每页数量 | list | array | 否 | 代金券列表 | list[].couponId | string | 否 | 代金券id | list[].status | integer | 否 | 使用状态(0:未使用 1:已冻结 2:已使用) | list[].statusDesc | string | 否 | 使用状态描述 | list[].amount | integer | 否 | 代金券金额 | list[].startTime | long | 否 | 代金券有效期始(unix时间戳 ) | list[].endTime | long | 否 | 代金券有效期止(unix时间戳 ) | list[].couponScopeDescList | array<string> | 否 | 使用规则描述 | list[].title | string | 否 | 代金券标题(通用券,限制使用) | list[].couponKind | integer | 否 | 代金券类型(1:金额,2:折扣) | list[].discountRate | float | 否 | 折扣比例值 ### 创建订单(支持代金券) #### 权限范围 > 代金券(coupon)--授权码模式或密码模式 #### 请求地址 /v1/action/order/createWithCoupon #### 请求方式 HTTP/POST #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | serviceId | integer | 否 | 服务类型id(7:接机 8:送机 11:包车(4小时) 12:包车(8小时) 13:预约用车 14:立即叫车) | carGroupId | integer | 否 | 车组id | cityId | integer | 是 | 出发城市id(如果为空,则根据出发地经纬度定位城市) | passengerMobile | string | 否 | 乘客手机号 | passengerName | string | 否 | 乘客姓名(不能超过50个字符) | passengerCountryCode | string | 是 | 乘客国家代码(默认为86) | slat | double | 是 | 出发地纬度(服务类型为“接机”时可为空) | slng | double | 是 | 出发地经度(服务类型为“接机”时可为空) | startName | string | 是 | 出发地名称(服务类型为“接机”时可为空) | startAddress | string | 是 | 出发地详细地址(服务类型为“接机”时可为空) | elat | double | 是 | 目的地纬度(服务类型为“包车(8小时)”或"包车(4小时)"时为空) | elng | double | 是 | 目的地经度(服务类型为“包车(8小时)”或"包车(4小时)"时为空) | endName | string | 是 | 目的地名称(服务类型为“包车(8小时)”或"包车(4小时)"时为空) | endAddress | string | 是 | 目的地详细地址(服务类型为“包车(8小时)”或"包车(4小时)"时为空) | departureTime | long | 是 | <p>出发时间(unix时间戳)(服务类型为"立即叫车"或“接机”时可为空)</p><p>时间范围:立即叫车为当前日期,预约用车/包车(8小时)/包车(4小时)为当前日期 至 当前日期+30天</p><p>例如:当前日期为2016-3-4 10:00,则日期范围:2016-3-4 10:00(含) 至 2016-4-3 23:59(含)</p> | flt | string | 是 | 航班号 | flightDate | long | 是 | <p>航班起飞日期(unix时间戳)<p>日期范围:当前日期-3天 至 当前日期+30天</p><p>例如:当前日期为2016-3-4,则日期范围:2016-3-1(含) 至 2016-4-3(含)</p> | flightDelayTime | integer | 是 | <p>航班到达后,延迟N分钟后用车(下飞机、拿行李、走出航站楼需要时间)</p><p>时间范围:10(含) 至 90(含)</p> | airCode | string | 是 | 接机机场三字码 | isPassengerSms | integer | 是 | 替他人叫车时短信通知乘车人,默认通知(0:不通知 1:通知) | isCallSms | integer | 是 | 是否给订车人发送短信,默认发送(0:表示不发,1:表示发) | driverMessage | string | 是 | 给司机留言的内容,留言内容通过base64编码以后字符数不超过500个字符 | couponId | string | 是 | 代金券ID | estimatePrice | float | 是 | 预估费用,不减代金券抵扣(代金券ID不为空时必填) | isIncludeUPlus | integer | 是 | 是否包含U+平台车辆。默认包括(0:不包括,1:包括) | estimateId | string | 否 | 预估标识,预估接口返回。 | customData | string | 是 |<p>订单号及优惠券信息等个性化自定义字段(Json字符串)如:</p> <p>{"dOrderId":"35456983384","dCouponId":"5462395218",</br>"dCouponAmount":20,"dEntProjectCode":"1001","dPurposeName":"加班","customfield1":"customValue1"}</p><p>其中dOrderId、dCouponId、dCouponAmount,dEntProjectCode,dPurposeName分别代表渠道订单id、渠道优惠券id、渠道优惠券金额、项目编号、用车目的若使用这几个字段则必须使用规定的key值,其他字段无限制要求</p> | isPickupVip | boolean | 是 | 是否使用接机礼宾服务(服务类型为接机时有效) #### 注意事项 测试环境创建的订单要跑完完整的流程,至少将订单状态流转到已提交费用状态 如果下企业单请先进行<a href="doc?r=api/content#企业鉴权">企业鉴权</a>,不进行鉴权为个人用车。企业用车将扣除企业账户的余额且可以享受特殊优惠(需<a href="?r=faq/contact" target="_blank">商务合作</a>),企业订单不支持代金券 服务类型为“接机”时,以下两组参数(航班信息和出发地信息)2选1,强烈建议使用第1组参数,如果两组参数全部填写则按照第1组参数(航班信息)为准: 1. 航班信息: flt(航班号),flightDate(航班起飞日期),flightDelayTime(航班到达后,延时N分钟后用车),airCode(接机机场三字码)。`注意:使用该组参数时,飞机晚点或提前到达,接机时间也会自动做出相应调整` 2. 出发地信息:slat(出发地纬度),slng(出发地经度),startName(出发地名称),startAddress(出发地详细地址),departureTime(出发时间)。 #### 响应数据 > 数据仅供参考 ``` 创建订单成功返回信息 { "busiCode": "BASE000", "code": 1, "content": { "createStatus": "createSuccess", "orderId": "6438718716671623171", "orderNumber": "30656340644037", "isDispatchedImmediately":true, "orderType": 1 }, "msg": "成功", "status": "SUCCESS", "uid": "c9874a85-04c7-4fd2-b58b-6e304f8af7ff1432016014489", "version": "001" } 创建订单失败返回信息, busiCode, msg和status会根据实际情况返回具体的值 { "busiCode": "passengerMoreThanThreeOrder", "code": 7, "content": null, "msg": "乘车人未结算订单达到三个", "status": "BASE_ERROR", "uid": "c9874a85-04c7-4fd2-b58b-6e304f8af7ff1432016014489", "version": "001" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | orderId| string | 否 | 订单ID,程序之间通信使用 | orderNumber| string | 否 | 订单号,给用户展示、线下对账时使用 | createStatus | string | 否 | 订单创建成功 | isDispatchedImmediately | boolean | 否 | 是否立即派单(测试环境该值有可能为null),立即派单订单,创建后120s内,通过回调通知是否有司机接单。非立即派单,订单创建成功就表示会有司机提供服务,120s内不会有司机接单回调。 | orderType | integer | 否 | 订单类型<br/> 1.个人订单<br/>2.企业订单 ## 企业 ### 企业鉴权 #### 权限范围 > 企业(company)--客户端或授权码模式或密码模式(注意:授权码模式与密码模式会校验用户是否在企业中) #### 请求地址 /v1/action/company/authenticate #### 请求方式 HTTP/POST #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | companyId | long | 否 | 企业ID | loginId | string | 是 | 企业管理员用户名(企业管理员鉴权时必填) | password | string | 是 | 企业管理员密码(企业管理员鉴权时必填) #### 注意事项 下企业订单前请先调用该接口,该接口不需要进行多次调用, 鉴权成功后将与access_token绑定,如access_token更换请重新调用该接口进行鉴权。 客户端模式访问此接口,会检验传入的企业ID是否与客户端ID绑定,如果未绑请联系<a href="?r=faq/contact" target="_blank">商务合作</a>。 客户端模式传入企业管理员用户名和密码字段则判断为企业管理员鉴权(开企业发票时使用)。 授权码模式(密码模式)访问此接口,会检验传入的企业ID是否与客户端ID绑定,且验证用户是否已经是传入企业的成员,如果不是对应企业成员请先<a href="doc?r=api/content#添加企业员工">添加</a>。 #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": { "authenticationResult": "SUCCESS" }, "msg": "成功", "status": "SUCCESS", "uid": "61dc881d-bc94-46ed-a2c8-6054f3375022", "version": "002" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | authenticationResult | string | 是 | 鉴权结果 ### 撤销企业鉴权 #### 权限范围 > 企业(company)--客户端或授权码模式或密码模式 #### 请求地址 /v1/action/company/revokeAuthentication #### 请求方式 HTTP/POST #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token #### 注意事项 无 #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": { "revokedResult": "SUCCESS" }, "msg": "成功", "status": "SUCCESS", "uid": "9d3b3f81-bc46-42dc-83e4-61d77597dee7", "version": "002" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | revokedResult | string | 是 | 撤销结果 ### 查询企业部门 #### 权限范围 > 企业(company)--客户端模式 #### 请求地址 /v1/resource/company/queryDepartment #### 请求方式 HTTP/POST #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | offset | integer | 是 | 开始索引位置(默认0) | limit | integer | 是 | 返回数量(默认50,最大200) #### 注意事项 该接口用于查询企业部门信息,需要先进行<a href="doc?r=api/content#企业鉴权">企业鉴权(客户端模式)</a> #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": { "limit": 50, "list": [ { "id": 23905, "name": "默认" } ], "offset": 0 }, "handler": "CLIENT", "msg": "成功", "status": "SUCCESS", "uid": "09bd8906-8285-4212-b744-a55aaecbd7de", "version": "" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | offset | integer | 否 | 开始索引位置 | limit | integer | 否 | 每页数量 | list | array | 否 | 部门列表 | list[].name | string | 否 | 部门名称 | list[].id | long | 否 | 部门ID ### 添加企业员工 #### 权限范围 > 企业(company)--客户端模式 #### 请求地址 /v1/action/company/addEmployee #### 请求方式 HTTP/POST #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | mobile | string | 否 | 手机号码 | name | string | 是 | 员工姓名(默认为手机号) | email | string | 是 |员工邮箱 | role | integer | 是 | 角色 1员工(默认) 2管理员 | number | string | 是 | 员工工号 | quota | integer | 是 | 月用车额度,0为不限制(默认) | remark | string | 是 | 备注 | departmentId | long | 是 | 部门id #### 注意事项 该接口用于给企业添加员工,需要先进行<a href="doc?r=api/content#企业鉴权">企业鉴权(客户端模式)</a> #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": null, "msg": "成功", "status": "SUCCESS", "uid": "c0b4ed94-6eeb-438c-9323-5fdef6ea80291471417526524", "version": "002" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | 无 | - | - | - ### 修改企业员工 #### 权限范围 > 企业(company)--客户端模式 #### 请求地址 /v1/action/company/modifyEmployee #### 请求方式 HTTP/POST #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | mobile | string | 否 | 手机号码 | name | string | 是 | 员工姓名(不能更新成"") | email | string | 是 |员工邮箱 | role | integer | 是 | 角色 1员工 2管理员 | number | string | 是 | 员工工号 | quota | integer | 是 | 月用车额度,0为不限制 | remark | string | 是 | 备注 | departmentId | long | 是 | 部门id #### 注意事项 该接口用于修改企业员工信息,需要先进行<a href="doc?r=api/content#企业鉴权">企业鉴权(客户端模式)</a> #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": null, "msg": "成功", "status": "SUCCESS", "uid": "c0b4ed94-6eeb-438c-9323-5fdef6ea80291471417526524", "version": "002" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | 无 | - | - | - ### 删除企业员工 #### 权限范围 > 企业(company)--客户端模式 #### 请求地址 /v1/action/company/deleteEmployee #### 请求方式 HTTP/POST #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | mobile | string | 否 | 手机号码 #### 注意事项 该接口用于删除企业员工信息,需要先进行<a href="doc?r=api/content#企业鉴权">企业鉴权(客户端模式)</a> #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": null, "msg": "成功", "status": "SUCCESS", "uid": "c0b4ed94-6eeb-438c-9323-5fdef6ea80291471417526524", "version": "002" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | 无 | - | - | - ### 查询企业员工 #### 权限范围 > 企业(company)--客户端模式 #### 请求地址 /v1/resource/company/queryEmployee #### 请求方式 HTTP/POST #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token | mobile | string | 是 | 手机号码 | name | string | 是 | 员工姓名 | email | string | 是 | 员工邮箱 | number | string | 是 |员工工号 | departmentId | long | 是 | 部门id | offset | integer | 是 | 开始索引位置(默认0) | limit | integer | 是 | 返回数量(默认50,最大200) #### 注意事项 该接口用于查询企业员工信息,需要先进行<a href="doc?r=api/content#企业鉴权">企业鉴权(客户端模式)</a> #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": { "limit": 50, "list": [ { "email": "", "mobile": "15000000015", "departmentId": 150, "departmentName": "财务", "name": "张三", "number": "", "quota": 0, "remark": "", "role": 1 }, { "email": "", "mobile": "13102927262", "departmentId": 131, "departmentName": "人力", "name": "李四", "number": "1313", "quota": 0, "remark": "", "role": 2 } ], "offset": 0 }, "msg": "成功", "status": "SUCCESS", "uid": "b5662b9c-7c77-4a2b-aa4f-49cebd42f258", "version": "002" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | offset | integer | 否 | 开始索引位置 | limit | integer | 否 | 每页数量 | list | array | 否 | 员工列表 | list[].name | string | 是 | 员工姓名 | list[].email | string | 是 | 员工邮箱 | list[].role | integer | 是 | 角色 1员工 2管理员 | list[].number | string | 是 | 员工工号 | list[].departmentId | long | 是 | 所在部门id | list[].departmentName | string | 是 | 所在部门名称 | list[].quoat | integer | 是 | 月用车额度,0为不限制 | list[].remark | string | 是 | 备注 | list[].mobile | string | 是 | 员工手机号 ## 意见反馈 ### 查询反馈类型 #### 权限范围 > 意见反馈(feedbackOrder)--客户端或授权码模式或密码模式 #### 请求地址 /v1/resource/feedbackOrder/type #### 请求方式 HTTP/POST #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | 授权后的access token #### 注意事项 #### 响应数据 > 数据仅供参考 ``` { busiCode: "BASE000", code: 1, content: { feedbackType: { 1001: { id: 1001, name: "未乘车扣费" }, 1002 : { id: 1002, name: "绕路类" }, 1003 : { id: 1003, name: "提前开始服务类" }, ...... } }, msg: "成功", status: "SUCCESS", uid: "1e4e49a6-5cf2-4900-bc0d-bd8077d10ce11455413029357", version: "001" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | feedbackType | json | 否 | 反馈类型 | feedbackType.[key].id | integer | 否 | 反馈类型id | feedbackType.[key].name | string | 否 | 反馈类型名称 ### 创建反馈单 #### 权限范围 > 意见反馈(feedbackOrder)--客户端或授权码模式或密码模式 #### 请求地址 /v1/action/feedbackOrder/create #### 请求方式 HTTP/POST #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | access token | orderId | string | 否 | 订单id | ableCallPassenger | integer | 是 | 是否可以通知乘客(0.否,1.是)默认1 | passengerPhone | string | 是 | 乘客手机号 | feedbackType | integer | 否 | 意见反馈类型 | description | string | 否 | 投诉事件描述 #### 注意事项 1.当入参ableCallPassenger为1的时候,入参passengerPhone是必填项 #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": "SUCCESS", "msg": "成功", "status": "SUCCESS", "uid": "b1d63369-6099-4b40-8aff-c532b0b7a7021432020014136", "version": "001" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | content | string | 否 | 返回SUCCESS为创建反馈单成功 ### 修改反馈单 #### 权限范围 > 意见反馈(feedbackOrder)--客户端或授权码模式或密码模式 #### 请求地址 /v1/action/feedbackOrder/update #### 请求方式 HTTP/POST #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | access token | orderId | string | 否 | 订单id | description | string | 否 | 投诉事件描述 #### 注意事项 无 #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": "SUCCESS", "msg": "成功", "status": "SUCCESS", "uid": "b1d63369-6099-4b40-8aff-c532b0b7a7021432020014136", "version": "001" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | content | string | 否 | 返回SUCCESS为修改反馈单成功 ### 确认反馈结果 #### 权限范围 > 意见反馈(feedbackOrder)--客户端或授权码模式或密码模式 #### 请求地址 /v1/action/feedbackOrder/confirm #### 请求方式 HTTP/POST #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | access token | orderId | string | 否 | 订单id | ableClosed | integer | 是 | 是否关闭反馈单(0.不关闭,1关闭),默认1.关闭 | comment | string | 否 | 评论反馈结果 #### 注意事项 #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": "SUCCESS", "msg": "成功", "status": "SUCCESS", "uid": "b1d63369-6099-4b40-8aff-c532b0b7a7021432020014136", "version": "001" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | content | string | 否 | 返回SUCCESS为确认反馈单结果成功 ### 重开反馈单 #### 权限范围 > 意见反馈(feedbackOrder)--客户端或授权码模式或密码模式 #### 请求地址 /v1/action/feedbackOrder/reopen #### 请求方式 HTTP/POST #### 请求参数 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | access_token | string | 否 | access token | orderId | string | 否 | 订单id | comment | string | 否 | 评论反馈结果 #### 注意事项 #### 响应数据 > 数据仅供参考 ``` { "busiCode": "BASE000", "code": 1, "content": "SUCCESS", "msg": "成功", "status": "SUCCESS", "uid": "b1d63369-6099-4b40-8aff-c532b0b7a7021432020014136", "version": "001" } ``` #### 响应数据说明 | 参数名称 | 类型 | 可选 | 说明 | ------ | --- | --- | --- | content | string | 否 | 返回SUCCESS为确认反馈单结果成功
加载中...
神州专车开放平台登录
邮箱
密码
验证码
验证码错误
登录
记住账号
忘记密码?