/api/geocode1

Address check / geocoding with results from cache and providers

Parameters

(string) ZIP and city (e.g. '04103 Leipzig')
(string) street name including house number
(string) country as ISO code (default from shop config)
(string) lat,lng for reverse geocoding (alternative to zipcity/streetnr)
(int) set to 1 for public (unauthenticated) access
(String) optionally define the response-format for this call. One of: compact (default) | compacts | full | fulls | json | md | html | js | openapi | yaml
(int) optionally force the API to check against the role (instead of silently not returning data). For guests or public access, the default is -1. 0 (regular customer) and above define the role for which the current session is expected to be authorized.

Response Types

GeoCodeResult

GeoCodeResult (v1) docs

Result of a geocode/address check operation

Fields (5)
#FieldTypeDescription
0actionstringthe action that was performed
1resultstringthe exit/result code of the action
2statusstringgeocode status: OK, NONE, PERROR, AUTHERROR, DISABLED, CACHED
3parameterstringname of the failing parameter (only on PERROR)
4countintnumber of address results

Data (1 record)

actionresultstatusparametercount
AddressCheckAUTHERRORAUTHERROR0