Skip to main content

District

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 Disctrict​

The Haravan API lets you do the following with the Disctrict resource.

Properties​

code : string

"code": "HC466"

The standard abbreviation for the state or district.

district_id : number

"province_id":  50

The unique numeric identifier for the district.

id : number

"id": 466

The unique numeric identifier for the state or district.

name : string

"name": "Quận 1"

The full name of the state or district.

Endpoints​

Retrieves all district for a province​

GET
https://apis.haravan.com/com/provinces/{province_id}/districts.json

Retrieves all district for a province.

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

{
    "districts": [
        {
            "id": 466,
            "name": "Quận 1",
            "code": "HC466",
            "province_id": 50
        },
        {
            "id": 467,
            "name": "Quận 2",
            "code": "HC467",
            "province_id": 50
        },
        {
            "id": 468,
            "name": "Quận 3",
            "code": "HC468",
            "province_id": 50
        },
        {
            "id": 469,
            "name": "Quận 4",
            "code": "HC469",
            "province_id": 50
        },
        {
            "id": 470,
            "name": "Quận 5",
            "code": "HC470",
            "province_id": 50
        },
        {
            "id": 471,
            "name": "Quận 6",
            "code": "HC471",
            "province_id": 50
        },
        {
            "id": 472,
            "name": "Quận 7",
            "code": "HC472",
            "province_id": 50
        },
        {
            "id": 473,
            "name": "Quận 8",
            "code": "HC473",
            "province_id": 50
        },
        {
            "id": 474,
            "name": "Quận 9",
            "code": "HC474",
            "province_id": 50
        },
        {
            "id": 475,
            "name": "Quận 10",
            "code": "HC475",
            "province_id": 50
        },
        {
            "id": 476,
            "name": "Quận 11",
            "code": "HC476",
            "province_id": 50
        },
        {
            "id": 477,
            "name": "Quận 12",
            "code": "HC477",
            "province_id": 50
        },
        {
            "id": 478,
            "name": "Quận Gò Vấp",
            "code": "HC478",
            "province_id": 50
        },
        {
            "id": 479,
            "name": "Quận Tân Bình",
            "code": "HC479",
            "province_id": 50
        },
        {
            "id": 480,
            "name": "Quận Bình Thạnh",
            "code": "HC480",
            "province_id": 50
        },
        {
            "id": 481,
            "name": "Quận Phú Nhuận",
            "code": "HC481",
            "province_id": 50
        },
        {
            "id": 482,
            "name": "Quận Thủ Đức",
            "code": "HC482",
            "province_id": 50
        },
        {
            "id": 483,
            "name": "Huyện Củ Chi",
            "code": "HC483",
            "province_id": 50
        },
        {
            "id": 484,
            "name": "Huyện Hóc Môn",
            "code": "HC484",
            "province_id": 50
        },
        {
            "id": 485,
            "name": "Huyện Bình Chánh",
            "code": "HC485",
            "province_id": 50
        },
        {
            "id": 486,
            "name": "Huyện Nhà Bè",
            "code": "HC486",
            "province_id": 50
        },
        {
            "id": 487,
            "name": "Huyện Cần Giờ",
            "code": "HC487",
            "province_id": 50
        },
        {
            "id": 679,
            "name": "Quận Bình Tân",
            "code": "HC679",
            "province_id": 50
        },
        {
            "id": 680,
            "name": "Quận Tân Phú",
            "code": "HC680",
            "province_id": 50
        },
        {
            "id": 2670,
            "name": "Thành phố Thủ Đức",
            "code": "HC2670",
            "province_id": 50
        }
    ]
}