- Summary :
Express Order can be easily created through this function
|
# |
Item |
Description |
|
1 |
Request URL |
/api/itxp/xporder_api |
|
2 |
Request Method |
POST |
|
3 |
Request Data Format |
JSON |
|
4 |
Request Data Encoding |
UTF-8 |
|
5 |
Complete URL Example |
http://track.jancoecommerce.com/ecom/api/itxp/xporder_api |
|
# |
Node with Example |
Explanation & Remark |
Max Length |
|
1 |
{ |
|
|
|
2 |
“Auth”: { |
|
|
|
3 |
“user_code”: “your user_code”, |
API username |
|
|
4 |
“password”: “your password” |
API password |
|
|
5 |
}, |
|
|
|
6 |
“Request”: { |
|
|
|
7 |
“RequestID”: “ABCHK_20170321_0001”, |
Request ID. |
60 |
|
8 |
“RequestDate”: “2017-03-21T17:03:47.0Z” |
Request time. |
|
|
9 |
}, |
|
|
|
10 |
“Orders”: { |
|
|
|
11 |
“Order”: [ |
Can upload multiple orders simultaneously. |
|
|
12 |
{ |
|
|
|
13 |
“Header”: { |
Express order info: |
|
|
14 |
“RequestSeq”: “1”, |
1 for 1st order, 2 for the 2nd, etc. |
|
|
15 |
“SenderDepartment”: “IT”, |
Sender department (optional) |
30 |
|
16 |
“SenderUser”: “GARY”, |
Sender |
20 |
|
17 |
“TransactionType”: “NEW”, |
Only accept NEW at the moment. |
|
|
18 |
“OrderStatus”: “CONFIRM”, |
DRAFT or CONFIRM |
|
|
19 |
“DocOrParcel”: “P”, |
D(document) or P(parcel) |
|
|
20 |
“OrderReferenceNumber”: “REF12345”, |
Sender’s reference number (optional) |
30 |
|
21 |
“ShipperAddress”: { |
Shipper info: |
|
|
22 |
“CompanyName”: “ABC (HK) LIMITED”, |
Name |
60 |
|
23 |
“Address1”: “RM 4, 3/F, DEF INDUSTRIAL BUILDING”, |
Address 1 |
60 |
|
24 |
“Address2”: “21 GHI ROAD”, |
Address 2 (optional) |
60 |
|
25 |
“ContactPerson”: “GARY”, |
Contact person |
60 |
|
26 |
“Tel”: “23456789”, |
Telephone |
30 |
|
27 |
“Email”: “gary@abc.com.hk”, |
Email (optional) |
120 |
|
28 |
“CountryISOCode”: “HK”, |
Country(ISO) |
2 |
|
29 |
“State”: “NA”, |
State or province |
30 |
|
30 |
“City”: “HONG KONG”, |
City |
19 |
|
31 |
“Postal”: “NA” |
Postal code |
9 |
|
32 |
}, |
|
|
|
33 |
“ConsigneeAddress”: { |
Consignee info: |
|
|
34 |
“CompanyName”: “KUSTO MA”, |
Name |
60 |
|
35 |
“Address1”: “5A FEDABC STREET”, |
Address 1 |
60 |
|
36 |
“Address2”: “”, |
Address 2 (optional) |
60 |
|
37 |
“ContactPerson”: “KUSTO MA”, |
Contact person |
60 |
|
38 |
“ContactPersonIDType”: “ID”, |
ID or PASSPORT (optional) |
|
|
39 |
“ContactPersonID”: “15263748”, |
Contact person ID (optional) |
20 |
|
40 |
“Tel”: “24681357”, |
Telephone |
30 |
|
41 |
“Email”: “kusto.ma@gmail.com.hk”, |
Email (optional) |
120 |
|
42 |
“Area”: “”, |
Area (optional) |
30 |
|
43 |
“CountryISOCode”: “AU”, |
Country(ISO) |
2 |
|
44 |
“State”: “SA”, |
State or province |
30 |
|
45 |
“City”: “KLEMZIG”, |
City |
19 |
|
46 |
“Postal”: “5087” |
Postal code |
9 |
|
47 |
}, |
|
|
|
48 |
“BillFreightTo”: “Shipper”, |
Shipper or Consignee, the party paying freight |
|
|
49 |
“BillDutyTo”: “Consignee”, |
Shipper or Consignee, the party paying duty |
|
|
50 |
“ReadyToPickupDate”: “2017-03-21T17:03:47.0Z”, |
Pickup time |
|
|
51 |
“ShipmentInstruction”: “” |
Special instructions or requests (optional) |
255 |
|
52 |
}, |
|
|
|
53 |
“Packages”: { |
Package info |
|
|
54 |
“Package”: [ |
Package(multiple) |
|
|
55 |
{ |
|
|
|
56 |
“LineNumber”: “1”, |
1 for 1st package, 2 for the 2nd, etc. |
|
|
57 |
“Quantity”: “1”, |
Quantity |
|
|
58 |
“KGS”: “2”, |
Weight |
|
|
59 |
“Length”: “3”, |
Length (optional) |
|
|
60 |
“Width”: “4”, |
Width (optional) |
|
|
61 |
“Height”: “5”, |
Height (optional) |
|
|
62 |
“Currency”: “USD”, |
Currency |
3 |
|
63 |
“ItemDetails”: { |
Inner package info of the package: |
|
|
64 |
“ItemDetail”: [ |
|
|
|
65 |
{ |
|
|
|
66 |
“LineNumber”: “1”, |
1 for 1st inner package, 2 for the 2nd, etc. |
|
|
67 |
“CargoID”: “PROD0001”, |
Product ID (optional) |
20 |
|
68 |
“PONO”: “PONO001”, |
PO number (optional) |
30 |
|
69 |
“ItemName”: “AFK48”, |
Product name |
50 |
|
70 |
“CargoDescp”: “CD”, |
Product description |
255 |
|
71 |
“Quantity”: “3”, |
Inner quantity |
|
|
72 |
“KGS”: “1”, |
Inner weight (optional) |
|
|
73 |
“DeclareValue”: “8”, |
Declared value |
|
|
74 |
“Brand”: “”, |
Brand (optional) |
50 |
|
75 |
“Specification”: “”, |
Specification (optional) |
255 |
|
76 |
“HSCode”: “HS001”, |
HS CODE (optional) |
12 |
|
77 |
“Origin”: “CHINA”, |
Origin (optional) |
30 |
|
78 |
“TaxNo”: “TAXNO001”, |
Tax Number (optional) |
20 |
|
79 |
“TaxRate”: “6.8” |
Tax Rate (optional) |
|
|
80 |
}, |
|
|
|
81 |
{ |
|
|
|
82 |
“LineNumber”: “2”, |
|
|
|
83 |
“CargoID”: “PROD0002”, |
|
|
|
84 |
“PONO”: “PONO001”, |
|
|
|
85 |
“ItemName”: “Henry Potter”, |
|
|
|
86 |
“CargoDescp”: “Blu-ray DVD”, |
|
|
|
87 |
“Quantity”: “2”, |
|
|
|
88 |
“KGS”: “1”, |
|
|
|
89 |
“DeclareValue”: “9”, |
|
|
|
90 |
“Brand”: “”, |
|
|
|
91 |
“Specification”: “”, |
|
|
|
92 |
“HSCode”: “HS001”, |
|
|
|
93 |
“Origin”: “CHINA”, |
|
|
|
94 |
“TaxNo”: “TAXNO001”, |
|
|
|
95 |
“TaxRate”: “6.8” |
|
|
|
96 |
} |
|
|
|
97 |
] |
|
|
|
98 |
} |
|
|
|
99 |
}, |
|
|
|
100 |
{ |
|
|
|
101 |
“LineNumber”: “2”, |
|
|
|
102 |
“Quantity”: “2”, |
|
|
|
103 |
“KGS”: “3”, |
|
|
|
104 |
“Length”: “4”, |
|
|
|
105 |
“Width”: “5”, |
|
|
|
106 |
“Height”: “6”, |
|
|
|
107 |
“Currency”: “USD”, |
|
|
|
108 |
“ItemDetails”: { |
|
|
|
109 |
“ItemDetail”: [ |
|
|
|
110 |
{ |
|
|
|
111 |
“LineNumber”: “1”, |
|
|
|
112 |
“CargoID”: “PROD0003”, |
|
|
|
113 |
“PONO”: “PONO002”, |
|
|
|
114 |
“ItemName”: “Manga”, |
|
|
|
115 |
“CargoDescp”: “Book”, |
|
|
|
116 |
“Quantity”: “2”, |
|
|
|
117 |
“KGS”: “1”, |
|
|
|
118 |
“DeclareValue”: “8”, |
|
|
|
119 |
“Brand”: “”, |
|
|
|
120 |
“Specification”: “”, |
|
|
|
121 |
“HSCode”: “HS002”, |
|
|
|
122 |
“Origin”: “CHINA”, |
|
|
|
123 |
“TaxNo”: “TAXNO001”, |
|
|
|
124 |
“TaxRate”: “6.8” |
|
|
|
125 |
}, |
|
|
|
126 |
{ |
|
|
|
127 |
“LineNumber”: “2”, |
|
|
|
128 |
“CargoID”: “PROD0004”, |
|
|
|
129 |
“PONO”: “PONO002”, |
|
|
|
130 |
“ItemName”: “Magazine”, |
|
|
|
131 |
“CargoDescp”: “Book”, |
|
|
|
132 |
“Quantity”: “1”, |
|
|
|
133 |
“KGS”: “1”, |
|
|
|
134 |
“DeclareValue”: “7”, |
|
|
|
135 |
“Brand”: “”, |
|
|
|
136 |
“Specification”: “”, |
|
|
|
137 |
“HSCode”: “HS002”, |
|
|
|
138 |
“Origin”: “CHINA”, |
|
|
|
139 |
“TaxNo”: “TAXNO001”, |
|
|
|
140 |
“TaxRate”: “6.8” |
|
|
|
141 |
} |
|
|
|
142 |
] |
|
|
|
143 |
} |
|
|
|
144 |
} |
|
|
|
145 |
] |
|
|
|
146 |
} |
|
|
|
147 |
} |
|
|
|
148 |
] |
|
|
|
149 |
} |
|
|
|
150 |
} |
|
|

|
# |
Node with Example |
Explanation & Remark |
Max Length |
|
1 |
{ |
|
|
|
2 |
“RequestID”: “ABCHK_20170321_0001”, |
The same RequestID as the corresponding request’s |
|
|
3 |
“ResponseDate”: “2017-03-21T17:03:47.8901944+08:00”, |
Response time |
|
|
4 |
“ResponseStatus”: “SUCCESS”, |
Response status SUCCESS or FAIL |
|
|
5 |
“ResponseMessage”: “”, |
FAIL reason |
Unlimited |
|
6 |
“Orders”: { |
|
|
|
7 |
“Order”: [ |
|
|
|
8 |
{ |
|
|
|
9 |
“RequestSeq”: 1, |
The same RequestSeq as the corresponding request’s |
|
|
10 |
“OrderStatus”: “SUCCESS”, |
Order status SUCCESS or FAIL |
|
|
11 |
“OrderMessage”: “”, |
Order FAIL reason |
Unlimited |
|
12 |
“TrackingNumber”: “JE0AU17030132”, |
Order number |
20 |
|
13 |
“TrackingUniqueID”: “HTH03000394”, |
Order unique ID |
12 |
|
14 |
“PDFBASE64”: “JVBERi0xL (omitted) jU9GCg==” |
Returned BASE64 string of PDF |
Unlimited |
|
15 |
} |
|
|
|
16 |
] |
|
|
|
17 |
} |
|
|
|
18 |
} |
|
|

When creating multiple orders simultaneously, all orders fail to be created if any order fails.