页面树结构

版本比较

标识

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

...

Generate and print labels, and return results according to the order of request.

Add a new field 'masterIds' on the basic of previous Print Label Interface

  • 'orderIds' and 'masterIds' field are set as condition. If they are filled in at the same time, the default value is from orderIds;
  • Support merge PDF type label by 'merged' field, other type label cannot be merged.
  • Add a new field 'masterRefno' in Response Message.

Path

HTTP Verb URL
Post/services/shipper/labels

...

Field (API)Data TypeLengthMandatoryDetails
orderIdsString80O

Support for using Tracking Number / Ref No. queries

masterIdsString80C

Master Ref No. Query is supported

labelTypeString80O

abelType:

0 Indicates the default value10cm * 15cm,

1 express10cm express 10cm * 15cm,

2 expressA4,express A4,

4 express10cm * 10cm,At express 10cm * 10cm. At present, the API only supports these three formats;

packinglistStringBoolean40true/falseOWhether to print a picking list or not
mergedStringBoolean64true/falseMOBoolean type,Specify Specify whether to merge into one PDF file; If consolidation is selected, only the successful orders will be merged and printed, and the consolidation will be carried out according to the order of orders in the request parameters.
labelFormatString3O

Label format: JPG format is optional. If it is not filled in, the default format is

pdf

PDF format.

Jpg

JPG format sheets do not support merging. When printing packinglist at the same time, multiple files will be returned.

ZPL

dpiString3O

When label format is ZPL, 300 or 203 dpi is supported.

If no dpi value or fields, default value is 300 dpi.


Request message

代码块
languagejs
borderStylesolid
firstline1
titleRequest
linenumberstrue
{
"orderIds":["ABC123456789001001002"],
"labelType":1,
"packinglist":false,
"merged":false,
"labelFormat":"JPG",
"dpi":"203"
}


Response message

代码块
languagejava
firstline1
titleResponse
linenumberstrue
 {
    "status": "Success",
    "errors": null,
    "data": [
        {
            "status":"Success",
            "errors": null,
            "labelContent":"Base64 String"
            "orderId":"JDQ002445001000931503",
            "trackingNo":"JDQ002445001000931503",
            "labelContents": null,
            "lastMileCarrier": null
        }
    ]
}