PUT /2025-07/cloud/calculate/order

Method: PUT

URL:

Sandbox URL:

Description: Calculate Order.

Parameters required to be sent

Parameter	Description	Type
dest_address	Dest address.	Object, Required
country_code	Dest country code, eg.CN, US. The maximum length is 2.	String, Required
city	Dest city. The maximum length is 60.	String
zip_code	Zip code. The maximum length is 15.	String
origin_addresses	Origin addresses.	Object, Required
warehouse_code	Warehouse code. The maximum length is 32.	String, Required
country_code	Origin country code, eg.CN, US. The maximum length is 2.	String, Required
city	Origin city. The maximum length is 60.	String
zip_code	Zip code. The maximum length is 15.	String
weight	Weight. The maximum total digits 12, with 2 decimal places.	Number, Required
weight_unit	Weight UOM: kg, lb. The maximum length is 8.	String, Required
alcohol	Contains battery: Yes, No, Not Applicable.	String, If not filled in, the default is "Not Applicable".
battery	Contains battery: Yes, No, Not Applicable.	String, If not filled in, the default is "Not Applicable".
liquid	Contains battery: Yes, No, Not Applicable.	String, If not filled in, the default is "Not Applicable".
declared_value	Declared value. The maximum total digits 12, with 2 decimal places.	Number
currency	Declared value currency. The maximum length is 3.	String
dimension	Dimension	Object
length	Length. The maximum total digits 12, with 2 decimal places.	Number
width	Width. The maximum total digits 12, with 2 decimal places.	Number
height	Height. The maximum total digits 12, with 2 decimal places.	Number
uom	UOM: m, cm, mm, in, ft. The maximum length is 8.	String

Result object contains

Parameter	Description	Type
code	Status code.	Integer
message	Message. The maximum length is 255.	String
error_code	Custom code. The maximum length is 255.	String
inco_term	Incoterm: DAP, DDP. The maximum length is 8.	String
fulfillment	Fulfillment cost. The maximum total digits 12, with 2 decimal places.	Number
packaging	Packaging cost. The maximum total digits 12, with 2 decimal places.	Number
pick_pack	Pick pack cost. The maximum total digits 12, with 2 decimal places.	Number
gift_card	Gift card cost. The maximum total digits 12, with 2 decimal places.	Number
shipping	Shipping cost. The maximum total digits 12, with 2 decimal places.	Number
total_shipping	Total shipping cost. The maximum total digits 12, with 2 decimal places.	Number
total_tax	Total tax. The maximum total digits 12, with 2 decimal places.	Number
fuel_surcharge	Fuel surcharge. The maximum total digits 12, with 2 decimal places.	Number
remote_area_surcharge	Remote area surcharge. The maximum total digits 12, with 2 decimal places.	Number
service_name	Service name. The maximum length is 64.	String
service_code	Service code. The maximum length is 64.	String
service_zone	Service zone. The maximum length is 8.	String
service_id	Service ID.	Long
service_zone_id	Service zone ID.	Long
platform	Platform. The maximum length is 32.	String
amount	Amount. The maximum total digits 12, with 2 decimal places.	Number
currency	Currency. The maximum length is 3.	String
vat	VAT. The maximum total digits 12, with 2 decimal places.	Number
duty	Duty. The maximum total digits 12, with 2 decimal places.	Number
ddp_handling	DDP handling. The maximum total digits 12, with 2 decimal places.	Number
tax_currency	Tax currency. The maximum length is 3.	String
charge_weight_unit	Carrier charge weight UOM. The maximum length is 8.	String
charge_weight	Carrier charge weight. The maximum total digits 12, with 2 decimal places.	Number
original_weight_unit	Original weight UOM. The maximum length is 3.	String
original_weight	Original weight. The maximum total digits 12, with 2 decimal places.	Number
timeliness	Delivery time. The maximum length is 16.	String
carrier	Carrier. The maximum length is 32.	String
warehouse_code	Warehouse code. The maximum length is 32.	String

Body

{
  "dest_address": {
    "country_code": "HK",
    "city": "New Territories",
    "zip_code": "518000"
  },
  "weight": 10,
  "weight_unit": "kg",
  "dimension": {
    "length": 1,
    "width": 20,
    "height": 3,
    "uom": "cm"
  },
  "battery": "Not Applicable",
  "liquid": "Not Applicable",
  "alcohol": "Not Applicable",
  "declared_value": 1.22,
  "currency": "USD",
  "origin_addresses": [
    {
      "warehouse_code": "12450",
      "country_code": "US",
      "city": "",
      "zip_code": "85021"
    }
  ]
}

Response

Response payload

Payload return an error with the description and data = empty. If the request is successful, the data contains an object with the result.

{
  "code": 200,
  "message": "Successful!",
  "data": [
    {
      "code": 1,
      "message": "Successful!",
      "error_code": null,
      "inco_term": "DDP",
      "fulfillment": 0.00,
      "packaging": 0,
      "pick_pack": 0.00,
      "gift_card": 0,
      "shipping": 12.00,
      "total_shipping": 15.23,
      "total_tax": 0,
      "fuel_surcharge": 0.00,
      "remote_area_surcharge": 0,
      "service_name": "ZHSGCN(DDP)",
      "service_code": "ZHSGCN",
      "service_zone": "Zone3",
      "service_id": 5240496153493504,
      "service_zone_id": 7011828935278592,
      "platform": "zhenhub",
      "amount": 15.23,
      "currency": "USD",
      "vat": 0,
      "duty": 0,
      "ddp_handling": 3.23,
      "tax_currency": "USD",
      "charge_weight_unit": "lb",
      "charge_weight": 30.00,
      "original_weight_unit": "kg",
      "original_weight": 10,
      "timeliness": "4-6",
      "carrier": "hong-kong-post",
      "warehouse_code": "12450"
    }
  ]
}