NAV

getProvinces

GET /v2/location/provinces

Whenever you create or update a customer’s main or billing address, you have to use province or state IDs supplied by SimplePin. Use this endpoint to retrieve the list of all provinces supported by SimplePin for a specific country.

Parameters
Name
Description
locale string (required)

This field is used to retrieve the provinces, countries and names of users. It returns a customer profile based on his/her specific language settings. So if we create a customer and set his/her settings to French, then SimplePin’s parameters will also be in French.

countryId ref (required)

Please set the country ID in order to return the list of provinces and states associated with the specific country.

Response Messages
Code
Description
200
OK
401
Unauthorized
403
Forbidden
404
Not Found
             [
    {
        "currency_code": "string",
        "id": 0,
        "name": "string"
    }
]
             
          
{ } LocationModel
currency_code (optional) string
id (optional) integer
name (optional) string
             <location_models>
  <location_model>
    <currency_code>string</currency_code>
    <id>0</id>
    <name>string</name>
  </location_model>
</location_models>

             
          
{ } LocationModel
currency_code (optional) string
id (optional) integer
name (optional) string