post
https://{subdomain}.myshoplaza.com/openapi/2025-06/areas/country//province
The Create Province API allows developers to create a new province within a specified country. This endpoint requires the province data in the request body.
The Create Province API allows developers to create a new province within a specified country. This endpoint requires the province data in the request body.
Request Parameters
Public Request Parameters
Path Parameters
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
country | string | Yes | Unique identifier for the province |
Body Parameters
| Field | Type | Required | Example | Description |
|---|---|---|---|---|
country | string | No | "Canada" | The country name |
provinces | array[Province] | No | List of provinces in the country | |
provinces.name | string | No | "Ontario" | Name of the province |
provinces.cities | array[City] | No | List of cities in the province | |
cities.name | string | No | "Toronto" | Name of the city |
cities.addresses | array[Address] | No | List of addresses in the city | |
addresses.name | string | No | "Head Office" | Name/label for the address |
addresses.address | array[string] | No | ["123 Main St", "Suite 500"] | Address lines (multiple lines possible) |
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 |
Error Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | InvalidParameter | Error http message |
message | string | `` | Error message |