eTower Developers
页面树结构

版本比较

旧版本 32

changes.mady.by.user 宁镭

保存于

比较

新版本 当前版本

changes.mady.by.user 陶诗

保存于

标识

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

接口说明

一个订单对应一个包裹和它的商品描述、重量、派送地址等信息。

请求正文包含一个订单序列，最多可以一次性发送 300 个订单。 同时系统可以接受外部 API 对接系统所产生的包裹运单号 TrackingNo，不过此功能权限需 要经过 eTower 授权确认。 “facility”：需要向物流服务提供方咨询。

一票多件，我们会拿一票多件中第一票订单的ref no作为master ref no，作为一个关系来关联该订单以下pieces中的子单的关系。

路径

HTTP Verb URL
Post/services/shipper/orders

请求字段

1Field (API)Data Type

Length

MandatoryDetails
2referenceNoString80M客户端的订单唯一标识
3referenceNo1String80O客户端订单号
4trackingNoString40O跟踪号
5serviceCodeString64M服务代码，物流商提供
6serviceOptionString64O服务选项，物流商提供
7incotermString3ODDU/DDP
7
8descriptionString60M英文品名
8
9nativeDescriptionString255O中文品名
9
10weightDouble　M重量(>=0.000001)
10
11weightUnitString3O重量单位，枚举值：G, KG,LB
默认值：KG
11
12lengthDouble　O长
12
13widthDouble　O宽
13
14heightDouble　O高
14
15volumeDouble　O体积(>=0.01) volume默认单位就是立方米
15
16dimensionUnitString3O长度单位，枚举值：M, CM
默认值：CM
16
17invoiceValueDouble　M货值(>=0.01)，与sum(itemCount * unitValue)的误差不能超过0.1
17
18invoiceCurrencyString3M币种，ISO货币代码
18
19
　
pickUpBoolean1O枚举值：Y/N
默认值：N
19
20authorityToLeaveBoolean　
　
O
　
不需要签名（置放于收货人门口）
20
21lockerServiceBoolean
　
3
　
O
　

22
21
batteryTypeString64O电池类型，枚举值：
  • No Battery
  • Lithium Ion

  • Polymer
  • Lithium Ion Alloy
默认值：No Battery
22
23batteryPackingString64O电池包装，枚举值：
  • No Battery
  • Inside Equipment
  • Packaged with Equipment
  • Battery Only
  • Other
默认值：No Battery
23
24dangerousGoodsBoolean　O默认值：false
24
25skuString128O捡货清单，一般面单上会显示出来
25serviceOptionString60O　
26instructionString255O派送指令
27facilityString20O发件网点，物流商提供
28platformString20O平台代码
29recipientNameString50M收件人名称

限制英语/法语字符/非纯数字
自动去除特殊字符
30recipientTaxIdString100O收件人税号
31recipientCompanyString50O收件人公司名
32phoneString20O电话
33emailString50O邮箱
34addressLine1String200M地址第一行

限制英语/法语字符/非纯数字

自动去除特殊字符
35addressLine2String200O地址第二行
36addressLine3String80O地址第三行
37cityString80M城市
38stateString80M省

限制英语/法语字符/非纯数字
自动去除特殊字符
39postcodeString16O邮编
40countryString2M国家二字代码
41shipperNameString50M发件人名称

限制英语/法语字符/非纯数字

自动去除特殊字符
42shipperPhoneString20O电话
43shipperAddressLine1String200O地址第一行
44shipperAddressLine2String200O地址第二行
45shipperAddressLine3String80O地址第三行
46shipperCityString80O城市
47shipperStateString80O省
48shipperPostcodeString16O邮编
49shipperCountryString2O国家二字代码
50shipperEmailString80O客户邮箱
51returnOptionString100O

退件选项

51

  • 空
  • Return
  • Destroy
  • Forward
52returnNameString50
M
O退件接收人名称
52
53returnAddressLine1String200
M
O地址第一行
53
54returnAddressLine2String200O地址第二行
54
55returnAddressLine3String80O地址第三行
55
56returnCityString80
M
O城市
56
57returnStateString80
M
O省
57
58returnPostcodeString16O邮编
58
59returnCountryString2
M
O国家二字代码
59items
60returnPhoneString50O退货电话
61orderItemsList　OItem信息
60
62　itemNoString128MItem编号
61
63　skuString128MSKU
62
64　descriptionString60M英文品名
如果值为空，设置成订单级别的description
1. 不能包含设置的违禁品关键词
2. 必须是英文和法文字符或数字
63
65　nativeDescriptionString255O中文品名
64
66　hsCodeString60OHS Code
65
67　originCountryString60M国家二字代码，三字代码或名称
66
68　itemCountInteger　M件数，>0
67
69　unitValueDouble　M单价，>0
68
70　warehouseNo　50O截取前50个字符
69
71　productURLString512O产品链接
70
72　
itemWeight
weightDouble　O
Item重量，转换成KG
Item重量，系统会将G自动转换成KG，四舍五入
71
73
extendData

use

　
String
List
255
　
O
扩展字段

商品用途

72
74
　vendorid

material

String
12
255O
税号73

商品材质

75extendData　Object　O扩展字段，仅展示部分，具体字段根据服务要求有所不同
76　vendoridString12O发件人税号
77　gstexemptionCodeSting4OGST免税码，如果vendorid正确，该字段值自动设置为“PAID”
74
78　senderTaxIdString255O发货人税号
75
79
injectPortString255O订单配送港口
80　
InjectPort
originPortString
256
255O
订单配送港口，针对加拿大服务
订单起始港口

...

81

服务端返回与请求相对应的订单结果，包括：

1)     订单状态(status)

Failed（失败），Success（成功），Partial Success（部分成功）；

2)     错误消息(errors)

2.1）出错代码(code)；

2.2）错误消息(message)；

3)     具体的消息列表(data)

   3.1）订单号（orderId)

   3.2）客户编号(referenceNo)

   3.3）跟踪号(trackingNo)

   3.4）该条记录操作状态(status)

   3.5）一票多件（piecesResult）

   3.6）扩展字段（extraProperty）

      3.6.1）飞入港口 (injectPort)

      3.6.2) 清关方式 (customsClearanceType)

   3.7）错误消息列表(errors)

      3.7.1）错误编码(code)

      3.7.2) 错误消息(message) 

4)     警告消息(warnings)

4.1）警告代码(code)；

4.2）警告消息(message)；

...

languagejs
borderStylesolid
firstline1
titleRequest
linenumberstrue

...


postageDecimal (12, 2)255O运费
82
icmsDecimal (12, 2)255O巴西icms 费用
83
vatDecimal (12, 2)255O税号
84
agentIDString10OparcelShopID
85onlineInsurance




86
insuranceCurrencyString3O投保额币种
87
insuranceAmountDouble/O投保额
88
beneficiaryTypeString255

O

被保险人类型

1=个人
2=公司

89
organizationCodeString255

O

如果beneficiaryType=1，请填写身份证号码

如果beneficiaryType=2，请填写组织机构代码证

90
beneficiaryString255O被保险人
91
insureString/O

是否投保

1=是

92
contactNameString20O被保人真实姓名
93pieces
array[map,...]
O一票多件包裹信息
94
Parcel Info


单个包裹的请求字段结构同上方要求一致



响应说明

服务端返回与请求相对应的订单结果，包括：

1)     订单状态(status)

Failure（失败），Success（成功），Partial Success（部分成功）；

2)     错误消息(errors)

2.1）出错代码(code)；

2.2）错误消息(message)；

3)     具体的消息列表(data)

   3.1）订单号（orderId)

   3.2）客户编号(referenceNo)

   3.3）跟踪号(trackingNo)

   3.4）客户编号1(referenceNo1)

   3.5）该条记录操作状态(status)

   3.6）一票多件（piecesResult）

   3.7）扩展字段（extraProperty）

      3.7.1）飞入港口 (injectPort)

      3.7.2) 清关方式 (customsClearanceType)

   3.8）错误消息列表(errors)

      3.8.1）错误编码(code)

      3.8.2) 错误消息(message) 

   3.9）换单状态(relabelStatus): 0-不换单；1-待处理；2-已完成

4)     警告消息(warnings)

4.1）警告代码(code)；

4.2）警告消息(message)；




请求报文

单票创建
代码块
languagejs
borderStylesolid
firstline1
titleRequest
linenumberstrue
[
  {
    "referenceNo": "TESTING1231211",
    "country": "AU",
    "serviceCode": "服务代码，请联系物流商提供",
    "serviceOption": "服务选项，请联系物流商提供",
    "facility": "can",
    "state": "VICTORIA",
    "city": "Berwick",
    "postcode": "3806",
    "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",
    "batteryType": "",
    "batteryPacking": ""
    "extendData": {
      "vendorid": "111",
      "injectPort": null,
      "postage": 12.3,
      "icms": 12.1,
      "vat": 1
    },
    "orderItems": [
      {
        "itemCount": 1,
        "originCountry": "CN",
        "description": "sw2111202146745684",
        "nativeDescription": "连衣裙",
        "unitValue": 3.87,
        "itemNo": "8247107",
        "sku": "sw2111202146745684"
      },
      {
        "itemCount": 1,
        "originCountry": "CN",
        "description": "sw2201125303640755",
        "nativeDescription": "背心",
        "unitValue": 2.36,
        "itemNo": "9743766",
        "sku": "sw2201125303640755"
      }
    ],
    "shipperCity": "FO SHAN",
    "volume": 0.1
  }
]
一票多件
代码块
languagejs
borderStylesolid
firstline1
titleRequest
linenumberstrue
 [
  {
    "referenceNo": "MAC2022041101012",
    "serviceCode": "服务代码，请联系物流商提供",
    "recipientName": "AMAZONYYC1",
    "phone": "68765183",
    "addressLine1": "University of Toronto 27",
    "addressLine2": "",
    "addressLine3": "",
    "city": "Toronto",
    "state": " Ontario",
    "postcode": "M5S 1A1",
    "country": "CA",
    "length": "",
    "width": "",
    "height": "",
    "shipperName": "alex",
    "shipperAddressLine1": "test",
    "shipperAddressLine2": "",
    "shipperAddressLine3": "",
    "shipperCity": "ON",
    "shipperState": "ON",
    "shipperPostcode": "k1z3yz",
    "shipperCountry": "CA",
    "shipperPhone": "15000695273",
    "facility": "",
    "weight": 1,
    "invoiceValue": 23.4,
    "invoiceCurrency": "USD",
    "description": "watch,pencil",
    "nativeDescription": "手表,铅笔",
    "sku": "sku001,sku002",
    "orderItems": [
      {
        "itemNo": 1,
        "sku": "sku001",
        "description": "watch",
        "nativeDescription": "手表",
        "hsCode": "hscode001",
        "originCountry": "CN",
        "itemCount": 2,
        "unitValue": 7.8,
        "warehouseNo": "",
        "productURL": "",
        "weight": 2
      },
      {
        "itemNo": 2,
        "sku": "sku002",
        "description": "pencil",
        "nativeDescription": "铅笔",
        "hsCode": "hscode002",
        "originCountry": "CN",
        "itemCount": 1,
        "unitValue": 7.8,
        "warehouseNo": "",
        "productURL": "",
        "weight": 2
      }
    ],
    "pieces": [
      {
        "referenceNo": "MAC2022040601012-1",
        "serviceCode": "服务代码，请联系物流商提供",
        "recipientName": "AMAZONYYC1",
        "phone": "68765183",
        "addressLine1": "University of Toronto 27",
        "addressLine2": "",
        "addressLine3": "",
        "city": "Toronto",
        "state": " Ontario",
        "postcode": "M5S 1A1",
        "country": "CA",
        "length": "",
        "width": "",
        "height": "",
        "shipperName": "alex",
        "shipperAddressLine1": "test",
        "shipperAddressLine2": "",
        "shipperAddressLine3": "",
        "shipperCity": "ON",
        "shipperState": "ON",
        "shipperPostcode": "k1z3yz",
        "shipperCountry": "CA",
        "shipperPhone": "15000695273",
        "facility": "",
        "invoiceValue": 23.4,
        "invoiceCurrency": "USD",
        "weight": 1,
        "description": "watch,pencil",
        "nativeDescription": "手表,铅笔",
        "sku": "sku001,sku002",
        "orderItems": [
          {
            "itemNo": 1,
            "sku": "sku001",
            "description": "watch",
            "nativeDescription": "手表",
            "hsCode": "hscode001",
            "originCountry": "CN",
            "itemCount": 2,
            "unitValue": 7.8,
            "warehouseNo": "",
            "productURL": "",
            "weight": 2
          },
          {
            "itemNo": 2,
            "sku": "sku002",
            "description": "pencil",
            "nativeDescription": "铅笔",
            "hsCode": "hscode002",
            "originCountry": "CN",
            "itemCount": 1,
            "unitValue": 7.8,
            "warehouseNo": "",
            "productURL": "",
            "weight": 2
          }
        ]
      },
      {
        "referenceNo": "MAC2022040601012-2",
        "serviceCode": "服务代码，请联系物流商提供",
        "recipientName": "AMAZONYYC1",
        "phone": "68765183",
        "addressLine1": "University of Toronto 27",
        "addressLine2": "",
        "addressLine3": "",
        "city": "Toronto",
        "state": " Ontario",
        "postcode": "M5S 1A1",
        "country": "CA",
        "length": "",
        "width": "",
        "height": "",
        "shipperName": "alex",
        "shipperAddressLine1": "test",
        "shipperAddressLine2": "",
        "shipperAddressLine3": "",
        "shipperCity": "ON",
        "shipperState": "ON",
        "shipperPostcode": "k1z3yz",
        "shipperCountry": "CA",
        "shipperPhone": "15000695273",
        "facility": "",
        "invoiceValue": 15.6,
        "invoiceCurrency": "USD",
        "weight": 1,
        "description": "mask",
        "nativeDescription": "口罩",
        "sku": "sku003",
        "orderItems": [
          {
            "itemNo": 1,
            "sku": "sku003",
            "description": "mask",
            "nativeDescription": "口罩",
            "hsCode": "hscode003",
            "originCountry": "CN",
            "itemCount": 2,
            "unitValue": 7.8,
            "warehouseNo": "",
            "productURL": "",
            "weight": 2
          }
        ]
      },
      {
        "referenceNo": "MAC2022040601012-3",
        "serviceCode": "服务代码，请联系物流商提供",
        "recipientName": "AMAZONYYC1",
        "phone": "68765183",
        "addressLine1": "University of Toronto 27",
        "addressLine2": "",
        "addressLine3": "",
        "city": "Toronto",
        "state": " Ontario",
        "postcode": "M5S 1A1",
        "country": "CA",
        "length": "",
        "width": "",
        "height": "",
        "shipperName": "alex",
        "shipperAddressLine1": "test",
        "shipperAddressLine2": "",
        "shipperAddressLine3": "",
        "shipperCity": "ON",
        "shipperState": "ON",
        "shipperPostcode": "k1z3yz",
        "shipperCountry": "CA",
        "shipperPhone": "15000695273",
        "facility": "",
        "invoiceValue": 15.6,
        "invoiceCurrency": "USD",
        "weight": 2,
        "description": "pencil,pencil",
        "nativeDescription": "铅笔,铅笔",
        "sku": "sku002,sku002",
        "orderItems": [
          {
            "itemNo": 1,
            "sku": "sku002",
            "description": "pencil",
            "nativeDescription": "铅笔",
            "hsCode": "hscode002",
            "originCountry": "CN",
            "itemCount": 1,
            "unitValue": 7.8,
            "warehouseNo": "",
            "productURL": "",
            "weight": 2
          },
          {
            "itemNo": 2,
            "sku": "sku002",
            "description": "pencil",
            "nativeDescription": "铅笔",
            "hsCode": "hscode002",
            "originCountry": "CN",
            "itemCount": 1,
            "unitValue": 7.8,
            "warehouseNo": "",
            "productURL": "",
            "weight": 1
          }
        ]
      }
    ]
  }
]

响应报文

单票
代码块
titleResponse
linenumberstrue
ResponseMsg
{
  "status": "Success",
  "errors": null,
  "data": [
    {
      "status": "Success",
      "errors": null,
      "warnings": null,
      "orderId": "",
      "referenceNo": "",
      "refNo1": "",
      "trackingNo": "",
      "connoteId": null,
      "piecesResult": null,
      "extraProperty": {},
      "relabelStatus": 1
      "lastMileCarrier":
    }
  ],
  "warnings": null
}
一票多件
代码块
firstline1
titleResponse
linenumberstrue
{
    "status": "Success",
    "errors": null,
    "data": [
        {
            "status": "Success",
            "errors": null,
            "warnings": null,
            "orderId": "",
            "referenceNo": "",
            "trackingNo": "",
            "connoteId": null,
            "piecesResult": [
                {
                    "status": "Success",
                    "errors": null,
                    "warnings": null,
                    "orderId": "",
                    "referenceNo": "",
                    "trackingNo": "",
                    "connoteId": null
                },
                {
                    "status": "Success",
                    "errors": null,
                    "warnings": null,
                    "descriptionorderId": "sw2111202146745684",
        "nativeDescription": "连衣裙",            "unitValuereferenceNo": 3.87"",
        "itemNo": "8247107",            "skutrackingNo": "sw2111202146745684",
      },       {         "itemCountconnoteId": 1,null
        "originCountry": "CN",         "description": "sw2201125303640755",
 },
      "nativeDescription": "背心",          {
"unitValue": 2.36,         "itemNo": "9743766",         "skustatus": "sw2201125303640755Success"
  ,
   }     ],     "shipperCity": "FO SHAN",     "volumeerrors": 0.1null,
   }
]

响应报文

代码块
languagejava
firstline1
titleResponse
linenumberstrue
 {
  "status": "Success",                 "errorswarnings": null,
  "data": [           {       "statusorderId": "Success",
      "errors": null,              "warningsreferenceNo": null"",
      "orderId": "z1Mkp-bpgIHPRFCcNg0cbw",              "referenceNotrackingNo": "Sammy2022318022939",
            "trackingNo": "9274890260113400044444",       "connoteId": null,
          "piecesResult": null,     }
 "extraProperty": {         "injectPort": "EWR", ],
            "customsClearanceTypeextraProperty": "T"{}
      }  }
  }   ],
    "warnings": null
}


Float_table_content
Hidablefalse

Float_table_content
Hidablefalse