# Get Province (New)

> List provinces/cities under the 2-level administrative model.

> **NOTE**
> **New 2-level address model.** The new APIs return the catalogue after Vietnam's 01/07/2025 administrative merger (provinces merged, district tier removed). The returned `name` is exactly what you pass as `to_province_name` in [Create Order](https://developer.ghn.dev/en/docs/order/create.md) with `is_new_to_address: true`. The legacy district-based catalogue remains at [Get Province](https://developer.ghn.dev/en/docs/master-data/get-province.md).

## Endpoint

| Environment | 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 | Required | Description |
| --- | --- | --- |
| `Token` | Yes | Your token (issued by GHN) — [get a token](https://developer.ghn.dev/en/docs/token/get-token.md) |
| `ShopId` | Yes | Shop ID (integer) |

## Parameters

- **offset** (Int): Pagination start position. Default: `0`
- **limit** (Int): Max items, at most `200`. Omit or `0` to fetch all — there are currently 34 provinces, so one call is enough

## Request Example

```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

### Success (HTTP 200)

_Captured from a real Staging call (trimmed to one of 34 provinces, internal audit fields removed)._

```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
    }
  ]
}
```

### Response Fields

| Field | Type | Description |
| --- | --- | --- |
| `data[]._id` | Int | 2-level-model province ID — pass as `province_id` to [Get Ward (New)](https://developer.ghn.dev/en/docs/master-data/get-ward-new.md) |
| `data[].name` | String | Canonical province name — use verbatim as `to_province_name` in [Create Order](https://developer.ghn.dev/en/docs/order/create.md) (new model) |
| `data[].extension_names` | String[] | Name variants (unaccented, abbreviated, prefixed…) — useful for matching or suggesting as the user types |
| `data[].type` | String | Always `province` |
| `data[].parent_id` | Int | Country ID (`1` for Vietnam) |
| `data[].status` | Int | `1` if active, `2` if disabled, `10` if deleted |

## Error Codes

| Condition | HTTP | Meaning |
| --- | --- | --- |
| `Authorization header is required!` | 401 | Missing `Token` |
| `limit tối đa chỉ được 200` | 400 | `limit` exceeds 200 |
| IP not allowed | 401 | Your account has an IP whitelist and the request came from another IP |
| `SERVER_ERROR_COMMON` | 500 | System error |