页面历史

Description

Create shipping orders.

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

...

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

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

serviceOptionString60O　

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

M

O	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

M

O	State
57	returnPostcode	String	16	O	Postcode
58	returnCountry	String	2

M

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

items

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,

converted to KG

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 tax exemption code. If the vendorid is correct, the field value is automatically set to "paid"
75		senderTaxId	String	255	O	senderTaxId
76		injectPort	String	255	O	Order delivery port

for Canadian service


77		originPort	String	255	O	Order origin port

piecesarray[map,...]

78

postage

Decimal (12, 2)

255

O

One ticket multiple package informationParcel InfoThe request field structure of a single package is consistent with the requirements above

...

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	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
  }
]

...

代码块

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
}

...

代码块

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
}

false

Float_table_content
Hidable

页面树结构

版本比较

旧版本 29

新版本当前版本

标识

Description

Request field

Request message

页面树结构

页面历史

版本比较

旧版本 29

新版本 当前版本

标识

Description

Request field

Request message

新版本当前版本