淘宝开放平台 - 文档中心

请求地址：

环境	HTTP请求地址
正式环境	http://qimen.api.taobao.com/router/qm
测试环境	http://qimen.api.taobao.com/router/qmtest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
customerId	String	是	WMS颁发给用户的ID
sign_method	String	是	签名的摘要算法，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。

名称	类型	是否必须	示例值	描述
searchReq	SearchReq	必须		筛选条件
└ storeCodeList String [] 必须门店Code列表
traceId	String	必须	215045d716776565095286972e11b4	traceId

名称	类型	示例值	描述
searchResp	SearchResp		返回信息
storeRuleInfoList StoreRuleInfo [] 门店规则信息列表 └ ruleCode String 122 供应商规则唯一标识，每个门店仅包含1个规则 └ storeCode String 122 供应商门店唯一标识 pickupMaterials PickupMaterials 取车材料 └ idType String 1,2,3,4,5,6 证件类型，0:身份证,1:护照,2:学生证,3:军官证,4:回乡证,5:台胞证,6:港澳通行证,7:国际海员,8:外国人永久居留(身份)证,9:其他证件,10:警官证,11:士兵证,12:台湾通行证,13:入台证,14:户口本,15:出生日期,16:驾驶证,17:港澳居民居住证,18:台湾居民居住证,多个证件类型使用逗号分隔 └ idValidMonth Number 12 证件最小有效期，整数，单位月 └ driveLicenseExpiryDate Number 4 驾驶证最小有效期，整数，单位月 └ minDriveExperience Number 10 最小驾龄，整数，单位月 └ depositPayType String 1,2,3 押金支付方式，1-信用卡，2-支付宝及其他在线支付工具，3-现金，多个押金支付方式使用逗号分隔 └ creditCardValidMonth Number 5 信用卡最小有效期，整数，单位月 └ maxDriverAge Number 70 最大驾驶人年龄(含)，整数，单位岁 └ minDriverAge Number 18 最小驾驶人年龄(含)，整数，单位岁 cancelRuleList CancelRule [] 取消规则，所有节假日取消规则按照当年节假日为准，如果此节假日已过，则同步下年此节假日规则，如果此规则日期还未公布，可不传 └ dateType Number 5 取消规则类型，0-平日，1-元旦，2-春节，3-清明节，4-劳动节，5-端午节，6-中秋节，7-国庆节，8-自定义，整体规则分为节假日，自定义和平日取消规则，平日取消规则即兜底规则，未命中自定义和节假日规则时，以平日规则为准 └ startTime String 2024-06-08 起始时间，格式yyyy-MM-dd，时间集合不得重叠，dateType为0时，不需要传递 └ endTime String 2024-06-10 结束时间，格式yyyy-MM-dd，时间集合不得重叠，dateType为0时，不需要传递 └ cancelChargeType Number 1 取车时间前取消类型：1-按照取消时间距离取车时间，收取订单金额百分比，2-取车时间之前均为免费取消 cancelCharge CancelCharge 取消收费规则，仅当 cancelChargeType 为1时需要传 └ pickUpFreeHours Number 4 取车时间前n小时之前的时间段取消免费。此处需传n，整数，单位小时 pickUpChargeList PickUpCharge [] 收费时间段，e.g [{pickUpChargeBeginHours: 0, pickUpChargeFeePercent: 100}, {pickUpChargeBeginHours: 4, pickUpChargeFeePercent: 50}] └ pickUpChargeBeginHours Number 3 取车前n小时，n取整数，单位小时 └ pickUpChargeFeePercent Number 30 在此时间段之内需要收费百分比x，x取整数，单位百分比 └ noshowChargePt Number 30 超时未取车时，取消收费百分比，整数，单位百分比 scatteredHoursList ScatteredHours [] 零散小时收费规则，每一个零散小时项必须连续，从0-24覆盖完毕 └ startHour Number 0 开始小时数 └ endHour Number 3 结束小时数 └ chargeFee Number 30 表示零散小时符合此时间段时，收费整天金额的百分比，整数，单位百分比 invoiceRule InvoiceRule 发票规则 └ invoiceType Number 1 发票类型，1-电子发票，2-纸质发票，整数 └ invoiceContent Number 1 发票内容，1-旅游服务费，2-代收租车费，3-旅游费，4-约车服务费，5-服务费，6-包车费，7-客运服务费，8-租车费，9-团款 └ invoiceFreightType Number 1 发票运费类型，1-免运费，2-运费到付，3-全国一口价 └ freightPrice String 20.00 一口价价格,单位元（invoiceFreight=3才有值） forbiddenDriveList ForbiddenDrive [] 禁行规则，同一个禁行类型和禁行区域，生效时间不得重叠；此外，同一时间段内，禁止驶出区域不能包含禁止驶入区域(两个区域相同也不可以) └ status Number 1 禁行状态，0启用,1禁用，整数 └ forbiddenType Number 1 禁行类型，1-禁止驶入，2-禁止驶出 └ forbiddenCityCode String 110000,230000 禁行类型城市Code，使用供应商城市divisionCode，多个使用逗号分隔 └ effectType Number 1 1-永久有效，2-一段时间有效 └ effectStartTime String 2024-03-09 生效开始时间，yyyy-MM-dd类型，仅当effectType为2时有效 └ effectEndTime String 2024-04-09 生效截止时间，yyyy-MM-dd类型，仅当effectType为2时有效 energyServiceFee EnergyServiceFee 能源服务费 └ batteryServiceFee String 30.00 充电服务费，保留两位小数，单位元 └ oilServiceFee String 20.00 加油服务费，保留两位小数，单位元 depositDeductionPolicy DepositDeductionPolicy 押金扣费标准 vehicleDamageInfoList VehicleDamageInfo [] 车辆损失扣费规则 └ type Number 101 维修或更换项目，101，维修保险杠(前、后)，102，维修前叶子板，103，维修前机盖，104，维修前风挡立柱，105，维修车门总成，106，维修反光镜总成，107，维修中门立柱，108，维修车顶，109，维修底大边、后围，110，维修后叶子板，111，维修后备箱盖，112，维修轮毂(灰色铝合金质地)，201，更换保险杠(前、后)，202，更换前叶子板，203，更换前机盖，204，更换前风挡立柱，205，更换车门总成，206，更换反光镜镜片，207，更换反光镜总成，208，更换中门立柱，209，更换车顶，210，更换底大边、后围，211，更换后叶子板，212，更换后备箱盖，213，更换前大灯总成，214，更换尾灯总成，215，更换侧转向灯总成，216，更换轮毂盖，217，更换轮毂(黑色铁质地)，218，更换轮毂(灰色铝合金质地)，219，更换钥匙(机械)，220，更换雾灯总成，221，更换轮胎，222，更换轮胎(漏气保用)，223，更换前挡风玻璃 vehicleDamagePriceInfoList VehiclePriceInfo [] 维修金额列表，每个type都需要传递 └ price Number 200 费用金额，单位元 └ type Number 1 车辆金额类型，1:十万以内;2:十万-二十万;3:二十万-三十万;4:大于三十万 vehicleItemLossInfoList VehicleItemLossInfo [] 随车物品损失扣费规则 └ type Number 100 遗失或损坏项目，101，三角警示牌102，千斤顶103，工具包104，灭火器105，音响喇叭（扬声器）106，遮阳板107，车内后视镜108，雨刷片109，车辆钥匙（需换全车锁）110，行驶证（含登报费）111，标贴（环保，年检，交强）112，附加税证/标（含登报费）113，车辆牌照（含登报费） vehicleItemLossPriceInfoList VehiclePriceInfo [] 更换遗失部件的金额列表，每个type都要传 └ price String 200 费用金额，单位元 └ type Number 1 车辆金额类型，1:十万以内;2:十万-二十万;3:二十万-三十万;4:大于三十万 violationDealing ViolationDealing 违章处理标准 notifyDetail NotifyDetail 违章通知及客户处理时限 └ auditTime Number 1 (字段已废弃，无需传递)车行审核违章时效，整数，单位天 └ userDealTime Number 2 客户处理时效，整数，单位天 └ notifyUserTime Number 3 实际还车后通知客户违章的时效，整数，单位天 driveLicenseLending DriveLicenseLending 驾驶证借用规则 └ lendingAdvanceBookingTime Number 9 通知违章后的行驶证借用申请时间，整数，单位天 └ lendingDriveLicenseDeposit Number 400 借用行驶证押金，整数，单位元 └ sameCityLendingAvailabilityTime Number 8 同城可借用时间，整数，单位小时 └ diffCityLendingAvailabilityTime Number 48 异地可借用时间，整数，单位小时 illegalDeductRule IllegalDeductRule 违章扣款规则 └ lateProcessingPenalty Number 200 客户逾期处理违约金，整数，单位元/天 roadAssistList RoadAssist [] 道路救援 └ assistType Number 3 救援类型，1-紧急送油，2-现场抢修，3-搭电服务，4-紧急加水，5-送备用钥匙 └ serviceRange Number 50 距离门店服务范围，整数，单位公里，e.g:距离门店50公里内 └ serviceCharge Number 200 收费，整数，单位元/次
success	Boolean	true	是否成功
retCode	String	1001	错误码
retMessage	String	错误信息	错误信息

{"traceId":"215045d716776565095286972e11b4","searchReq":{"storeCodeList":[""]}}

{
    "searchResp":{
        "storeRuleInfoList":[
            {
                    "ruleCode":"122",
                    "storeCode":"122",
                    "pickupMaterials":{
                        "idType":"1,2,3,4,5,6",
                        "idValidMonth":12,
                        "driveLicenseExpiryDate":4,
                        "minDriveExperience":10,
                        "depositPayType":"1,2,3",
                        "creditCardValidMonth":5,
                        "maxDriverAge":70,
                        "minDriverAge":18
                    },
                    "cancelRuleList":[
                        {
                                "dateType":5,
                                "startTime":"2024-06-08",
                                "endTime":"2024-06-10",
                                "cancelChargeType":1,
                                "cancelCharge":{
                                    "pickUpFreeHours":4,
                                    "pickUpChargeList":[
                                        {
                                                "pickUpChargeBeginHours":3,
                                                "pickUpChargeFeePercent":30
                                        }
                                    ]
                                },
                                "noshowChargePt":30
                        }
                    ],
                    "scatteredHoursList":[
                        {
                                "startHour":0,
                                "endHour":3,
                                "chargeFee":30
                        }
                    ],
                    "invoiceRule":{
                        "invoiceType":1,
                        "invoiceContent":1,
                        "invoiceFreightType":1,
                        "freightPrice":"20.00"
                    },
                    "forbiddenDriveList":[
                        {
                                "status":1,
                                "forbiddenType":1,
                                "forbiddenCityCode":"110000,230000",
                                "effectType":1,
                                "effectStartTime":"2024-03-09",
                                "effectEndTime":"2024-04-09"
                        }
                    ],
                    "energyServiceFee":{
                        "batteryServiceFee":"30.00",
                        "oilServiceFee":"20.00"
                    },
                    "depositDeductionPolicy":{
                        "vehicleDamageInfoList":[
                            {
                                    "type":101,
                                    "vehicleDamagePriceInfoList":[
                                        {
                                                "price":200,
                                                "type":1
                                        }
                                    ]
                            }
                        ],
                        "vehicleItemLossInfoList":[
                            {
                                    "type":100,
                                    "vehicleItemLossPriceInfoList":[
                                        {
                                                "price":"200",
                                                "type":1
                                        }
                                    ]
                            }
                        ],
                        "violationDealing":{
                            "notifyDetail":{
                                "auditTime":1,
                                "userDealTime":2,
                                "notifyUserTime":3
                            },
                            "driveLicenseLending":{
                                "lendingAdvanceBookingTime":9,
                                "lendingDriveLicenseDeposit":400,
                                "sameCityLendingAvailabilityTime":8,
                                "diffCityLendingAvailabilityTime":48
                            },
                            "illegalDeductRule":{
                                "lateProcessingPenalty":200
                            }
                        }
                    },
                    "roadAssistList":[
                        {
                                "assistType":3,
                                "serviceRange":50,
                                "serviceCharge":200
                        }
                    ]
            }
        ]
    },
    "success":true,
    "retCode":"1001",
    "retMessage":"错误信息"
}

{"success":"false","retMessage":"Illegal request","retCode":"sign-check-failure"}

错误码	错误描述	解决方案

错误码查询工具 SDK下载

开放平台

旅行用车API

qimen.alitrip.rentcar.rule.query (规则同步接口)

公共参数

请求参数

响应参数

请求示例

响应示例

验签示例

错误码解释

API工具

FAQ