get
https://{subdomain}.myshoplaza.com/openapi/2025-06/areas/country//province
The Province List API allows developers to fetch a comprehensive list of provinces within a specified country using its unique identifier. This endpoint supports retrieving specific fields based on the user’s request.
No Access Control.
This API retrieves a list of provinces or states for a specified country. The list of provinces is based on the provided country code and can be used for administrative purposes or region-specific operations.
Path Parameters
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
country | string | Yes | code of the country. |
Response Description
Public Response Fields
Success Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | "success" | Status code of the response |
message | string | Descriptive message of the response | |
data.provinces.cn_name | string | 北京 | The Chinese name of province |
data.provinces.code | string | BJ | The code of provinces |
data.provinces.country_code2 | string | CN | The country_code2 of provinces |
data.provinces.name | string | Beijing | The name of provinces |
data.provinces.old_code | string | Peking | The old_code of provinces |
data.provinces.province_id | integer | 1 | The province_id of provinces |
Error Detail
| Field | Type | Example | Description |
|---|---|---|---|
code | string | InvalidParameter | Error http message |
message | string | `` | Error message |