接口说明
产生和打印标签,按照请求顺序返回结果。
|
路径
| HTTP Verb | URL |
|---|---|
| Post | /services/shipper/labels |
请求字段
| 1 | Field (API) | Data Type | Length | Mandatory | Details | |
| 2 | orderIds | String | 80 | O | 我们支持用户使用Tracking Number / Ref No.查询 | |
| 3 | masterIds | String | 80 | C | 我们支持用户使用Master Ref No. 查询 | |
| 4 | labelType | String | 80 | O | labelType: 0表示默认值10cm * 15cm, 1表示10cm * 15cm, 2表示A4, 4表示10cm * 10cm,目前API只支持这三种格式; | |
| 5 | packinglist | Boolean | true/false | O | 是否打印拣货清单 | |
| 6 | merged | Boolean | true/false | O | 指定是否需要合并为一个PDF文件,默认拆分; 若选择合并,则只会合并打印出成功的订单,并且按照请求参数中订单的顺序进行合并。 | |
| 7 | labelFormat | String | 3 | O | 标签格式,可选JPG格式,不填默认为PDF格式。JPG格式面单不支持合并,当同时选择打印packinglist时,会返回多个文件。 可选ZPL格式。选择ZPL时,字段值为“ZPL”。 | |
| 8 | dpi | String | 3 | O | 当标签格式为ZPL时,支持填写此字段,“300”和“203”是支持的。如不填写,默认为“300” | |
响应字段
Field | Data Type | Mandatory | Details | ||
status | String | M | Failure(失败) Success(成功) Partial Success(部分成功) | ||
errors | Array | O | 报错信息 | ||
| code | Int | O | 报错Code | ||
| message | String | O | 报错英文信息 | ||
| messageCn | String | O | 报错中文信息 | ||
data | Array | M | 具体的数据列表 | ||
| status | String | M | Failure(失败) Success(成功) | ||
| errors | Array | O | 报错信息 | ||
| code | Int | O | 报错Code | ||
| message | String | O | 报错英文信息 | ||
| messageCn | String | O | 报错中文信息 | ||
| warnings | String | O | 警告消息 | ||
| labelContent | String | M | 面单Base64内容 | ||
| orderId | String | M | 同请求报文中的orderIds值,为Tracking Number / Ref No. | ||
| trackingNo | String | M | 尾程单号 | ||
| lastMileCarrier | String | O | 订单所属服务的尾程供应商 | ||
| labelUrl | String | M | 面单URL | ||
| labelContents | String | O | / | ||
| warnings | String | O | 警告消息 | ||
请求报文
Request
{
"orderIds": [
"420950359361211015300000143152"
],
"masterIds": null,
"labelType": 1,
"packinglist": false,
"merged": false,
"labelFormat": null,
"dpi": null
}
响应报文
Response
{
"status": "Success",
"errors": null,
"data": [
{
"status": "Success",
"errors": null,
"warnings": null,
"labelContent":"Base64 String",
"orderId": "420950359361211015300000143152",
"trackingNo": "420950359361211015300000143152",
"lastMileCarrier": null,
"labelUrl": "https://qa.etowertech.com/label/download/EXAk3ggLz6rYQqOU2wRIaA/1",
"labelContents": null
}
],
"warnings": null
}
评论
宁镭 发表:
"M":必填字段,用户必须提供相关信息才能继续进行操作或提交表单。Mandatory (required field)
"O":非必填字段,用户可以选择性地填写相关信息,但不是必需的。Optional (non-required field)
"C":选择性填写字段,也就是可选填的字段。Conditional (selective field)