首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >集成全国多家快递公司同城配送下单API接口代码-快递100

集成全国多家快递公司同城配送下单API接口代码-快递100

原创
作者头像
快递100API
修改2021-05-25 10:47:25
1.1K0
修改2021-05-25 10:47:25
举报

一、同城配送下单

选择快递公司进行下单。

1.1 接口格式

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

1.2 请求地址

https://order.kuaidi100.com/sameCity/order

请求参数:

参数名

是否必填

类型

说明

method

string

业务类型(默认:order)

key

string

授权码, 请到快递100页面申请企业版接口获取 https://api.kuaidi100.com/register

sign

string

32位大写,签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号secret在授权邮件里面有

t

string

时间戳如:1576123932000

param

param

由其他字段拼接

param数据结构:

参数名

是否必填

类型

说明

com

string

快递公司的编码,一律用小写字母,见《快递公司编码》

recManName

string

收件人姓名

recManMobile

string

收件人的手机号,手机号和电话号二者其一必填

recManPrintAddr

string

收件人所在完整地址,如广东深圳市深圳市南山区科技南十二路2号金蝶软件园

sendManName

string

寄件人姓名

sendManMobile

string

寄件人的手机号,手机号和电话号二者其一必填

sendManPrintAddr

string

寄件人所在的完整地址,如广东深圳市深圳市南山区科技南十二路2号金蝶软件园B10

callbackUrl

string

callBackUrl订单信息回调

orderType

string

订单类型 0:立即单(默认) 1:预约单

pickupTime

string

预约取件时间(2020-02-02 22:00:00),预约件必填

weight

double

物品总重量KG,不需要带单位,例:1.5

serviceType

string

快递业务服务类型,例:文件广告;对照参数字典

remark

string

备注

salt

string

签名用随机字符串

orderSourceNo

String

物品来源单号(比如美团、饿了么订单方便骑手取货)

orderSourceType

String

物品来源(比如美团、饿了么订单方便骑手取货)

storeId

String

店铺id(对应快递公司提供的店铺标识)

additionFee

Int

小费,单位分,不需要带单位,例:1000

price

Int

商品价格,单位分,不需要带单位,例:1000

partnerId

String

服务商授权信息,对照参数字典

partnerKey

String

服务商授权信息,对照参数字典

goods

obj

商品详情(强烈建议提供,方便骑手在取货时确认货品信息)

goods数据结构:

参数名

是否必填

类型

说明

name

String

商品名称

price

Int

商品价格

count

Int

商品数量

uint

String

商品单位

1.3 返回结果

字段

类型

说明

备注

result

boolean

提交结果

true提交成功,false失败

returnCode

string

返回编码

message

string

返回报文描述

data

data

data数据结构

字段

类型

说明

备注

taskId

string

任务ID

orderId

string

订单ID

fee

int

费用,单位分

distance

int

距离,单位公里

kuaidiNum

string

快递公司订单号

1.4 提供数据内容

param例子

{

 		"com": "kfw",

 		"recManName": "测试",

 		"recManMobile": "13542651579",

 		"recManPrintAddr": "深圳市南山区伟易达大夏",

 		"sendManName": "小张",

 		"sendManMobile": "13542651579",

 		"sendManPrintAddr": "深圳市南山区高新南地铁站b口",

 		"serviceType": "火锅",

 		"weight": 1.00,

  "remark": "测试订单,待会取消",

 		"salt": "123",

 	"callBackUrl": "http://www.baiud.com",

 		"pickupTime": "",

 		"orderSourceNo": "168168168",

 		"orderSourceType": "美团",

 		"storeId": "106396",

 		"additionFee": 1000,

 		"partnerId": "155555555",

 		"partnerKey": "1111111111"

}

返回结果例子

{

  "returnCode": "200",

  "result": true,

  "message": "提交成功",

  "data": {

    "taskId": "13F873760DCB4CF28D666A13FDE6B31A",

    "com": "kfw",

    "orderId": "1000090",

    "fee": 5000,

    "distance": 1000,

    "kuaidiNum": "KFWZS1476131277"

  }

} 

1.5 信息代码含义

信息代码

信息内容描述

原因及建议处理方式

200

成功

成功

400

参数错误等

提交数据不完整, 检查提交的格式是否为x-www-form-urlencoded的post格式

500

服务器错误

快递100的服务器出理间隙或临时性异常,有时如果因为不按规范提交请求,比如快递公司参数没有按照文档规定填写等,也会报此错误

501

重复提交

快递100的服务器出理间隙或临时性异常,有时如果因为不按规范提交请求,比如快递公司参数没有按照文档规定填写等,也会报此错误

503

验证签名失败

请检查加密方式,param + t + key+ secret 的顺序进行MD5加密,加密后字符串转大写

601

key已过期

没有可用单量,账号需要充值使用

二、下单回调接口

订单有状态变更是会触发回调,回调后如果没有得到合作方正确返回,会重复回调多2次,即最多回调3次。间隔30分钟。

2.1 接口格式

提供统一格式的HTTP POST,并返回统一格式JSON数据。

请求报头:Content-Type=application/x-www-form-urlencoded;charset=UTF-8

2.2 请求地址

授权时贵司填入的callbackUrl

请求参数:

字段

类型

说明

备注

taskId

String

任务id

sign

String

签名

下单时填写了salt时会带sign md5(param+salt)

param

param

参数主体

param数据结构:

参数名

是否必填

类型

说明

kuaidicom

string

快递公司的编码,一律用小写字母,见《快递公司编码》,选填。

kuaidinum

string

快递单号,单号的最大长度是32个字符。

message

string

状态描述

orderId

string

平台订单ID

status

string

订单状态0-下单成功 1-已接单 10-已取货 13-已签收 9-用户主动取消 99-订单已取消

courierName

string

快递员姓名

courierMobile

string

快递员电话

weight

string

重量

freight

string

运费

2.3 返回结果

字段

说明

备注

result

提交结果

true提交成功,false失败

returnCode

返回编码

message

返回报文描述

2.4 提供数据内容

入参param例子

	{
  	"courierMobile":"15010033036",
  		"courierName":"G师傅",
  		"kuaidiCom":"kfw",
  		"kuaidiNum":"KFWZS1476130507",
  		"message":"订单已取消",
  		"orderId":"1000086",
  		"status":99
  }

要求返回结果

{

  		"returnCode": "200",

  		"result": true,

  		"message": "成功"

}

2.4 推送响应报文及错误码解释

字段名称

字段含义

result

true表示成功,false表示失败。如果提交回调接口的地址失败,30分钟后重新回调,3次仍旧失败的,自动放弃

returnCode

200: 提交成功 500: 服务器错误 其他错误请自行定义

message

返回的提示

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 一、同城配送下单
    • 1.1 接口格式
      • 1.2 请求地址
        • 1.3 返回结果
          • 1.4 提供数据内容
            • 1.5 信息代码含义
            • 二、下单回调接口
              • 2.1 接口格式
                • 2.2 请求地址
                  • 2.3 返回结果
                    • 2.4 提供数据内容
                      • 2.4 推送响应报文及错误码解释
                      领券
                      问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档