Base URL
https://{tenant}.logzi.com/api/locales/
Every request returns a JSON response. On success result.code == 1, on failure result.code == 0. The locales API manages the postal code and locality name database used to fill in address data for partners and delivery destinations.
/api/locales/get
Retrieve a single locale record.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int | Record identifier | |
zip | string | Postal code for filtering | |
country_id | int | Country identifier for filtering |
Example request
GET /api/locales/get?zip=1011&country_id=1
X-API-KEY: {your_api_key}/api/locales/list
Retrieve the list of locale records.
No parameters required.
Example request
GET /api/locales/list
X-API-KEY: {your_api_key}/api/locales/save
Create or update a locale record.
POST fields — data object
The data object should contain the postal code record's details (postal code, locality name, country identifier).
Example request
POST /api/locales/save
X-API-KEY: {your_api_key}
Content-Type: application/json
{ "data": { "id": 1 } }/api/locales/delete
Delete a locale record.
POST fields — data object
The data object should contain the details of the record to delete.
Example request
POST /api/locales/delete
X-API-KEY: {your_api_key}
Content-Type: application/json
{ "data": { "id": 1 } }Create your account now,
pay later!
