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

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	Length unit, enumeration value：M, CM Default value：CM
17	invoiceValue			Double		M	The error between the value of goods (> = 0.01) and sum (itemcount * unitvalue) cannot exceed 0.1
18	invoiceCurrency			String	3	M	Currency, ISO currency code
19	pickUp			Boolean	1	O	enumerator values：Y/N Default value：N
20	authorityToLeave			Boolean
21	lockerService			Boolean
22	batteryType			String	64	O	Battery type, enumeration values： No Battery Lithium Ion Polymer Lithium Ion Alloy Default value：No Battery
23	batteryPacking			String	64	O	Battery packaging，enumerator values： No Battery Inside Equipment Packaged with Equipment Battery Only Other Default value：No Battery
24	dangerousGoods			Boolean		O	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	Return recipient name
52	returnAddressLine1			String	200	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	O	City
56	returnState			String	80	O	State
57	returnPostcode			String	16	O	Postcode
58	returnCountry			String	2	O	Country two character code
59	returnPhone			String	50	O	Phone
60	orderItems			List		O	Item information
61		itemNo		String	128	M	itemNo
62		sku		String	128	M	SKU
63		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
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	number，>0
68		unitValue		Double		M	Unit Price，>0
69		warehouseNo			50	O	Intercept the first 50 characters
70		productURL		String	512	O	Product link
71		weight		Double		O	Item weight, automaticlly convert g to kg by rounding
72		extendData		List			Item extend information
73			itemExportInvoiceValue	Double	255	O	item Export Invoice Value
74			itemExportInvoiceCurrency	String	255	O	item Export Invoice Currency
75	extendData			List		O	Extended field, only part is displayed, depends on the service requirements
76		vendorid		String	12	O	vendorid
77		gstexemptionCode		Sting	4	O	GST tax exemption code. If the vendorid is correct, the field value is automatically set to "paid"
78		senderTaxId		String	255	O	senderTaxId
79		injectPort		String	255	O	Order delivery port
80		originPort		String	255	O	Order origin port
81		postage		Decimal (12, 2)	255	O	Postage
82		icms		Decimal (12, 2)	255	O	ICMS fee for BR services
83		vat		Decimal (12, 2)		O	VAT amount
84		coverAmount		Double		O	Cover amount, for additional insurance business related to specific services
85		shipperOrganizationCode		String	255	O	A code system that uniquely identifies enterprises and other organizations and is launched to strengthen the construction of the corporate credit system
86		shipperCompanyName		String	255	O	shipper company name
87		exportInvoiceValue		Double		O	Export Invoice Value
88		exportInvoiceCurrency		String	255	O	Export Invoice Currency
89	onlineInsurance
90		insuranceCurrency		String	3	O	Currency of insurance amount
91		insuranceAmount		Double	/	O	Insurance amount
92		beneficiaryType		String	255	O	Type of beneficiary 1=Individual 2=Company
93		organizationCode		String	255	O	If beneficiaryType=1, please fill in the ID card number If benefitaryType=2, please fill in the organization code
94		beneficiary		String	255	O	Beneficiary
95		insure		String	/	O	Whether to insure or not 1 = Yes
96		contactName		String	20	O	Contact name for beneficiary
97	pieces			array[map,...]		O	One ticket multiple package information
98		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

Request

[
  {
    "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",
		"extendData":{
			"itemExportInvoiceValue": 0.1,
			"itemExportinvoiceCurrency":"USD"
		}
      },
      {
        "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

Request

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

Response

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

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 ×
Description Path Request field Request message Multiple items in one ticket Response message Single ticket Multiple items in one ticket Description Path Request field Request message Multiple items in one ticket Response message Single ticket Multiple items in one ticket

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

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	Length unit, enumeration value：M, CM Default value：CM
17	invoiceValue			Double		M	The error between the value of goods (> = 0.01) and sum (itemcount * unitvalue) cannot exceed 0.1
18	invoiceCurrency			String	3	M	Currency, ISO currency code
19	pickUp			Boolean	1	O	enumerator values：Y/N Default value：N
20	authorityToLeave			Boolean
21	lockerService			Boolean
22	batteryType			String	64	O	Battery type, enumeration values： No Battery Lithium Ion Polymer Lithium Ion Alloy Default value：No Battery
23	batteryPacking			String	64	O	Battery packaging，enumerator values： No Battery Inside Equipment Packaged with Equipment Battery Only Other Default value：No Battery
24	dangerousGoods			Boolean		O	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	Return recipient name
52	returnAddressLine1			String	200	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	O	City
56	returnState			String	80	O	State
57	returnPostcode			String	16	O	Postcode
58	returnCountry			String	2	O	Country two character code
59	returnPhone			String	50	O	Phone
60	orderItems			List		O	Item information
61		itemNo		String	128	M	itemNo
62		sku		String	128	M	SKU
63		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
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	number，>0
68		unitValue		Double		M	Unit Price，>0
69		warehouseNo			50	O	Intercept the first 50 characters
70		productURL		String	512	O	Product link
71		weight		Double		O	Item weight, automaticlly convert g to kg by rounding
72		extendData		Object			Item extend information
73			itemExportInvoiceValue	Double	255	O	item Export Invoice Value
74			itemExportInvoiceCurrency	String	255	O	item Export Invoice Currency
75	extendData			Object		O	Extended field, only part is displayed, depends on the service requirements
76		vendorid		String	12	O	vendorid
77		gstexemptionCode		Sting	4	O	GST tax exemption code. If the vendorid is correct, the field value is automatically set to "paid"
78		senderTaxId		String	255	O	senderTaxId
79		injectPort		String	255	O	Order delivery port
80		originPort		String	255	O	Order origin port
81		postage		Decimal (12, 2)	255	O	Postage
82		icms		Decimal (12, 2)	255	O	ICMS fee for BR services
83		vat		Decimal (12, 2)		O	VAT amount
84		coverAmount		Double		O	Cover amount, for additional insurance business related to specific services
85		shipperOrganizationCode		String	255	O	A code system that uniquely identifies enterprises and other organizations and is launched to strengthen the construction of the corporate credit system
86		shipperCompanyName		String	255	O	shipper company name
87		exportInvoiceValue		Double		O	Export Invoice Value
88		exportInvoiceCurrency		String	255	O	Export Invoice Currency
89	onlineInsurance
90		insuranceCurrency		String	3	O	Currency of insurance amount
91		insuranceAmount		Double	/	O	Insurance amount
92		beneficiaryType		String	255	O	Type of beneficiary 1=Individual 2=Company
93		organizationCode		String	255	O	If beneficiaryType=1, please fill in the ID card number If benefitaryType=2, please fill in the organization code
94		beneficiary		String	255	O	Beneficiary
95		insure		String	/	O	Whether to insure or not 1 = Yes
96		contactName		String	20	O	Contact name for beneficiary
97	pieces			array[map,...]		O	One ticket multiple package information
98		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

Request

[
  {
    "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",
		"extendData":{
			"itemExportInvoiceValue": 0.1,
			"itemExportinvoiceCurrency":"USD"
		}
      },
      {
        "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

Request

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

Response

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

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 ×
Description Path Request field Request message Multiple items in one ticket Response message Single ticket Multiple items in one ticket Description Path Request field Request message Multiple items in one ticket Response message Single ticket Multiple items in one ticket

页面树结构

1. Create Shipping Orders

Description

Path

Request field

Request message

Multiple items in one ticket

Response message

Single ticket

Multiple items in one ticket

Description

Path

Request field

Request message

Multiple items in one ticket

Response message

Single ticket

Multiple items in one ticket