顺丰接口 api对接说明

时间:2023-02-12 21:30:39

1       功能说明

物流轨迹查询-使用的物流单号和快递单号即可实现查询物流信息。

1.1   接口规则

(1)、查询接口支持按照运单号查询(单个查询)。

(2)、指定的物流运单号选择相应的快递公司编码,格式不对或则编码错误都会返失败的信息。如EMS物流单号应选择快递公司编码(EMS)

(3)、接口来源:快递鸟

(4)、返回的物流跟踪信息按照发生的时间升序排列。

(5)、接口指令1002。

1.2   系统级输入参数

参数名称

类型

必须要求

说明

RequestData

String

R

请求内容,JSON格式,和DataType一致

EBusinessID

String

R

电商ID

RequestType

String

R

请求指令类型:1002

DataSign

String

R

数据内容签名

DataType

String

R

请求、返回数据类型: 2-json;

1.3   应用级输入参数

参数名称

类型

必须要求

说明

OrderCode

String

O

订单编号

ShipperCode

String

R

快递公司编码

LogisticCode

String

R

物流单号

1.4   返回结果参数

参数名称

类型

必须要求

说明

EBusinessID

String

R

电商用户ID

OrderCode

String

O

订单编号

ShipperCode

String

R

快递公司编码

LogisticCode

String

R

物流运单号

CallBack

String

O

用户标识

Success

Bool

R

成功与否

Reason

String

O

失败原因

State

String

R

物流状态: 2-在途中,3-签收,4-问题件

Traces/物流轨迹详情

AcceptTime

String

R

时间

AcceptStation

String

R

描述

Remark

String

O

备注

2       物流轨迹(订阅查询)

2.1   接口规则

(1)、订单接收的信息(分给了的网点,业务员的信息),会通过推送接口推给客户。客户需要按要求实现接口。

(2)、仅支持Json格式。

(3)、请求指令1008。

(4)、测试接口地址:http://testapi.kdniao.cc:8081/api/dist

(5)、联调通过后请更换为正式地址:http:// api.kdniao.cc/api/dist

(6)、分发及订阅接口需要客户方实现回调接口,回调RequestType(1008)

2.2   系统级输入参数

参数名称

类型

必须要求

说明

RequestData

String

R

请求内容为JSON格式

EBusinessID

String

R

电商ID

RequestType

String

R

请求指令类型:1008

DataSign

String

R

数据内容签名

DataType

String

R

请求、返回数据类型:2-json;

2.3   应用级输入参数

参数名称

类型

是否必须

描述

CallBack

String

O

用户自定义回调信息

MemberID

String

O

会员标识(备用字段)

CustomerName

String

O

电子面单客户账号

(与快递网点申请)

CustomerPwd

String

O

电子面单密码

SendSite

String

O

收件网点标识

ShipperCode

String

R

快递公司编码

LogisticCode

String

R

快递单号

OrderCode

String

O

订单编号

MonthCode

String

O

月结编码

PayType

Int

O

邮费支付方式:

1-现付,2-到付,3-月结,4-第三方支付

ExpType

String

O

快递类型:1-标准快件

Cost

Double

O

寄件费(运费)

OtherCost

Double

O

其他费用

Receiver

Company

String

O

收件人公司

Name

String

O

收件人

Tel

String

O

电话

Mobile

String

O

手机

PostCode

String

O

收件人邮编

ProvinceName

String

O

收件省(如广东省,不要缺少“省”)

CityName

String

O

收件市(如深圳市,不要缺少“市”)

ExpAreaName

String

O

收件区(如福田区,不要缺少“区”或“县”)

Address

String

O

收件人详细地址

Sender

Company

String

O

发件人公司

Name

String

O

发件人

Tel

String

O

发件人电话

Mobile

String

O

发件人手机

PostCode

String

O

发件人邮编

ProvinceName

String

O

发件省(如广东省,不要缺少“省”)

CityName

String

O

发件市(如深圳市,不要缺少“市”)

ExpAreaName

String

O

发件区(如福田区,不要缺少“区”或“县”)

Address

String

O

发件详细地址

StartDate

String

O

上门取货时间段:

"yyyy-MM-dd HH:mm:ss"格式化,本文中所有时间格式相同

EndDate

String

O

Weight

Double

O

物品总重量kg

Quantity

Int

O

件数/包裹数

Volume

Double

O

物品总体积m3

Remark

String

O

备注

IsNotice

Int

O

是否分发到快递公司:1-不分发;0-分发.默认为0

AddService

Name

String

0

增值服务名称

Value

String

0

增值服务值

CustomerID

String

0

客户标识(选填)

Commodity

GoodsName

String

O

商品名称

GoodsCode

String

O

商品编码

Goodsquantity

Int

O

件数

GoodsPrice

Double

O

商品价格

GoodsWeight

Double

O

商品重量kg

GoodsDesc

String

O

商品描述

GoodsVol

Double

O

商品体积m3

           

2.4   返回结果参数

同步返回

参数名称

类型

必须要求

说明

EBusinessID

String

R

电商用户ID

UpdateTime

String

R

时间

Success

Bool

R

成功与否:true,false

Reason

String

O

失败原因

EstimatedDeliveryTime

String

O

订单预计到货时间yyyy-mm-dd

注:订单分发会自动触发运单订阅推送

2.5   JSON请求示例

{

"ShipperCode":"SF",

"OrderCode":"SF201608081055208281",

"LogisticCode":"3100707578976",

"PayType":"1",

"ExpType":"1",

"CustomerName":"",

"CustomerPwd":"",

"MonthCode":"",

"IsNotice":"0",

"Sender":{

"Name":"1255760",

"Tel":"",

"Mobile":"13700000000",

"ProvinceName":"广东省",

"CityName":"深圳市",

"ExpAreaName":"福田区",

"Address":"测试地址"

},

"Receiver":{

"Name":"1255760",

"Tel":"",

"Mobile":"13800000000",

"ProvinceName":"广东省",

"CityName":"深圳市",

"ExpAreaName":"龙华新区",

"Address":"测试地址2"

},

"Commodity":[

{

"GoodsName":"书本"

}

]

}

2.6   JSON返回示例

{

"EBusinessID": "1151847",

"UpdateTime": "2016-08-09 16:42:38",

"Success": true,

"Reason": ""

"EstimatedDeliveryTime":"2016-8-12"

}