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

接口说明

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

  • 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”


请求报文

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

响应报文

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






  • 无标签

评论

  1. 宁镭 发表:

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