页面树结构

版本比较

标识

  • 该行被添加。
  • 该行被删除。
  • 格式已经改变。

接口说明

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

在现有获取Label的接口基础上新增加字段值 masterIds

  • orderIds、masterIds 两个字段值设定为有条件,如果同时填写了,默认取值OrderIds内容;
  • masterIds支持通过Master Ref No.  进行查询获取面单;
  • 通过字段值Merged支持去合并PDF格式的面单,其它格式不支持合并;
  • 返回响应增加masterRefno字段值;两个字段值,如果同时填写了默认取值OrderIds内容;
  • 通过字段值Merged支持去合并PDF格式的面单,其它格式不支持合并;

路径

HTTP Verb URL
Post/services/shipper/labels

...

1Field (API)Data TypeLengthMandatoryDetails
2orderIdsString80MO

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

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

abelTypelabelType:

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

1表示10cm * 15cm,

2表示A4,

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

5packinglistStringBoolean40true/falseO是否打印拣货清单
6mergedStringBoolean64true/falseO

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

Boolean类型,指定是否需要合并为一个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警告消息

请求报文

代码块
languagejs
borderStylesolid
firstline1
titleRequest
linenumberstrue

{
 
  "orderIds": [
 
      "AOE8246115L-002420950359361211015300000143152",
        "AOE8246115L-001"
    ],
 
  "masterIds":[],
    "connoteIds":[],
 null,
   "labelType": 1,
    "packinglist": false,
 
  "merged": truefalse,

   "labelFormat": null,
  "JPGdpi": null
}


响应报文

代码块
languagejava
firstline1
titleResponse
linenumberstrue
 {
    "status": "Success",
    "errors": null,
    "data": [
        {
            "status": "Success",
            "errors": null,
            "labelContentwarnings":"Base64 String",
            "orderIdnull,
			"labelContent":"JDQ002445001000931503Base64 String",
            "trackingNo":"JDQ002445001000931503",
            "labelContents":null			"orderId": "420950359361211015300000143152",
            "masterRefnotrackingNo":"",             "connoteId":""
        },
"420950359361211015300000143152",
  {             "statuslastMileCarrier":"Success",             "errors":null,
            "labelContentlabelUrl":"Base64 String",
            "orderId":"JDQ002445001000931503"https://qa.etowertech.com/label/download/EXAk3ggLz6rYQqOU2wRIaA/1",
            "trackingNolabelContents":"JDQ002445001000931503", null
        }
  "labelContents":null,
            "masterRefno":"",
  ],
           "connoteId"warnings":""
        }
    ]
}





 null
}