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

正在查看旧版本。 查看 当前版本.

与当前比较 查看页面历史

« 前一个 版本 23 下一个 »

接口说明

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

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

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

路径

HTTP Verb URL
Post/services/shipper/labels

请求字段

1Field (API)Data TypeLengthMandatoryDetails
2orderIdsString80C

支持Tracking Number / Ref No.

3masterIdsString80C支持Master Ref No. 查询
4labelTypeString80O

abelType:

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

1表示10cm * 15cm,

2表示A4,

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

5packinglistString40O是否打印拣货清单
6mergedString64O

默认拆分;

Boolean类型,指定是否需要合并为一个PDF文件;

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

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


请求报文

Request
{
    "orderIds": [
        "AOE8246115L-002",
        "AOE8246115L-001"
    ],
    "masterIds":[],
    "connoteIds":[],
    "labelType": 1,
    "packinglist": false,
    "merged": true,
    "labelFormat": "JPG"
}

响应报文

Response
 {
    "status":"Success",
    "errors":null,
    "data":[
        {
            "status":"Success",
            "errors":null,
            "labelContent":"Base64 String",
            "orderId":"JDQ002445001000931503",
            "trackingNo":"JDQ002445001000931503",
            "labelContents":null,
            "masterRefno":"",
            "connoteId":""
        },
   {
            "status":"Success",
            "errors":null,
            "labelContent":"Base64 String",
            "orderId":"JDQ002445001000931503",
            "trackingNo":"JDQ002445001000931503",
            "labelContents":null,
            "masterRefno":"",
            "connoteId":""
        }
    ]
}






  • 无标签