Skip to content

POST /2026-05/cloud/label

Method: POST

URL:

Sandbox URL:

Description: Creates a shipping label for a shipment on ZhenHub.

Parameters required to be sent

ParameterDescriptionType
shipping_addressConsignee (receiver) address.Object, Required
  first_nameFirst name. Maximum length: 64.String, Required
  last_nameLast name. Maximum length: 64.String, Required
  company_nameCompany name. Maximum length: 128.String
  phonePhone number. Maximum length: 32.String, Required
  emailEmail address. Maximum length: 128.String
  address1Address line 1. Maximum length: 256.String, Required
  address2Address line 2. Maximum length: 256.String
  districtDistrict. Maximum length: 64.String
  cityCity. Maximum length: 64.String, Required
  provinceState / Province. Maximum length: 64.String
  province_codeProvince code. Maximum length: 32.String
  zip_codePostal / ZIP code. Maximum length: 16.String
  countryFull country or region name (e.g. United States, China, Hong Kong SAR China).String, Required
  country_codeISO 2-letter country code (e.g. CN, US, HK).String, Required
shipper_addressSender (shipper) address.Object, Required
  first_nameFirst name. Maximum length: 64.String, Required
  last_nameLast name. Maximum length: 64.String, Required
  company_nameCompany name. Maximum length: 128.String
  phonePhone number. Maximum length: 32.String, Required
  emailEmail address. Maximum length: 128.String
  address1Address line 1. Maximum length: 256.String, Required
  address2Address line 2. Maximum length: 256.String
  districtDistrict. Maximum length: 64.String
  cityCity. Maximum length: 64.String, Required
  provinceState / Province. Maximum length: 64.String
  province_codeProvince code. Maximum length: 32.String
  zip_codePostal / ZIP code. Maximum length: 16.String
  countryFull country or region name (e.g. United States, China, Hong Kong SAR China).String, Required
  country_codeISO 2-letter country code (e.g. CN, US, HK).String, Required
referenceMerchant order reference number. Maximum length: 64.String, Required
currencyISO 4217 currency code (e.g. USD, EUR, GBP).String, Required
weight_unitWeight unit. Supported values: kg, g, lb, oz.String, Required
lengthPackage length. The measurement unit is determined by length_unit.Number
widthPackage width. The measurement unit is determined by length_unit.Number
heightPackage height. The measurement unit is determined by length_unit.Number
length_unitDimension unit. Supported values: m, cm, mm, ft, in.String
expect_pickup_timeExpected carrier pickup time in ISO 8601 format.String
serviceShipping service selected from the carrier service query response.Object, Required
  service_codeCarrier service code selected from the service query response. Maximum length: 32.String, Required
  inco_termIncoterm (e.g. DAP, DDP). Maximum length: 16.String
itemsList of items included in the shipment.Array, Required
  product_nameProduct name. Maximum length: 100.String, Required
  quantityQuantity of the product.Integer, Required
  weightWeight per unit. The measurement unit is determined by weight_unit.Number, Required
  lengthItem length. The measurement unit is determined by length_unit.Number
  widthItem width. The measurement unit is determined by length_unit.Number
  heightItem height. The measurement unit is determined by length_unit.Number
  unit_priceSelling price per unit.Number, Required
  declared_unit_valueDeclared customs value per unit used for customs clearance and duty assessment.Number
  taxTotal tax amount for this item line.Number
  sku_codeSKU code. Maximum length: 128.String
  brandBrand name. Maximum length: 64.String
  unitUnit of measure (e.g. pcs). Maximum length: 16.String
  hs_codeHS code. Maximum length: 32.String
  customs_descriptionCustoms declaration description. Maximum length: 512.String
  origin_country_codeISO 3166-1 alpha-2 country code of the item's country of origin (e.g. US, CN, HK).String
package_attributesPackage attributes.Object
  contains_alcoholIndicates whether the package contains alcohol. This may affect carrier availability and shipping restrictions.Boolean
  contains_liquidIndicates whether the package contains liquids. This may affect carrier availability and shipping restrictions.Boolean
  contains_batteryIndicates whether the package contains batteries. This may affect carrier availability and shipping restrictions.Boolean
  contains_dangerous_goodsIndicates whether the package contains dangerous goods. This may affect carrier availability and shipping restrictions.Boolean
  contains_prohibited_itemsIndicates whether the package contains prohibited items. This may affect carrier availability and shipping restrictions.Boolean
  weightTotal package weight. Unit is the same as weight_unit in the request body.Number
metadataAdditional metadata.Object
  platform_order_noMarketplace order number.String
  platformMarketplace or sales channel name.String

Body

json
{
  "shipping_address": {
    "address1": "3 Hoi Shing Rd, TML Tower",
    "address2": "",
    "zip_code": "000000",
    "district": "Tsuen Wan",
    "city": "New Territories",
    "province": "Hong Kong",
    "province_code": "NT",
    "country": "Hong Kong SAR China",
    "country_code": "HK",
    "email": "arthur@zhenhub.com",
    "first_name": "Arthur",
    "last_name": "Chen",
    "company_name": "",
    "phone": "+852 3152xxxx"
  },
  "shipper_address": {
    "address1": "3 Hoi Shing Rd, TML Tower",
    "address2": "",
    "zip_code": "000000",
    "district": "Tsuen Wan",
    "city": "New Territories",
    "province": "Hong Kong",
    "province_code": "NT",
    "country": "Hong Kong SAR China",
    "country_code": "HK",
    "email": "arthur@zhenhub.com",
    "first_name": "Arthur",
    "last_name": "Chen",
    "company_name": "",
    "phone": "+852 3152xxxx"
  },
  "reference": "#Z00001",
  "currency": "USD",
  "weight_unit": "kg",
  "length": null,
  "width": null,
  "height": null,
  "length_unit": "cm",
  "expect_pickup_time": "2026-06-01T10:00:00+08:00",
  "service": {
    "service_code": "DHL",
    "inco_term": "DAP"
  },
  "items": [
    {
      "product_name": "iPhone 15",
      "quantity": 1,
      "weight": 1,
      "length": null,
      "width": null,
      "height": null,
      "unit_price": 6800,
      "declared_unit_value": 6800,
      "tax": 0,
      "sku_code": "IPHONE15-BLK-128",
      "brand": "Apple",
      "unit": "pcs",
      "hs_code": "",
      "customs_description": "",
      "origin_country_code": "HK"
    }
  ],
  "package_attributes": {
    "contains_alcohol": false,
    "contains_liquid": false,
    "contains_battery": true,
    "contains_dangerous_goods": false,
    "contains_prohibited_items": false,
    "weight": 1.25
  },
  "metadata": {
    "platform_order_no": "SHOPEE20260530192101",
    "platform": "Shopee"
  }
}

Response

The response body contains the generated label ID.

json
{
  "code": 200,
  "message": "OK – The request was successful.",
  "data": 8050996080689152
}

If the request fails, the data field will be null or omitted, and the error details will be returned in message.

Notes

  • The returned data value is the generated label ID.
  • The label ID is required for retrieving printable label content and shipment tracking information.
  • shipper_address is the sender information.
  • shipping_address is the recipient information.
  • At least one item must be included in items.
  • country_code must follow the ISO 3166-1 alpha-2 standard.
  • expect_pickup_time must be provided in ISO 8601 format.
  • The declared value and weight of each item may be used for customs clearance and freight calculation.