eTower Developers
页面树结构
转至元数据结尾
转至元数据起始

接口说明

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

请求正文包含一个订单序列，最多可以一次性发送 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
8descriptionString255M英文品名
9nativeDescriptionString255O中文品名
10weightDouble　M重量(>=0.000001)
11weightUnitString3O重量单位，枚举值：G, KG,LB,
默认值：KG
12lengthDouble　O长
13widthDouble　O宽
14heightDouble　O高
15volumeDouble　O体积(>=0.01) volume默认单位就是立方米
16dimensionUnitString3O长度单位，枚举值：M, CM,IN
默认值：CM
17invoiceValueDouble　M货值(>=0.01)，与sum(itemCount * unitValue)的误差不能超过0.1
18invoiceCurrencyString3M币种，ISO货币代码
19pickUpBoolean1O枚举值：Y/N
默认值：N
20authorityToLeaveBoolean　O不需要签名（置放于收货人门口）
21lockerServiceBoolean3O
22batteryTypeString64O电池类型，枚举值：
  • No Battery
  • Lithium Ion Polymer
  • Lithium Ion Alloy
默认值：No Battery
23batteryPackingString64O电池包装，枚举值：
  • No Battery
  • Inside Equipment
  • Packaged with Equipment
  • Battery Only
  • Other
默认值：No Battery
24dangerousGoodsBoolean　O默认值：false
25skuString128O捡货清单，一般面单上会显示出来
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

退件选项

  • 空
  • Return
  • Destroy
  • Forward
52returnNameString50O退件接收人名称
53returnAddressLine1String200O地址第一行
54returnAddressLine2String200O地址第二行
55returnAddressLine3String80O地址第三行
56returnCityString80O城市
57returnStateString80O省
58returnPostcodeString16O邮编
59returnCountryString2O国家二字代码
60returnPhoneString50O退货电话
61orderItemsList　OItem信息
62　itemNo
String128OItem编号
63　sku
String128MSKU
64　description
String255M英文品名
如果值为空，设置成订单级别的description
1. 不能包含设置的违禁品关键词
2. 必须是英文和法文字符或数字
65　nativeDescription
String255O中文品名
66　hsCode
String60OHS Code
67　originCountry
String60M国家二字代码，三字代码或名称
68　itemCount
Integer　M件数，>0
69　unitValue
Double　M单价，>0
70　warehouseNo
　50O截取前50个字符
71　productURL
String512O产品链接
72　weight
Double　O

Item重量，重量单位跟包裹weightUnit一致

73

use


String255O

商品用途

74

material


String255O

商品材质

75
extendData
Object

Item拓展信息
76

itemExportInvoiceValueDouble
O物品出口申报金额，支持两位小数
77

itemExportInvoiceCurrencyString255O物品出口申报币种
78

asinNoString255OAmazon平台 ASIN No
79extendData　
Object　O扩展字段，仅展示部分，具体字段根据服务要求有所不同
80　vendorid
String12O发件人税号
81　gstexemptionCode
Sting4OGST免税码，如果vendorid正确，该字段值自动设置为“PAID”
82　senderTaxId
String255O发货人税号
83
injectPort
String255O订单配送港口
84　originPort
String255O订单起始港口
85
postage
Decimal (12, 2)255O运费
86
icms
Decimal (12, 2)255O巴西icms 费用
87
vat
Decimal (12, 2)255O税号
88
agentID
String10OparcelShopID
89
coveramount
Double
O保费金额，针对于特定服务的额外投保业务
90
shipperCompanyName
String255O发件人公司名
91
shipperOrganizationCode
String255O发件人企业统一社会信用代码
92
mailingDate
String
O时间格式是YYYY-MM-DD HH:mm:SS
93
exportInvoiceValue
Double
O包裹出口申报金额，支持两位小数
94
exportInvoiceCurrency
String255O出口申报币种
95
recipientFamilyName
String50O收件人姓氏
96
recipientMiddleName
String50O收件人中间名
97
recipientPassportSerial
String50O护照本编号（护照序列号）
98
recipientPassportNumber
String50O护照证件号码
99
passportIssueDate
String
O护照签发日期，时间格式是YYYY-MM-DD
100
OOH_Option
String50O是否为澳邮OOH订单，传值为Y时判断为澳邮OOH订单
101onlineInsurance





102
insuranceCurrency
String3O投保额币种
103
insuranceAmount
Double/O投保额
104
beneficiaryType
String255

O

被保险人类型

1=个人
2=公司

105
organizationCode
String255

O

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

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

106
beneficiary
String255O被保险人
107
insure
String/O

是否投保

1=是

108
contactName
String20O被保人真实姓名
109pieces

array[map,...]
O一票多件包裹信息
110
Parcel Info



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


响应说明

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

序号/层级Field (API)中文参考详情
1status订单状态

Failure: 失败；

Success: 成功；

Partial Success: 部分成功

2errors错误消息（顶层）错误消息集合，包含 code、message
2.1errors[].code出错代码出错代码
2.2errors[].message错误消息错误消息内容
3data具体的消息列表订单记录列表，每项包含以下字段
3.1data[].orderId订单号订单号
3.2data[].referenceNo客户编号客户编号
3.3data[].trackingNo跟踪号跟踪号
3.4data[].referenceNo1客户编号1客户编号1
3.5data[].status该条记录操作状态该条记录的操作状态
3.6data[].piecesResult一票多件一票多件结果/信息
3.7data[].extraProperty扩展字段扩展字段对象
3.7.1data[].extraProperty.injectPort飞入港口飞入港口
3.7.2data[].extraProperty.customsClearanceType清关方式清关方式
3.7.3data[].extraProperty.lastMileCarrier尾程运输商尾程运输商
3.8data[].errors错误消息列表该条记录的错误消息列表，包含 code、message
3.8.1data[].errors[].code错误编码错误编码
3.8.2data[].errors[].message错误消息错误消息内容
3.9data[].relabelStatus换单状态

0：不换单

1：待处理

2：已完成

4warnings警告消息警告消息集合，包含 code、message
4.1warnings[].code警告代码警告代码
4.2warnings[].message警告消息警告消息内容



请求报文

* 请注意，API请求报文为序列，支持一次性发送多票订单，结构为[{},{},{}]，最外层为 [ ]

单票创建
Request
[
  {
    "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": "dress2111202146745684",
    "invoiceCurrency": "USD",
    "invoiceValue": 6.23,
    "weightUnit": "g",
    "weight": 264,
    "description": "dress211120214674568",
    "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,
	  "OOH_Option":"Y"
    },
    "orderItems": [
      {
        "itemCount": 1,
        "originCountry": "CN",
        "description": "dress2111202146745684",
        "nativeDescription": "连衣裙",
        "unitValue": 3.87,
        "itemNo": "8247107",
        "sku": "dress2111202146745684",
		"extendData":{
			"itemExportInvoiceValue": 0.1,
			"itemExportinvoiceCurrency":"USD"
		}
      },
      {
        "itemCount": 1,
        "originCountry": "CN",
        "description": "vest2201125303640755",
        "nativeDescription": "背心",
        "unitValue": 2.36,
        "itemNo": "9743766",
        "sku": "sw2201125303640755"
      }
    ],
    "shipperCity": "FO SHAN",
    "volume": 0.1
  }
]
一票多件
Request
 [
  {
    "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
          }
        ]
      }
    ]
  }
]

响应报文

单票
Response
ResponseMsg
{
  "status": "Success",
  "errors": null,
  "data": [
    {
      "status": "Success",
      "errors": null,
      "warnings": null,
      "orderId": "",
      "referenceNo": "",
      "refNo1": "",
      "trackingNo": "",
      "connoteId": null,
      "piecesResult": null,
      "extraProperty": {},
      "relabelStatus": 1
      "lastMileCarrier":null
    }
  ],
  "warnings": null
}
一票多件
Response
{
    "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,
                    "orderId": "",
                    "referenceNo": "",
                    "trackingNo": "",
                    "connoteId": null
                },
                {
                    "status": "Success",
                    "errors": null,
                    "warnings": null,
                    "orderId": "",
                    "referenceNo": "",
                    "trackingNo": "",
                    "connoteId": null
                }
            ],
            "extraProperty": {}
        }
    ],
    "warnings": null
}


Table of Contents

Table of Contents



  • 无标签