Get Wards for a City

GET

/reference/cities/{cityCode}/wards

Retrieve the list of wards/communes for a specific Vietnamese province/city. Only applicable when the selected country is Vietnam (code = VN).

Scope Required: properties:read

Path Parameters:

• city_code (required): Province TMSCode from /reference/cities (e.g., 101 for Hà Nội)

Use Cases:

• Populate the ward select dropdown after user selects a province
• Validate ward before submitting guest address data

Important Notes:

• Vietnam wards only — use this endpoint only when country = VN
• Results are sorted alphabetically by name
• DB stores the ward name (not the code) in the ward field
• Results are cached permanently (static data)

Authorizations

• http

Parameters

Path Parameters

cityCode

required

string

Responses

200

object

success

required

boolean

data

required

Array<object>

object

code

required

string

name

required

string