服务目录

公告栏

接入流程

开发指南

常用工具

业务流程

常见问题

面向买家服务

面向商家服务

京麦服务市场

供应商服务

京东云服务

【京东快递】接口导航


 相关文档下载：ERP对接方案【10月24日更新】   京东快递可配送区域

1. 获取京东物流运单号接口   

 2. 京东物流接单接口
3. 京东物流全程跟踪查询接口   

京东快递常见问题FAQ


1.获取京东物流运单号接口

接口名称

jingdong.etms.waybillcode.get

功能说明

获取京东物流预分配的运单号    相关文档下载：ERP对接方案【10月24日更新】   京东快递可配送区域

API用户授权类型

需要

系统级别输入参数

名称

类型

是否必须

描述

method

String

是

API接口名称

access_token

String

是

采用OAuth授权方式为必填参数

app_key

String

是

应用的app_key

sign

String

是

签名

timestamp

String

是

时间戳，格式为yyyy-MM-dd HH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟

format

String

否

暂时只支持json

v

String

否

API协议版本，可选值:2.0

应用级输入参数

名称

类型

是否必须

示例值

描述

preNum  String 是   获取运单号数量（最大100）

customerCode

String

是

 

商家编码（区分英文大小写）

（登录京东物流网站（http://www.jd-ex.com/）查看。如无登录账号，可向配送运营人员索取。并非POP系统商家id。）

返回结果

名称

类型

示例值

描述

resultInfo 

ResultInfoDTO 

 

处理结果

ResultInfoDTO属性

名称

类型

是否必须

示例值

描述

code 

String 

否

100

结果编码   

message  

String 

否

成功

结果描述

deliveryIdList 

String  

否

000989987688

京东运单号

返回示例

JSON数据格式

{
  "jingdong_etms_waybillcode_get_responce":{
  "resultInfo":{
  "message":"成功",
"deliveryIdList":"000989987688",
"code":"100",
  }
  }
  }

SDK调用示例（java）

public JdClient client=new DefaultJdClient(SERVER_URL,accessToken,appKey,appSecret); 
EtmsWaybillcodeGetRequest request=new EtmsWaybillcodeGetRequest();
request.setPreNum( "jingdong" );
request.setCustomerCode( "jingdong" );
EtmsWaybillcodeGetResponse response=client.execute(request);
2.京东物流接单接口

接口名称

jingdong.etms.waybill.send

功能说明

向京东物流系统提交运单信息   相关文档下载：ERP对接方案【10月24日更新】   京东快递可配送区域

API用户授权类型

需要

系统级别输入参数

名称

类型

是否必须

描述

method

String

是

API接口名称

access_token

String

是

采用OAuth授权方式为必填参数

app_key

String

是

应用的app_key

sign

String

是

签名

timestamp

String

是

时间戳，格式为yyyy-MM-dd HH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟

format

String

否

暂时只支持json

v

String

否

API协议版本，可选值:2.0

应用级输入参数

序号

字段描述

名称

类型

是否必须

示例值

描述

1

运单号

deliveryId 

String 

是

 

运单号（通过jingdong.etms.waybillcode.get获取到的运单号）

2

销售平台编码

salePlat 

String 

是

 

京东快递物流系统为各平台维护了数据字典，如为京东平台，则传入0010001。如没有以下平台，可传入0030001（即其他），数据字典如下：
0010001 京东
0010002 天猫
0010003 苏宁
0010004 亚马逊中国
0020001 ChinaSkin
0030001 其他小型销售平台
务必保证该字段的正确

3

商家店铺编码

customerCode

String 

是

 

商家跟京东快递签订合同后京东快递给商家根据店铺创建的编号，需要唯一。
商家编码（登录京东物流网站（http://www.jd-ex.com/）查看。如无登录账号，可向配送运营人员索取。并非POP系统商家id。）

4

商家订单号

orderId 

String 

是

 

商家发货商品的唯一标识，可能为ERP软件生成的新订单号，即商家订单号未必等于平台订单号

5

京东订单号

thrOrderId

String

否

如果销售平台编码为0010001（京东），则此字段不能为空。

如果订单为京东平台订单，此字段必填。
如果该订单为京东平台之外的订单，请为空。

6

是否客户打印运单

selfPrintWayBill

Number

否

1

是否客户打印运单(是：1，否：0。不填或者超出范围，默认是1)

7

取件方式

pickMethod

String

否

1

取件方式(上门收货：1，自送：2。不填或者超出范围，默认是1)

8

包装要求

packageRequired 

String 

否

1

包装要求(不需包装：1，简单包装：2，特殊包装：3。不填或者超出范围，默认是1) 

9

寄件人姓名

senderName 

String 

是

 

寄件人姓名

10

寄件人地址

senderAddress 

String 

是

 

寄件人地址

11

寄件人电话

senderTel 

String 

否

 

寄件人电话

12

寄件人手机

senderMobile 

String 

否

 

寄件人手机(寄件人电话、手机至少有一个不为空) 

13

寄件人邮编

senderPostcode 

String 

否

 

寄件人邮编

14

收件人姓名

receiveName 

String 

是

 

收件人姓名

15

手机人地址

receiveAddress 

String 

是

 

收件人地址 

16

收件人省 

province 

String 

否

 

收件人省 

17

收件人市

city 

String 

否

 

收件人市

18

收件人县

county 

String 

否

 

收件人县

19

收件人镇 

town 

String 

否

 

收件人镇 

20

收件人电话

receiveTel 

String 

否

 

收件人电话

21

收件人手机

receiveMobile 

String 

否

 

收件人手机号(收件人电话、手机至少有一个不为空)

22

收件人邮编

postcode 

String 

否

 

收件人邮编

23

包裹数量

packageCount 

Number

是

 

该订单下的包裹数(大于0，小于1000)，几个包裹就需要打印几个快递单

24

重量

weight 

Number

是

 

重量(单位：kg，保留小数点后两位，默认为0 ) 

25

包裹长度

vloumLong 

Number

否

 

包裹长(单位：cm,保留小数点后两位)

26

包裹宽度

vloumWidth 

Number

否

 

包裹宽(单位：cm，保留小数点后两位) 

27

包裹高

vloumHeight  

Number

否

 

包裹高(单位：cm，保留小数点后两位)

28

包裹体积

vloumn 

Number

是

10000

体积(单位：CM3，保留小数点后两位，默认可传为0 )

29

商品描述

description  

String  

否

 

商品描述

30

是否代收货款

collectionValue 

Number

是

1

1为代收货款，0为非代收货款

31

代收货款金额

collectionMoney 

Number

否

98.00

【是否代收货款】为1，则必填：保留小数点后两位，后台会校验
如果【是否代收货款】为0，则为空。

32

是否保价

guaranteeValue 

Number

否

1

是否保价(是：1，否：0。不填或者超出范围，默认是0) 

33

保价金额

guaranteeValueAmount  

Number

否

100.00

如果有保价，则保价金额(保留小数点后两位) 为必填，后台有校验。

34

是否签单返还

signReturn 

Number

否

1

签单返还(是：1，否：0。不填或者超出范围，默认是0) 

35

运单时效

aging 

Number

否

1

时效(普通：1，工作日：2，非工作日：3，晚间：4。不填或者超出范围，默认是1) 

36

运输业务类型

transType 

Number

否

1

运输类型(陆运：1，航空：2。不填或者超出范围，默认是1) 

 

返回结果

名称

类型

示例值

描述

resultInfo 

ResultInfoDTO 

 

处理结果

ResultInfoDTO 属性

名称

类型

示例值

描述

code 

String 

100

结果编码 

message 

String 

成功

结果描述 

orderId 

String 

658898

商家订单号 

deliveryId 

String 

000989987688 

京东运单号. 

 

返回示例

JSON数据格式

{
  "jingdong_etms_waybill_send_responce":{
  "resultInfo":{
  "message":"成功",
"deliveryId":"000989987688",
"code":"100",
"orderId":"658898"
  }
  }
  }

SDK调用示例（java）

public JdClient client=new DefaultJdClient(SERVER_URL,accessToken,appKey,appSecret);
EtmsWaybillSendRequest request=new EtmsWaybillSendRequest();
request.setDeliveryId( "jingdong" );
request.setSalePlat( "jingdong" );
request.setCustomerCode( "jingdong" );
request.setOrderId( "jingdong" );
request.thrOrderId( "jingdong" );
request.setSelfPrintWayBill( 123 );
request.setPickMethod( "jingdong" );
request.setPackageRequired( "jingdong" );
request.setSenderName( "jingdong" );
request.setSenderAddress( "jingdong" );
request.setSenderTel( "jingdong" );
request.setSenderMobile( "jingdong" );
request.setSenderPostcode( "jingdong" );
request.setReceiveName( "jingdong" );
request.setReceiveAddress( "jingdong" );
request.setProvince( "jingdong" );
request.setCity( "jingdong" );
request.setCounty( "jingdong" );
request.setTown( "jingdong" );
request.setReceiveTel( "jingdong" );
request.setReceiveMobile( "jingdong" );
request.setPostcode( "jingdong" );
request.setPackageCount( 123 );
request.setWeight( 123 );
request.setVloumLong( 123 );
request.setVloumWidth( 123 );
request.setVloumHeight( 123 );
request.setVloumn( 123 );
request.setDescription( "jingdong" );
request.setCollectionValue( 123 );
request.setCollectionMoney( 123 );
request.setGuaranteeValue( 123 );
request.setGuaranteeValueAmount( 123 );
request.setSignReturn( 123 );
request.setAging( 123 );
request.setTransType( 123 );
EtmsWaybillSendResponse response=client.execute(request);

3.京东物流全程跟踪查询接口
  接口名称

jingdong.etms.trace.get

 功能说明

京东物流全程跟踪查询接口   相关文档下载：ERP对接方案【10月24日更新】   京东快递可配送区域

API用户授权类型

不需要


系统级别输入参数

名称 类型 是否必须 描述
method String 是 API接口名称
access_token String 否 采用OAuth授权方式为必填参数
app_key String 是 应用的app_key
sign String 是 签名
timestamp String 是 时间戳，格式为yyyy-MM-dd HH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟
format String 否 暂时只支持json
v String 否 API协议版本，可选值:2.0

应用级输入参数

名称 类型 是否必须 示例值 描述
waybillCode  String  是 000123456789  运单号 

返回结果

名称 类型 示例值 描述
trace_api_dtos  TraceApiDto[]  请参考返回示例中的JSON数据格式  全程跟踪数据结果集 

trace_api_dtos  属性

名称 类型 是否必须 示例值 描述
ope_title  String  否 站点验货  操作标题 
ope_remark  String  否 您的订单已分配  操作详情 
ope_name  String  否 张三  操作人姓名 
ope_time  String  否 2013/06/25 09:16:09  操作时间 

 返回示例

JSON数据格式

{
  "jingdong_etms_trace_get_responce":{
  "trace_api_dtos":[{
  "ope_remark":"您的订单已分配",
"ope_time":"2013/06/25 09:16:09",
"ope_title":"站点验货",
"ope_name":"张三"
  }]
  }
  } 

SDK调用示例（java）

public JdClient client=new DefaultJdClient(SERVER_URL,accessToken,appKey,appSecret); 
EtmsTraceGetRequest request=new EtmsTraceGetRequest();
request.setWaybillCode( "jingdong" );
EtmsTraceGetResponse response=client.execute(request);