{"info":{"_postman_id":"529e470d-9185-484d-8e88-f15b7e643911","name":"ZenLocator API (beta)","description":"

API Status

\n

Status for the API can be found at https://status.zenlocator.com

\n

Getting Started

\n

ZenLocator API exposes the ZenLocator infrastructure via a standardized programmatic interface. Using ZenLocator's API, you have programmatic access to your data, while using your programming language of choice.

\n

The API is in beta status and endpoints are added often. If you'd like to see support for something but don't see it in the documentation yet, please reach out to us so we can add it.

\n

Not all ZenLocator accounts have REST API support. To check whether your API access is turned on, login to your dashboard at https://app.zenlocator.com and navigate to App > API. If you do not see that page, please upgrade your app to a Business plan to use the API.

\n

On App > API page you will find ids used throughout the documentation:

\n

{{account}} - your account id (eg: \"act_abcdefgh\")

\n

{{app}} - your app id (eg: \"app_abcdefgh\")

\n

Client-side API

\n

Are you looking for a JavaScript API to access and control your widgets on your own website? There's a different documentation for that.

\n

Need help?

\n

The ZenLocator engineers are always around answering questions. To reach out please use your dashboard to send us a message and we'll be happy to take a look!

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"6886719","collectionId":"529e470d-9185-484d-8e88-f15b7e643911","publishedId":"S17wPSGy","public":true,"customColor":{"top-bar":"FFF","right-sidebar":"303030","highlight":"4095D8"},"publishDate":"2019-03-31T17:31:18.000Z"},"item":[{"name":"Locations","item":[{"name":"list locations","id":"0f8f81fe-4911-46bf-99a9-5e84aa8ba43b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.zenlocator.com/v1/apps/{{app}}/locations/search","description":"

List locations for the app.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
KeyRequiredValue
pageoptionalPage number
countoptionalNumber of results to return per page
\n
","urlObject":{"protocol":"https","path":["v1","apps","{{app}}","locations","search"],"host":["api","zenlocator","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"0f8f81fe-4911-46bf-99a9-5e84aa8ba43b"},{"name":"search by query","id":"36ebc750-d268-4044-8be3-7b83018b570e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.zenlocator.com/v1/apps/{{app}}/locations/search","description":"

Search for locations by geographical area.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
KeyRequiredValue
queryrequiredGeographical area to search (city, state, region, postal code, country)
radiusoptionalRadius of the area from the center (in meters)
countryCodeoptionalSuggested country code to use for geocoding query (alpha-2 code)
productsoptionalA comma-separated list of product ids to filter by (eg: \"prd_abc,prd_xyz\")
filtersoptionalA comma-separated list of filter ids to filter by (eg: \"flt_abc,flt_xyz\")
retailersoptionalA comma-separated list of retailer ids to filter by (eg: \"rtl_abc,rtl_xyz\")
\n
","urlObject":{"protocol":"https","path":["v1","apps","{{app}}","locations","search"],"host":["api","zenlocator","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"36ebc750-d268-4044-8be3-7b83018b570e"},{"name":"search by coordinates","id":"0e31458b-eeb8-466f-8479-89a02524e6aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.zenlocator.com/v1/apps/{{app}}/locations/search","description":"

Search for locations from specific coordinates.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
KeyRequiredValue
latrequiredLatitude
lngrequiredLongitude
radiusrequiredRadius of the area from coordinates (in meters)
countryCodeoptionalSuggested country code to use for geocoding query (alpha-2 code)
productsoptionalA comma-separated list of product ids to filter by (eg: \"prd_abc,prd_xyz\")
filtersoptionalA comma-separated list of filter ids to filter by (eg: \"flt_abc,flt_xyz\")
retailersoptionalA comma-separated list of retailer ids to filter by (eg: \"rtl_abc,rtl_xyz\")
\n
","urlObject":{"protocol":"https","path":["v1","apps","{{app}}","locations","search"],"host":["api","zenlocator","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"0e31458b-eeb8-466f-8479-89a02524e6aa"},{"name":"search by bounds","id":"b8d8a310-0b61-4825-8fda-e436cd46b9b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.zenlocator.com/v1/apps/{{app}}/locations/search","description":"

Search for locations gives specific bounds.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
KeyRequiredValue
southwestrequiredSouthwest coordinates in format \"lat,lng\" (eg: \"32,-180\")
northeastrequiredNortheast coordinates in format \"lat,lng\" (eg: \"38,-100\")
productsoptionalA comma-separated list of product ids to filter by (eg: \"prd_abc,prd_xyz\")
filtersoptionalA comma-separated list of filter ids to filter by (eg: \"flt_abc,flt_xyz\")
retailersoptionalA comma-separated list of retailer ids to filter by (eg: \"rtl_abc,rtl_xyz\")
\n
","urlObject":{"protocol":"https","path":["v1","apps","{{app}}","locations","search"],"host":["api","zenlocator","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b8d8a310-0b61-4825-8fda-e436cd46b9b7"}],"id":"acb8d075-6a2c-44eb-be87-ab3a26fe91ef","_postman_id":"acb8d075-6a2c-44eb-be87-ab3a26fe91ef","description":""}],"event":[{"listen":"prerequest","script":{"id":"8fa2e253-75c9-413c-9b92-b2173ce1404a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a0ea41bf-bca6-4adb-89cf-cf8f5fb65b47","type":"text/javascript","exec":[""]}}]}