6、请求参数
字段名 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
sign | String | 是 | 4BBDE07660E5EFF90873642CFAE9A8DD | 加密签名信息:MD5(param+t+key+secret);加密后字符串转大写 |
key | String | 是 | kytRsteof | 我方分配给贵司的的授权key,见授权key邮件说明 |
t | Long | 是 | 1470304729724 | 请求时间戳 |
param | String | 是 | {"recMan":{"name":"张三","mobile":"13751866787","tel":"","zipCode":"","province":"广东省","city":"深圳市","district":"南山区","addr":"科技南十二路2号金蝶软件园B10","company":""},"sendMan":{"name":"李四","mobile":"13751866787","tel":"","zipCode":"","province":"广东省","city":"深圳市","district":"南山区","addr":"高新南一道2号","company":""},"kuaidicom":"shunfeng","partnerId":"XXXXXXXXX","partnerKey":"","net":"","kuaidinum":"","orderId":"A2147","payType":"SHIPPER","expType":"标准快递","weight":"1","volumn":"0","count":1,"remark":"备注","valinsPay":"0","collection":"0","needChild":"0","needBack":"0","cargo":"书","needTemplate":"1"} | 请求电子面单数据实体,JSON格式字符串,JSON内容见下面具体参数表 |
7、param字段参数内容
字段名 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
partnerId | String | 否 | DB83CDE6E35CEB298B47716DF3048991 | 电子面单客户账户或月结账号,需向快递公司在贵司当地的网点申请;若已和快递100超市业务合作,则可不填。顺丰、EMS的可输入月结账号;若所选快递公司为宅急送(即kuaidicom字段为zhaijisong),则此项可不填。 |
partnerKey | String | 否 | EpLzwptJ8922 | 电子面单密码,需向快递公司在贵司当地的网点申请;若已和快递100超市业务合作,则可不填。顺丰、EMS的如果partnerId填月结账号,则此字段不填;若所选快递公司为宅急送(即kuaidicom字段为zhaijisong),则此项可不填。 |
net | String | 否 | EpLzwptJ8922 | 收件网点名称,由快递公司当地网点分配,若已和快递100超市业务合作,则可不填。顺丰、EMS的如果partnerId填月结账号,则此字段不填;若所选快递公司为宅急送(即kuaidicom字段为zhaijisong),则此项可不填。 |
kuaidicom | String | 是 | ems | 快递公司的编码,一律用小写字母,见《快递公司编码》 |
kuaidinum | String | 否 | 881443775034378914 | 快递单号,单号的最大长度是32个字符 |
orderId | String | 否 | 881443775034378914 | 贵司内部自定义的订单编号,需要保证唯一性 |
recMan | Object | 是 | 收件人地址信息 | |
└ name | String | 是 | 张三 | 收件人姓名 |
└ mobile | String | 否 | 13898896666 | 收件人的手机号,手机号和电话号二者其一必填 |
└ tel | String | 否 | 0755-86689999 | 收件人的电话号,手机号和电话号二者其一必填 |
└ zipCode | String | 否 | 518000 | 收件人所在地邮编 |
└ province | String | 否 | 广东省 | 收件人所在省份 |
└ city | String | 否 | 深圳市 | 收件人所在市 |
└ district | String | 否 | 南山区 | 收件人所在区 |
└ addr | String | 否 | 科技南十二路2号金蝶软件园 | 收件人所在地址 |
└ printAddr | String | 否 | 广东深圳市深圳市南山区科技南十二路2号金蝶软件园 | 收件人所在完整地址;province、city、distinct、addr 和 printAddr 任选一个必填。如果有填写province,city,distinct,addr 则系统优先读取这些信息;如果只填写printAddr,系统将自动识别对应的省、市与区 |
└ company | String | 否 | 快递100 | 收件人所在公司名称 |
sendMan | Object | 是 | 寄件人地址信息 | |
└ name | String | 是 | 张三 | 寄件人姓名 |
└ mobile | String | 否 | 13898896666 | 寄件人的手机号,手机号和电话号二者其一必填 |
└ tel | String | 否 | 0755-86689999 | 寄件人的电话号,手机号和电话号二者其一必填 |
└ zipCode | String | 否 | 518000 | 寄件人所在地邮编 |
└ province | String | 否 | 广东省 | 寄件人所在省份 |
└ city | String | 否 | 深圳市 | 寄件人所在市 |
└ district | String | 否 | 南山区 | 寄件人所在区 |
└ addr | String | 否 | 科技南十二路2号金蝶软件园 | 寄件人所在地址 |
└ printAddr | String | 否 | 广东深圳市深圳市南山区科技南十二路2号金蝶软件园 | 寄件人所在完整地址;province、city、distinct、addr 和 printAddr 任选一个必填。如果有填写province,city,distinct,addr 则系统优先读取这些信息;如果只填写printAddr,系统将自动识别对应的省、市与区 |
└ company | String | 否 | 快递100 | 寄件人所在公司名称 |
cargo | String | 否 | 发票 | 物品名称 |
count | Int | 是 | 1 | 物品总数量;如果需要子单(指同一个订单打印出多张电子面单,即同一个订单返回多个面单号),needChild = 1、count 需要大于1,如count = 2 则一个主单 一个子单,count = 3则一个主单 二个子单;返回的子单号码见返回结果的childNum字段 |
weight | double | 是 | 0.5 | 物品总重量KG |
volumn | double | 否 | 0.1 | 物品总体积:CM*CM*CM |
payType | String | 否 | SHIPPER | 支付方式:SHIPPER:寄方付(默认)、CONSIGNEE:到付、MONTHLY:月结、THIRDPARTY:第三方支付 |
expType | String | 否 | 标准快递 | 快递类型:标准快递(默认)、顺丰特惠、EMS经济 |
remark | String | 否 | 发票 | 备注 |
valinsPay | double | 否 | 0 | 保价额度 |
collection | double | 否 | 0 | 代收货款额度 |
needChild | String | 否 | 0 | 是否需要子单:1:需要、0:不需要(默认)。如果需要子单(指同一个订单打印出多张电子面单,即同一个订单返回多个面单号),needChild = 1、count 需要大于1,如count = 2 一个主单 一个子单,count = 3 一个主单 二个子单,返回的子单号码见返回结果的childNum字段 |
needBack | String | 否 | 0 | 是否需要回单:1:需要、 0:不需要(默认)。返回的回单号见返回结果的returnNum字段 |
needTemplate | String | 否 | 0 | 是否需要打印模板:1:需要、 0 不需要(默认)。如果需要,则返回要打印的模版的HTML代码,贵司可以直接将之显示到IE等浏览器,然后通过浏览器进行打印 |
key | String | 是 | kytRsteof | 我方分配给贵司的的授权key,见授权key邮件说明 |
t | Long | 是 | 1470304729724 | 请求时间戳 |
param | String | 是 | {"recMan":{"name":"张三","mobile":"13751866787","tel":"","zipCode":"","province":"广东省","city":"深圳市","district":"南山区","addr":"科技南十二路2号金蝶软件园B10","company":""},"sendMan":{"name":"李四","mobile":"13751866787","tel":"","zipCode":"","province":"广东省","city":"深圳市","district":"南山区","addr":"高新南一道2号","company":""},"kuaidicom":"shunfeng","partnerId":"XXXXXXXXX","partnerKey":"","net":"","kuaidinum":"","orderId":"A2147","payType":"SHIPPER","expType":"标准快递","weight":"1","volumn":"0","count":1,"remark":"备注","valinsPay":"0","collection":"0","needChild":"0","needBack":"0","cargo":"书","needTemplate":"1"} | 请求电子面单数据实体,JSON格式字符串,JSON内容见下面具体参数表 |
9、响应报文
9.1、成功返回(不需要模版)
字段名称 | 示例值 | 字段含义 |
---|---|---|
result | true | 状态值:true-表示成功;false-表示失败 |
message | 成功 | 信息内容:返回具体的信息体描述 |
status | 200 | 状态码 |
data | Object | 返回数据体信息 |
└ kuaidinum | 606568155331 | 快递单号 |
└ returnNum | 123456 | 回单号 |
└ childNum | 子单号,如果有多个,逗号分隔。 如果需要子单,则需要提交needChild = 1、count 需要大于1,如count = 2则一个主单、一个子单,count=3则一个主单、二个子单 | |
└ bulkpen | 大头笔,用于显示于电子面单上规定位置;是否有值取决于快递公司 | |
└ orgCode | 始发地区域编码,用于显示于电子面单上规定位置;是否有值取决于快递公司 | |
└ orgName | 始发地/始发网点名称,用于显示于电子面单上规定位置;是否有值取决于快递公司 | |
└ destCode | 目的地区域编码,用于显示于电子面单上规定位置;是否有值取决于快递公司 | |
└ destName | 目的地/到达网点,用于显示于电子面单上规定位置;是否有值取决于快递公司 | |
└ orgSortingCode | 始发分拣编码,用于显示于电子面单上规定位置;是否有值取决于快递公司 | |
└ orgSortingName | 始发分拣名称,用于显示于电子面单上规定位置;是否有值取决于快递公司 | |
└ destSortingCode | 目的分栋编码,用于显示于电子面单上规定位置;是否有值取决于快递公司 | |
└ destSortingName | 目的分栋中心名称,用于显示于电子面单上规定位置;是否有值取决于快递公司 | |
└ orgExtra | 始发其他信息,用于显示于电子面单上规定位置;是否有值取决于快递公司 | |
└ destExtra | 目的其他信息,用于显示于电子面单上规定位置;是否有值取决于快递公司 | |
└ pkgCode | 集包编码,用于显示于电子面单上规定位置;是否有值取决于快递公司 | |
└ pkgName | 集包地名称,用于显示于电子面单上规定位置;是否有值取决于快递公司 | |
└ road | 路区,用于显示于电子面单上规定位置;是否有值取决于快递公司 | |
└ qrCode | 二维码,用于显示于电子面单上规定位置;是否有值取决于快递公司 | |
└ orderNum | 快递公司订单号,用于显示于电子面单上规定位置;是否有值取决于快递公司 | |
└ expressCode | 快递业务类型编码,用于显示于电子面单上规定位置 | |
└ expressName | 快递业务类型名称,用于显示于电子面单上规定位置 | |
└ templateurl | http://www.frifi.biz/XXX | 在线显示电子面单模版的网址,用浏览器打开该网址,就能看到生成的电子面单,直接通过浏览器的打印功能即可完成打印 |
响应报文正确示例
{ "result": true, "message": "成功", "status": "200", "data": [ { "kuaidinum": "606568155331", "returnNum": "", "childNum": "", "bulkpen": "", "orgCode": "755", "orgName": "", "destCode": "755", "destName": "", "orgSortingCode": "", "orgSortingName": "", "destSortingCode": "", "destSortingName": "", "orgExtra": "", "destExtra": "", "pkgCode": "", "pkgName": "", "road": "", "qrCode": "", "orderNum": "", "expressCode": "", "expressName": "", "templateurl": "http://www.frifi.biz/XXX" } ] }
9.2、正确返回(需要模版)
字段名称 | 示例值 | 字段含义 |
---|---|---|
result | true | 状态值:true-表示成功;false-表示失败 |
message | 成功 | 信息内容:返回具体的信息体描述 |
status | 200 | 状态码 |
data | Object | 返回数据体信息 |
└ kuaidinum | 606568155331 | 快递单号 |
└ returnNum | 123456 | 回单号 |
└ childNum | 子单号,如果有多个,逗号分隔。 如果需要子单,则需要提交needChild = 1、count 需要大于1,如count = 2则一个主单、一个子单,count=3则一个主单、二个子单 | |
└ bulkpen | 大头笔,用于显示于电子面单上规定位置;是否有值取决于快递公司 | |
└ orgCode | 始发地区域编码,用于显示于电子面单上规定位置;是否有值取决于快递公司 | |
└ orgName | 始发地/始发网点名称,用于显示于电子面单上规定位置;是否有值取决于快递公司 | |
└ destCode | 目的地区域编码,用于显示于电子面单上规定位置;是否有值取决于快递公司 | |
└ destName | 目的地/到达网点,用于显示于电子面单上规定位置;是否有值取决于快递公司 | |
└ orgSortingCode | 始发分拣编码,用于显示于电子面单上规定位置;是否有值取决于快递公司 | |
└ orgSortingName | 始发分拣名称,用于显示于电子面单上规定位置;是否有值取决于快递公司 | |
└ destSortingCode | 目的分栋编码,用于显示于电子面单上规定位置;是否有值取决于快递公司 | |
└ destSortingName | 目的分栋中心名称,用于显示于电子面单上规定位置;是否有值取决于快递公司 | |
└ orgExtra | 始发其他信息,用于显示于电子面单上规定位置;是否有值取决于快递公司 | |
└ destExtra | 目的其他信息,用于显示于电子面单上规定位置;是否有值取决于快递公司 | |
└ pkgCode | 集包编码,用于显示于电子面单上规定位置;是否有值取决于快递公司 | |
└ pkgName | 集包地名称,用于显示于电子面单上规定位置;是否有值取决于快递公司 | |
└ road | 路区,用于显示于电子面单上规定位置;是否有值取决于快递公司 | |
└ qrCode | 二维码,用于显示于电子面单上规定位置;是否有值取决于快递公司 | |
└ orderNum | 快递公司订单号,用于显示于电子面单上规定位置;是否有值取决于快递公司 | |
└ expressCode | 快递业务类型编码,用于显示于电子面单上规定位置 | |
└ expressName | 快递业务类型名称,用于显示于电子面单上规定位置 | |
└ templateurl | http://www.frifi.biz/XXX | 在线显示电子面单模版的网址,用浏览器打开该网址,就能看到生成的电子面单,直接通过浏览器的打印功能即可完成打印 |
└ template | XXXXXXXXXXXXXXXXXXXXXXXXX | 电子面单显示html代码,贵方只需要将之写着一个web页面并显示出来,即可在网页中显示出电子面单并通过浏览器实现面单打印 |
响应报文正确示例
{ "result": true, "message": "成功", "status": "200", "data": [ { "kuaidinum": "606568155331", "returnNum": "", "childNum": "", "bulkpen": "", "orgCode": "755", "orgName": "", "destCode": "755", "destName": "", "orgSortingCode": "", "orgSortingName": "", "destSortingCode": "", "destSortingName": "", "orgExtra": "", "destExtra": "", "pkgCode": "", "pkgName": "", "road": "", "qrCode": "", "orderNum": "", "expressCode": "", "expressName": "", "templateurl": "http://www.frifi.biz/XXX", "template": [ "HTML页面代码1", "HTML页面代码2" ] } ] }
9.3、失败返回
字段名称 | 示例值 | 字段含义 |
---|---|---|
result | false | 状态值:true-表示成功;false-表示失败 |
message | 非法的数据签名 | 信息内容:返回具体的信息体描述 |
status | 601 | 状态码 |
data | null | 返回数据体信息 |
响应报文错误示例
{ "result": false, "message": "非法的数据签名", "status": 601, "data": null }
10、电子面单示例
关注快递100接口API