# Lấy Tỉnh/Thành (Mới)

> Lấy danh sách tỉnh/thành theo mô hình hành chính 2 cấp.

> **NOTE**
> **Mô hình địa chỉ 2 cấp (mới).** Bộ API mới trả danh mục sau đợt sắp xếp hành chính 01/07/2025 (sáp nhập tỉnh, bỏ cấp quận/huyện). `name` trả về là giá trị truyền thẳng vào `to_province_name` khi [Tạo đơn](https://developer.ghn.vn/vi/docs/order/create.md) với `is_new_to_address: true`. Danh mục theo quận/huyện cũ vẫn ở [Lấy Tỉnh/Thành](https://developer.ghn.vn/vi/docs/master-data/get-province.md).

## Endpoint

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

**Method**: `GET`

## Headers

| Header | Bắt buộc | Mô tả |
| --- | --- | --- |
| `Token` | Có | Token của bạn (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ố

- **offset** (Int): Vị trí bắt đầu khi phân trang. Mặc định: `0`
- **limit** (Int): Số phần tử tối đa, không quá `200`. Bỏ trống hoặc `0` để lấy tất cả — hiện có 34 tỉnh/thành nên một lần gọi là đủ

## Ví dụ Request

```bash
curl -X GET "https://dev-online-gateway.ghn.vn/shiip/public-api/v3/master-data/province/all?offset=0&limit=200" \
  -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 trong 34 tỉnh/thành, bỏ các trường quản trị nội bộ)._

```json
{
  "code": 200,
  "message": "Success",
  "data": [
    {
      "_id": 1000001,
      "name": "Hồ Chí Minh",
      "extension_names": [
        "hồ chí minh",
        "tp.hồ chí minh",
        "thành phố hồ chí minh",
        "hcm",
        "ho chi minh"
      ],
      "type": "province",
      "parent_id": 1,
      "status": 1
    }
  ]
}
```

### Các trường Response

| Trường | Kiểu | Mô tả |
| --- | --- | --- |
| `data[]._id` | Int | Mã tỉnh/thành hệ 2 cấp — truyền vào `province_id` của [Lấy Phường/Xã (Mới)](https://developer.ghn.vn/vi/docs/master-data/get-ward-new.md) |
| `data[].name` | String | Tên chuẩn của tỉnh/thành — dùng nguyên văn cho `to_province_name` khi [Tạo đơn](https://developer.ghn.vn/vi/docs/order/create.md) hệ mới |
| `data[].extension_names` | String[] | Các biến thể tên (không dấu, viết tắt, có tiền tố…) — dùng để so khớp hoặc gợi ý khi người dùng gõ tự do |
| `data[].type` | String | Luôn là `province` |
| `data[].parent_id` | Int | Mã quốc gia (Việt Nam là `1`) |
| `data[].status` | Int | Là `1` nếu đang hoạt động, là `2` nếu ngưng sử dụng, là `10` nếu đã xoá |

## Bảng mã lỗi

| Điều kiện | HTTP | Ý nghĩa |
| --- | --- | --- |
| `Authorization header is required!` | 401 | Thiếu `Token` |
| `limit tối đa chỉ được 200` | 400 | `limit` vượt quá 200 |
| 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 |