文档中心
一、订单导入接口 二、发货接口 三、附录:订单来源平台

一、订单导入接口

同步订单到快递100物流全链路监控产品进行监控服务。

1.1 接口格式

提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。

1.2 请求地址

http://api.kuaidi100.com/logistics/monitor/api/order

1.3 请求参数

请求参数(header)

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

请求参数(body)

参数名称数据类型是否必填参数描述
methodstring业务类型(默认:orderExport)
keystring授权码,请申请企业版获取
signstring32位大写,签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号,secret可在企业管理后台中企业信息查看
tstring时间戳如:1576123932000
paramparam由其他字段拼接

param数据结构:

参数名称数据类型是否必填参数描述
sysNumstring系统内订单号
pltNumstring平台订单号
orderFeestring订单金额
payTimestring支付时间(格式:yyyy-MM-dd HH:mm:ss)
deliveryTimestring发货时间(格式:yyyy-MM-dd HH:mm:ss),指商家实际发货的时间,已发货则需要填入
deliveryTypeint发货模式,0:现货,1:预售,默认为0
proDeliveryTimestring承诺发货时间(格式:yyyy-MM-dd HH:mm:ss),也是平台订单的计划发货时间,若填入则按照此时间监控发货超时
sourcePlatformstring订单来源平台,参考附录:订单来源平台
sourceResellerstring订单来源分销商名称/自营
storeNamestring系统内店铺名称
warehouseNamestring发货仓/供应商名称
expressNumstring快递公司单号,已发货则需要填入
expressCodestring快递公司的编码,已发货则需要填入, 一律用小写字母 下载编码表格
remoteAreaFlagstring是否偏远地区,0:普通地区,1:偏远地区,2:极偏远地区,默认为0
receiverManInfo收件人信息
senderManInfo寄件人信息

ManInfo数据结构:

参数名称数据类型是否必填参数描述
mobilestring手机和固定电话均可,只能填写一个,顺丰速运、顺丰快运必填,其他快递公司选填。如座机号码有分机号,分机号无需传入。
provincestring
citystring
districtstring区/县
addressstring详细地址

1.3 返回结果

字段类型说明备注
successboolean提交结果true提交成功,false失败
codeInt返回编码200 成功
messagestring返回报文描述
datastring任务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-Typestringapplication/x-www-form-urlencoded

请求参数(body)

参数名称数据类型是否必填参数描述
methodstring业务类型(默认:sendOut)
keystring授权码,请申请企业版获取
signstring32位大写,签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号,secret可在企业管理后台中企业信息查看
tstring时间戳如:1576123932000
paramObject由其他字段拼接

param数据结构:

参数名称数据类型是否必填参数描述
sysNumstring系统内订单号
expressNumstring快递公司单号
expressCodestring快递公司的编码, 一律用小写字母 下载编码表格
deliveryTimestring发货时间

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 返回结果

字段类型说明备注
successboolean提交结果true提交成功,false失败
codeint返回编码200 成功
messagestring返回报文描述
dataObject任务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其他