# Địa chỉ

> Base URL: `https://pos.pages.fm/api/v1`. Xác thực bằng tham số truy vấn `api_key`.

## Danh sách tỉnh thành phố

`GET /geo/provinces`

Lấy danh sách tỉnh thành phố

### Tham số

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `country_code` | query | string | yes | Mã quốc gia (ví dụ mã quốc gia Viet Nam là 84) |
| `is_new` | query | boolean |  | Tỉnh thành mới (với quốc gia Viet Nam) |
| `all` | query | boolean |  | Tỉnh thành gồm cả cũ và mới (với quốc gia Viet Nam) |

### Phản hồi

- `200` Success (object)

```json
{
  "data": [
    {
      "id": "101",
      "name": "Hà Nội",
      "name_en": "ha noi",
      "new_id": "84_VN101"
    },
    {
      "id": "701",
      "name": "Hồ Chí Minh",
      "name_en": "ho chi minh",
      "new_id": "84_VN129"
    }
  ]
}
```

## Danh sách quận huyện

`GET /geo/districts`

Lấy danh sách quận huyện

### Tham số

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `province_id` | query | string | yes | Mã tỉnh thành phố của các quận huyện bạn muốn lấy. Lấy mã tỉnh thành phố trong api GET /geo/provinces |

### Phản hồi

- `200` Success (object)

```json
{
  "data": [
    {
      "id": "10101",
      "name": "Quận Ba Đình",
      "name_en": "ba dinh",
      "province_id": "101"
    }
  ]
}
```

## Danh sách phường xã

`GET /geo/communes`

Lấy danh sách phường xã

### Tham số

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `district_id` | query | string | yes | Mã quận huyện của các phường xã bạn muốn lấy. Lấy mã quận huyện trong api GET /geo/districts |
| `province_id` | query | string | yes | Mã tỉnh thành phố của các phường xã bạn muốn lấy. Lấy mã tỉnh thành phố trong api GET /geo/provinces |

### Phản hồi

- `200` Success (object)

```json
{
  "data": [
    {
      "district_id": "10101",
      "id": "1010115",
      "name": "Phường Cống Vị",
      "name_en": "cong vi",
      "new_id": null,
      "postcode": null,
      "province_id": "101"
    }
  ]
}
```