易途吧开放平台提供了标准的境外用车业务包含询价、下单的全套接口。通过平台API,用户可实现自有业务系统和易途吧的境外用车服务进行对接。
境外用车询价,及根据询价结果向易途吧下单
可于用车前更新乘客信息
可于用车前取消订单
机场/城市等基础数据支持
生产环境:api.yitu8.com.cn
测试环境:api.yitu8.ltd
接口仅支持 HTTP 协议的 POST 方法,通过 BODY 传递 Json 格式的请求参数,接口 URL 区分大小写。请求以及返回都使用 UTF-8 字符集进行编码。接口返回的数据封装为统一的 Json 格式。文档中所列举的类型皆为 Java 语言的数据类型,其它编程语言的的数据类型请自行对应。格式详见:返回数据类型。
建议在HTTP请求头中设置以下参数:
| 参数名 | 参数值 |
|---|---|
| Accept | application/json |
| Content-Type | application/json |
所有接口的请求参数需要封装为统一的 Json 格式,属性名称区分大小写。数据类型如下:
| 类型 | 属性 | 是否必需 | 属性说明 |
|---|---|---|---|
| String | partnerId | 必需 | 4位分销商数字编号 |
| String | timestamp | 必需 | 接口调用时间,格式为:yyyy-MM-dd HH:mm:ss |
| String | sign | 必需 | 数据签名 |
| String | data | 必需 | 加密的请求参数 |
接口请求参数请使用 secretKey 进行 3DES 加密后输出 hex 并转大写,作为 data 的属性值进行传递。
数据签名使用 MD5 摘要算法,32位小写,具体的签名算法为:
MD5(partnerId + timestamp + data + secretKey)
partnerId 和 secretKey 为易途吧分配给接入用户的分销商编号和密钥
timestamp 为接口调用时间(yyyy-MM-dd HH:mm:ss)
data 为加密后的请求参数
| 类型 | 属性 | 属性说明 |
|---|---|---|
| Boolean | success | 接口调用是否成功,成功:true;失败:false |
| Integer | code | 错误代码,2xx代表成功,4xx或5xx代表失败 |
| String | message | 错误消息,描述了接口调用失败原因 |
| Object | data | 接口返回数据 |
| Object | option | 附加数据,如分页数据的总条数 |
根据条件查询易途吧机场基础信息,支持分页搜索。
接口URL:/car/common/getAirportList
查询机场参数如下:
| 类型 | 属性 | 是否必需 | 属性说明 |
|---|---|---|---|
| String | keyword | 非必需 | 关键词,支持机场中文名,英文名,三字码模糊搜索 |
| String | cityId | 非必需 | 机场所属城市ID |
| String | firstChars | 非必需 | 机场所属城市首字母 |
| Integer | countryType | 非必需 | 搜索机场类型,0.境外;1.境内;2.全部 |
| Integer | page | 非必需 | 页码,默认为1 |
| Integer | pageSize | 非必需 | 单页数量,默认为20条数据 |
接口返回数据类型:
| 类型 | 属性 | 属性说明 |
|---|---|---|
| String | id | 机场ID |
| String | name | 机场名称 |
| String | enName | 机场英文名 |
| String | firstChar | 机场所属城市首字母 |
| String | countryId | 所属国家ID |
| String | country | 所属国家名称 |
| String | cityId | 所属城市ID |
| String | city | 所属城市名称 |
| String | iataCode | 机场三字码 |
| BigDecimal | longitude | 机场经度 |
| BigDecimal | latitude | 机场纬度 |
请求参数示例:
{ "keyword":"成田"}返回结果示例:
xxxxxxxxxx{ "success":true, "code":200, "message":"请求成功", "data":[ { "firstChar":"D", "country":"日本", "iataCode":"NRT", "city":"东京", "latitude":35.7719867, "name":"东京成田国际机场", "enName":"Narita", "id":"518e8ba9f83911e8a6170242ac110006", "cityId":"1330824d78c011e893190242ac110002", "countryId":"125a904278c011e893190242ac110002", "longitude":140.3928501 } ], "option":1}根据条件查询易途吧城市基础信息,不支持分页搜索
接口URL:/car/common/getCityList
查询城市参数如下:
| 类型 | 属性 | 是否必需 | 属性说明 |
|---|---|---|---|
| Integer | countryType | 必需 | 搜索城市类型,0.境外;1.境内;2.全部 |
| String | keyword | 必需 | 关键词,支持城市中文名,英文名搜索 |
接口返回数据类型:
| 类型 | 属性 | 属性说明 |
|---|---|---|
| String | id | 城市ID |
| String | name | 城市名称 |
| String | enName | 城市英文名 |
| String | firstChar | 城市首字母 |
| String | countryId | 所属国家ID |
| String | country | 所属国家名称 |
| String | provinceId | 所属州省ID |
| String | province | 所属州省名称 |
| String | countryEnName | 所属国家英文名 |
| BigDecimal | longitude | 城市中心点经度(境内城市为空) |
| BigDecimal | latitude | 城市中心点机场纬度(境内城市为空) |
请求参数示例:
xxxxxxxxxx{ "keyword":"东京", "countryType":0}返回结果示例:
xxxxxxxxxx{ "success":true, "code":200, "message":"请求成功", "data":[ { "id":"1330824d78c011e893190242ac110002", "name":"东京", "enName":"Tokyo", "firstChar":"D", "provinceId":"12681e6b78c011e893190242ac110002", "province":"关东地方", "country":"日本", "countryId":"125a904278c011e893190242ac110002", "countryEnName":"Japan", "latitude":35.709026, "longitude":139.732 } ], "option":null}查询地址列表及经纬度,不支持分页搜索
接口URL:/car/map/getAddressListByKeyword
查询经纬度参数如下:
| 类型 | 属性 | 是否必需 | 属性说明 |
|---|---|---|---|
| String | keyword | 必需 | 地址关键词 |
| BigDecimal | longitude | 非必需 | 目标城市的经度 |
| BigDecimal | latitude | 非必需 | 目标城市的纬度 |
接口返回数据类型:
| 类型 | 属性 | 属性说明 |
|---|---|---|
| String | name | 地址名称 |
| String | address | 详细地址 |
| String | longitude | 地址经度 |
| String | latitude | 地址纬度 |
请求参数示例:
xxxxxxxxxx{ "keyword": "酒店", "latitude": 51.50735, "longitude": -0.140428}返回结果示例:
xxxxxxxxxx{ "success":true, "code":200, "message":"请求成功", "data":[ { "name":"伦敦斯塔福德酒店", "address":"16-18 St James's Pl, St. James's, London SW1A 1NJ英国", "longitude":-0.140428, "latitude":51.5057738 }, { "name":"Endeavour Hotel", "address":"196 Thisselt Rd, Canvey Island SS8 9BQ英国", "longitude":0.582974, "latitude":51.527033 } ], "option":null}用户指定的用车时间(当地)、行程计划,即可通过询价接口获取相应的各种车型的报价, 多个行程时如果包括接机,则接机必须在第一个行程,如果包括送机,则送机必须在最后一个行程。
接口URL:/car/order/queryPrice
询价参数如下:
| 类型 | 属性 | 是否必需 | 属性说明 |
|---|---|---|---|
| String | useTime | 必需 | 用车时间(当地时间),格式为:yyyy-MM-dd HH:mm:ss |
| List<Schedule> | schedules | 必需 | 一个或多个行程计划 |
【Schedule】数据类型:
| 类型 | 属性 | 是否必需 | 属性说明 |
|---|---|---|---|
| Integer | productType | 必需 | 用车类型,详见用车类型说明 |
| String | useDate | 多日包车必需 | 用车日期(当地时间),格式为:yyyy-MM-dd |
| String | useTime | 详见说明 | 当地用车时间,格式为:yyyy-MM-dd HH:mm:ss |
| String | airportCode | 接送机必需 | 机场三字码 |
| String | fromCityId | 必需 | 出发城市ID |
| String | fromCity | 必需 | 出发城市名称 |
| String | fromAddressName | 详见说明 | 出发地名 |
| String | fromAddress | 详见说明 | 出发地详细地址 |
| String | fromLongitude | 详见说明 | 出发地经度 |
| String | fromLatitude | 详见说明 | 出发地纬度 |
| String | toCityId | 详见说明 | 目的地城市ID |
| String | toCity | 详见说明 | 目的地城市名称 |
| String | toAddressName | 详见说明 | 目的地名 |
| String | toAddress | 详见说明 | 目的地详细地址 |
| String | toLongitude | 详见说明 | 目的地经度 |
| String | toLatitude | 详见说明 | 目的地纬度 |
0.不出车;1.接机;2.送机;3.单次接送;4.市内包车;5.周边包车;6.跨城包车;7.半日包车;8.线路包车;8.指定时长里程包车
最后一天行程只有送机时 useTime 必需;
除多日包车的非首日行程外,fromAddressName、fromAddress、fromLongitude、fromLatitude等四个出发地参数皆为【必需】参数;
除接送机、单次接送、跨城包车外,toCityId、toCity、toAddress、toAddressName、toLongitude、toLatitude等六个目的地参数为【非必需】参数,出发城市=到达城市(到达城市不传默认出发城市);
接口返回数据类型:
| 类型 | 属性 | 属性说明 |
|---|---|---|
| String | priceMark | 价格标识 |
| List<PriceAddition> | additions | 附加服务 |
| List<ServiceTag> | serviceTags | 服务标签 |
| List<CarType> | carTypes | 车型列表 |
| Integer | freeChildSeat | 免费儿童座椅数量 |
| Integer | distance | 预估里程,单位米 |
| Integer | duration | 预估时长,单位分钟 |
【PriceAddition】数据类型:
| 类型 | 属性 | 属性说明 |
|---|---|---|
| String | sid | 唯一标识 |
| String | content | 附加服务名称 |
| BigDecimal | price | 单价 |
【ServiceTag】数据类型:
| 类型 | 属性 | 属性说明 |
|---|---|---|
| String | sid | 唯一标识 |
| String | content | 服务标签名称 |
【CarType】数据类型:
| 类型 | 属性 | 属性说明 |
|---|---|---|
| String | carTypeId | 车型编号 |
| String | name | 车型名称 |
| String | typical | 代表车型 |
| String | imageUrl | 车型图片 |
| BigDecimal | setPrice | 价格 |
| Integer | maxPassenger | 最大载客数 |
| Integer | maxLuggage | 最大行李数 |
| DateTime | latestTime | 车型报价有效时间 |
请求参数示例:
xxxxxxxxxx{ "useTime":"2019-04-26 10:00:00", "schedules":[ { "productType":1, "useDate":"2019-04-26", "airportCode":"NRT", "fromCityId":"1330824d78c011e893190242ac110002", "fromCity":"东京", "fromAddressName":"成田国际机场", "fromAddress":"成田国际机场", "fromLongitude":140.3928501, "fromLatitude":35.7719867, "toCityId":"1330824d78c011e893190242ac110002", "toCity":"东京", "toAddressName":"半藏门蒙特利酒店", "toAddress":"半藏门蒙特利酒店", "toLongitude":139.741952, "toLatitude":35.68669 } ]}返回结果示例:
xxxxxxxxxx{ "success":true, "code":200, "message":"请求成功", "data":{ "priceMark":"2f71b3d4d8474369b647ab2f594ef860", "additions":[ { "sid":"airportCardFee", "content":"举牌费", "price":100 }, { "sid":"airportCheckFee", "content":"机场checkin费", "price":100 }, { "sid":"childSeatFee", "content":"儿童座椅费", "price":100 } ], "serviceTags":[ { "sid":"1001", "content":"中文客服" }, { "sid":"1010", "content":"免费等待" }, { "sid":"1011", "content":"迟到赔付" } ], "carTypes":[ { "carTypeId":"2455", "name":"经济5座", "typical":"本田缤智,丰田Picnic", "imageUrl":"https://image.pro.io.yitu8.cn/cloudfile/carmodel/经济5座.png", "setPrice":1127, "maxPassenger":4, "maxLuggage":2, "latestTime":"2019-04-03 12:00:00" }, { "carTypeId":"2475", "name":"豪华7座", "typical":"丰田埃尔法,丰田VELLFIRE", "imageUrl":"https://image.pro.io.yitu8.cn/cloudfile/carmodel/豪华7座.png", "setPrice":1214, "maxPassenger":6, "maxLuggage":5, "latestTime":"2019-04-03 12:01:00" }, { "carTypeId":"2464", "name":"舒适10座", "typical":"丰田海狮", "imageUrl":"https://image.pro.io.yitu8.cn/cloudfile/carmodel/舒适10座.png", "setPrice":1560, "maxPassenger":9, "maxLuggage":9, "latestTime":"2019-04-03 12:02:00" }, { "carTypeId":"2465", "name":"舒适14座", "typical":"丰田海狮", "imageUrl":"https://image.pro.io.yitu8.cn/cloudfile/carmodel/舒适14座.png", "setPrice":1907, "maxPassenger":13, "maxLuggage":7, "latestTime":"2019-04-03 12:03:00" } ], "freeChildSeat":1, "distance":70583, "duration":64 }, "option":null}用户根据询价返回的标识,选择对应车型进行下单。
接口URL:/car/order/addOrder
下单参数如下:
| 类型 | 属性 | 是否必需 | 属性说明 |
|---|---|---|---|
| String | thirdOrderNo | 必需 | 第三方订单号 |
| String | priceMark | 必需 | 询价返回的价格标识 |
| String | carTypeId | 必需 | 所选车型ID |
| BigDecimal | totalAmount | 非必需 | 订单总金额 |
| String | remark | 非必需 | 订单备注 |
| PassengerInfo | passengerInfo | 必需 | 乘客信息 |
| List<PriceAddition> | additions | 非必需 | 附加服务 |
| List<Flight> | flightList | 非必需 | 航班号集合,如有接送机的行程则为必需 |
【PassengerInfo】数据类型:
| 类型 | 属性 | 是否必需 | 属性说明 |
|---|---|---|---|
| String | contactName | 必需 | 联系人姓名 |
| String | contactPhone | 必需 | 联系人号码,格式为:区号-号码,如86-18158117651 |
| String | wechatNo | 非必需 | 联系人微信号 |
| Integer | adults | 必需 | 成人数 |
| Integer | children | 必需 | 儿童数 |
| Integer | luggages | 必需 | 行李数 |
| String | backupPhone | 非必需 | 备用号码,格式为:区号-号码,如86-18158117651 |
| String | hotelPhone | 非必需 | 酒店/民宿电话 |
【PriceAddition】数据类型:
| 类型 | 属性 | 是否必需 | 属性说明 |
|---|---|---|---|
| String | sid | 必需 | 唯一标识 |
| String | count | 必需 | 附加服务个数 |
| Detail | detail | 非必需 | 附加服务详细信息 |
【Detail】数据类型:
| 类型 | 属性 | 是否必需 | 属性说明 |
|---|---|---|---|
| String | pickupName | 非必需 | 举牌姓名 |
| List<String> | pickupImages | 非必需 | 举牌图片外网链接 |
【Flight】数据类型:
| 类型 | 属性 | 是否必需 | 属性说明 |
|---|---|---|---|
| Integer | productType | 必需 | 套餐类型:1.接机;2.送机 |
| String | flightNo | 必需 | 航班号 |
接口返回数据类型:
| 类型 | 属性 | 属性说明 |
|---|---|---|
| String | orderNo | 易途吧订单号 |
请求参数示例:
xxxxxxxxxx{ "thirdOrderNo":"ThirdOrderNo111111", "priceMark":"1b4caf149e09453f9e604be366e7f63e", "carTypeId":"2455", "additions":[ { "sid":"airportCardFee", "count":1 } ], "passengerInfo":{ "contactName":"张三", "contactPhone":"86-18258115872", "backupPhone":null, "wechatNo":"18567876652", "hotelPhone":null, "adults":1, "children":1, "luggages":1 }, "flightList":[ { "productType":1, "flightNo":"CA0981" } ], "totalAmount":9999.91, "remark":"这是订单备注订单备注"}返回结果示例:
xxxxxxxxxx{ "success":true, "code":200, "message":"请求成功", "data":{ "orderNo":"O1263168168718" }, "option":null}根据易途吧订单号或第三方订单号(用户系统订单号)更新乘客信息,只需要传修改过的属性。
接口URL:/car/order/updateOrder
更新订单参数如下:
| 类型 | 属性 | 是否必需 | 属性说明 |
|---|---|---|---|
| String | orderNo | 必需 | 易途吧订单号 |
| String | thirdOrderNo | 非必需 | 第三方订单号 |
| PassengerInfo | passengerInfo | 必需 | 乘客信息 |
【PassengerInfo】数据类型:
| 类型 | 属性 | 是否必需 | 属性说明 |
|---|---|---|---|
| String | contactName | 非必需 | 联系人姓名 |
| String | contactPhone | 非必需 | 联系人号码,格式为:区号-号码,如86-18158117651 |
| Integer | adults | 非必需 | 成人数 |
| Integer | children | 非必需 | 儿童数 |
| Integer | luggages | 非必需 | 行李数 |
| String | backupPhone | 非必需 | 备用号码,格式为:区号-号码,如86-18158117651 |
| String | wechatNo | 非必需 | 联系人微信号 |
| String | hotelPhone | 非必需 | 酒店/民宿电话 |
请求参数示例:
xxxxxxxxxx{ "thirdOrderNo":"ThirdOrderNo111111", "orderNo":"088888888888", "passengerInfo":{ "contactName":"张三", "contactPhone":"86-18258115872", "adults":2 }}返回结果示例:
xxxxxxxxxx{ "success":true, "code":200, "message":"请求成功", "data":null, "option":null}根据易途吧订单号或第三方订单号(用户系统订单号)取消订单。
接口URL:/car/order/cancelOrder
取消订单参数如下:
| 类型 | 属性 | 是否必需 | 属性说明 |
|---|---|---|---|
| String | orderNo | 必需 | 易途吧订单号 |
| String | thirdOrderNo | 非必需 | 第三方订单号 |
| String | cancelReason | 非必需 | 取消原因 |
接口返回数据类型:
| 类型 | 属性 | 属性说明 |
|---|---|---|
| BigDecimal | refundAmount | 应退款金额 |
| BigDecimal | deductAmount | 违约金金额 |
| List<String> | remark | 退款文案信息 |
请求参数示例:
xxxxxxxxxx{ "thirdOrderNo":"ThirdOrderNo111111", "orderNo":"O88888888888", "cancelReason":"我自己原因取消"}返回结果示例:
xxxxxxxxxx{ "success":true, "code":200, "message":"请求成功", "data": { "deductAmount":0, "remark":[ "距离用车时间>48小时,按订单金额100%退款;", "24小时<距离用车时间≤48小时,按订单金额50%退款;", "距离用车时间≤24小时,不退款。" ], "refundAmount":851 }, "option":null}根据易途吧订单号查询取消订单可退款金额及相应的退款政策。
接口URL:/car/common/getCancelOrderInfo
查询退款政策参数如下:
| 类型 | 属性 | 是否必需 | 属性说明 |
|---|---|---|---|
| String | orderNo | 必需 | 易途吧订单号 |
接口返回数据类型:
| 类型 | 属性 | 属性说明 |
|---|---|---|
| BigDecimal | refundAmount | 应退款金额 |
| BigDecimal | deductAmount | 违约金金额 |
| List<String> | remark | 退款文案信息 |
请求参数示例:
xxxxxxxxxx{ "orderNo":"O88888888888"}返回结果示例:
xxxxxxxxxx{ "success":true, "code":200, "message":"请求成功", "data":{ "deductAmount":0, "remark":[ "距离用车时间>48小时,按订单金额100%退款;", "24小时<距离用车时间≤48小时,按订单金额50%退款;", "距离用车时间≤24小时,不退款。" ], "refundAmount":851 }, "option":null}根据易途吧订单号查询订单的详细信息。
接口URL:/car/common/getOrderDetail
查询订单详情参数如下:
| 类型 | 属性 | 是否必需 | 属性说明 |
|---|---|---|---|
| String | orderNo | 必需 | 易途吧订单号 |
| String | thirdOrderNo | 非必需 | 第三方订单号 |
接口返回数据类型:
| 类型 | 属性 | 属性说明 |
|---|---|---|
| Integer | type | 服务类型。1:接机;2:送机;3:单次接送;4:包车 |
| Integer | status | 订单状态。 3:已确认;4:已派司机;5:已完成;6:已取消 |
| localTime | DateTime | 当地用车时间 |
| useTime | DateTime | 北京用车时间 |
| BigDecimal | amount | 订单金额,如:100.00 |
| DriverInfo | driverInfo | 司机信息 |
| VehicleInfo | vehicleInfo | 车辆信息 |
【DriverInfo】数据类型:
| 类型 | 属性 | 属性说明 |
|---|---|---|
| String | driverName | 司机姓名,如:黄非 |
| String | driverMobile | 司机电话,如:86-12345678901 |
| String | driverWechat | 司机微信,如:wechat |
【VehicleInfo】数据类型:
| 类型 | 属性 | 属性说明 |
|---|---|---|
| String | carTypeId | 车型Id,如:2455 |
| String | carNumber | 车牌号,如:Sk09871 |
| String | carBrandName | 车辆品牌,如:宝马 |
| String | carColor | 车辆颜色,如:白色 |
| Integer | seats | 座位数,如:8 |
| Integer | maxPassenger | 最大乘客数,如:7 |
| Integer | maxLuggage | 最大行李数,如:3 |
请求参数示例:
xxxxxxxxxx{ "orderNo":"O88888888888"}返回结果示例:
xxxxxxxxxx{ "success":true, "code":200, "message":"请求成功", "data":{ "type": 1, "status": 3, "localTime": "2024-12-01 09:00:00", "useTime": "2024-12-01 10:00:00", "amount": 500.00, "driverInfo": { "name": "张三", "mobile": "86-12345678901", "wechat": "yitu8", }, "vehicleInfo": { "carTypeId": "2455", "carNumber": "Sk09871", "carBrandName": "宝马", "carColor": "白色", "seats": 8, "maxPassenger": 7, "maxLuggage": 3 } }}易途吧需要平台接入方提供三个回调接口来实现:确认订单、推送司机信息和推送订单服务完成功能。平台接入方必须向易途吧注册一个固定的 DOMAIN/URL 参数,该参数若发生变化,需提前通知易途吧进行修改。
回调接口仅支持 HTTP 协议的 POST 方法,通过 BODY 传递 Json 格式的请求参数。请求以及返回都使用 UTF-8 字符集进行编码。URL格式为:http://{DOMAIN/URL}/{API},如:http://api.yitu8.cn/order/confirmOrder。
回调接口的请求参数的封装、数据签名、加密方法以及返回的数据类型同易途吧提供的数据接口。如调用成功,应返回以下数据:
xxxxxxxxxx{ "success":true, "code":200, "message":"请求成功", "data":null, "option":null}如调用失败,应于 message 中返回错误的原因,同时 success 为 false 、code 为 400。例如:
xxxxxxxxxx{ "success":false, "code":400, "message":"订单号不存在!", "data":null, "option":null}调用易途吧下单接口成功后,易途吧需要回调第三方的确认接口以确认订单。
回调API:confirmOrder
确认订单参数如下:
| 类型 | 属性 | 属性说明 |
|---|---|---|
| String | orderNo | 易途吧订单号 |
| String | thirdOrderNo | 第三方订单号 |
请求参数示例:
xxxxxxxxxx{ "thirdOrderNo":"thirdOrderNo111111", "orderNo":"O88888888"}返回结果示例:
xxxxxxxxxx{ "success":true, "code":200, "message":"请求成功", "data":null, "option":null}调用易途吧下单接口成功后,司机接单后向第三方推送司机信息。
回调API:pushDriverInfo
推送司机信息参数如下:
| 类型 | 属性 | 属性说明 |
|---|---|---|
| Integer | type | 类型:1.已派司机;2.改派司机 |
| String | orderNo | 易途吧订单号 |
| String | thirdOrderNo | 第三方订单号 |
| String | driverName | 司机姓名 |
| String | driverMobile | 司机手机号 |
| String | driverWechat | 司机微信 |
| String | carNumber | 服务车辆车牌号 |
| String | carBrandName | 车辆品牌 |
| String | carColor | 车辆颜色 |
请求参数示例:
xxxxxxxxxx{ "type":1, "thirdOrderNo":"thirdOrderNo111111", "orderNo":"O88888888", "driverName":"张三", "driverMobile":"81-876541121", "driverWechat":"112311411", "carNumber":"Sk09871", "carBrandName":"宝马", "carColor":"白色"}返回结果示例:
xxxxxxxxxx{ "success":true, "code":200, "message":"请求成功", "data":null, "option":null}调用易途吧下单接口成功后,司机接单完成服务后向第三方推送订单完成信息。
回调API:orderFinished
完成订单参数如下:
| 类型 | 属性 | 属性说明 |
|---|---|---|
| String | orderNo | 易途吧订单号 |
| String | thirdOrderNo | 第三方订单号 |
请求参数示例:
xxxxxxxxxx{ "thirdOrderNo":"thirdOrderNo111111", "orderNo":"O88888888"}返回结果示例:
xxxxxxxxxx{ "success":true, "code":200, "message":"请求成功", "data":null, "option":null}无忧行需求单列表
URL:/ota/manage/jego/list
列表接口参数如下:
| 类型 | 属性 | 属性说明 |
|---|---|---|
| int | status | 需求单状态:1待录单 2已录单 3待取消 4已取消 |
| string | orderId | yt8订单号 |
| string | thirdOrderId | 无忧行订单号 |
| int | page | 页数 |
| int | pageSize | 每页条数 |
请求参数示例:
xxxxxxxxxx{ "status":1, "page":1, "pageSize": 10}返回结果示例:
xxxxxxxxxx{ "success":true, "code":200, "message":"请求成功", "data":null, "option":null}返回参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| success | Boolean | 是否成功 true Or false |
| code | Integer | 状态码 |
| message | String | 错误信息 |
| option | Object | 条数 |
| data | obj对象 | 返回值 |
| recordCount | int | 待录单数量 |
| cancelCount | int | 待取消数量 |
| list | obj数组 | 该状态订单的对象数组 |
| order_id | string | yt8订单号 |
| third_order_id | string | 无忧行订单号 |
| use_type | int | 用车类型:1接机 2送机 |
| price | bigdecimal | 售卖价 |
| created_time | date | 下单时间 |
| local_time | date | 用车时间(当地) |
| car_model | string | 所需车型 |
| status | int | 状态 0 已关闭 1待录单 2已录单 3待取消 4已取消 |
无忧行需求单详情
URL:/ota/manage/jego/get
列表接口参数如下:
| 类型 | 属性 | 属性说明 |
|---|---|---|
| String | id | 需求单uuid |
请求参数示例:
xxxxxxxxxx{ "id":"1"}返回结果示例:
xxxxxxxxxx{ "success":true, "code":200, "message":"请求成功", "data":null, "option":null}返回参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| success | Boolean | 是否成功 true Or false |
| code | Integer | 状态码 |
| message | String | 错误信息 |
| option | Object | 条数 |
| data | obj对象 | 返回值 |
| recordCount | int | 已录单数量 |
| cancelCount | int | 已取消数量 |
| list | obj数组 | 该状态订单的对象数组 |
| order_id | string | yt8订单号 |
| third_order_id | string | 无忧行订单号 |
| use_type | int | 用车类型:1接机 2送机 |
| price | bigdecimal | 售卖价 |
| created_time | date | 下单时间 |
| local_time | date | 用车时间(当地) |
| car_model | string | 所需车型 |
| status | int | 状态 0 已关闭 1待录单 2已录单 3待取消 4已取消 |
无忧行能否确认需求单
URL:/ota/manage/jego/would/confirm
列表接口参数如下:
| 类型 | 属性 | 属性说明 |
|---|---|---|
| String | id | 需求单uuid |
请求参数示例:
xxxxxxxxxx{ "id":"1"}返回结果示例:
xxxxxxxxxx{ "success":true, "code":200, "message":"请求成功", "data":null, "option":null}返回参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| success | Boolean | 是否成功 true Or false |
| code | Integer | 状态码 |
| message | String | 错误信息 |
| option | Object | 条数 |
| data | obj对象 | 返回值 |
| orderId | string | yt8订单号(成功状态返回) |
| thirdOrderId | string | 无忧行订单号(成功状态返回) |
无忧行确认需求单
URL:/ota/manage/jego/confirm
列表接口参数如下:
| 类型 | 属性 | 属性说明 |
|---|---|---|
| String | id | 需求单uuid |
| String | orderId | yt8订单号 |
| String | thirdOrderId | 无忧行订单号 |
请求参数示例:
xxxxxxxxxx{ "id":"1", "orderId":"1", "thirdOrderId":"1"}返回结果示例:
xxxxxxxxxx{ "success":true, "code":200, "message":"请求成功", "data":null, "option":null}返回参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| success | Boolean | 是否成功 true Or false |
| code | Integer | 状态码 |
| message | String | 错误信息 |
| option | Object | 条数, |
| data | obj对象 | 返回值 |
无忧行取消需求单
URL:/ota/manage/jego/cancel
列表接口参数如下:
| 类型 | 属性 | 属性说明 |
|---|---|---|
| String | id | 需求单uuid |
请求参数示例:
xxxxxxxxxx{ "id":"1"}返回结果示例:
xxxxxxxxxx{ "success":true, "code":200, "message":"请求成功", "data":null, "option":null}返回参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| success | Boolean | 是否成功 true Or false |
| code | Integer | 状态码 |
| message | String | 错误信息 |
| option | Object | 条数, |
| data | obj对象 | 返回值 |
无忧行取消需求单
URL:/ota/manage/jego/cannot/cancel
列表接口参数如下:
| 类型 | 属性 | 属性说明 |
|---|---|---|
| String | id | 需求单uuid |
| String | reason | 不能取消的原因 |
请求参数示例:
xxxxxxxxxx{ "id":"1", "reason":"xxxx"}返回结果示例:
xxxxxxxxxx{ "success":true, "code":200, "message":"请求成功", "data":null, "option":null}返回参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| success | Boolean | 是否成功 true Or false |
| code | Integer | 状态码 |
| message | String | 错误信息 |
| option | Object | 条数, |
| data | obj对象 | 返回值 |
获取日志
URL:/ota/log/jego/getById
列表接口参数如下:
| 类型 | 属性 | 属性说明 |
|---|---|---|
| String | id | 需求单uuid |
请求参数示例:
xxxxxxxxxx{ "id":"1", "reason":"xxxx"}返回结果示例:
xxxxxxxxxx{ "success":true, "code":200, "message":"请求成功", "data":null, "option":null}返回参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| success | Boolean | 是否成功 true Or false |
| code | Integer | 状态码 |
| message | String | 错误信息 |
| option | Object | 条数, |
| data | obj对象 | 返回值 |
| id | String | uuid |
| jegoDemandId | string | 需求单uuid |
| creator | string | 操作人 |
| createdTime | date | 创建时间 |
| content | string | 内容 |