...
HTTPVerb | URL |
---|---|
POST | /services/shipper/orders |
Request field
Field (API) | Data Type | Length | Mandatory | Details | |
referenceNo | String | 80 | M |
Unique ID of the client's order | ||||
referenceNo1 | String | 80 | O |
Client order number | ||||
trackingNo | String | 40 | O |
Tracking number | ||||
serviceCode | String | 64 | M |
Service code, provided by logistics provider | |||||
incoterm | String | 3 | O | DDU/DDP | |
description | String | 60 | M |
English product name | ||||
nativeDescription | String | 255 | O |
Chinese name | ||||
weight | Double | M |
weight(>=0.000001) | ||||
weightUnit | String | 3 | O |
Weight unit, enumeration value:G, KG,LB |
Default value:KG | ||||
length | Double | O |
long | ||||
width | Double | O |
wide | ||||
height | Double | O |
high | |||||
volume | Double | O | 体积(>=0.01) | ||
dimensionUnit | String | 3 | O | 长度单位,枚举值:M, CM 默认值:CM | |
invoiceValue | Double | M | 货值(>=0.01),与sum(itemCount * unitValue)的误差不能超过0.1 | ||
invoiceCurrency | String | 3 | M | 币种,ISO货币代码 | |
Boolean | 1 | O | 枚举值:Y/N 默认值:N | ||
authorityToLeave | Boolean | ||||
lockerService | Boolean | ||||
batteryType | String | 64 | O | 电池类型,枚举值: No Battery Lithium Ion Polymer Lithium Ion Alloy 默认值:No Battery | |
batteryPacking | String | 64 | O | 电池包装,枚举值: No Battery Inside Equipment Packaged with Equipment Battery Only Other 默认值:No Battery | |
dangerousGoods | Boolean | O | 默认值:false | ||
sku | String | 128 | O | 捡货清单,一般面单上会显示出来 | |
serviceOption | String | 60 | O | ||
instruction | String | 255 | O | 派送指令 | |
facility | String | 20 | O | 发件网点,物流商提供 | |
platform | String | 20 | O | 平台代码 | |
recipientName | String | 50 | M | 收件人名称 限制英语/法语字符/非纯数字 自动去除特殊字符 | |
recipientTaxId | String | 100 | O | 收件人税号 | |
recipientCompany | String | 50 | O | 收件人公司名 | |
phone | String | 20 | O | 电话 | |
String | 50 | O | 邮箱 | ||
addressLine1 | String | 200 | M | 地址第一行 限制英语/法语字符/非纯数字 自动去除特殊字符 | |
addressLine2 | String | 200 | O | 地址第二行 | |
addressLine3 | String | 80 | O | 地址第三行 | |
city | String | 80 | M | 城市 | |
state | String | 80 | M | 省 限制英语/法语字符/非纯数字 自动去除特殊字符 | |
postcode | String | 16 | O | 邮编 | |
country | String | 2 | M | 国家二字代码 | |
shipperName | String | 50 | M | 发件人名称 限制英语/法语字符/非纯数字 自动去除特殊字符 | |
shipperPhone | String | 20 | O | 电话 | |
shipperAddressLine1 | String | 200 | O | 地址第一行 | |
shipperAddressLine2 | String | 200 | O | 地址第二行 | |
shipperAddressLine3 | String | 80 | O | 地址第三行 | |
shipperCity | String | 80 | O | 城市 | |
shipperState | String | 80 | O | 省 | |
shipperPostcode | String | 16 | O | 邮编 | |
shipperCountry | String | 2 | O | 国家二字代码 | |
returnOption | String | 100 | O | 退件选项 | |
returnName | String | 50 | M | 退件接收人名称 | |
returnAddressLine1 | String | 200 | M | 地址第一行 | |
returnAddressLine2 | String | 200 | O | 地址第二行 | |
returnAddressLine3 | String | 80 | O | 地址第三行 | |
returnCity | String | 80 | M | 城市 | |
returnState | String | 80 | M | 省 | |
returnPostcode | String | 16 | O | 邮编 | |
returnCountry | String | 2 | M | 国家二字代码 | |
items | List | O | Item信息 | ||
itemNo | String | 128 | M | Item编号 | |
sku | String | 128 | M | SKU | |
description | String | 60 | M | 英文品名 如果值为空,设置成订单级别的description 1. 不能包含设置的违禁品关键词 2. 必须是英文和法文字符或数字 | |
nativeDescription | String | 255 | O | 中文品名 | |
hsCode | String | 60 | O | HS Code | |
originCountry | String | 60 | M | 国家二字代码,三字代码或名称 | |
itemCount | Integer | M | 件数,>0 | ||
unitValue | Double | M | 单价,>0 | ||
warehouseNo | 50 | O | 截取前50个字符 | ||
productURL | String | 512 | O | 产品链接 | |
itemWeight | Double | O | Item重量,转换成KG | ||
extendData | List | O | 扩展字段 | ||
vendorid | String | 12 | O | 税号 | |
gstexemptionCode | Sting | 4 | O | GST免税码,如果vendorid正确,该字段值自动设置为“PAID” | |
senderTaxId | String | 255 | O | 发货人税号 | |
InjectPort | String | 256 | O | 订单配送港口,针对加拿大服务 | |
pieces | array[map,...] | O | 一票多件包裹信息 | ||
Parcel Info | 单个包裹的请求字段结构同上方要求一致 |