API für Gebietsstrukturen

Verwaltung von Postleitzahlen und Gebietsdaten

Basis-URL

https://{tenant}.logzi.com/api/locales/

Jede Anfrage liefert eine JSON-Antwort zurück. Bei Erfolg ist result.code == 1, bei einem Fehler result.code == 0. Die API für Gebietsstrukturen dient der Verwaltung der Postleitzahlen- und Ortsnamendatenbank, die zur Adressvervollständigung bei Partnern und Lieferzielen benötigt wird.

GET /api/locales/get

Abrufen eines einzelnen Gebietsdatensatzes.

Query-Parameter

ParameterTypErforderlichBeschreibung
idintKennung des Datensatzes
zipstringPostleitzahl zur Filterung
country_idintKennung des Landes zur Filterung

Beispielanfrage

GET /api/locales/get?zip=1011&country_id=1
X-API-KEY: {ihr_api_schluessel}
GET /api/locales/list

Abrufen der Liste der Gebietsdatensätze.

Kein Parameter erforderlich.

Beispielanfrage

GET /api/locales/list
X-API-KEY: {ihr_api_schluessel}
POST /api/locales/save

Anlegen oder Ändern eines Gebietsdatensatzes.

POST-Felder — Objekt data

Im Objekt data sind die Daten des Postleitzahl-Datensatzes anzugeben (Postleitzahl, Ortsname, Länderkennung).

Beispielanfrage

POST /api/locales/save
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json

{ "data": { "id": 1 } }
POST /api/locales/delete

Löschen eines Gebietsdatensatzes.

POST-Felder — Objekt data

Im Objekt data sind die Daten des zu löschenden Datensatzes anzugeben.

Beispielanfrage

POST /api/locales/delete
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json

{ "data": { "id": 1 } }

Nimm Kontakt mit uns auf

Interessierst du dich für unsere Software? Schreib uns einfach!

Brauchst du Hilfe?

Wenn du keine Antwort findest und Unterstützung brauchst

Jetzt registrieren,
später bezahlen!

Teste es 3 Tage kostenlos, ohne Risiko und Verpflichtungen!