API ReferenceRatesGet rate quotes

Get rate quotes

POST/api/v1/rates

Quotes are entitlement-scoped: options come from the Service Codes your account can book — resolved from BOTH entitlement tracks (Product Code entitlements and assigned rate cards) — and each option carries the pricing-model v2 metadata (product_code, service_options, is_standard_service). Zoned destinations (currently AU) price by postal-code zone: supply destination_postal_code, or zoned options come back available=false with unavailable_reason. Opt-in surcharges (e.g. SIGNATURE, INSURANCE) can be passed in selected_surcharges; per-option eligibility is returned in opt_in_availability and surcharges that could not be applied are listed in surcharge_conflicts. EU destinations include an ioss_notice block showing the VAT-prepay picture without IOSS — IOSS itself is applied at shipment create (ioss_number / account default), so using_ioss is always false here. Engine rejections return 400 INVALID_FIELD whose message is the engine's actual reason; data.field classifies it — rate_card (entitlement / pricing setup; also the fallback), declared_value_hkd (destination declared-value cap), parcels (size over carrier limit) — and data.errors lists every reason.

Parameters

cod

booleanbody

declared_value_hkd

numberbody

destination_country*

stringbody

destination_postal_code

stringbody

Destination postal code. Required for accurate zoned pricing (AU Z1/Z2/Z3) — without it, zoned options return available=false with a reason.

goods_category*

stringbody

selected_surcharges

array<string>body

weight_kg*

numberbody

Responses

Success body

{
  "status": 200,
  "message": "OK",
  "data": {
    "data": [
      {
        "service_tier_id": "HKASTDGGSTCM",
        "name": {
          "en": "香港發貨公開價標準服務",
          "zh": "香港發貨公開價標準服務"
        },
        "eta_days_min": 8,
        "eta_days_max": 12,
        "free_pickup": true,
        "supports_cod": false,
        "freight_hkd": 58.5,
        "reg_fee_hkd": 36,
        "surcharges": [
          {
            "code": "FUEL",
            "name_zh": "燃油附加費",
            "amount_hkd": 4.7,
            "is_estimate": false,
            "basis": "8% × 運費"
          }
        ],
        "total_hkd": 99.2,
        "rate_table_code": "RT-HKASTDGGSTCM-US-v1",
        "rate_table_version": 1,
        "zone": null,
        "product_code": "HKASTD",
        "is_standard_service": true,
        "service_options": [
          {
            "layer_key": "cargo_type",
            "option_code": "GG",
            "label_zh": "普貨（帶電）",
            "is_vas": false
          },
          {
            "layer_key": "air_service",
            "option_code": "ST",
            "label_zh": "標準",
            "is_vas": false
          },
          {
            "layer_key": "tail_service",
            "option_code": "CM",
            "label_zh": "綜合",
            "is_vas": false
          }
        ],
        "available": true,
        "unavailable_reason": null,
        "opt_in_availability": [
          {
            "code": "SIGNATURE",
            "selectable": false,
            "reason": "此路線承運商不支援簽名簽收"
          },
          {
            "code": "INSURANCE",
            "selectable": true,
            "reason": null
          }
        ],
        "surcharge_conflicts": [],
        "carrier": {
          "code": "yunexpress",
          "product_code": "HKTHZXR",
          "dispatch_mode": "B2C"
        }
      }
    ],
    "available_opt_in_surcharges": [
      {
        "code": "SIGNATURE",
        "name_zh": "簽名簽收",
        "description": "Signature on delivery"
      },
      {
        "code": "INSURANCE",
        "name_zh": "保價",
        "description": "0.7% × (申報 + 運費), min HKD 9"
      }
    ],
    "ioss_notice": null
  }
}

Returned object

Field	Type	Sample
status	number	200
message	string	OK
data	object	{3 keys}