Float_table_content |
---|
Description
...
接口说明
产生和打印标签,按照请求顺序返回结果。
|
路径
HTTP Verb | URL |
---|---|
Post | /services/shipper/ |
labels |
...
请求字段
#
)Field (Excel Template
1 referenceNo Ref No. String 80 M 客户端的订单唯一标识
referenceNo1 referenceNo1
客户端订单号 3 trackingNo Tracking No. String 40 O 跟踪号 4 serviceCode N/A String 64 M 服务代码,物流商提供 5 incoterm Incoterm String 3 O DDU/DDP 6 description Goods Description String 60 M 英文品名 7 nativeDescription Native Description String 255 O 中文品名 8 weight Total weight Double M 重量(>=0.000001) 9 weightUnit Total Weight Unit String 3 O 重量单位,枚举值:G, KG,LB
默认值:KG 10 length Length Double O 长 11 width Width Double O 宽 12 height Height Double O 高 13 volume Volume Double O 体积(>=0.01) 14 dimensionUnit Dimension Unit String 3 O 长度单位,枚举值:M, CM
默认值:CM 15 invoiceValue Invoice Value Double M 货值(>=0.01),与sum(itemCount * unitValue)的误差不能超过0.1 16 invoiceCurrency Invoice Currency String 3 M 币种,ISO货币代码 17 Pick Up Boolean 1 O 枚举值:Y/N
默认值:N 18 authorityToLeave ATL Boolean 19 lockerService Locker Service Boolean 20 batteryType Battery Type String 64 O 电池类型,枚举值:
No Battery
Lithium Ion
Polymer
Lithium Ion Alloy
默认值:No Battery 21 batteryPacking Battery Packing String 64 O 电池包装,枚举值:
No Battery
Inside Equipment
Packaged with Equipment
Battery Only
Other
默认值:No Battery 22 dangerousGoods Dangerours Goods Boolean O 默认值:false 23 sku Packing List String 128 O 捡货清单,一般面单上会显示出来 24 serviceOption Service Option String 60 O 25 instruction Shipping Instructions String 255 O 派送指令 26 facility Shipper Facility/Origin String 20 O 发件网点,物流商提供 27 platform E-Commerce Platform String 20 O 平台代码 28 recipientName Recipient Name String 50 M 收件人名称
限制英语/法语字符/非纯数字
自动去除特殊字符29 recipientTaxId Recipient Tax ID String 100 O 收件人税号 30 recipientCompany Recipient Company String 50 O 收件人公司名 31 phone Phone String 20 O 电话 32 email Email String 50 O 邮箱 33 addressLine1 Address line 1 String 200 M 地址第一行
限制英语/法语字符/非纯数字
自动去除特殊字符34 addressLine2 Address line 2 String 200 O 地址第二行 35 addressLine3 Address line 3 String 80 O 地址第三行 36 city City/Suburb String 80 M 城市 37 state State String 80 M 省
限制英语/法语字符/非纯数字
自动去除特殊字符38 postcode Postcode String 16 O 邮编 39 country Country String 2 M 国家二字代码 40 shipperName Shipper Name String 50 M 发件人名称
限制英语/法语字符/非纯数字
自动去除特殊字符41 shipperPhone Shipper Phone String 20 O 电话 42 shipperAddressLine1 Shipper Address Line1 String 200 O 地址第一行 43 shipperAddressLine2 Shipper Address Line2 String 200 O 地址第二行 44 shipperAddressLine3 Shipper Address Line3 String 80 O 地址第三行 45 shipperCity Shipper Address City String 80 O 城市 46 shipperState Shipper Address State String 80 O 省 47 shipperPostcode Shipper Address Postcode String 16 O 邮编 48 shipperCountry Shipper Address Country String 2 O 国家二字代码 49 returnOption Return Option String 100 O 退件选项 50 returnName Return Name String 50 M 退件接收人名称 51 returnAddressLine1 Return Address Line1 String 200 M 地址第一行 52 returnAddressLine2 Return Address Line2 String 200 O 地址第二行 53 returnAddressLine3 Return Address Line3 String 80 O 地址第三行 54 returnCity Return Address City String 80 M 城市 55 returnState Return Address State String 80 M 省 56 returnPostcode Return Address Postcode String 16 O 邮编 57 returnCountry Return Address Country String 2 M 国家二字代码 58 items N/A List O Item信息 59 itemNo Item No String 128 M Item编号 60 sku Item SKU String 128 M SKU 61 description Item Desc String 60 M 英文品名
如果值为空,设置成订单级别的description
1. 不能包含设置的违禁品关键词
2. 必须是英文和法文字符或数字 62 nativeDescription Item Native Desc String 255 O 中文品名 63 hsCode Item HSCode String 60 O HS Code 64 originCountry Item Origin String 60 M 国家二字代码,三字代码或名称 65 itemCount Item Count Integer M 件数,>0 66 unitValue Item Unit Value Double M 单价,>0 67 warehouseNo Warehouse No 50 O 截取前50个字符 68 productURL Item Product URL String 512 O 产品链接 69 itemWeight Item Weight Double O Item重量,转换成KG 70 extendData N/A List O 扩展字段 71 vendorid vendorid String 12 O 税号 72 gstexemptionCode gstexemptionCode Sting 4 O GST免税码,如果vendorid正确,该字段值自动设置为“PAID” 73 senderTaxId senderTaxId String 255 O 发货人税号 74 InjectPort InjectPort String 256 O 订单配送港口,针对加拿大服务
1 | Field (API |
) | Data Type | Length | Mandatory | Details |
2 |
orderIds | String | 80 | O |
默认值:KG
默认值:CM
默认值:N
No Battery
Lithium Ion
Polymer
Lithium Ion Alloy
默认值:No Battery
No Battery
Inside Equipment
Packaged with Equipment
Battery Only
Other
默认值:No Battery
限制英语/法语字符/非纯数字
自动去除特殊字符
限制英语/法语字符/非纯数字
自动去除特殊字符
限制英语/法语字符/非纯数字
自动去除特殊字符
限制英语/法语字符/非纯数字
自动去除特殊字符
如果值为空,设置成订单级别的description
1. 不能包含设置的违禁品关键词
2. 必须是英文和法文字符或数字
...
我们支持用户使用Tracking Number / Ref No.查询 | ||||||
3 | masterIds | String | 80 | C | 我们支持用户使用Master Ref No. 查询 | |
4 | labelType | String | 80 | O | labelType: 0表示默认值10cm * 15cm, 1表示10cm * 15cm, 2表示A4, 4表示10cm * 10cm,目前API只支持这三种格式; | |
5 | packinglist | Boolean | true/false | O | 是否打印拣货清单 | |
6 | merged | Boolean | true/false | O | 指定是否需要合并为一个PDF文件,默认拆分; 若选择合并,则只会合并打印出成功的订单,并且按照请求参数中订单的顺序进行合并。 | |
7 | labelFormat | String | 3 | O | 标签格式,可选JPG格式,不填默认为PDF格式。JPG格式面单不支持合并,当同时选择打印packinglist时,会返回多个文件。 可选ZPL格式。选择ZPL时,字段值为“ZPL”。 | |
8 | dpi | String | 3 | O | 当标签格式为ZPL时,支持填写此字段,“300”和“203”是支持的。如不填写,默认为“300” |
响应字段
Field | Data Type | Mandatory | Details | ||
status | String | M | Failure(失败) Success(成功) Partial Success(部分成功) | ||
errors | Array | O | 报错信息 | ||
code | Int | O | 报错Code | ||
message | String | O | 报错英文信息 | ||
messageCn | String | O | 报错中文信息 | ||
data | Array | M | 具体的数据列表 | ||
status | String | M | Failure(失败) Success(成功) | ||
errors | Array | O | 报错信息 | ||
code | Int | O | 报错Code | ||
message | String | O | 报错英文信息 | ||
messageCn | String | O | 报错中文信息 | ||
warnings | String | O | 警告消息 | ||
labelContent | String | M | 面单Base64内容 | ||
orderId | String | M | 同请求报文中的orderIds值,为Tracking Number / Ref No. | ||
trackingNo | String | M | 尾程单号 | ||
lastMileCarrier | String | O | 订单所属服务的尾程供应商 | ||
labelUrl | String | M | 面单URL | ||
labelContents | String | O | / | ||
warnings | String | O | 警告消息 |
请求报文
代码块 | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
[ { "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 } |
响应报文
代码块 | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "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
代码块 | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "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 } |