文档中心
一、价格查询接口 二、托运下单接口 三、订单取消接口 四、下单回调接口

快递100电动车托运API接口文档

快递100电动车托运API接口文档,涵盖价格查询、托运下单、订单取消及状态回调等全部接口。支持电瓶车、摩托车、三轮车等车型,开发者可快速集成,实现实时运费查询、在线下单与全流程订单追踪。

调用流程说明:

1、价格查询:用户先调用 价格查询接口 ,传入起止地、物品类型等,获取预估运费。

2、托运下单:确认后调用 托运下单接口 ,提交完整寄收件信息、预约时间及回调地址,获得订单号。

3、状态回调:快递100会按订单状态变化(待取件→配送中→已完成),主动向用户提供的 callbackUrl 推送状态通知;回调失败有重试机制。

4、订单取消:仅在“待取件”状态下可调用 订单取消接口 取消订单,成功后同样会通过回调通知状态更新为“订单取消”。

一、 价格查询接口

1.1 请求地址

POST https://api.kuaidi100.com/consign/price

名称类型默认值
Content-TypeStringapplication/x-www-form-urlencoded

1.2 请求参数

参数名是否必填类型说明
keystring授权码,请到快递100页面申请企业版接口获取
signstring32位大写,签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号。secret在企业管理后台获取
tstring时间戳如:1576123932000
paramparam由其他字段拼接

param 数据结构

参数名类型说明备注
sendProvinceString寄件人省份-
sendCityString寄件人城市-
sendDistrictString寄件人区县-
sendAddressString寄件人详细地址-
recProvinceString收件人省份-
recCityString收件人城市-
recDistrictString收件人区县-
recAddressString收件人详细地址-
goodsNumInteger物品数量
extraObject

extra数据结构:

参数名类型说明备注
goodsTypeIdInteger物品类型id30-电瓶车;31-摩托车;34-三轮车
appreciateIdInteger包装方式id1-无需包装;2-定制木架;4-自己包装
deliveryIdInteger取货方式id1-到站自提;2送货上门

*到站自提:收货人需去最近营业网点取货;送货上门:送货至收货人楼下不上楼。

请求示例

{
    "sendProvince": "广东省",
    "sendCity": "深圳市",
    "sendDistrict": "南山区",
    "sendAddress": "科技园南区深圳湾科技生态园",
    "recProvince": "广东省",
    "recCity": "深圳市",
    "recDistrict": "龙华区",
    "recAddress": "龙华某某街道11号",
    "goodsNum": 2,
    "extra": {
        "goodsTypeId": 31,
        "appreciateId": 1,
        "deliveryId": 2
    }
}

1.3 响应参数

字段类型说明备注
successboolean提交结果true提交成功,false失败
codeInt返回编码200为成功
messagestring返回报文描述
dataObject

data数据结构

字段类型是否必填说明备注
totalFeestring非必须总运费
deliverFeestring非必须运输费
taskIdstring非必须taskId
otherFeearray非必须其他费用item 类型: object

otherFee 对象结构:

字段类型是否必填说明备注
feeTypestring非必须暂时只有delivery_service_fee,配送服务费
feeDescstring非必须
amountstring非必须

响应示例

{
    "result": true,
    "returnCode": 200,
    "message": "成功",
    "data": {
        "deliverFee": "922.00",
        "otherFee": [
            {
                "feeType": "delivery_service_fee",
                "feeDesc": "配送服务费",
                "amount": "90.00"
            }
        ],
        "taskId": "B1E203B23DA94BB6B6563D22C8294772",
        "totalFee": "1012.00"
    }
}

二、 托运下单接口

2.1 请求地址

POSThttps://api.kuaidi100.com/consign/createOrder

名称类型默认值
Content-TypeStringapplication/x-www-form-urlencoded

2.2 请求参数

参数名是否必填类型说明
keystring授权码,请到快递100页面申请企业版接口获取
signstring32位大写,签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号。secret在企业管理后台获取
tstring时间戳如:1576123932000
paramparam由其他字段拼接

param 数据结构

参数名类型说明备注
sendNameString寄件人姓名-
sendMobileString寄件人电话
sendProvinceString寄件人省份-
sendCityString寄件人城市-
sendDistrictString寄件人区县-
sendAddressString寄件人详细地址-
recNameString收件人姓名-
recMobileString收件人电话
recProvinceString收件人省份-
recCityString收件人城市-
recDistrictString收件人区县-
recAddressString收件人详细地址-
dayTypeString预约时间类型枚举值:今天、明天、后天
pickupStartTimeString预约取件开始时间格式:HH:mm
pickupEndTimeString预约取件截止时间格式:HH:mm
goodsNumInteger物品数量
commentString订单备注
callbackUrlString订单信息回调
saltstring随机字符串,用于回调签名默认为空。客户提供,用于验证回调信息
extraObject

extra数据结构:

参数名类型说明备注
goodsTypeIdInteger物品类型id30-电瓶车;31-摩托车;34-三轮车
appreciateIdInteger包装方式id1-无需包装;2-定制木架;4-自己包装
deliveryIdInteger取货方式id1-收件人网点取货;2-送至收件人楼下

*到站自提:收货人需去最近营业网点取货;送货上门:送货至收货人楼下不上楼。

请求示例:

{
    "sendName": "张三",
    "sendMobile": "13800138000",
    "sendProvince": "广东省",
    "sendCity": "深圳市",
    "sendDistrict": "南山区",
    "sendAddress": "科技园南区深圳湾科技生态园1111",
    "recName": "李四",
    "recMobile": "13900139000",
    "recProvince": "广东省",
    "recCity": "深圳市",
    "recDistrict": "龙华区",
    "recAddress": "龙华某某街道11号",
    "goodsNum": 1,
    "extra": {
        "goodsTypeId": 31,
        "appreciateId": 1,
        "deliveryId": 1
    },
    "remark": "易碎物品,请轻拿轻放",
    "dayType": "明天",
    "pickupStartTime": "09:00",
    "pickupEndTime": "12:00",
    "callbackUrl": "http://106.12.21.101:3001/callback/sentorder",
    "salt": "123"
}

2.3 响应参数

字段类型说明备注
resultboolean提交结果true提交成功,false失败
returnCodeInt返回编码200为成功
messagestring返回报文描述
dataObject

data数据结构

字段类型是否必填说明备注
taskIdstring任务ID32位随机字符串,用于记录订单整个生命周期
orderIdInt非必须订单id
outOrderIdString非必须第三方单号
deliveryDistanceString非必须配送距离
phoneString非必须联系电话
totalFeeString非必须总运费
deliverFeeString非必须运输费
otherFeearray非必须其他费用item 类型: Object

otherFee 对象结构:

字段类型是否必填说明备注
feeTypestring非必须暂时只有delivery_service_fee,配送服务费
feeDescstring非必须
amountstring非必须

响应示例:

{
    "result": true,
    "returnCode": 200,
    "message": "成功",
    "data": {
        "taskId": "3B9A04EA8D8443F18F72670212ACAC01",
        "orderId": 268,
        "outOrderId": "20302423432",
        "deliveryDistance": null,
        "phone": "4006115858",
        "totalFee": "436.00",
        "deliverFee": "436.00",
        "otherFee": [
            {
                "feeType": "delivery_service_fee",
                "feeDesc": "配送服务费",
                "amount": "0.00"
            }
        ],

    }
}

三、 订单取消接口

只有在待取件状态下才允许调用取消接口,快递员已揽收不允许取消

3.1 请求地址

POSThttps://api.kuaidi100.com/consign/cancel

名称类型默认值
Content-TypeStringapplication/x-www-form-urlencoded

3.2 请求参数

参数名是否必填类型说明
keystring授权码,请到快递100页面申请企业版接口获取
signstring32位大写,签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号。secret在企业管理后台获取
tstring时间戳如:1576123932000
paramparam由其他字段拼接

param 数据结构

字段名数据类型含义
orderIdString订单id
cancelMsgString取消原因

请求示例:

{
    "orderId": "45",
    "cancelMsg": "张三"
}

3.3 响应参数

响应示例:

{
    "result": true,
    "returnCode": 200,
    "message": "成功",
    "data": {
        "taskId": "32599AA3DEA8423E8F26638988FEDCAB",
        "orderId": 45
    }
}

四、 下单回调接口

4.1 请求地址

POST 下单填写的callbackUrl

名称类型默认值
Content-TypeStringapplication/x-www-form-urlencoded

4.2 请求参数

字段类型说明备注
taskIdstring任务ID
signstring签名MD5 (param +salt)
paramparam参数主体

param字段:

名称类型是否必须默认值备注其他信息
orderIdnumber非必须 订单id
outOrderIdstring非必须 第三方订单号
statusnumber非必须 状态,见备注

状态码

订单状态码状态描述
210待取件
310配送中
520已完成
720订单取消
{
    "param": {
        "taskId": "B8237E815CFF46CE98AEAA0B6851BD84",
        "orderId": 46,
        "status": 720
    },
    "sign": "c945f835b6fb517c6083123c23bb7cec",
    "taskId": "B8237E815CFF46CE98AEAA0B6851BD84"
}

4.3 响应参数

{
    "result": true,
    "returnCode": "200",
    "message": "提交成功"
}

失败后每隔20min重试一次,最多(含首次)调用3次。