取号接口

基本信息

请求方式	Post application/x-www-form-urlencoded
功能描述	商家调用该接口获取运单号
编码	UTF-8

入参

项目	名称	类型	必填	描述
对接码	logistic_provider_id	String	是	菜鸟侧提供
签名	data_digest	String	是	Base64(Md5(logistics_interface+双方约定的secretKey)),0.2 签名方法
业务报文	logistics_interface	String	是	JSON

logistics_interface内容

项目	名称	类型	必填	描述
订单号	outBizCode	String(32)	是
发件人信息	sender	ContactInfo	是
收件人信息	receiver	ContactInfo	是
包裹信息	packageInfos	List<PackageInfo>	是	线上一次只允许取一个号，所以一次只能有一条记录，一单多包裹需要多次调用，给相同的outBizCode不同的packageCode
扩展信息	feature	Map<String,String>	否

ContactInfo内容

项目	名称	类型	必填	描述
姓名	name	String(40)	是
手机	mobile	String(20)	否	手机和电话二选一，不能包含"-"以外的特殊字符
电话	telephone	String(20)	否
省	provinceName	String(20)	是
市	cityName	String(20)	否
区县	areaName	String(20)	否
城镇	townName	String(30)	否
详细地址	addrDetail	String(256)	是
邮编	zipCode	String(20)	否
备注	remark	String(256)	否

PackageInfo内容

项目	名称	类型	必填	描述
包裹编码	packageCode	String(40)	否	一单多件的时候必填且不能重复
包裹名称	packageName	String(128)	否
重量	weight	Long	否	单位:克
体积	volume	Long	否	单位:立方厘米
长	length	Long	否	单位:毫米
宽	width	Long	否	单位:毫米
高	height	Long	否	单位:毫米
商品信息	items	List<PackageItem>	是

PackageItem内容

项目	名称	类型	必填
商品名称	itemName	String(128)	是
商品编码	itemCode	String(32)	否
商品数量	itemCount	Integer	是

出参

项目	名称	类型	必填	描述
成功标识	success	boolean	是
错误码	errorCode	String	否
错误说明	errorMsg	String	否
运单信息	waybillNos	List<WaybillInfo>	否	运单信息

WaybillInfo内容

项目	名称	类型	必填	描述
运单号	waybillNo	String	否

注意: 接口以订单号+ packageCode幂等，如果没给packageCode，则以订单号幂等

示例报文

url:

http://edi-daily.xpm.cainiao.com/ext/gateway/ediStandardWaybillNoGet/ediStandardWaybillNoGet/api

请求： 仅供参考，实际测试账号需联系菜鸟速递开发提供

logistics_interface:

{
    "packageInfos": [{
        "items": [{
            "itemCount": 1,
            "itemName": "测试商品1"
        }, {
            "itemCount": 1,
            "itemName": "测试商品2"
        }],
        "packageCode": "1"
    }],
    "receiver": {
        "addrDetail": "浙江省杭州市西湖区中节能西溪首座",
        "areaName": "西湖区",
        "cityName": "杭州市",
        "mobile": "13111111111",
        "name": "张三",
        "provinceName": "浙江省"
    },
    "sender": {
        "addrDetail": "长江路99号",
        "areaName": "玄武区",
        "cityName": "南京市",
        "mobile": "13222222222",
        "name": "李四",
        "provinceName": "江苏省"
    },
    "outBizCode": "test190703003"
}

data_digest: cfUbipTuVHUaOLbPGBJnxg==

logistic_provider_id: edi_test_json

返回：

{
    "success": true,
    "waybillNos": [{
        "waybillNo": "889002168759"
    }]
}