Skip to main content

Ward

Version: 1.0

Shop owners can specify which country or countries they will ship to and these countries are made available through the API using the country resource. Shop owners can do this by navigating to the "Preferences" tab under "Regions & Taxes." If any of those countries have states or provinces, those states or provinces are also registered as shipping destinations, each of which can have its own state or provincial sales tax.

States and provinces are represented by the province resource. We use the term "province" to cover both.

Authenticated access scopes: com.read_shop

What you can do with Ward​

Properties​

code : string

"code": "26734"

The standard abbreviation for the state or ward.

district_id : number

"country_id":  241

The unique numeric identifier for the district.

id : number

"id": 26734

The unique numeric identifier for the state or ward.

name : string

"name": "Phường Tân Định"

The full name of the state or ward.

Endpoints​

Retrieves all wards for a district​

GET
https://apis.haravan.com/com/districts/{district_id}/wards.json

Retrieves all wards for a district.

  • GET https://apis.haravan.com/com/districts/466/wards.json
Details
HTTP/1.1 200 OK

{
    "wards": [
        {
            "id": 26734,
            "name": "Phường Tân Định",
            "code": "26734",
            "district_id": 466
        },
        {
            "id": 26737,
            "name": "Phường Đa Kao",
            "code": "26737",
            "district_id": 466
        },
        {
            "id": 26740,
            "name": "Phường Bến Nghé",
            "code": "26740",
            "district_id": 466
        },
        {
            "id": 26743,
            "name": "Phường Bến Thành",
            "code": "26743",
            "district_id": 466
        },
        {
            "id": 26746,
            "name": "Phường Nguyễn Thái Bình",
            "code": "26746",
            "district_id": 466
        },
        {
            "id": 26749,
            "name": "Phường Phạm Ngũ Lão",
            "code": "26749",
            "district_id": 466
        },
        {
            "id": 26752,
            "name": "Phường Cầu Ông Lãnh",
            "code": "26752",
            "district_id": 466
        },
        {
            "id": 26755,
            "name": "Phường Cô Giang",
            "code": "26755",
            "district_id": 466
        },
        {
            "id": 26758,
            "name": "Phường Nguyễn Cư Trinh",
            "code": "26758",
            "district_id": 466
        },
        {
            "id": 26761,
            "name": "Phường Cầu Kho",
            "code": "26761",
            "district_id": 466
        }
    ]
}