PATCH /2026-05/cloud/label/{id} ​

Method: PATCH

URL:

Sandbox URL:

Description: Replaces a label's shipment details with a complete request snapshot.

Parameters ​

id is the current label ID. The request body uses the same fields, required-field rules, formats, and length limits as the Create Shipping Label API.

This is a full replacement request. Send every required create field, including complete service, shipper_address, shipping_address, and items values. Omitted optional fields are cleared rather than retained from the previous label.

Body ​

json
{
  "shipping_address": {
    "address1": "18 Harbour Road",
    "address2": "Unit 1201",
    "zip_code": "000000",
    "district": "Wan Chai",
    "city": "Hong Kong",
    "province": "Hong Kong",
    "province_code": "HK",
    "country": "Hong Kong SAR China",
    "country_code": "HK",
    "email": "recipient@example.com",
    "first_name": "Alex",
    "last_name": "Chan",
    "company_name": "Example Company",
    "phone": "+852 31520000"
  },
  "shipper_address": {
    "address1": "3 Hoi Shing Road",
    "address2": "TML Tower",
    "zip_code": "000000",
    "district": "Tsuen Wan",
    "city": "New Territories",
    "province": "Hong Kong",
    "province_code": "NT",
    "country": "Hong Kong SAR China",
    "country_code": "HK",
    "email": "shipper@example.com",
    "first_name": "Arthur",
    "last_name": "Chen",
    "company_name": "Example Shipper",
    "phone": "+852 31521111"
  },
  "reference": "#Z00001-UPDATED",
  "currency": "USD",
  "weight_unit": "kg",
  "length": 20,
  "width": 15,
  "height": 10,
  "length_unit": "cm",
  "expect_pickup_time": "2026-09-11T10:00:00+08:00",
  "service": {
    "service_code": "DHL",
    "inco_term": "DAP"
  },
  "items": [
    {
      "product_name": "iPhone 15",
      "quantity": 1,
      "weight": 1,
      "unit_price": 6800,
      "declared_unit_value": 6800,
      "tax": 0,
      "sku_code": "IPHONE15-BLK-128",
      "brand": "Apple",
      "unit": "pcs",
      "hs_code": "",
      "customs_description": "Mobile phone",
      "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 public Label ID remains unchanged. A successful update does not return a data object:

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

Notes ​

  • A label cannot be modified after the shipment has been scanned by the warehouse. The API returns 409 Conflict.
  • The Label ID is stable. Continue using the original id for print, tracking, cancellation, later updates, and Manifest requests.
  • If shipment details have already been submitted to a carrier, ZhenHub handles the required carrier cancellation and recreation internally. Internal shipment identifiers and revisions are not part of this API response.
  • The label must belong to the authenticated company and API environment; otherwise the API returns 404 Not Found.