1. Create Shipping Orders

Description

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

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

HTTP Verb	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	volume(>=0.01)
dimensionUnit		String	3	O	Length unit, enumeration value：M, CM Default value：CM
invoiceValue		Double		M	The error between the value of goods (> = 0.01) and sum (itemcount * unitvalue) cannot exceed 0.1
invoiceCurrency		String	3	M	Currency, ISO currency code
pickUp		Boolean	1	O	enumerator values：Y/N Default value：N
authorityToLeave		Boolean
lockerService		Boolean
batteryType		String	64	O	Battery type, enumeration values： No Battery Lithium Ion Polymer Lithium Ion Alloy Default value：No Battery
batteryPacking		String	64	O	Battery packaging，enumerator values： No Battery Inside Equipment Packaged with Equipment Battery Only Other Default value：No Battery
dangerousGoods		Boolean		O	Default value：false
sku		String	128	O	The picking list is usually displayed on the face list
serviceOption		String	60	O
instruction		String	255	O	Dispatch instruction
facility		String	20	O	Delivery outlets, provided by logistics providers
platform		String	20	O	Platform code
recipientName		String	50	M	Recipient name Limit English / French characters / non pure numbers Automatic removal of special characters
recipientTaxId		String	100	O	Recipient tax number
recipientCompany		String	50	O	Recipient company name
phone		String	20	O	Telephone
email		String	50	O	mailbox
addressLine1		String	200	M	First line of address Limit English / French characters / non pure numbers Automatic removal of special characters
addressLine2		String	200	O	Second line of address
addressLine3		String	80	O	Third line of address
city		String	80	M	城市
state		String	80	M	省 Limit English / French characters / non pure numbers Automatic removal of special characters
postcode		String	16	O	Zip code
country		String	2	M	Country two character code
shipperName		String	50	M	shipperr name Limit English / French characters / non pure numbers Automatic removal of special characters
shipperPhone		String	20	O	Phone
shipperAddressLine1		String	200	O	First line of address
shipperAddressLine2		String	200	O	Second line of address
shipperAddressLine3		String	80	O	Third line of address
shipperCity		String	80	O	City
shipperState		String	80	O	State
shipperPostcode		String	16	O	Postcode
shipperCountry		String	2	O	Country two character code
returnOption		String	100	O	return option
returnName		String	50	M	Return recipient name
returnAddressLine1		String	200	M	First line of address
returnAddressLine2		String	200	O	Second line of address
returnAddressLine3		String	80	O	Third line of address
returnCity		String	80	M	City
returnState		String	80	M	State
returnPostcode		String	16	O	Postcode
returnCountry		String	2	M	Country two character code
returnPhone		String	50	O	Phone
items		List		O	Item information
	itemNo	String	128	M	itemNo
	sku	String	128	M	SKU
	description	String	60	M	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
	nativeDescription	String	255	O	Chinese name
	hsCode	String	60	O	HS Code
	originCountry	String	60	M	Country two word code, three word code or name
	itemCount	Integer		M	number，>0
	unitValue	Double		M	Unit Price，>0
	warehouseNo		50	O	Intercept the first 50 characters
	productURL	String	512	O	Product link
	weight	Double		O	Item weight, converted to KG
extendData		List		O	Extended field
	vendorid	String	12	O	vendorid
	gstexemptionCode	Sting	4	O	GST tax exemption code. If the vendorid is correct, the field value is automatically set to "paid"
	senderTaxId	String	255	O	senderTaxId
	InjectPort	String	256	O	Order delivery port for Canadian service
pieces		array[map,...]		O	One ticket multiple package information
	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
Copyright© 2014 -2020 WallTech Limited. All rights reserved
9eTower Shipper API
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) error code
4.2) error message

Request message

Single ticket creation

Request

[
  {
    "referenceNo": "reedzhang1231211",
    "country": "AU",
    "serviceCode": "UBI.AU2AU.AUPOST.1",
    "serviceOption": "Expedited",
    "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",
    "vendorid": "111",
    "abnnumber": "",
    "gstexemptioncode": "PAID",
    "extendData": {
      "injectPort": null
    },
    "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