GET /2025-07/cloud/order
Method: GET
URL:
Sandbox URL:
Description: Return orders on ZhenHub.
Parameters required to be sent
| Parameter | Description | Type |
|---|---|---|
page | Current page number. | Integer |
size | Amount of data per page. | Integer |
Submit a "GET" request to above endpoint
Result object contains:
| Parameter | Description | Type |
|---|---|---|
id | Order ID. | Long |
shipping_address | Shipping address. | Object, Required |
first_name | First name. The maximum length is 64. | String, Required |
last_name | Last name. The maximum length is 64. | String, Required |
email | Email. The maximum length is 128. | String, Required, must have @ |
phone | Phone number. The maximum length is 32. | String, Required |
address1 | Address. The maximum length is 256. | String, Required |
address2 | Address 2. The maximum length is 256. | String |
zip_code | Zip code. The maximum length is 15. | String, Required |
district | District. The maximum length is 60. | String, Required |
city | City. The maximum length is 60. | String, Required |
province | Province. The maximum length is 60. | String, Required |
country | Country. The maximum length is 60. | String |
country_code | Country code, eg.CN, US. The maximum length is 2. | String, Required |
billing_address | Billing address. If “billing_address” is not filled, “shipping_address” is used by default. | Object |
first_name | First name. The maximum length is 64. | String, Required |
last_name | Last name. The maximum length is 64. | String, Required |
email | Email. The maximum length is 128. | String, Required, must have @ |
phone | Phone number. The maximum length is 32. | String, Required |
address1 | Address. The maximum length is 256. | String, Required |
address2 | Address 2. The maximum length is 256. | String |
zip_code | Zip code. The maximum length is 15. | String, Required |
district | District. The maximum length is 60. | String, Required |
city | City. The maximum length is 60. | String, Required |
province | Province. The maximum length is 60. | String, Required |
country | Country. The maximum length is 60. | String |
country_code | Country code, eg.CN, US. The maximum length is 2. | String, Required |
reference | Reference of the order. The maximum length is 47. | String |
currency | Currency of the order, default value is “USD”. The maximum length is 3. | String |
totals_include_tax | Indicates whether the total amount includes tax. If true, tax is included; otherwise, it's excluded. Default: false. | Boolean |
issue_date | Issue date. | Date Time |
status | Status: OnHold, Draft, Approved, Processing, Fulfilled, Completed, Cancelled. The maximum length is 31. | String |
shipping_cost | Shipping cost of the order. The maximum total digits 12, with 2 decimal places. | Number |
sku_items | Array containing product SKU details. | Array, Required |
sku_number | SKU No. of the product. The maximum length is 128. | String, Required |
quantity | Quantity of the product. | Integer, Required |
price | Price of the product. The maximum total digits 12, with 2 decimal places. | Number, Required |
discount | Discount of the product. The maximum total digits 12, with 2 decimal places. | Number |
tax | Tax of the product, 5%==>0.05. The maximum total digits 12, with 2 decimal places. | Number |
created_time | Created time. | Date Time |
service | Service | Object |
service_code | Service code. The maximum length is 63. | String |
inco_term | Incoterm. The maximum length is 8. | String |
warehouse_code | Warehouse code. The maximum length is 32. | String |
Response
json
{
"code": 200,
"message": "Successful!",
"data": {
"page": 1,
"size": 10,
"total": 563,
"list": [
{
"id": 465923620988248064,
"shipping_address": {
"first_name": "Arthur",
"last_name": "Chen",
"email": "arthur@zhenhub.com",
"phone": "+852 3152xxxx",
"address1": "7 Cassia Rd, Yau Yat Chuen, Hong Kong",
"address2": "department 1201010",
"zip_code": "1008",
"district": "22224",
"city": "Kowloon",
"province": "Kowloon",
"country_code": "HK"
},
"billing_address": {
"first_name": "Arthur",
"last_name": "Chen",
"email": "arthur@zhenhub.com",
"phone": "+852 3152xxxx",
"address1": "7 Cassia Rd, Yau Yat Chuen, Hong Kong",
"address2": "department 1201010",
"zip_code": "1008",
"district": "22224",
"city": "Kowloon",
"province": "Kowloon",
"country_code": "HK"
},
"reference": "427883",
"currency": "USD",
"totals_include_tax": false,
"issue_date": "2025-07-09T16:54+08:00",
"status": "Processing",
"shipping_cost": 0.0,
"service": null,
"sku_items": [
{
"sku_number": "BuZhiDe_001",
"quantity": 1,
"price": 1.66,
"discount": 0.0,
"tax": null
}
],
"created_time": "2025-07-09T08:54:07.692663Z"
}
]
}
}