页面树结构
转至元数据结尾
转至元数据起始

接口说明

产生和打印标签,按照请求顺序返回结果。

  • orderIds、masterIds 两个字段值,如果同时填写了默认取值OrderIds内容;
  • 通过字段值Merged支持去合并PDF格式的面单,其它格式不支持合并;

路径

HTTP Verb URL
Post/services/shipper/labels

请求字段

1Field (API)Data TypeLengthMandatoryDetails
2orderIdsString80O

我们支持用户使用Tracking Number / Ref No.查询

3masterIdsString80C我们支持用户使用Master Ref No. 查询
4labelTypeString80O

labelType:

0表示默认值10cm * 15cm,

1表示10cm * 15cm,

2表示A4,

4表示10cm * 10cm,目前API只支持这三种格式;

5packinglistBooleantrue/falseO是否打印拣货清单
6mergedBooleantrue/falseO

指定是否需要合并为一个PDF文件,默认拆分;

若选择合并,则只会合并打印出成功的订单,并且按照请求参数中订单的顺序进行合并。

7labelFormatString3O

标签格式,可选JPG格式,不填默认为PDF格式。JPG格式面单不支持合并,当同时选择打印packinglist时,会返回多个文件。

可选ZPL格式。选择ZPL时,字段值为“ZPL”。

8dpiString3O当标签格式为ZPL时,支持填写此字段,“300”和“203”是支持的。如不填写,默认为“300”



响应字段

Field

Data Type

Mandatory

Details

status



String

M

Failure(失败)

Success(成功)

Partial Success(部分成功)

errors



Array

O

报错信息


code
IntO报错Code

message
StringO报错英文信息

messageCn
StringO报错中文信息

data



Array

M

具体的数据列表


status
StringM

Failure(失败)

Success(成功)


errors
ArrayO

报错信息



codeIntO报错Code


messageStringO报错英文信息


messageCnStringO报错中文信息

warnings
StringO警告消息

labelContent
StringM面单Base64内容

orderId
StringM同请求报文中的orderIds值,为Tracking Number / Ref No.

trackingNo
StringM

尾程单号


lastMileCarrier
StringO订单所属服务的尾程供应商

labelUrl
StringM面单URL

labelContents
StringO/
warnings

StringO警告消息

请求报文

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
}
  • 无标签

评论

  1. 宁镭 发表:

    "M":必填字段,用户必须提供相关信息才能继续进行操作或提交表单。Mandatory (required field)
    "O":非必填字段,用户可以选择性地填写相关信息,但不是必需的。Optional (non-required field)
    "C":选择性填写字段,也就是可选填的字段。Conditional (selective field)