页面历史

...

Description

Create shipping orders.

A shipping order refers to a parcel with a specific description, weight, delivery info etc.Route.

An order list in JSON format. The interface accepts up to 300 orders at a time.

In generally, trackingNo should be generated by eTower. If trackingNo needs to be specified in request, it should be authorized by eTower.

Please consult your logistics service provider about “Facility” .

Path

HTTPVerb	URL
POST	/services/shipper/orders

Request field

1	Field (API)	Data Type	Length	Mandatory	Details
2	referenceNo	String	80	M	Unique ID of the client's order
3	referenceNo1	String	80	O	Client order number
4	trackingNo	String	40	O	Tracking number
5	serviceCode	String	64	M	Service code, provided by logistics provider
6	serviceOption	String	64	O	Service option, provided by logistics provider
7	incoterm	String	3	O	DDU/DDP
8	description	String	60	M	English product name
9	nativeDescription	String	255	O	Chinese name
10	weight	Double		M	weight(>=0.000001)
11	weightUnit	String	3	O	Weight unit, enumeration value：G, KG,LB Default value：KG
12	length	Double		O	long
13	width	Double		O	wide
14	height	Double		O	high
15	volume	Double		O

体积

volume(>=0.01) The default unit of the volume field is cubic meters
16	dimensionUnit		String	3	O

长度单位，枚举值：M

Length unit, enumeration value：M, CM

默认值：CM

Default value：CM
17	invoiceValue		Double		M

货值

The error between the value of goods (> = 0.01)

，与sum

and sum (

itemCount

itemcount *

unitValue

unitvalue)

的误差不能超过0

cannot exceed 0.1
18	invoiceCurrency		String	3	M

币种，ISO货币代码　

	Currency, ISO currency code
19	pickUp		Boolean	1	O

枚举值：Y

enumerator values：Y/N
Default value：N

默认值：N

20	authorityToLeave	Boolean
21	lockerService	Boolean
22	batteryType	String	64	O

电池类型，枚举值：

Battery type, enumeration values：No Battery
Lithium Ion 

 Polymer
Lithium Ion Alloy

默认值：No

Default value：No Battery
23	batteryPacking		String	64	O

电池包装，枚举值：

Battery packaging，enumerator values：No Battery
Inside Equipment
Packaged with Equipment
Battery Only
Other

默认值：No

Default value：No Battery
24	dangerousGoods		Boolean		O

默认值：falseserviceOptionString60O　

Default value：false
25	sku		String	128	O

捡货清单，一般面单上会显示出来

The picking list is usually displayed on the face list
26	instruction		String	255	O	Dispatch instruction

派送指令

27

facility

String

20

O

发件网点，物流商提供

Delivery outlets, provided by logistics providers
28	platform		String	20	O	Platform code

平台代码

29

recipientName

String

50

M

收件人名称

Recipient name

限制英语

Limit English /

法语字符/非纯数字
自动去除特殊字符

French characters / non pure numbers
30	recipientTaxId		String	100	O	Recipient tax number

收件人税号

31

recipientCompany

String

50

O

Recipient company name

收件人公司名

32

phone

String

20

O

Telephone

电话

33

email

String

50

O

mailbox

邮箱

34

addressLine1

String

200

M

地址第一行
限制英语/法语字符/非纯数字
自动去除特殊字符

First line of address Limit English / French characters / non pure numbers
35	addressLine2		String	200	O	Second line of address

地址第二行

36

addressLine3

String

80

O

Third line of address

地址第三行

37

city

String

80

M

城市

Recipient City
38	state		String	80	M

省

Recipient State

限制英语

Limit English /

法语字符/非纯数字
自动去除特殊字符

French characters / non pure numbers
39	postcode		String	16	O	Zip code

邮编

40

country

String

2

M

Country two character code

国家二字代码

41

shipperName

String

50

M

发件人名称

shipperr name

限制英语

Limit English /

法语字符/非纯数字
自动去除特殊字符

French characters / non pure numbers
42	shipperPhone		String	20	O	Phone

电话

43

shipperAddressLine1

String

200

O

First line of address

地址第一行

44

shipperAddressLine2

String

200

O

Second line of address

地址第二行

45

shipperAddressLine3

String

80

O

Third line of address

地址第三行

46

shipperCity

String

80

O

城市

City
47	shipperState		String	80	O	State

省

48

shipperPostcode

String

16

O

Postcode

邮编

49

shipperCountry

String

2

O

国家二字代码

Country two character code
50	returnOption		String	100	O

退件选项

return option

Null
Return
Destroy
Forward

51

returnName

String

50

O

M

Return recipient name

退件接收人名称

52

returnAddressLine1

String

200

M地址第一行

	O	First line of address
53	returnAddressLine2		String	200	O	Second line of address

地址第二行

54

returnAddressLine3

String

80

O

地址第三行

Third line of address
55	returnCity		String	80

M

O

City

城市

56

returnState

String

80

O

M

State

省

57

returnPostcode

String

16

O

邮编

Postcode
58	returnCountry		String	2

M国家二字代码items

	O	Country two character code
59	returnPhone		String	50	O	Phone
60	orderItems		List		O

Item信息

Item information
61		itemNo	String	128	M	itemNo

Item编号

62		sku	String	128	M	SKU
63		description	String	60	M

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

English product name If the value is empty, it is set to the description of the order level 1. The keyword of contraband set cannot be included 2. Must be English and French characters or numbers
64		nativeDescription	String	255	O	Chinese name

中文品名


65	hsCode	String	60	O	HS Code
66	originCountry	String	60	M

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

	Country two word code, three word code or name
67		itemCount	Integer		M

件数，>0

number，>0
68		unitValue	Double		M	Unit Price，>0

单价，>0

69

warehouseNo

50

O

截取前50个字符

Intercept the first 50 characters
70		productURL	String	512	O	Product link

产品链接

71

itemWeight

weight

Double

O

Item重量，转换成KG

	Item weight, automaticlly convert g to kg by rounding
72	extendData		List		O

扩展字段

	Extended field, only part is displayed, depends on the service requirements
73		vendorid	String	12	O	vendorid

税号

74

gstexemptionCode

Sting

4

O

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

GST tax exemption code. If the vendorid is correct, the field value is automatically set to "paid"
75		senderTaxId	String	255	O	senderTaxId

发货人税号　InjectPortString256O订单配送港口，针对加拿大服务

76		injectPort	String	255	O	Order delivery port
77		originPort	String	255	O	Order origin port
78		postage	Decimal (12, 2)	255	O	Postage
79		icms	Decimal (12, 2)	255	O	ICMS fee for BR services
80		vat	Decimal (12, 2)		O	VAT amount
81	onlineInsurance
82		insuranceCurrency	String	3	O	Currency of insurance amount
83		insuranceAmount	Double	/	O	Insurance amount
84		beneficiaryType	String	255	O	Type of beneficiary 1=Individual 2=Company
85		organizationCode	String	255	O	If beneficiaryType=1, please fill in the ID card number If benefitaryType=2, please fill in the organization code
86		beneficiary	String	255	O	Beneficiary
87		insure	String	/	O	Whether to insure or not 1 = Yes
88		contactName	String	20	O	Contact name for beneficiary
89	pieces		array[map,...]		O

一票多件包裹信息Parcel Info单个包裹的请求字段结构同上方要求一致

One ticket multiple package information
90		Parcel Info				The request field structure of a single package is consistent with the requirements above

Response Elements
Return results in the order of shipping info in request, including:

1)status

1.1) Succeeded

1.2) Failed

1.3) Partial Success

2)errors

2.1) error code

2.2) error message

3)data

3.1)orderId

3.2) referenceNo

3.3) trackingNo

3.4) 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

4)warnings

4.1) error code

4.2) error message

Request message

代码块

language	js
borderStyle	solid
firstline	1
title	Request
linenumbers	true

[
  {
    "referenceNo": "TESTING1231211",
    "country": "AU",
    "serviceCode": "Service code, provided by logistics provider",
    "serviceOption": "Service option, provided by logistics provider",
    "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",
    "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
  }
]

Multiple items in one ticket

代码块

language	js
borderStyle	solid
firstline	1
title	Request
linenumbers	true

 [
  {
    "referenceNo": "MAC2022041101012",
    "serviceCode": "Service code, provided by logistics provider",
    "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": "Service code, provided by logistics provider",
        "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": "Service code, provided by logistics provider",
        "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": "Service code, provided by logistics provider",
        "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 message

Single ticket

代码块

firstline	1
title	Response
linenumbers	true

{
  "status": "Success",
  "errors": null,
  "data": [
    {
      "status": "Success",
      "errors": null,
      "warnings": null,
      "orderId": "",
      "referenceNo": "",
      "trackingNo": "",
      "refNo1": "",
      "connoteId": null,
      "piecesResult": null,
      "extraProperty": {},
      "relabelStatus": 1
      "lastMileCarrier":
    }
  ],
  "warnings": null
}

Multiple items in one ticket

代码块

language	java
firstline	1
title	Response
linenumbers	true

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

Float_table_content

页面树结构

版本比较

旧版本 3

新版本当前版本

标识

Description

Path

Request field

Request message

Multiple items in one ticket

Response message

Single ticket

Multiple items in one ticket

页面树结构

页面历史

版本比较

旧版本 3

新版本 当前版本

标识

Description

Path

Request field

Request message

Multiple items in one ticket

Response message

Single ticket

Multiple items in one ticket

新版本当前版本