EMS自助服务系统和大客户接口规范V0.9(取单号打印后回传数据)

自助服务系统和大客户接口规范变更历史日期变更描述版本号变更人批准创建文档王一松总体说明接口目的本文包含了相关接口的数据格式通讯格式本文附录包含了接口使用的基础代码信息该文档约束了中国邮政速递物流自助服务系统和大客户的接口规范文档内容需严格保密接口规范自助服务系统和大客户接口建议采用接口方式同时支持接口方式接口编码格式均为格式为保证单号正常获取不影响用户使用需在当天将打印后的数据更新到自助服务系统接口自助服务客户端和大客户接口规范根据大客户号业务类型获取详情单号接口功能描述通过大客户号业务类型获取详情单号服务端自助服务系统客户端大客户系统接口方式接口地址输入参数大客户号密码业务种类获取数量输入参数格式定义使用加密输入参数特别注意单号是唯一的获取后本地保存时必须作为唯一索引标记串大客户号必填代码调试期间请务必传入大客户号大客户密码必填小写加密对接方平台作为接口调用方的身份凭据由接口提供方提供业务类型必填为标准快递为经济快递传数字需要详情单数量最多输入个字段类型说明订单信息大客户号密码加密全小写位平台暂时留空请求数量返回值格式定义使用加密返回值标记串是否执行成功是成功是失败错误原因描述详情单号参考方法名实现类备注详情单打印信息更新到自助服务系统接口功能描述将详情单打印信息更新到自助服务系统服务端自助服务系统客户端大客户系统接口方式接口地址输入参数大客户号打印类型将详情单信息按照格式封装成一个字符串传入系统进行数据更新输入参数格式定义使用加密输入参数标记串大客户号必填大客户密码必填小写加密对接方平台作为接口调用方的身份凭据由接口提供方提供打印类型为五联单打印为热敏打印必填大客户数据的唯一标识如某电商公司的配货单号必填订单如果打印条码应为非位数字详情单号和配货单号对应必填详情单号打印条形码必须码寄件人姓名寄件人联系方式寄件人联系方式选填寄件人邮编寄件人地址寄件人公司收件人姓名收件人联系方式收件人联系方式选填收件人邮编收件人地址收件人公司到件省到件市到件县寄件重量物品长度保价每件最高投保金额以人民币万元为限保险小写金额代收货款和收件人付费不保留小数点标准快递和经济快递保留两位小数点大写金额代收货款和收件人付费需要填写业务类型为标准快递为代收货款为收件人付费为经济快递传数字内件信息根据货品的实际情况填写对个别已与和买家达成协议的可只写货号不写实际货物名称内件类型文件物品备注对揽投员的投递要求填写客户的个性化投递要求产品代码预留字段预留字段预留字段预留字段预留字段字段类型说明订单信息寄件人姓名寄件人联系方式寄件人联系方式寄件人邮编寄件人地址寄件人公司收件人姓名收件人邮编收件人地址收件人公司收件人联系方式收件人联系方式到件省到件市到件县寄件重量物品长度备注大客户数据的唯一标识如某电商公司的配货单号详情单号大客户数据的客户订单号主要是对于电商客户有用保价保险小写金额大写金额对揽投员的投递要求业务种类内件信息内件类型产品代码预留字段预留字段预留字段预留字段预留字段返回值格式定义使用加密返回值标记串是否执行成功是成功是失败错误原因描述参考方法名实现类备注接口调用身份验证程序加载过程中调用一次本方法即可相当于登陆功能描述大客户系统调用自助服务系统身份验证接口方式接口地址在自助服务客户端安装根目录下输入参数大客户号密码小写加密输入参数格式定义单个字符串使用分隔不同参数参数示例大客户号密码小写加密返回值格式定义单个字符串使用分隔不同返回值字段返回值示例验证成功验证成功寄件城市验证失败错误代码错误信息参考方法名错误信息定义网络连接失败该用户不存在版本不一致请更新客户端并登录一次后使用当前版本密码错误其他错误错误信息备注获取邮件号种类及邮件产品代码功能描述大客户系统调用自助服务系统打印详情单接口方式接口地址在自助服务客户端安装根目录下输入参数开头结尾参数字段以分隔拼接的字符串空值也需要用占位拼接完成后将整个字符串传入接口输入参数格式定义字符串开头结尾各字段值使用英文竖线分隔拼接完成后使用整个字符串作为接口参数空值也需要用占位业务类型为标准快递为代收货款为收件人付费为经济快递不可传空内件性质为物品为文件传空默认为物品到件省到件市到件县输入参数示例返回值格式定义单个字符串使用分隔不同返回值字段返回值参数格式如下单号类型产品代码返回值说明单号类型标快单号开头经快单号开头参考方法名错误信息定义请验证账号后使用参数错误错误信息其他错误备注大客户系统调用客户端打印详情单功能描述大客户系统调用自助服务系统打印详情单接口方式接口地址在自助服务客户端安装根目录下输入参数开头结尾参数字段以分隔拼接的字符串空值也需要用占位拼接完成后将整个字符串传入接口输入参数格式定义字符串开头结尾各字段值使用英文竖线分隔拼接完成后使用整个字符串作为接口参数空值也需要用占位业务类型为标准快递为代收货款为收件人付费为经济快递不可传空单号类型为标快为经快业务类型为代收货款收件人付费时不可传空详情单号运单号邮件号时间类型为收寄时间为打印时间可传空收寄时间或打印时间形式如可精确到秒时间类型为空时本值可为空也可进行传值寄件人姓名寄件人联系方式寄件人联系方式选填寄件人邮编寄件人地址收件人姓名收件人联系方式收件人联系方式选填收件人邮编收件人地址到件省到件市到件县寄件重量保价每件最高投保金额以人民币万元为限小写金额代收货款和收件人付费不保留小数点标准快递和经济快递保留两位小数点大写金额代收货款和收件人付费需要填写内件信息根据货品的实际情况填写对个别已与和买家达成协议的可只写货号不写实际货物名称大客户数据的唯一标识如某电商公司的配货单号大客户数据的客户订单号主要是对于电商客户有用主单邮件号分单对应的主单邮件号可为空留白留白字段类型说明订单信息业务类型单号类型详情单号时间类型时间值寄件人姓名寄件人联系方式寄件人联系方式寄件人邮编寄件人地址收件人姓名收件人联系方式收件人联系方式收件人邮编收件人地址到件省到件城市到件县寄件重量保价小写金额大写金额内件信息大客户数据的唯一标识如某电商公司的配货单号大客户数据的客户订单号主要是对于电商客户有用主单邮件号可为空留白留白输入参数示例返回值格式定义单个字符串使用分隔不同返回值字段返回值参数格式如下打印成功打印成功打印失败错误代码错误信息参考方法名错误信息定义请验证账号后使用参数错误您没有打印代收货款面单的权限如有需要请向申请开通您没有打印收件人付费面单的权限如有需要请向申请开通错误信息其他错误备注已同步的订单信息打印前有变化时需作为新订单获取新单号附录接口调用说明本文档中各接口根据对接系统处理方式的不同提供以下两个分支的建议调用流程说明需调用接口时必须先调用接口程序加载过程中调用一次本方法即可相当于登陆单号获取后给订单分配单号可选择对接系统完全自开发也可使用接口的返回值作为参考依据对面单自定义需求较强的对接系统建议完全自开发面单打印订单打印后建议对接系统尽可能及时的批量上传已打印数据