订单信息导入
1.功能描述
用于将贵方系统待发货订单信息导入到快递管家,实现快递单打印;不支持批量导入需逐一提交;
2.接口信息
| 请求地址 | b.kuaidi100.com/v7/open/api… |
| 通信协议 | HTTPS |
| 请求方式 | POST |
| 字符集 | UTF-8 |
| 请求Conent-Type | application/x-www-form-urlencoded |
3.接口规则
-
订单信息导入成功即扣除订单导入量,导入量需在快递管家—API服务中购买;
-
请求内容中尽量不要包含以下特殊字符:' " # & + < > % \
4.请求参数
| 名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| app_key | String | 是 | 由快递100提供,接入应用的唯一标识([快递管家官网API服务],管理中的App Key) |
| access_token | String | 是 | 授权注册时获取的access_token(访问令牌) |
| timestamp | long | 是 | 时间戳,自1970年01月01日起到现在的秒数, 例: 1502963129 |
| sign | String | 是 | 签名,签名算法参照【签名说明】 |
| data | String | 是 | Json字符串,贵方的订单信息数据 |
data参数
| 名称 | 类型(字符长度) | 是否必填 | 描述 |
|---|---|---|---|
| receiver | Object | 是 | 收件人信息 |
| └company | String(30) | 否 | 收件人公司名称 |
| └mobile | String(30) | 是 | 收件人电话(电话/固话至少一个必传); 例:13800138000 |
| └phone | String(30) | 是 | 收件人固话(电话/固话至少一个必传); 例:0755-12345678 |
| └name | String(30) | 是 | 收件人姓名;例:张三 |
| └addr | String(100) | 是 | 收件人详细地址(必传,含省市区); 例:广东省深圳市南山区科技南十二路2号 |
| └country | String(30) | 否 | 收件人国家(默认【中国】) |
| sender | Object | 是 | 寄件人信息 |
| └company | String(30) | 否 | 寄件人公司名称 |
| └mobile | String(30) | 是 | 寄件人电话(电话/固话至少一个必传); 例:13800138000 |
| └phone | String(30) | 是 | 寄件人固话(电话/固话至少一个必传); 例:0755-12345678 |
| └name | String(30) | 是 | 寄件人姓名;例:张三 |
| └addr | String(100) | 是 | 寄件人详细地址(必传,含省市区); 例:广东省深圳市南山区科技南十二路2号 |
| order_number | String(30) | 是 | 订单编号(客户自定义,保证唯一); 例:ORD123456 |
| cargo_name | String(100) | 是 | 物品名称;例:发票、文件等,可打印在面单上 |
| cargo_count | int(3) | 否 | 物品件数,默认值1 |
| volume | String(20 ,3) | 否 | 包裹总体积(长宽高,单位cm³) |
| order_source | String(30) | 否 | 订单来源,默认为:OPENAPI寄件,针对开通微信物流助手的订单必传(固定值为大写:WX) |
| openid | String(30) | 否 | 第三方用户openId(比如微信用户的openId),针对开通微信物流助手的订单必传 |
| express_custom_code | String(30) | 否 | 快递客户编码,针对开通微信物流助手的订单必传 |
| express_company | String(30) | 否 | 快递公司编码,针对开通微信物流助手的订单必传 |
| order_page_url | String(100) | 否 | 商家小程序的路径,建议为订单页面,针对开通微信物流助手的订单必传 |
| service_type | String(30) | 否 | 业务类型,默认:标准快递,其他值可在快递管家下单页面查看 |
| weight | Double(10,3) | 否 | 包裹重量,单位:公斤,不传默认为1公斤 |
| insured_money | Double(10,3) | 否 | 保价金额,单位:元, 如需保价请传金额,默认不保价 |
| collection | Double(10,3) | 否 | 代收货款金额,单位:元, 如需代收请传金额,默认不代收 |
| payment | String(30) | 否 | 运费付款方式,默认为:SHIPPER 寄方月结:SHIPPER 到付:CONSIGNEE 协议结算:MONTHLY(快递超市的协议用户才可使用) |
| comment | String(50) | 否 | 备注信息,可显示在面单“备注”区域 |
| package_count | int(3) | 否 | 包裹数,大于1时为子母单,默认为1件 |
| api_pay_mode | String(10) | 否 | API的扣费模式,默认:SINGLE 直接使用者付费(如入驻商家): SINGLE 对接服务商统一付费(如电商平台):STANDARD |
| need_back_check | Boolean | 否 | 是否签回单,默认值:false |
| goods_list | Array | 是 | 物品清单列表 |
| └name | String(30) | 是 | 商品名称 |
| └spec | String(30) | 否 | 商品规格 |
| └count | int(3) | 否 | 商品数量,默认值1 |
| └unit | String(30) | 否 | 商品单位 |
| └outer_id | String(30) | 否 | 商品外部编号或id |
| └img_url | String(100) | 否 | 商品缩略图url,针对开通微信物流助手的订单必传 |
示例:
app_key=LeWFeuaGwdf&access_token=uoKbfafdfafcCce×tamp=1502963129&sign=3CF35D130E8B197553ADE1BAEA2615F0&data={
"cargo_count":1,
"cargo_name":"货物名称",
"collection":123,
"comment":"货物测试",
"goods_list":[
{
"count":1,
"name":"衣服"
}
],
"order_number":"12121112348800232",
"package_count":1,
"payment":"SHIPPER",
"receiver":{
"addr":"广东省深圳市福田区下沙",
"country":"中国",
"mobile":"13233332222",
"name":"收件人",
"phone":"13233332222"
},
"sender":{
"addr":"广东省深圳市龙岗区龙城街道龙红格社区龙翔大道",
"country":"中国",
"mobile":13233332222,
"name":"发件人",
"phone":"13233332222"
},
"service_type":"标准快递",
"weight":1
}
5.返回参数
| 名称 | 类型(字符长度) | 是否必填 | 描述 |
|---|---|---|---|
| status | String(5) | 是 | 200:成功401:失败 |
| message | String(30) | 是 | 成功/失败原因 |
示例:
成功:
{
"status": "200",
"message": "success"
}
失败:
{
"status": "401",
"message": "签名方式有误"
}
6.接口异步回调信息
请求的Content-Type:application/json;charset=UTF-8
6.1 请求参数
| 名称 | 类型(字符长度) | 是否必填 | 描述 |
|---|---|---|---|
| app_key | String | 是 | 由快递100提供,接入应用的唯一标识([快递管家官网API服务],管理中的App Key) |
| timestamp | long | 是 | 时间戳,自1970年01月01日起到现在的秒数, 例: 1502963129 |
| type | String | 是 | 回调接口推送类型,固定为:SEND |
| sign | String | 否 | 签名,签名算法参照【签名说明】 |
| data | String | 是 | Json字符串 |
| └order_number | String(30) | 是 | 订单编号 |
| └status | String(5) | 是 | 200:成功 401:失败 |
| └message | String(30) | 是 | 成功/失败原因 |
示例:
成功:
{
"app_key": "LeWFeuaGwx1v",
"data":{
"order_number":"ORD123456",
"status": "200",
"message": "success"
},
"type": "SEND",
"timestamp": 1596100607
}
失败:
{
"app_key": "LeWFeuaGwx1v",
"data":{
"order_number":"ORD123456",
"status": "401",
"message": "添加寄件失败"
},
"type": "SEND",
"timestamp": 1596100607
}
6.2 返回参数
| 名称 | 类型(字符长度) | 是否必填 | 描述 |
|---|---|---|---|
| status | String(5) | 是 | 200:成功 400:失败 |
示例:
成功:
{“status”:200}
失败:
{“status”:400}