一、订单导入接口
同步订单到快递100物流全链路监控产品进行监控服务。
1.1 接口格式
提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。
1.2 请求地址
http://api.kuaidi100.com/logistics/monitor/api/order
1.3 请求参数
请求参数(header)
名称 | 类型 | 默认值 |
---|---|---|
Content-Type | string | application/x-www-form-urlencoded |
请求参数(body)
参数名称 | 数据类型 | 是否必填 | 参数描述 |
---|---|---|---|
method | string | 是 | 业务类型(默认:orderExport) |
key | string | 是 | 授权码,请申请企业版获取 |
sign | string | 是 | 32位大写,签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号,secret可在企业管理后台中企业信息查看 |
t | string | 是 | 时间戳如:1576123932000 |
param | param | 是 | 由其他字段拼接 |
param数据结构:
参数名称 | 数据类型 | 是否必填 | 参数描述 |
---|---|---|---|
sysNum | string | 是 | 系统内订单号 |
pltNum | string | 否 | 平台订单号 |
orderFee | string | 否 | 订单金额 |
payTime | string | 是 | 支付时间(格式:yyyy-MM-dd HH:mm:ss) |
deliveryTime | string | 否 | 发货时间(格式:yyyy-MM-dd HH:mm:ss),指商家实际发货的时间,已发货则需要填入 |
deliveryType | int | 否 | 发货模式,0:现货,1:预售,默认为0 |
proDeliveryTime | string | 否 | 承诺发货时间(格式:yyyy-MM-dd HH:mm:ss),也是平台订单的计划发货时间,若填入则按照此时间监控发货超时 |
sourcePlatform | string | 是 | 订单来源平台,参考附录:订单来源平台 |
sourceReseller | string | 否 | 订单来源分销商名称/自营 |
storeName | string | 否 | 系统内店铺名称 |
warehouseName | string | 否 | 发货仓/供应商名称 |
expressNum | string | 否 | 快递公司单号,已发货则需要填入 |
expressCode | string | 否 | 快递公司的编码,已发货则需要填入, 一律用小写字母 下载编码表格 |
remoteAreaFlag | string | 否 | 是否偏远地区,0:普通地区,1:偏远地区,2:极偏远地区,默认为0 |
receiver | ManInfo | 否 | 收件人信息 |
sender | ManInfo | 否 | 寄件人信息 |
ManInfo数据结构:
参数名称 | 数据类型 | 是否必填 | 参数描述 |
---|---|---|---|
mobile | string | 否 | 手机和固定电话均可,只能填写一个,顺丰速运、顺丰快运必填,其他快递公司选填。如座机号码有分机号,分机号无需传入。 |
province | string | 否 | 省 |
city | string | 否 | 市 |
district | string | 否 | 区/县 |
address | string | 否 | 详细地址 |
1.3 返回结果
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
success | boolean | 提交结果 | true提交成功,false失败 |
code | Int | 返回编码 | 200 成功 |
message | string | 返回报文描述 | |
data | string | 任务id | 建议记录,用于定位问题 |
1.4 返回结果示例
成功返回示例:
{
"code": 200,
"data": "123456789",
"message": "success",
"time": 0,
"success": true
}
失败返回示例:
{
"code": 30001,
"message": "sourcePlatform不能为空",
"time": 0,
"success": false
}
1.5 返回信息代码含义
信息代码 | 信息内容描述 | 原因及建议处理方式 |
---|---|---|
-1 | 服务器错误 | 快递100的服务器出现间歇或临时性异常,有时如果因为不按规范提交请求,比如快递公司参数写错等,也会报此错误 |
200 | 提交成功 | 提交成功 |
30001 | 参数错误 | 请根据技术文档请求,注意参数类型及是否必填。 |
30002 | 验证签名失败 | 检查加密方式,param +t+key+ secret的顺序进行MD5加密,加密后字符串转32位大写,不用加上“+”号 |
30003 | 账号信息不正确 | 检查key是否正确 |
30004 | 账号单量不足 | 单量不足需要充值 |
30005 | 快递公司返回异常 | 按照描述可以自行检查参数的数据类型是否正确 |
二、发货接口
调订单导入接口时未填入发货时间、快递公司编码和快递单号等发货信息,订单发货后,可单独调用此接口更新订单发货信息。
2.1 接口格式
提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。
2.2 请求地址
http://api.kuaidi100.com/logistics/monitor/api/order
2.3 请求参数
请求参数(header)
名称 | 类型 | 默认值 |
---|---|---|
Content-Type | string | application/x-www-form-urlencoded |
请求参数(body)
参数名称 | 数据类型 | 是否必填 | 参数描述 |
---|---|---|---|
method | string | 是 | 业务类型(默认:sendOut) |
key | string | 是 | 授权码,请申请企业版获取 |
sign | string | 是 | 32位大写,签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号,secret可在企业管理后台中企业信息查看 |
t | string | 是 | 时间戳如:1576123932000 |
param | Object | 是 | 由其他字段拼接 |
param数据结构:
参数名称 | 数据类型 | 是否必填 | 参数描述 |
---|---|---|---|
sysNum | string | 是 | 系统内订单号 |
expressNum | string | 是 | 快递公司单号 |
expressCode | string | 是 | 快递公司的编码, 一律用小写字母 下载编码表格 |
deliveryTime | string | 是 | 发货时间 |
2.4 请求参数示例
method=sendOut
key=kytRsteof
sign=4BBDE07660E5EFF90873642CFAE9A8DD
t=1470304729724
param= {
"sysNum": "11111",
"expressNum": "1111",
"expressCode": "shunfeng",
"deliveryTime": "2023-09-04 14:08:00"
}
2.5 返回结果
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
success | boolean | 提交结果 | true提交成功,false失败 |
code | int | 返回编码 | 200 成功 |
message | string | 返回报文描述 | |
data | Object | 任务id | 建议记录,用于定位问题 |
2.6 返回结果示例
成功返回示例:
{
"code": 200,
"data": "123456789",
"message": "success",
"time": 0,
"success": true
}
失败返回示例:
{
"code": 30009,
"message": "该订单已有运单号",
"time": 0,
"success": false
}
2.7 返回信息代码含义
信息代码 | 信息内容描述 | 原因及建议处理方式 |
---|---|---|
-1 | 服务器错误 | 快递100的服务器出现间歇或临时性异常,有时如果因为不按规范提交请求,比如快递公司参数写错等,也会报此错误 |
200 | 提交成功 | 提交成功 |
30001 | 参数错误 | 请根据技术文档请求,注意参数类型及是否必填。 |
30002 | 验证签名失败 | 检查加密方式,param +t+key+ secret的顺序进行MD5加密,加密后字符串转32位大写,不用加上“+”号 |
30003 | 账号信息不正确 | 检查key是否正确 |
30004 | 账号单量不足 | 单量不足需要充值 |
30006 | 参数转换异常 | 按照描述可以自行检查参数的数据类型是否正确 |
30009 | 订单信息存在异常 | 该订单已有运单号 |
三、附录:订单来源平台
平台编码 | 平台名称 |
---|---|
TAOBAO | 淘宝 |
TIANMAO | 天猫 |
TIANMAOCHAOSHI | 天猫超市 |
TAOBAOTEJIA | 淘宝特价 |
JINGDONG | 京东 |
JINGDONGGUOJI | 京东国际 |
JINGDONGCHANGJIAZHISONG | 京东厂家直送 |
TOUTIAO | 抖音 |
DOUYINCHAOSHI | 抖音超市 |
PINDUODUO | 拼多多 |
KUAISHOU | 快手 |
MEITUANTUANHAOHUO | 美团团好货 |
WEIPINHUI | 唯品会 |
YUNJI | 云集 |
TAOGONGCHANG | 淘工厂 |
ALI1688 | 阿里1688 |
YOUZAN | 有赞 |
KUAITUANTUAN | 快团团 |
WEIDIAN | 微店 |
QITA | 其他 |