页面历史

接口说明

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

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

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

...

HTTP Verb	URL
Post	/services/shipper/orders

请求字段

1	Field (API)	Data Type	Length	Mandatory	Details
2	referenceNo	String	80	M	客户端的订单唯一标识
3	referenceNo1	String	80	O	客户端订单号
4	trackingNo	String	40	O	跟踪号
5	serviceCode	String	64	M	服务代码，物流商提供
6	serviceOption	String	64	O	服务选项，物流商提供
7	incoterm	String	3	O	DDU/DDP
8	description	String	60	M	英文品名
9	nativeDescription	String	255	O	中文品名
10	weight	Double		M	重量(>=0.000001)
11	weightUnit	String	3	O	重量单位，枚举值：G, KG,LB 默认值：KG
12	length	Double		O	长
13	width	Double		O	宽
14	height	Double		O	高
15	volume	Double		O	体积(>=0.01) volume默认单位就是立方米
16	dimensionUnit	String	3	O	长度单位，枚举值：M, CM 默认值：CM
17	invoiceValue	Double		M	货值(>=0.01)，与sum(itemCount * unitValue)的误差不能超过0.1
18	invoiceCurrency	String	3	M	币种，ISO货币代码
19	pickUp	Boolean	1	O	枚举值：Y/N 默认值：N
20	authorityToLeave	Boolean		O	不需要签名（置放于收货人门口）
21	lockerService	Boolean	3	O
22	batteryType	String	64	O	电池类型，枚举值： No Battery Lithium Ion Polymer Lithium Ion Alloy 默认值：No Battery
23	batteryPacking	String	64	O	电池包装，枚举值： No Battery Inside Equipment Packaged with Equipment Battery Only Other 默认值：No Battery
24	dangerousGoods	Boolean		O	默认值：false
25	sku	String	128	O	捡货清单，一般面单上会显示出来
26

String60O　27

instruction

String

255

O

派送指令

28

27

facility

String

20

O

发件网点，物流商提供

29

28

platform

String

20

O

平台代码

30

29

recipientName

String

50

M

收件人名称

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

31

30

recipientTaxId

String

100

O

收件人税号

32

31

recipientCompany

String

50

O

收件人公司名

33

32

phone

String

20

O

电话

34

33

email

String

50

O

邮箱

35

34

addressLine1

String

200

M

地址第一行

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

36

35

addressLine2

String

200

O

地址第二行

37

36

addressLine3

String

80

O

地址第三行

38

37

city

String

80

M

城市

39

38

state

String

80

M

省

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

40

39

postcode

String

16

O

邮编

41

40

country

String

2

M

国家二字代码

42

41

shipperName

String

50

M

发件人名称

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

43

42

shipperPhone

String

20

O

电话

44

43

shipperAddressLine1

String

200

O

地址第一行

45

44

shipperAddressLine2

String

200

O

地址第二行

46

45

shipperAddressLine3

String

80

O

地址第三行

47

46

shipperCity

String

80

O

城市

48

47

shipperState

String

80

O

省

49

48

shipperPostcode

String

16

O

邮编

50

49

shipperCountry

String

2

O

国家二字代码

51

50

shipperEmail

String

80

O

客户邮箱

52

51

returnOption

String

100

O

退件选项

53

空 Return Destroy Forward
52	returnName		String	50

M

O

退件接收人名称

54

53

returnAddressLine1

String

200

M

O

地址第一行

55

54

returnAddressLine2

String

200

O

地址第二行

56

55

returnAddressLine3

String

80

O

地址第三行

57

56

returnCity

String

80

M

O

城市

58

57

returnState

String

80

M

O

省

59

58

returnPostcode

String

16

O

邮编

60

59

returnCountry

String

2

M

O

国家二字代码

61

60

returnPhone

String

50

O

退货电话

62

61

orderItems

List

O

Item信息

63

62

itemNo

String

128

M

Item编号

64

63

sku

String

128

M

SKU

65

64

description

String

60

M

英文品名
如果值为空，设置成订单级别的description
1. 不能包含设置的违禁品关键词
2. 必须是英文和法文字符或数字

66

65

nativeDescription

String

255

O

中文品名

67

66

hsCode

String

60

O

HS Code

68

67

originCountry

String

60

M

国家二字代码，三字代码或名称

69

68

itemCount

Integer

M

件数，>0

70

69

unitValue

Double

M

单价，>0

71

70

warehouseNo

50

O

截取前50个字符

72

71

productURL

String

512

O

产品链接

73

72		weight	Double		O	Item重量，系统会将G自动转换成KG，四舍五入
73		use	String	255	O

Item重量，转换成KG

商品用途
74		material	String	255	O	商品材质
75	extendData		Object		O

扩展字段

扩展字段，仅展示部分，具体字段根据服务要求有所不同

75

76

vendorid

String

12

O

税号

发件人税号

76

77

gstexemptionCode

Sting

4

O

GST免税码，如果vendorid正确，该字段值自动设置为“PAID”

77

78

senderTaxId

String

255

O

发货人税号

78

79

injectPort

InjectPort

String

256

255

O

订单配送港口，针对加拿大服务

订单配送港口

79

80

pieces

	originPort	String	255	O	订单起始港口
81		postage	Decimal (12, 2)	255	O	运费
82		icms	Decimal (12, 2)	255	O	巴西icms 费用
83		vat	Decimal (12, 2)	255	O	税号
84		agentID	String	10	O	parcelShopID
85	onlineInsurance
86		insuranceCurrency	String	3	O	投保额币种
87		insuranceAmount	Double	/	O	投保额
88		beneficiaryType	String	255	O	被保险人类型 1=个人 2=公司
89		organizationCode	String	255	O	如果beneficiaryType=1，请填写身份证号码如果beneficiaryType=2，请填写组织机构代码证
90		beneficiary	String	255	O	被保险人
91		insure	String	/	O	是否投保 1=是
92		contactName	String	20	O	被保人真实姓名
93	pieces		array[map,...]		O	一票多件包裹信息

80

94

Parcel Info

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

响应说明

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

1) 订单状态(status)

...

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

3.1）订单号（orderId)

3.2）客户编号(referenceNo)

3.2）客户编号3）跟踪号(referenceNotrackingNo)

3.3）跟踪号4）客户编号1(trackingNoreferenceNo1)

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

3.5）一票多件（piecesResult）6）一票多件（piecesResult）

3.6）扩展字段（extraProperty）7）扩展字段（extraProperty）

3.67.1）飞入港口 (injectPort)

3.67.2) 清关方式 (customsClearanceType)

3.7）错误消息列表8）错误消息列表(errors)

3.78.1）错误编码(code)

3.78.2) 错误消息(message)

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

...

代码块

language	js
borderStyle	solid
firstline	1
title	Request
linenumbers	true

[
  {
    "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
  }
]

...

代码块

title	Response
linenumbers	true

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
}

...

页面树结构

版本比较

旧版本 73

新版本当前版本

标识

接口说明

请求字段

响应说明

页面树结构

页面历史

版本比较

旧版本 73

新版本 当前版本

标识

接口说明

请求字段

响应说明

新版本当前版本