## 面单接口
请求地址:`https://open-api.10ss.net/expressprint/index`
请求方式:POST
提示:(k4&k6系列机型不建议调用面单API),请使用k5系列打印机;
### 所需参数
|名 称|类 型|描 述|
|----|----|----|
|client_id|string|开发者的应用ID,在开放平台创建应用时获得|
|access_token|string|授权的token 必要参数|
|machine_code|string|易联云打印机终端号|
|origin_id|string|商户系统内部订单号,要求32个字符内,只能是数字、大小写字母 ,且在同一个client_id下唯一。详见商户订单号|
|id|string|UUID4 详见API文档列表-uuid4|
|sign|string|签名 详见API文档列表-接口签名|
|timestamp|string|当前服务器时间戳(10位)|
|content|json|详情请看下方说明|
|sandbox|int|`1`沙箱环境调用,`非必传参数,正式环境可以不传入sandbox`|
### content参数说明
* <a href = "http://www.kdniao.com/documents" target="new">详情可看,快递鸟接口API文档说明</a>
备注:R-必填(Required),O-可选(Optional),C-报文中该参数在一定条件下可选(Conditional)
<table class="p-table"><tbody><tr><th colspan="2">参数名称</th><th class="g-w-80">类型</th><th>说明</th><th width="80">是否必须</th></tr><tr><td colspan="2">MemberID</td><td class="g-w-80">String</td><td>会员标识</td><td>O</td></tr><tr><td colspan="2">CustomerName</td><td class="g-w-80">String</td><td>电子面单客户账号(与快递网点申请)</td><td>O</td></tr><tr><td colspan="2">CustomerPwd</td><td class="g-w-80">String</td><td>电子面单密码</td><td>O</td></tr><tr><td colspan="2">SendSite</td><td class="g-w-80">String</td><td>收件网点标识</td><td>O</td></tr><tr><td colspan="2">ShipperCode</td><td class="g-w-80">String</td><td>快递公司编码</td><td>R</td></tr><tr><td colspan="2">LogisticCode</td><td class="g-w-80">String</td><td>快递单号</td><td>O</td></tr><tr><td colspan="2">OrderCode</td><td class="g-w-80">String</td><td>订单编号</td><td>R</td></tr><tr><td colspan="2">ThrOrderCode</td><td class="g-w-80">String</td><td>第三方订单编号</td><td>O</td></tr><tr><td colspan="2">MonthCode</td><td class="g-w-80">String</td><td>月结编码</td><td>C</td></tr><tr><td colspan="2">PayType</td><td class="g-w-80">Int</td><td>邮费支付方式:1-现付,2-到付,3-月结,4-第三方支付</td><td>R</td></tr><tr><td colspan="2">ExpType</td><td class="g-w-80">String</td><td>快递类型:1-标准快件</td><td>R</td></tr><tr><td colspan="2">IsNotice</td><td class="g-w-80">Int</td><td>是否通知快递员上门揽件:0-通知;1-不通知;不填则默认为1</td><td>O</td></tr><tr><td colspan="2">Cost</td><td class="g-w-80">Double</td><td>寄件费(运费)</td><td>O</td></tr><tr><td colspan="2">OtherCost</td><td class="g-w-80">Double</td><td>其他费用</td><td>O</td></tr><tr><td rowspan="9">Receiver</td><td>Company</td><td class="g-w-80">String</td><td>收件人公司</td><td>O</td></tr><tr><td>Name</td><td class="g-w-80">String</td><td>收件人</td><td>R</td></tr><tr><td>Tel</td><td class="g-w-80">String</td><td rowspan="2">电话与手机,必填一个</td><td rowspan="2">R</td></tr><tr><td>Mobile</td><td class="g-w-80">String</td></tr><tr><td>PostCode</td><td class="g-w-80">String</td><td>收件人邮编(邮政相关快递必传)</td><td>O</td></tr><tr><td>ProvinceName</td><td class="g-w-80">String</td><td>收件省(如广东省,不要缺少“省”,必须是中文!数字、字母、特殊符号无效)</td><td>R</td></tr><tr><td>CityName</td><td class="g-w-80">String</td><td>收件市(如深圳市,不要缺少“市”,必须是中文!数字、字母、特殊符号无效)</td><td>R</td></tr><tr><td>ExpAreaName</td><td class="g-w-80">String</td><td>收件区(如福田区,不要缺少“区”或“县”,必须是中文!数字、字母、特殊符号无效)</td><td>R</td></tr><tr><td>Address</td><td class="g-w-80">String</td><td>收件人详细地址</td><td>R</td></tr><tr><td rowspan="9">Sender</td><td>Company</td><td class="g-w-80">String</td><td>发件人公司</td><td>O</td></tr><tr><td>Name</td><td class="g-w-80">String</td><td>发件人</td><td>R</td></tr><tr><td>Tel</td><td class="g-w-80">String</td><td rowspan="2">电话与手机,必填一个</td><td rowspan="2">R</td></tr><tr><td>Mobile</td><td class="g-w-80">String</td></tr><tr><td>PostCode</td><td class="g-w-80">String</td><td>发件人邮编</td><td>O</td></tr><tr><td>ProvinceName</td><td class="g-w-80">String</td><td>发件省(如广东省,不要缺少“省”,必须是中文!数字、字母、特殊符号无效)</td><td>R</td></tr><tr><td>CityName</td><td class="g-w-80">String</td><td>发件市(如深圳市,不要缺少“市”,必须是中文!数字、字母、特殊符号无效)</td><td>R</td></tr><tr><td>ExpAreaName</td><td class="g-w-80">String</td><td>发件区(如福田区,不要缺少“区”或“县”,必须是中文!数字、字母、特殊符号无效)</td><td>R</td></tr><tr><td>Address</td><td class="g-w-80">String</td><td>发件人详细地址</td><td>R</td></tr><tr><td colspan="2">StartDate</td><td class="g-w-80">String</td><td rowspan="2">上门取货时间段:"yyyy-MM-dd HH:mm:ss"格式化,本文中所有时间格式相同</td><td>O</td></tr><tr><td colspan="2">EndDate</td><td class="g-w-80">String</td><td>O</td></tr><tr><td colspan="2">Weight</td><td class="g-w-80">Double</td><td>物品总重量kg</td><td>O</td></tr><tr><td colspan="2">Quantity</td><td class="g-w-80">Int</td><td>件数/包裹数(最大值为4,超出不会打印子件面单)</td><td>O</td></tr><tr><td colspan="2">Volume</td><td class="g-w-80">Double</td><td>物品总体积m3</td><td>O</td></tr><tr><td colspan="2">Remark</td><td class="g-w-80">String</td><td>备注</td><td>O</td></tr><tr><td colspan="5" style='text-align: center;'>AddServices</td></tr><tr><td rowspan="3">AddService</td><td>Name</td><td class="g-w-80">String</td><td>增值服务名称</td><td>O</td></tr><tr><td>Value</td><td class="g-w-80">String</td><td>增值服务值</td><td>O</td></tr><tr><td>CustomerID</td><td class="g-w-80">String</td><td>客户标识(选填)</td><td>O</td></tr><tr><td colspan="5" style=' text-align: center;'>Commoditys</td></tr><tr><td rowspan="7">Commodity</td><td>GoodsName</td><td class="g-w-80">String</td><td>商品名称</td><td>R</td></tr><tr><td>GoodsCode</td><td class="g-w-80">String</td><td>商品编码</td><td>O</td></tr><tr><td>Goodsquantity</td><td class="g-w-80">Int</td><td>商品数量</td><td>O</td></tr><tr><td>GoodsPrice</td><td class="g-w-80">Double</td><td>商品价格</td><td>O</td></tr><tr><td>GoodsWeight</td><td class="g-w-80">Double</td><td>商品重量kg</td><td>O</td></tr><tr><td>GoodsDesc</td><td class="g-w-80">String</td><td>商品描述</td><td>O</td></tr><tr><td>GoodsVol</td><td class="g-w-80">Double</td><td>商品体积m3</td><td>O</td></tr><tr><td colspan="2">TemplateSize</td><td class="g-w-80">String(10)</td><td>模板规格(默认的模板无需传值,非默认模板传对应模板尺寸)</td><td>O</td></tr></tbody></table>
### 应用场景
目前接口支持了:顺丰(SF)、EMS(EMS)、宅急送(ZJS)、圆通(YTO)、百世快递(HTKY)、中通(ZTO)、韵达(YD)、申通(STO)、德邦(DBL)、优速(UC)、京东(JD)、信丰(XFEX)、全峰(QFKD)、跨越速运(KYSY)、安能小包(ANE)、快捷快递(FAST)、国通(GTO)、天天快递(HHTT)、邮政快递包裹(YZPY)、中铁快运(ZTKY)、邮政国内标快(YZBK)、全一快递(UAPEX)、速尔快递(SURE),后续更多的快递公司正在对接中。
<table class="p-table"><tbody><tr><th width="200">账号类型</th><th>支持快递公司</th></tr><tr><td>无需申请直接打单</td><td>顺丰(SF)、EMS(EMS)(仅支持广东省内发货)、快捷快递(FAST)、宅急送(ZJS)、邮政快递包裹(YZPY)、中铁快运(ZTKY)、邮政国内标快(YZBK)、全一快递(UAPEX)</td></tr><tr><td>月结账号直接打单</td><td>德邦(DBL)、EMS(EMS)</td></tr><tr><td>线下(网点)申请账号</td><td>EMS(EMS)、中通(ZTO)、申通(STO)、德邦(DBL)、京东(JD)、信丰(XFEX)、全峰(QFKD)、国通(GTO)、天天快递(HHTT)、速尔快递(SURE)、优速(UC)、韵达(YD)、圆通(YTO)、远成(YCWL)、安能(ANE)、百世快递(HTKY)</td></tr></tbody></table>
### 请求示例 JSON
```json
{
"ShipperCode":"SF",
"OrderCode":"dev-0002",
"EBusinessID":"1615047",
"Receiver":{
"ProvinceName":"四川省",
"Address":"四川省成都市武侯区吉泰路666号福年广场T2-2205",
"Tel":"18215625507",
"CityName":"成都市",
"ExpAreaName":"武侯区",
"Mobile":"18*****2507",
"Name":"胡1"
},
"Quantity":1,
"PayType":1,
"IsNotice":1,
"Cost":0,
"Weight":0,
"Sender":{
"ProvinceName":"四川省",
"Address":"四川省成都市武侯区吉泰路666号福年广场T2-2205",
"Tel":"18******507",
"CityName":"成都市",
"ExpAreaName":"武侯区",
"Mobile":"182****507",
"Name":"宁1"
},
"ExpType":"1",
"LogisticCode":"FH-1903-0002",
"Commodity":[
{
"GoodsName":"欧洲红色A,欧洲红色B"
}],
"Volume":0,
"IsReturnPrintTemplate":"1",
"IsSendMessage":0,
"TemplateSize":"180"
}
```
### 返回详情
~~~
{"error":"0","error_description":"success","body":{"id":"订单号","logistic_code":"快递单号 ","origin_id":"xxxx","shipper_code":"快递公司编码"}}
{"error":"8","error_description":"打印机信息错误,参数有误"}
{"error":"9","error_description":"连接打印机失败,参数有误"}
{"error":"10","error_description":"权限不足"}
{"error":"12","error_description":"缺少必要参数"}
{"error":"13","error_description":"打印失败,参数有误"}
{'error':'33', 'error_description':'Uuid不合法'}
{'error':'49', 'error_description':'错误',"body":{"错误详情"}}
~~~
### 错误说明
申通返回错误`SiteName`字段不能为`null`是未传入`sendsite`字段,需要传入的值是`网点名称`,还有缺少`772`开头的运单号,需要充值
- 平台简介
- 概念和术语
- 新手指南
- 开发文档
- 接入API服务指南
- API调用协议说明
- 开放应用服务模式
- 自有应用服务模式
- 扫描二维码授权模式
- 消息推送协议说明
- API文档列表
- 文本打印接口
- 图形打印接口
- 面单打印接口
- 设置内置语音接口
- 删除内置语音接口
- 删除终端授权
- 添加应用菜单
- 关机重启接口
- 声音调节接口
- 获取机型打印宽度接口
- 获取机型软硬件版本接口
- 取消所有未打印订单接口
- 取消单条未打印订单接口
- 设置logo接口
- 取消logo接口
- 打印方式接口
- 接单拒单设置接口
- 设置推送url接口
- 获取订单状态接口
- 获取订单列表接口
- 获取终端状态接口
- 推送接口
- 签名规则
- 打印完成推送
- 接单拒单推送
- 按键请求推送
- 应用菜单推送
- 打印机实时状态推送
- 打印机指令
- K7-GHC/K7-WHC排版指令
- K4-GH(新固件)/K4-WH(新固件)排版指令
- K6-WH(新固件)排版指令
- M1-G(新固件)排版指令
- W1(新固件)排版指令
- K5(新固件)排版指令
- K2S、K3S、M1排版指令
- K7、K6、K5、K4排版指令
- X1排版指令
- W1排版指令
- Ai语音播报指令
- 指令详解
- 二维码打印
- 条码打印
- 打印多联
- 字体加大
- 字体加粗
- 字体加高
- 字体加宽
- 换行
- 居中对齐
- 左右对齐
- 右对齐
- 一行三格或四格对齐排版
- 制表符
- 自定义来单提醒
- 自定义来单声音控制
- 订单确认
- SDK使用说明
- 注意事项
- 全局返回码
- 获取终端号和特殊密钥