# Lấy Tỉnh/Thành

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

> **NOTE**
> **Mô hình địa chỉ cũ.** API này dùng mô hình địa chỉ theo quận/huyện của GHN (trước đợt sắp xếp hành chính 01/07/2025). Với tích hợp mới, nên dùng địa chỉ theo tên trong [Tạo đơn](https://developer.ghn.vn/vi/docs/order/create.md) (`to_province_name` + `is_new_to_address`) và hỏi GHN về bộ API địa chỉ v3 mới hơn.

## Endpoint

| Môi trường | URL |
| --- | --- |
| Production | `https://online-gateway.ghn.vn/shiip/public-api/master-data/province` |
| Staging | `https://dev-online-gateway.ghn.vn/shiip/public-api/master-data/province` |

**Method**: `GET`

## Headers

| Header | Bắt buộc | Mô tả |
| --- | --- | --- |
| `Token` | Có | Token của shop (do GHN cấp) — [lấy token](https://developer.ghn.vn/vi/docs/token/get-token.md) |
| `ShopId` | Có | Shop ID (số nguyên) |

## Tham số

API này **không nhận tham số** — luôn trả về toàn bộ danh sách tỉnh/thành.

## Ví dụ Request

```bash
curl -X GET https://dev-online-gateway.ghn.vn/shiip/public-api/master-data/province \
  -H "Token: 5c1d8a9e-2f4b-11ed-..." \
  -H "ShopId: 92837"
```

## Response

### Thành công (HTTP 200)

_Lấy từ một lần gọi thật trên môi trường Staging (rút gọn còn một tỉnh, các trường thường dùng)._

```json
{
  "code": 200,
  "message": "Success",
  "data": [
    {
      "ProvinceID": 202,
      "ProvinceName": "Hồ Chí Minh",
      "CanUpdateCOD": false
    }
  ]
}
```

### Các trường Response

`data` là một mảng object tỉnh/thành.

| Trường | Kiểu | Mô tả |
| --- | --- | --- |
| `ProvinceID` | Int | Mã tỉnh — truyền sang [Lấy Quận/Huyện](https://developer.ghn.vn/vi/docs/master-data/get-district.md) |
| `ProvinceName` | String | Tên tỉnh / thành phố |
| `CanUpdateCOD` | Bool | Đơn ở tỉnh này có được phép cập nhật COD hay không |

## Bảng mã lỗi

| Điều kiện | HTTP | Ý nghĩa |
| --- | --- | --- |
| `Authorization header is required!` | 401 | Thiếu `Token` |
| IP không được phép | 401 | Tài khoản của bạn có whitelist IP và request đến từ IP khác |
| `SERVER_ERROR_COMMON` | 500 | Lỗi hệ thống |
