页面树结构

版本比较

标识

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

Description

...

接口说明

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

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

路径

HTTP Verb URL
Post/services/shipper/
orders
labels

...

请求字段

#
1Field (API
)Field (Excel Template
)Data TypeLengthMandatoryDetails
1referenceNoRef No.String80M客户端的订单唯一标识
2
referenceNo1referenceNo1
orderIdsString80O
客户端订单号3trackingNoTracking No.String40O跟踪号4serviceCodeN/AString64M服务代码,物流商提供5incotermIncotermString3ODDU/DDP6descriptionGoods DescriptionString60M英文品名7nativeDescriptionNative DescriptionString255O中文品名8weightTotal weightDouble M重量(>=0.000001)9weightUnitTotal Weight UnitString3O重量单位,枚举值:G, KG,LB
默认值:KG10lengthLengthDouble O11widthWidthDouble O12heightHeightDouble O13volumeVolumeDouble O体积(>=0.01)14dimensionUnitDimension UnitString3O长度单位,枚举值:M, CM
默认值:CM15invoiceValueInvoice ValueDouble M货值(>=0.01),与sum(itemCount * unitValue)的误差不能超过0.116invoiceCurrencyInvoice CurrencyString3M币种,ISO货币代码17 Pick UpBoolean1O枚举值:Y/N
默认值:N18authorityToLeaveATLBoolean   19lockerServiceLocker ServiceBoolean   20batteryTypeBattery TypeString64O电池类型,枚举值:
No Battery
Lithium Ion
Polymer
Lithium Ion Alloy
默认值:No Battery21batteryPackingBattery PackingString64O电池包装,枚举值:
No Battery
Inside Equipment
Packaged with Equipment
Battery Only
Other
默认值:No Battery22dangerousGoodsDangerours GoodsBoolean O默认值:false23skuPacking ListString128O捡货清单,一般面单上会显示出来24serviceOptionService OptionString60O 25instructionShipping InstructionsString255O派送指令26facilityShipper Facility/OriginString20O发件网点,物流商提供27platformE-Commerce PlatformString20O平台代码28recipientNameRecipient NameString50M收件人名称
限制英语/法语字符/非纯数字
自动去除特殊字符29recipientTaxIdRecipient Tax IDString100O收件人税号30recipientCompanyRecipient CompanyString50O收件人公司名31phonePhoneString20O电话32emailEmailString50O邮箱33addressLine1Address line 1String200M地址第一行
限制英语/法语字符/非纯数字
自动去除特殊字符34addressLine2Address line 2String200O地址第二行35addressLine3Address line 3String80O地址第三行36cityCity/SuburbString80M城市37stateStateString80M
限制英语/法语字符/非纯数字
自动去除特殊字符38postcodePostcodeString16O邮编39countryCountryString2M国家二字代码40shipperNameShipper NameString50M发件人名称
限制英语/法语字符/非纯数字
自动去除特殊字符41shipperPhoneShipper PhoneString20O电话42shipperAddressLine1Shipper Address Line1String200O地址第一行43shipperAddressLine2Shipper Address Line2String200O地址第二行44shipperAddressLine3Shipper Address Line3String80O地址第三行45shipperCityShipper Address CityString80O城市46shipperStateShipper Address StateString80O47shipperPostcodeShipper Address PostcodeString16O邮编48shipperCountryShipper Address CountryString2O国家二字代码49returnOptionReturn OptionString100O退件选项50returnNameReturn NameString50M退件接收人名称51returnAddressLine1Return Address Line1String200M地址第一行52returnAddressLine2Return Address Line2String200O地址第二行53returnAddressLine3Return Address Line3String80O地址第三行54returnCityReturn Address CityString80M城市55returnStateReturn Address StateString80M56returnPostcodeReturn Address PostcodeString16O邮编57returnCountryReturn Address CountryString2M国家二字代码58itemsN/AList OItem信息59 itemNoItem NoString128MItem编号60 skuItem SKUString128MSKU61 descriptionItem DescString60M英文品名
如果值为空,设置成订单级别的description
1. 不能包含设置的违禁品关键词
2. 必须是英文和法文字符或数字62 nativeDescriptionItem Native DescString255O中文品名63 hsCodeItem HSCodeString60OHS Code64 originCountryItem OriginString60M国家二字代码,三字代码或名称65 itemCountItem CountInteger M件数,>066 unitValueItem Unit ValueDouble M单价,>067 warehouseNoWarehouse No 50O截取前50个字符68 productURLItem Product URLString512O产品链接69 itemWeightItem WeightDouble OItem重量,转换成KG70extendData N/AList O扩展字段71 vendoridvendoridString12O税号72 gstexemptionCodegstexemptionCodeSting4OGST免税码,如果vendorid正确,该字段值自动设置为“PAID”73 senderTaxIdsenderTaxIdString255O发货人税号74 InjectPortInjectPortString256O订单配送港口,针对加拿大服务

...

我们支持用户使用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警告消息

请求报文

代码块
languagejs
borderStylesolid
firstline1
titleRequest
linenumberstrue
[
  {
 
  "referenceNoorderIds": "reedzhang1231211",[
    "country": "AU",420950359361211015300000143152"
    "serviceCode": "UBI.AU2AU.AUPOST.1",
 ],
  "serviceOptionmasterIds": "Expedited"null,
 
  "facilitylabelType": "can"1,
    "statepackinglist": "VICTORIA"false,
 
  "citymerged": "Berwick"false,
 
  "postcodelabelFormat": "3806"null,
 
  "addressLine1": "3 Lakeside Drivie",
    "addressLine2": "",
    "recipientName": "Corrie McKee",
    "phone": "0403536112",
    "email": "corrie.mckee@monash.edu",
    "sku": "sw2111202146745684",
    "invoiceCurrency": "USD",
    "invoiceValue": 6.23,
    "weightUnit": "g",
    "weight": 264,
    "description": "sw2111202146745684",
    "nativeDescription": "连衣裙",
    "shipperName": "Jiang Yuanfei",
    "shipperPhone": "+86 02586707811",
    "shipperAddressLine1": "Prologis (Anbo) Logistics Center Datang Town,Sanshui Industrial Park",
    "vendorid": "111",
    "abnnumber": "",
    "gstexemptioncode": "PAID",
    "extendData": {
      "injectPort": null
    },
    "orderItems": [
      {
   dpi": null
}


响应报文

代码块
languagejava
firstline1
titleResponse
linenumberstrue
{
    "itemCountstatus": 1,
        "originCountry": "CNSuccess",
   
    "descriptionerrors": "sw2111202146745684",
   null,
    "nativeDescriptiondata": "连衣裙",
        "unitValue": 3.87,
        "itemNo": "8247107",
        "sku": "sw2111202146745684"
      },[
        {
     
  "itemCount": 1,         "originCountrystatus": "CNSuccess",
     
  "description": "sw2201125303640755",         "nativeDescriptionerrors": "背心"null,
        "unitValue": 2.36,
        "itemNowarnings": "9743766",
        "sku": "sw2201125303640755"
      }
    ],
    "shipperCity": "FO SHAN",
    "volume": 0.1
  }
]

Response

代码块
languagejava
firstline1
titleResponse
linenumberstrue
 {
  "status": "Success",
  "errors": null,
  "data": [null,
			"labelContent":"Base64 String",
			"orderId": "420950359361211015300000143152",
        {       "statustrackingNo": "Success420950359361211015300000143152",
 
    "errors": null,       "warningslastMileCarrier": null,
 
    "orderId": "z1Mkp-bpgIHPRFCcNg0cbw",       "referenceNolabelUrl": "Sammy2022318022939",
      "trackingNo": "9274890260113400044444https://qa.etowertech.com/label/download/EXAk3ggLz6rYQqOU2wRIaA/1",
      "connoteId": null,
      "piecesResultlabelContents": null,
      "extraProperty": { }
       "injectPort": "EWR",
  ],
     "customsClearanceType": "T"
      }
    }
  ],
  "warnings": null
}