openapi: 3.1.0
info:
title: Woosmap Platform API Reference
description: |
The Woosmap API is a RESTful API built on HTTP. It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. You can use your favorite HTTP/REST library for your programming language to use Woosmap's API, or you can use one of our Javascript SDKs for supported APIs:
- [Map JS](https://developers.woosmap.com/products/map-api/get-started/) - support All APIs
- [Localities JS](https://developers.woosmap.com/products/localities/localities-jsapi/get-started/) - for Localities API
- [MultiSearch JS](https://developers.woosmap.com/products/multisearch-lib/js/get-started/) - for Localities API and Stores API
You can use Postman to test the API (if you use the `PUBLIC_API_KEY` authentication, don't forget to set the `Referer` Header corresponding to one of your restricted domain name).
[](https://god.gw.postman.com/run-collection/18437534-dad12f37-6d84-42d1-9889-2f529aee0ab9?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D18437534-dad12f37-6d84-42d1-9889-2f529aee0ab9%26entityType%3Dcollection%26workspaceId%3Dff0698d5-c4db-403e-b7c6-b622b68032d3)
termsOfService: https://www.woosmap.com/en/policies/terms/
x-document-meta-data:
copyright: © 2025 Woosmap
version: 1.46.4
contact:
name: Woosmap API
servers:
- url: https://api.woosmap.com
security:
- PublicApiKeyAuth: []
RefererHeader: []
- PrivateApiKeyAuth: []
- PrivateApiKeyHeaderAuth: []
tags:
- name: Search
description: |
Store Search lets you query the Assets which are returned as a [GeoJson](https://geojson.org/). Request is done over HTTPS using GET. You must specify a key in your request, included as the value of a `key` parameter for your public key or `private_key` for your private key. This key identifies your application for purposes of quota management. Learn how to [get a key](https://developers.woosmap.com/api-reference/authentication/). If your request returns a high number of assets, the result will be paginated. If so, you can request assets by page using `page` and `stores_by_page` parameters (Default is **100**, max is **300**).
externalDocs:
url: https://developers.woosmap.com/products/stores-api/overview/
- name: Data Management
description: |
Manage the store and asset data within your Woosmap project. It provides full CRUD (Create, Read, Update, Delete) operations through standard HTTP methods, supporting batch imports up to 15MB, along with an atomic replace operation for swapping entire datasets without downtime.
This endpoint handles the complete lifecycle of your location data. You can add new assets in batch using POST, update existing assets with PUT, retrieve assets as GeoJSON with GET, remove individual or all assets with DELETE, and atomically replace your entire dataset using the replace operation. All write operations accept JSON payloads containing an array of store objects, each with a unique storeId, name, and geographic coordinates.
``` POST|GET|PUT|DELETE https://api.woosmap.com/stores ```
externalDocs:
url: https://developers.woosmap.com/products/stores-api/overview/
- name: Zones
description: |
The Zones Endpoint lets you associate geographic polygons (zones) with your stores and then search for stores whose zone contains a specific point. Unlike distance-based search, which relies on straight-line proximity, zone-based search accounts for real-world boundaries like delivery areas, service regions, or franchise territories.
Zone management provides a full set of CRUD operations: import zones in bulk, update existing zones, list all zones in your project, retrieve or delete individual zones by ID, and remove all zones at once. Each zone links a polygon (defined in WKT format) to a specific store via store_id and zone_id.
Once zones are imported, you can search for stores by adding `zone=true` to your Search request. The API returns stores whose zone polygon intersects the queried location rather than the nearest stores by distance.
``` https://api.woosmap.com/zones ```
externalDocs:
url: https://developers.woosmap.com/products/stores-api/overview/
- name: Geolocation API
description: |
Geolocation API returns a location (or nearby stores) and accuracy radius based on an IP address. Request is done over HTTPS using GET. Response is formatted as JSON. You must specify a key in your request, included as the value of a `key` parameter for your public key or `private_key` for your private key. This key identifies your application for purposes of quota management. Learn how to [get a key](https://developers.woosmap.com/api-reference/authentication/).
externalDocs:
url: https://developers.woosmap.com/products/geolocation-api/location/
paths:
/geolocation/position:
get:
summary: Geolocation from an IP address
operationId: getGeolocationPosition
servers:
- url: https://api.woosmap.com
tags:
- Geolocation API
description: |
The `/position` returns JSON location of your users thanks to IP address of their devices.
security:
- PublicApiKeyAuth: []
RefererHeader: []
- PrivateApiKeyAuth: []
- PrivateApiKeyHeaderAuth: []
parameters:
- $ref: '#/components/parameters/ip_address'
responses:
'200':
description: Geolocation successfully retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/GeolocationResponse'
examples:
default:
summary: Geolocation position for the IP `173.79.254.254`
value:
country_code: US
country_name: United States
continent: North America
latitude: 38.719
longitude: -77.1067
viewport:
northeast:
lat: 38.763915764205976
lng: -77.0491321464058
southwest:
lat: 38.674084235794034
lng: -77.16426785359421
accuracy: 5
city: Alexandria
region_state: Virginia
postal_code: '22309'
timezone: America/New_York
raw_offset: -18000
dst_offset: 3600
'401':
description: Unauthorized. Incorrect authentication credentials.
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
examples:
Unauthorized:
summary: Error 401
value:
detail: Incorrect authentication credentials. Please check or use a valid API Key
'403':
description: Forbidden. This Woosmap API is not enabled for this project.
content:
application/json:
schema:
$ref: '#/components/schemas/Error403'
examples:
Forbidden:
summary: Error 403
value:
detail: This Woosmap API is not enabled for this project.
'429':
description: Too Many Requests. The rate limit for this endpoint has been exceeded.
content:
application/json:
schema:
$ref: '#/components/schemas/Error429'
examples:
Forbidden:
summary: Error 429
value:
detail: The rate limit for this endpoint has been exceeded
x-codeSamples:
- lang: curl
label: cURL
source: curl -L 'https://api.woosmap.com/geolocation/position?private_key=YOUR_PRIVATE_API_KEY&ip_address=173.79.254.254'
- lang: javascript
label: JavaScript
source: |-
const requestOptions = {
method: "GET",
redirect: "follow"
};
fetch("https://api.woosmap.com/geolocation/position?private_key=YOUR_PRIVATE_API_KEY&ip_address=173.79.254.254", requestOptions)
.then((response) => response.text())
.then((result) => console.log(result))
.catch((error) => console.error(error));
- lang: python
label: Python
source: |
import requests
url = "https://api.woosmap.com/geolocation/position?private_key=YOUR_PRIVATE_API_KEY&ip_address=173.79.254.254"
payload = {}
headers = {}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
/geolocation/stores:
get:
summary: Assets nearby a Geolocation
operationId: getStoresFromGeolocationPosition
servers:
- url: https://api.woosmap.com
tags:
- Geolocation API
description: |
Retrieve the stores nearby an ip location. Stores are returned only if a relevant ip location is found - for an accuracy of 20km or less.
security:
- PublicApiKeyAuth: []
RefererHeader: []
- PrivateApiKeyAuth: []
- PrivateApiKeyHeaderAuth: []
parameters:
- $ref: '#/components/parameters/ip_address'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/query'
responses:
'200':
description: Geolocation and Stores successufully retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/GeolocationStoresResponse'
examples:
default:
summary: Geolocation Position and Stores for the IP `173.79.254.254`
value:
country_code: US
country_name: United States
continent: North America
latitude: 38.719
longitude: -77.1067
viewport:
northeast:
lat: 38.763915764205976
lng: -77.0491321464058
southwest:
lat: 38.674084235794034
lng: -77.16426785359421
accuracy: 5
city: Alexandria
region_state: Virginia
postal_code: '22309'
timezone: America/New_York
raw_offset: -18000
dst_offset: 3600
stores:
type: FeatureCollection
features:
- type: Feature
properties:
store_id: STORE_ID_123456
name: My Cool Store
contact:
email: contact@woosmap.com
phone: +44 20 7693 4000
website: https://www.woosmap.com
address:
lines:
- Building Centre
- 26 Store Street
country_code: UK
city: London
zipcode: WC1E 7BT
user_properties:
some_user_properties: associated user value
tags:
- wifi
- covered_parking
types:
- drive
- click_and_collect
last_updated: '2025-09-16T08:49:42.523114+00:00'
distance: 0
open:
open_now: true
open_hours:
- end: '22:00'
start: '08:30'
week_day: 2
current_slice:
end: '22:00'
start: '08:30'
weekly_opening:
'1':
hours: []
isSpecial: false
'2':
hours:
- end: '22:00'
start: '08:30'
isSpecial: false
'3':
hours:
- end: '22:00'
start: '08:30'
isSpecial: false
'4':
hours:
- end: '22:00'
start: '08:30'
isSpecial: false
'5':
hours:
- end: '22:00'
start: '08:30'
isSpecial: false
'6':
hours:
- end: '22:00'
start: '08:30'
isSpecial: false
'7':
hours:
- end: '22:00'
start: '08:30'
isSpecial: false
timezone: Europe/London
opening_hours:
usual:
'1': []
default:
- end: '22:00'
start: '08:30'
special:
'2015-02-07':
- end: '23:00'
start: '08:00'
timezone: Europe/London
geometry:
type: Point
coordinates:
- -77.1067
- 38.719
pagination:
page: 1
pageCount: 2
hasNext: true
'401':
description: Unauthorized. Incorrect authentication credentials.
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
examples:
Unauthorized:
summary: Error 401
value:
detail: Incorrect authentication credentials. Please check or use a valid API Key
'403':
description: Forbidden. This Woosmap API is not enabled for this project.
content:
application/json:
schema:
$ref: '#/components/schemas/Error403'
examples:
Forbidden:
summary: Error 403
value:
detail: This Woosmap API is not enabled for this project.
'429':
description: Too Many Requests. The rate limit for this endpoint has been exceeded.
content:
application/json:
schema:
$ref: '#/components/schemas/Error429'
examples:
Forbidden:
summary: Error 429
value:
detail: The rate limit for this endpoint has been exceeded
x-codeSamples:
- lang: curl
label: cURL
source: curl -L 'https://api.woosmap.com/geolocation/stores?private_key=YOUR_PRIVATE_API_KEY&ip_address=173.79.254.254&limit=1'
- lang: javascript
label: JavaScript
source: |-
const requestOptions = {
method: "GET",
redirect: "follow"
};
fetch("https://api.woosmap.com/geolocation/stores?private_key=YOUR_PRIVATE_API_KEY&ip_address=173.79.254.254&limit=1", requestOptions)
.then((response) => response.text())
.then((result) => console.log(result))
.catch((error) => console.error(error));
- lang: python
label: Python
source: |
import requests
url = "https://api.woosmap.com/geolocation/stores?private_key=YOUR_PRIVATE_API_KEY&ip_address=173.79.254.254&limit=1"
payload = {}
headers = {}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
/geolocation/timezone:
get:
summary: Timezone
operationId: getTimezone
servers:
- url: https://api.woosmap.com
tags:
- Geolocation API
description: |
Returns timezone information based on the location, and optionally a timestamp for daylight saving time.
> Note: rawOffset never contains the dst.
security:
- PublicApiKeyAuth: []
RefererHeader: []
- PrivateApiKeyAuth: []
- PrivateApiKeyHeaderAuth: []
parameters:
- description: The location {lat},{lng}
name: location
in: query
schema:
type: string
required: true
- description: The UTC timestamp
name: timestamp
in: query
schema:
type: integer
minimum: 0
responses:
'200':
description: Timezone successfully retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/TimezoneResponse'
examples:
default:
summary: Timezone for 43.6, 3.883 location.
value:
timezone: Europe/Paris
timezone_name: CEST
raw_offset: 3600
dst_offset: 3600
'401':
description: Unauthorized. Incorrect authentication credentials.
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
examples:
Unauthorized:
summary: Error 401
value:
detail: Incorrect authentication credentials. Please check or use a valid API Key
'403':
description: Forbidden. This Woosmap API is not enabled for this project.
content:
application/json:
schema:
$ref: '#/components/schemas/Error403'
examples:
Forbidden:
summary: Error 403
value:
detail: This Woosmap API is not enabled for this project.
'429':
description: Too Many Requests. The rate limit for this endpoint has been exceeded.
content:
application/json:
schema:
$ref: '#/components/schemas/Error429'
examples:
Forbidden:
summary: Error 429
value:
detail: The rate limit for this endpoint has been exceeded
x-codeSamples:
- lang: curl
label: cURL
source: curl -L 'https://api.woosmap.com/geolocation/timezone?private_key=YOUR_PRIVATE_API_KEY&location=43.6114130%2C3.8735291'
- lang: javascript
label: JavaScript
source: |-
const requestOptions = {
method: "GET",
redirect: "follow"
};
fetch("https://api.woosmap.com/geolocation/timezone?private_key=YOUR_PRIVATE_API_KEY&location=43.6114130%2C3.8735291", requestOptions)
.then((response) => response.text())
.then((result) => console.log(result))
.catch((error) => console.error(error));
- lang: python
label: Python
source: |
import requests
url = "https://api.woosmap.com/geolocation/timezone?private_key=YOUR_PRIVATE_API_KEY&location=43.6114130%2C3.8735291"
payload = {}
headers = {}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
/stores:
post:
summary: Create your Assets
operationId: createStores
servers:
- url: https://api.woosmap.com
tags:
- Data Management
description: |
Used to batch create Assets to a specific project identified with the `private_key` parameter.
security:
- PrivateApiKeyAuth: []
requestBody:
description: The request body must of Stores Creation be formatted as JSON.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AssetsCollectionRequest'
examples:
default:
summary: Stores data to create as JSON
value:
stores:
- types:
- drive
- click_and_collect
tags:
- wifi
- covered_parking
location:
lat: 38.719
lng: -77.1067
storeId: STORE_ID_123456
name: My Cool Store
address:
lines:
- Building Centre
- 26 Store Street
countryCode: UK
city: London
zipcode: WC1E 7BT
contact:
website: https://www.woosmap.com
phone: +44 20 7693 4000
email: contact@woosmap.com
userProperties:
some_user_properties: associated user value
openingHours:
timezone: Europe/London
usual:
'1': []
default:
- start: '08:30'
end: '22:00'
special:
'2015-02-07':
- start: '08:00'
end: '23:00'
- types:
- drive
tags:
- covered_parking
location:
lat: 38.5239
lng: -77.0157
storeId: STORE_ID_45678
name: My Cool Store 2
address:
lines:
- 1805-1899
- Orchard St
countryCode: US
city: Alexandria
zipcode: '22309'
contact:
website: https://www.woosmap.com
phone: +44 20 7693 4000
email: contact@woosmap.com
userProperties:
some_user_properties: associated user value
openingHours:
timezone: America/New_York
usual:
'1': []
default:
- start: '08:30'
end: '22:00'
responses:
'200':
description: Assets successfully created
content:
application/json:
schema:
$ref: '#/components/schemas/Success'
examples:
default:
summary: Success response for Stores Created
value:
status: success
value: 2 stores
'400':
description: Invalid. The data is not a valid JSON.
content:
application/json:
schema:
$ref: '#/components/schemas/Error400'
examples:
Invalid:
summary: Error 400
value:
status: error
value: The request is invalid, the data is not a valid JSON.
'401':
description: Unauthorized. Incorrect authentication credentials.
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
examples:
Unauthorized:
summary: Error 401
value:
detail: Incorrect authentication credentials. Please check or use a valid API Key
'403':
description: Forbidden. This Woosmap API is not enabled for this project.
content:
application/json:
schema:
$ref: '#/components/schemas/Error403'
examples:
Forbidden:
summary: Error 403
value:
detail: This Woosmap API is not enabled for this project.
x-codeSamples:
- lang: curl
label: cURL
source: |-
curl -L 'https://api.woosmap.com/stores?private_key=YOUR_PRIVATE_API_KEY' \
-H 'content-type: application/json' \
--data-raw '{
"stores": [
{
"types": [
"drive",
"click_and_collect"
],
"tags": [
"wifi",
"covered_parking"
],
"location": {
"lat": 38.719,
"lng": -77.1067
},
"storeId": "STORE_ID_123456",
"name": "My Cool Store",
"address": {
"lines": [
"Building Centre",
"26 Store Street"
],
"countryCode": "UK",
"city": "London",
"zipcode": "WC1E 7BT"
},
"contact": {
"website": "https://www.woosmap.com",
"phone": "+44 20 7693 4000",
"email": "contact@woosmap.com"
},
"userProperties": {
"some_user_properties": "associated user value"
},
"openingHours": {
"timezone": "Europe/London",
"usual": {
"1": [],
"default": [
{
"start": "08:30",
"end": "22:00"
}
]
},
"special": {
"2015-02-07": [
{
"start": "08:00",
"end": "23:00"
}
]
}
}
},
{
"types": [
"drive"
],
"tags": [
"covered_parking"
],
"location": {
"lat": 38.5239,
"lng": -77.0157
},
"storeId": "STORE_ID_45678",
"name": "My Cool Store 2",
"address": {
"lines": [
"1805-1899",
"Orchard St"
],
"countryCode": "US",
"city": "Alexandria",
"zipcode": "22309"
},
"contact": {
"website": "https://www.woosmap.com",
"phone": "+44 20 7693 4000",
"email": "contact@woosmap.com"
},
"userProperties": {
"some_user_properties": "associated user value"
},
"openingHours": {
"timezone": "America/New_York",
"usual": {
"1": [],
"default": [
{
"start": "08:30",
"end": "22:00"
}
]
}
}
}
]
}'
- lang: python
label: Python
source: |
import requests
import json
url = "https://api.woosmap.com/stores?private_key=YOUR_PRIVATE_API_KEY"
payload = json.dumps({
"stores": [
{
"types": [
"drive",
"click_and_collect"
],
"tags": [
"wifi",
"covered_parking"
],
"location": {
"lat": 38.719,
"lng": -77.1067
},
"storeId": "STORE_ID_123456",
"name": "My Cool Store",
"address": {
"lines": [
"Building Centre",
"26 Store Street"
],
"countryCode": "UK",
"city": "London",
"zipcode": "WC1E 7BT"
},
"contact": {
"website": "https://www.woosmap.com",
"phone": "+44 20 7693 4000",
"email": "contact@woosmap.com"
},
"userProperties": {
"some_user_properties": "associated user value"
},
"openingHours": {
"timezone": "Europe/London",
"usual": {
"1": [],
"default": [
{
"start": "08:30",
"end": "22:00"
}
]
},
"special": {
"2015-02-07": [
{
"start": "08:00",
"end": "23:00"
}
]
}
}
},
{
"types": [
"drive"
],
"tags": [
"covered_parking"
],
"location": {
"lat": 38.5239,
"lng": -77.0157
},
"storeId": "STORE_ID_45678",
"name": "My Cool Store 2",
"address": {
"lines": [
"1805-1899",
"Orchard St"
],
"countryCode": "US",
"city": "Alexandria",
"zipcode": "22309"
},
"contact": {
"website": "https://www.woosmap.com",
"phone": "+44 20 7693 4000",
"email": "contact@woosmap.com"
},
"userProperties": {
"some_user_properties": "associated user value"
},
"openingHours": {
"timezone": "America/New_York",
"usual": {
"1": [],
"default": [
{
"start": "08:30",
"end": "22:00"
}
]
}
}
}
]
})
headers = {
'content-type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
- lang: nodejs
label: NodeJS
source: |
const axios = require('axios');
let data = JSON.stringify({
"stores": [
{
"types": [
"drive",
"click_and_collect"
],
"tags": [
"wifi",
"covered_parking"
],
"location": {
"lat": 38.719,
"lng": -77.1067
},
"storeId": "STORE_ID_123456",
"name": "My Cool Store",
"address": {
"lines": [
"Building Centre",
"26 Store Street"
],
"countryCode": "UK",
"city": "London",
"zipcode": "WC1E 7BT"
},
"contact": {
"website": "https://www.woosmap.com",
"phone": "+44 20 7693 4000",
"email": "contact@woosmap.com"
},
"userProperties": {
"some_user_properties": "associated user value"
},
"openingHours": {
"timezone": "Europe/London",
"usual": {
"1": [],
"default": [
{
"start": "08:30",
"end": "22:00"
}
]
},
"special": {
"2015-02-07": [
{
"start": "08:00",
"end": "23:00"
}
]
}
}
},
{
"types": [
"drive"
],
"tags": [
"covered_parking"
],
"location": {
"lat": 38.5239,
"lng": -77.0157
},
"storeId": "STORE_ID_45678",
"name": "My Cool Store 2",
"address": {
"lines": [
"1805-1899",
"Orchard St"
],
"countryCode": "US",
"city": "Alexandria",
"zipcode": "22309"
},
"contact": {
"website": "https://www.woosmap.com",
"phone": "+44 20 7693 4000",
"email": "contact@woosmap.com"
},
"userProperties": {
"some_user_properties": "associated user value"
},
"openingHours": {
"timezone": "America/New_York",
"usual": {
"1": [],
"default": [
{
"start": "08:30",
"end": "22:00"
}
]
}
}
}
]
});
let config = {
method: 'post',
maxBodyLength: Infinity,
url: 'https://api.woosmap.com/stores?private_key=YOUR_PRIVATE_API_KEY',
headers: {
'content-type': 'application/json'
},
data : data
};
axios.request(config)
.then((response) => {
console.log(JSON.stringify(response.data));
})
.catch((error) => {
console.log(error);
});
put:
summary: Update the Assets
operationId: updateStores
servers:
- url: https://api.woosmap.com
tags:
- Data Management
description: Used to update assets in batch. `storeId` must exists when using `PUT` method, if one asset does not exists, the batch will be refused.
security:
- PrivateApiKeyAuth: []
requestBody:
description: The request body of Stores Update must be formatted as JSON.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AssetsCollectionRequest'
examples:
default:
summary: Stores data to update as JSON
value:
stores:
- types:
- drive
- click_and_collect
tags:
- wifi
- covered_parking
location:
lat: 38.719
lng: -77.1067
storeId: STORE_ID_123456
name: My Cool Store
address:
lines:
- 698-500
- ' Lloyds Ln'
countryCode: US
city: Alexandria
zipcode: VA 22302
contact:
website: https://www.woosmap.com
phone: +44 20 7693 4000
email: contact@woosmap.com
userProperties:
some_user_properties: associated user value
openingHours:
timezone: Europe/London
usual:
'1': []
default:
- start: '08:30'
end: '22:00'
special:
'2015-02-07':
- start: '08:00'
end: '23:00'
responses:
'200':
description: Assets successfully updated
content:
application/json:
schema:
$ref: '#/components/schemas/Success'
examples:
default:
summary: Success response for Stores updated
value:
status: success
value: 1 stores
'400':
description: Invalid. The data is not a valid JSON.
content:
application/json:
schema:
$ref: '#/components/schemas/Error400'
examples:
Invalid:
summary: Error 400
value:
status: error
value: The request is invalid, the data is not a valid JSON.
'401':
description: Unauthorized. Incorrect authentication credentials.
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
examples:
Unauthorized:
summary: Error 401
value:
detail: Incorrect authentication credentials. Please check or use a valid API Key
'403':
description: Forbidden. This Woosmap API is not enabled for this project.
content:
application/json:
schema:
$ref: '#/components/schemas/Error403'
examples:
Forbidden:
summary: Error 403
value:
detail: This Woosmap API is not enabled for this project.
x-codeSamples:
- lang: curl
label: cURL
source: |-
curl -L -X PUT 'https://api.woosmap.com/stores?private_key=YOUR_PRIVATE_API_KEY' \
-H 'content-type: application/json' \
--data-raw '{
"stores": [
{
"types": [
"drive",
"click_and_collect"
],
"tags": [
"wifi",
"covered_parking"
],
"location": {
"lat": 38.719,
"lng": -77.1067
},
"storeId": "STORE_ID_123456",
"name": "My Cool Store",
"address": {
"lines": [
"698-500",
" Lloyds Ln"
],
"countryCode": "US",
"city": "Alexandria",
"zipcode": "VA 22302"
},
"contact": {
"website": "https://www.woosmap.com",
"phone": "+44 20 7693 4000",
"email": "contact@woosmap.com"
},
"userProperties": {
"some_user_properties": "associated user value"
},
"openingHours": {
"timezone": "Europe/London",
"usual": {
"1": [],
"default": [
{
"start": "08:30",
"end": "22:00"
}
]
},
"special": {
"2015-02-07": [
{
"start": "08:00",
"end": "23:00"
}
]
}
}
}
]
}'
- lang: python
label: Python
source: |
import requests
import json
url = "https://api.woosmap.com/stores?private_key=YOUR_PRIVATE_API_KEY"
payload = json.dumps({
"stores": [
{
"types": [
"drive",
"click_and_collect"
],
"tags": [
"wifi",
"covered_parking"
],
"location": {
"lat": 38.719,
"lng": -77.1067
},
"storeId": "STORE_ID_123456",
"name": "My Cool Store",
"address": {
"lines": [
"698-500",
" Lloyds Ln"
],
"countryCode": "US",
"city": "Alexandria",
"zipcode": "VA 22302"
},
"contact": {
"website": "https://www.woosmap.com",
"phone": "+44 20 7693 4000",
"email": "contact@woosmap.com"
},
"userProperties": {
"some_user_properties": "associated user value"
},
"openingHours": {
"timezone": "Europe/London",
"usual": {
"1": [],
"default": [
{
"start": "08:30",
"end": "22:00"
}
]
},
"special": {
"2015-02-07": [
{
"start": "08:00",
"end": "23:00"
}
]
}
}
}
]
})
headers = {
'content-type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, data=payload)
print(response.text)
- lang: nodejs
label: NodeJS
source: |
const axios = require('axios');
let data = JSON.stringify({
"stores": [
{
"types": [
"drive",
"click_and_collect"
],
"tags": [
"wifi",
"covered_parking"
],
"location": {
"lat": 38.719,
"lng": -77.1067
},
"storeId": "STORE_ID_123456",
"name": "My Cool Store",
"address": {
"lines": [
"698-500",
" Lloyds Ln"
],
"countryCode": "US",
"city": "Alexandria",
"zipcode": "VA 22302"
},
"contact": {
"website": "https://www.woosmap.com",
"phone": "+44 20 7693 4000",
"email": "contact@woosmap.com"
},
"userProperties": {
"some_user_properties": "associated user value"
},
"openingHours": {
"timezone": "Europe/London",
"usual": {
"1": [],
"default": [
{
"start": "08:30",
"end": "22:00"
}
]
},
"special": {
"2015-02-07": [
{
"start": "08:00",
"end": "23:00"
}
]
}
}
}
]
});
let config = {
method: 'put',
maxBodyLength: Infinity,
url: 'https://api.woosmap.com/stores?private_key=YOUR_PRIVATE_API_KEY',
headers: {
'content-type': 'application/json'
},
data : data
};
axios.request(config)
.then((response) => {
console.log(JSON.stringify(response.data));
})
.catch((error) => {
console.log(error);
});
delete:
summary: Delete the Assets
operationId: deleteStores
servers:
- url: https://api.woosmap.com
tags:
- Data Management
description: |
Used to delete one or more assets. The `storeId` specified in `query` parameter is the id of the asset to delete. To delete several assets, use the comma as a separator. To delete all project assets, omit the `query` parameter.
security:
- PrivateApiKeyAuth: []
parameters:
- name: query
description: The query to target assets ID to delete
in: query
example: idstore:[{storeId1},{storeId2}]
schema:
type: string
responses:
'200':
description: Assets successfully deleted
content:
application/json:
schema:
$ref: '#/components/schemas/Success'
examples:
default:
summary: Success response for Stores deleted
value:
status: success
value: 2
'401':
description: Unauthorized. Incorrect authentication credentials.
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
examples:
Unauthorized:
summary: Error 401
value:
detail: Incorrect authentication credentials. Please check or use a valid API Key
'403':
description: Forbidden. This Woosmap API is not enabled for this project.
content:
application/json:
schema:
$ref: '#/components/schemas/Error403'
examples:
Forbidden:
summary: Error 403
value:
detail: This Woosmap API is not enabled for this project.
x-codeSamples:
- lang: curl
label: cURL
source: curl -L -X DELETE 'https://api.woosmap.com/stores/?private_key=YOUR_PRIVATE_API_KEY'
- lang: python
label: Python
source: |
import requests
url = "https://api.woosmap.com/stores/?private_key=YOUR_PRIVATE_API_KEY"
payload = {}
headers = {}
response = requests.request("DELETE", url, headers=headers, data=payload)
print(response.text)
- lang: nodejs
label: NodeJS
source: |
const axios = require('axios');
let config = {
method: 'delete',
maxBodyLength: Infinity,
url: 'https://api.woosmap.com/stores/?private_key=YOUR_PRIVATE_API_KEY',
headers: { }
};
axios.request(config)
.then((response) => {
console.log(JSON.stringify(response.data));
})
.catch((error) => {
console.log(error);
});
/stores/{storeId}:
get:
summary: Get Asset from ID
operationId: getStore
servers:
- url: https://api.woosmap.com
tags:
- Data Management
description: |
Used to retrieve an asset from his `storeId`
security:
- PublicApiKeyAuth: []
RefererHeader: []
- PrivateApiKeyAuth: []
- PrivateApiKeyHeaderAuth: []
parameters:
- in: path
name: storeId
schema:
type: string
required: true
example: STORE_ID_123456
description: ID of the asset to get
responses:
'200':
description: Asset successfully retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/AssetFeatureResponse'
examples:
default:
summary: Get a store from its store_id
value:
type: Feature
properties:
store_id: '10031'
name: Santa Rosa & Yolanda
contact:
phone: 707-527-1006
website: https://www.starbucks.com/store-locator/store/10031/santa-rosa-yolanda-2688-santa-rosa-ave-santa-rosa-ca-954077625-us
address:
lines:
- 2688 Santa Rosa Ave
- Santa Rosa, CA 95407
country_code: US
city: Santa Rosa
zipcode: '954077625'
user_properties:
take_away: available
tags:
- DT
- WA
- CD
- DR
- LB
- GO
- XO
- MX
- NB
- BE
- LU
types:
- Coffee shop
last_updated: '2022-11-10T13:26:55.066524+00:00'
open:
open_now: false
open_hours:
- end: '20:00'
start: '05:00'
week_day: 2
next_opening:
day: '2025-09-16'
start: '05:00'
end: '20:00'
weekly_opening:
'1':
hours:
- end: '20:00'
start: '05:00'
isSpecial: false
'2':
hours:
- end: '20:00'
start: '05:00'
isSpecial: false
'3':
hours:
- end: '20:00'
start: '05:00'
isSpecial: false
'4':
hours:
- end: '20:00'
start: '05:00'
isSpecial: false
'5':
hours:
- end: '20:00'
start: '05:00'
isSpecial: false
'6':
hours:
- end: '20:00'
start: '05:00'
isSpecial: false
'7':
hours:
- end: '20:00'
start: '05:00'
isSpecial: false
timezone: America/Los_Angeles
opening_hours:
usual:
'1':
- end: '20:00'
start: '05:00'
'2':
- end: '20:00'
start: '05:00'
'3':
- end: '20:00'
start: '05:00'
'4':
- end: '20:00'
start: '05:00'
'5':
- end: '20:00'
start: '05:00'
'6':
- end: '20:00'
start: '05:00'
'7':
- end: '20:00'
start: '05:00'
special: {}
timezone: America/Los_Angeles
geometry:
type: Point
coordinates:
- -122.712924
- 38.41244
'401':
description: Unauthorized. Incorrect authentication credentials.
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
examples:
Unauthorized:
summary: Error 401
value:
detail: Incorrect authentication credentials. Please check or use a valid API Key
'403':
description: Forbidden. This Woosmap API is not enabled for this project.
content:
application/json:
schema:
$ref: '#/components/schemas/Error403'
examples:
Forbidden:
summary: Error 403
value:
detail: This Woosmap API is not enabled for this project.
'404':
description: Not Found - `storeId` do not exist.
x-codeSamples:
- lang: curl
label: cURL
source: |-
curl -L 'https://api.woosmap.com/stores/10031/?key=YOUR_PUBLIC_API_KEY' \
-H 'Referer: http://localhost'
- lang: javascript
label: JavaScript
source: |-
const requestOptions = {
method: "GET",
redirect: "follow"
};
fetch("https://api.woosmap.com/stores/10031/?key=YOUR_PUBLIC_API_KEY", requestOptions)
.then((response) => response.text())
.then((result) => console.log(result))
.catch((error) => console.error(error));
- lang: python
label: Python
source: |
import requests
url = "https://api.woosmap.com/stores/10031/?key=YOUR_PUBLIC_API_KEY"
payload = {}
headers = {
'Referer': 'http://localhost'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
/stores/replace:
post:
summary: Replace all assets
operationId: replaceStores
servers:
- url: https://api.woosmap.com
tags:
- Data Management
description: To replace all your Assets. This endpoint will delete all previous assets and import assets in request body. During the operation previous assets could always be displayed on map. If the import failed previous assets are not deleted.
security:
- PrivateApiKeyAuth: []
requestBody:
description: The request body of Stores Replace must be formatted as JSON.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AssetsCollectionRequest'
examples:
default:
summary: Stores Data to replace as JSON
value:
stores:
- types:
- drive
- click_and_collect
tags:
- wifi
- covered_parking
location:
lat: 38.719
lng: -77.1067
storeId: STORE_ID_123456
name: My Cool Store
address:
lines:
- Building Centre
- 26 Store Street
countryCode: UK
city: London
zipcode: WC1E 7BT
contact:
website: https://www.woosmap.com
phone: +44 20 7693 4000
email: contact@woosmap.com
userProperties:
some_user_properties: associated user value
openingHours:
timezone: Europe/London
usual:
'1': []
default:
- start: '08:30'
end: '22:00'
special:
'2015-02-07':
- start: '08:00'
end: '23:00'
- types:
- drive
tags:
- covered_parking
location:
lat: 38.5239
lng: -77.0157
storeId: STORE_ID_45678
name: My Cool Store 2
address:
lines:
- 1805-1899
- Orchard St
countryCode: US
city: Alexandria
zipcode: '22309'
contact:
website: https://www.woosmap.com
phone: +44 20 7693 4000
email: contact@woosmap.com
userProperties:
some_user_properties: associated user value
openingHours:
timezone: America/New_York
usual:
'1': []
default:
- start: '08:30'
end: '22:00'
responses:
'200':
description: Assets successfully replaced
content:
application/json:
schema:
$ref: '#/components/schemas/Success'
examples:
default:
summary: Success response for Stores replaced
value:
status: success
value: 2 stores deleted, 2 stores created
'400':
description: Invalid. The data is not a valid JSON.
content:
application/json:
schema:
$ref: '#/components/schemas/Error400'
examples:
Invalid:
summary: Error 400
value:
status: error
value: The request is invalid, the data is not a valid JSON.
'401':
description: Unauthorized. Incorrect authentication credentials.
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
examples:
Unauthorized:
summary: Error 401
value:
detail: Incorrect authentication credentials. Please check or use a valid API Key
'403':
description: Forbidden. This Woosmap API is not enabled for this project.
content:
application/json:
schema:
$ref: '#/components/schemas/Error403'
examples:
Forbidden:
summary: Error 403
value:
detail: This Woosmap API is not enabled for this project.
x-codeSamples:
- lang: curl
label: cURL
source: |-
curl -L 'https://api.woosmap.com/stores/replace?private_key=YOUR_PRIVATE_API_KEY' \
-H 'content-type: application/json' \
--data-raw '{
"stores": [
{
"types": [
"drive",
"click_and_collect"
],
"tags": [
"wifi",
"covered_parking"
],
"location": {
"lat": 38.719,
"lng": -77.1067
},
"storeId": "STORE_ID_123456",
"name": "My Cool Store",
"address": {
"lines": [
"Building Centre",
"26 Store Street"
],
"countryCode": "UK",
"city": "London",
"zipcode": "WC1E 7BT"
},
"contact": {
"website": "https://www.woosmap.com",
"phone": "+44 20 7693 4000",
"email": "contact@woosmap.com"
},
"userProperties": {
"some_user_properties": "associated user value"
},
"openingHours": {
"timezone": "Europe/London",
"usual": {
"1": [],
"default": [
{
"start": "08:30",
"end": "22:00"
}
]
},
"special": {
"2015-02-07": [
{
"start": "08:00",
"end": "23:00"
}
]
}
}
},
{
"types": [
"drive"
],
"tags": [
"covered_parking"
],
"location": {
"lat": 38.5239,
"lng": -77.0157
},
"storeId": "STORE_ID_45678",
"name": "My Cool Store 2",
"address": {
"lines": [
"1805-1899",
"Orchard St"
],
"countryCode": "US",
"city": "Alexandria",
"zipcode": "22309"
},
"contact": {
"website": "https://www.woosmap.com",
"phone": "+44 20 7693 4000",
"email": "contact@woosmap.com"
},
"userProperties": {
"some_user_properties": "associated user value"
},
"openingHours": {
"timezone": "America/New_York",
"usual": {
"1": [],
"default": [
{
"start": "08:30",
"end": "22:00"
}
]
}
}
}
]
}'
- lang: python
label: Python
source: |
import requests
import json
url = "https://api.woosmap.com/stores/replace?private_key=YOUR_PRIVATE_API_KEY"
payload = json.dumps({
"stores": [
{
"types": [
"drive",
"click_and_collect"
],
"tags": [
"wifi",
"covered_parking"
],
"location": {
"lat": 38.719,
"lng": -77.1067
},
"storeId": "STORE_ID_123456",
"name": "My Cool Store",
"address": {
"lines": [
"Building Centre",
"26 Store Street"
],
"countryCode": "UK",
"city": "London",
"zipcode": "WC1E 7BT"
},
"contact": {
"website": "https://www.woosmap.com",
"phone": "+44 20 7693 4000",
"email": "contact@woosmap.com"
},
"userProperties": {
"some_user_properties": "associated user value"
},
"openingHours": {
"timezone": "Europe/London",
"usual": {
"1": [],
"default": [
{
"start": "08:30",
"end": "22:00"
}
]
},
"special": {
"2015-02-07": [
{
"start": "08:00",
"end": "23:00"
}
]
}
}
},
{
"types": [
"drive"
],
"tags": [
"covered_parking"
],
"location": {
"lat": 38.5239,
"lng": -77.0157
},
"storeId": "STORE_ID_45678",
"name": "My Cool Store 2",
"address": {
"lines": [
"1805-1899",
"Orchard St"
],
"countryCode": "US",
"city": "Alexandria",
"zipcode": "22309"
},
"contact": {
"website": "https://www.woosmap.com",
"phone": "+44 20 7693 4000",
"email": "contact@woosmap.com"
},
"userProperties": {
"some_user_properties": "associated user value"
},
"openingHours": {
"timezone": "America/New_York",
"usual": {
"1": [],
"default": [
{
"start": "08:30",
"end": "22:00"
}
]
}
}
}
]
})
headers = {
'content-type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
- lang: nodejs
label: NodeJS
source: |
const axios = require('axios');
let data = JSON.stringify({
"stores": [
{
"types": [
"drive",
"click_and_collect"
],
"tags": [
"wifi",
"covered_parking"
],
"location": {
"lat": 38.719,
"lng": -77.1067
},
"storeId": "STORE_ID_123456",
"name": "My Cool Store",
"address": {
"lines": [
"Building Centre",
"26 Store Street"
],
"countryCode": "UK",
"city": "London",
"zipcode": "WC1E 7BT"
},
"contact": {
"website": "https://www.woosmap.com",
"phone": "+44 20 7693 4000",
"email": "contact@woosmap.com"
},
"userProperties": {
"some_user_properties": "associated user value"
},
"openingHours": {
"timezone": "Europe/London",
"usual": {
"1": [],
"default": [
{
"start": "08:30",
"end": "22:00"
}
]
},
"special": {
"2015-02-07": [
{
"start": "08:00",
"end": "23:00"
}
]
}
}
},
{
"types": [
"drive"
],
"tags": [
"covered_parking"
],
"location": {
"lat": 38.5239,
"lng": -77.0157
},
"storeId": "STORE_ID_45678",
"name": "My Cool Store 2",
"address": {
"lines": [
"1805-1899",
"Orchard St"
],
"countryCode": "US",
"city": "Alexandria",
"zipcode": "22309"
},
"contact": {
"website": "https://www.woosmap.com",
"phone": "+44 20 7693 4000",
"email": "contact@woosmap.com"
},
"userProperties": {
"some_user_properties": "associated user value"
},
"openingHours": {
"timezone": "America/New_York",
"usual": {
"1": [],
"default": [
{
"start": "08:30",
"end": "22:00"
}
]
}
}
}
]
});
let config = {
method: 'post',
maxBodyLength: Infinity,
url: 'https://api.woosmap.com/stores/replace?private_key=YOUR_PRIVATE_API_KEY',
headers: {
'content-type': 'application/json'
},
data : data
};
axios.request(config)
.then((response) => {
console.log(JSON.stringify(response.data));
})
.catch((error) => {
console.log(error);
});
/stores/search:
get:
summary: Search for assets
operationId: storeSearch
servers:
- url: https://api.woosmap.com
tags:
- Store Search
description: |
Used to retrieve assets from query.
security:
- PublicApiKeyAuth: []
RefererHeader: []
- PrivateApiKeyAuth: []
- PrivateApiKeyHeaderAuth: []
parameters:
- $ref: '#/components/parameters/query'
- $ref: '#/components/parameters/lat'
- $ref: '#/components/parameters/lng'
- $ref: '#/components/parameters/radius'
- $ref: '#/components/parameters/polyline'
- $ref: '#/components/parameters/bounds'
- $ref: '#/components/parameters/stores_by_page'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/zone'
- $ref: '#/components/parameters/enhanced'
responses:
'200':
description: Assets successfully retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/AssetFeatureCollectionResponse'
examples:
default:
summary: Search stores nearby a latlng and given a radius
value:
type: FeatureCollection
features:
- type: Feature
properties:
store_id: '2354'
name: Berkeley Street/Berkeley Square
contact:
phone: '02076295779'
website: https://www.starbucks.com/store-locator/store/2354/berkeley-street-berkeley-square-27-berkeley-st-berkeley-square-london-eng-w-1-x-5-
address:
lines:
- 27 Berkeley St
- London, ENG W1X 5AD
country_code: GB
city: London
zipcode: W1X 5AD
user_properties:
take_away: available
tags:
- WA
- WF
- CD
- DR
- XO
types:
- Coffee shop
last_updated: '2022-11-10T13:23:53.564829+00:00'
distance: 135.28682936
open:
open_now: true
open_hours:
- end: '18:00'
start: '06:30'
week_day: 2
current_slice:
end: '18:00'
start: '06:30'
weekly_opening:
'1':
hours:
- end: '18:00'
start: '06:30'
isSpecial: false
'2':
hours:
- end: '18:00'
start: '06:30'
isSpecial: false
'3':
hours:
- end: '18:00'
start: '06:30'
isSpecial: false
'4':
hours:
- end: '18:00'
start: '06:30'
isSpecial: false
'5':
hours:
- end: '18:00'
start: '06:30'
isSpecial: false
'6':
hours:
- end: '17:00'
start: '08:00'
isSpecial: false
'7':
hours:
- end: '17:00'
start: '08:00'
isSpecial: false
timezone: Europe/London
opening_hours:
usual:
'1':
- end: '18:00'
start: '06:30'
'2':
- end: '18:00'
start: '06:30'
'3':
- end: '18:00'
start: '06:30'
'4':
- end: '18:00'
start: '06:30'
'5':
- end: '18:00'
start: '06:30'
'6':
- end: '17:00'
start: '08:00'
'7':
- end: '17:00'
start: '08:00'
special: {}
timezone: Europe/London
geometry:
type: Point
coordinates:
- -0.14408
- 51.5088
pagination:
page: 1
pageCount: 1
hasNext: false
'401':
description: Unauthorized. Incorrect authentication credentials.
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
examples:
Unauthorized:
summary: Error 401
value:
detail: Incorrect authentication credentials. Please check or use a valid API Key
'403':
description: Forbidden. This Woosmap API is not enabled for this project.
content:
application/json:
schema:
$ref: '#/components/schemas/Error403'
examples:
Forbidden:
summary: Error 403
value:
detail: This Woosmap API is not enabled for this project.
'429':
description: Too Many Requests. The rate limit for this endpoint has been exceeded.
content:
application/json:
schema:
$ref: '#/components/schemas/Error429'
examples:
Forbidden:
summary: Error 429
value:
detail: The rate limit for this endpoint has been exceeded
x-codeSamples:
- lang: curl
label: cURL
source: |-
curl -L 'https://api.woosmap.com/stores/search/?lat=51.50976&lng=-0.145276&radius=300&key=YOUR_PUBLIC_API_KEY' \
-H 'Referer: http://localhost'
- lang: javascript
label: JavaScript
source: |-
const requestOptions = {
method: "GET",
redirect: "follow"
};
fetch("https://api.woosmap.com/stores/search/?lat=51.50976&lng=-0.145276&radius=300&key=YOUR_PUBLIC_API_KEY", requestOptions)
.then((response) => response.text())
.then((result) => console.log(result))
.catch((error) => console.error(error));
- lang: python
label: Python
source: |
import requests
url = "https://api.woosmap.com/stores/search/?lat=51.50976&lng=-0.145276&radius=300&key=YOUR_PUBLIC_API_KEY"
payload = {}
headers = {
'Referer': 'http://localhost'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
/stores/autocomplete:
get:
summary: Autocomplete for assets
operationId: storeAutocomplete
servers:
- url: https://api.woosmap.com
tags:
- Store Search
description: |
Autocomplete on `localizedNames` with highlighted results on asset name. Use the field `localized` in your query parameter to search for localized names. Without `query`, the response has no predictions.
security:
- PublicApiKeyAuth: []
RefererHeader: []
- PrivateApiKeyAuth: []
- PrivateApiKeyHeaderAuth: []
parameters:
- $ref: '#/components/parameters/query'
- $ref: '#/components/parameters/language'
- $ref: '#/components/parameters/limit-2'
responses:
'200':
description: Assets Successfully Replaced
content:
application/json:
schema:
$ref: '#/components/schemas/AssetAutocompleteResponse'
examples:
default:
summary: Autocomplete on stores in localized names nearby a latlng and specifying a radius
value:
predictions:
- store_id: '2670'
name: Sun Street
types:
- Coffee shop
matched_substrings:
- offset: 4
length: 6
highlighted: Sun Street
- store_id: '16069'
name: 7th Street
types:
- Coffee shop
matched_substrings:
- offset: 4
length: 6
highlighted: 7th Street
- store_id: '1013873'
name: The Street
types:
- Coffee shop
matched_substrings:
- offset: 4
length: 6
highlighted: The Street
'401':
description: Unauthorized. Incorrect authentication credentials.
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
examples:
Unauthorized:
summary: Error 401
value:
detail: Incorrect authentication credentials. Please check or use a valid API Key
'403':
description: Forbidden. This Woosmap API is not enabled for this project.
content:
application/json:
schema:
$ref: '#/components/schemas/Error403'
examples:
Forbidden:
summary: Error 403
value:
detail: This Woosmap API is not enabled for this project.
'429':
description: Too Many Requests. The rate limit for this endpoint has been exceeded.
content:
application/json:
schema:
$ref: '#/components/schemas/Error429'
examples:
Forbidden:
summary: Error 429
value:
detail: The rate limit for this endpoint has been exceeded
x-codeSamples:
- lang: curl
label: cURL
source: |-
curl -L 'https://api.woosmap.com/stores/autocomplete/?language=en&query=localized%3Astreet&limit=3&key=YOUR_PUBLIC_API_KEY' \
-H 'Referer: http://localhost'
- lang: javascript
label: JavaScript
source: |-
const requestOptions = {
method: "GET",
redirect: "follow"
};
fetch("https://api.woosmap.com/stores/autocomplete/?language=en&query=localized%3Astreet&limit=3&key=YOUR_PUBLIC_API_KEY", requestOptions)
.then((response) => response.text())
.then((result) => console.log(result))
.catch((error) => console.error(error));
- lang: python
label: Python
source: |
import requests
url = "https://api.woosmap.com/stores/autocomplete/?language=en&query=localized%3Astreet&limit=3&key=YOUR_PUBLIC_API_KEY"
payload = {}
headers = {
'Referer': 'http://localhost'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
/stores/search/bounds:
get:
summary: Bounds for assets
operationId: storesBounds
servers:
- url: https://api.woosmap.com
tags:
- Store Search
description: |
Used to retrieve Bounds for assets.
security:
- PublicApiKeyAuth: []
RefererHeader: []
- PrivateApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/query'
- $ref: '#/components/parameters/lat'
- $ref: '#/components/parameters/lng'
- $ref: '#/components/parameters/radius'
responses:
'200':
description: Bounds successfully retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/BoundsResponse'
examples:
default:
summary: Retrieve Bounds nearby a latlng and given a radius
value:
bounds:
west: -0.14408
south: 51.5088
east: -0.14408
north: 51.5088
'401':
description: Unauthorized. Incorrect authentication credentials.
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
examples:
Unauthorized:
summary: Error 401
value:
detail: Incorrect authentication credentials. Please check or use a valid API Key
'403':
description: Forbidden. This Woosmap API is not enabled for this project.
content:
application/json:
schema:
$ref: '#/components/schemas/Error403'
examples:
Forbidden:
summary: Error 403
value:
detail: This Woosmap API is not enabled for this project.
'429':
description: Too Many Requests. The rate limit for this endpoint has been exceeded.
content:
application/json:
schema:
$ref: '#/components/schemas/Error429'
examples:
Forbidden:
summary: Error 429
value:
detail: The rate limit for this endpoint has been exceeded
x-codeSamples:
- lang: curl
label: cURL
source: |-
curl -L 'https://api.woosmap.com/stores/search/bounds?lat=51.50976&lng=-0.145276&radius=300&key=YOUR_PUBLIC_API_KEY' \
-H 'Referer: http://localhost'
- lang: javascript
label: JavaScript
source: |-
const requestOptions = {
method: "GET",
redirect: "follow"
};
fetch("https://api.woosmap.com/stores/search/bounds?lat=51.50976&lng=-0.145276&radius=300&key=YOUR_PUBLIC_API_KEY", requestOptions)
.then((response) => response.text())
.then((result) => console.log(result))
.catch((error) => console.error(error));
- lang: python
label: Python
source: |
import requests
url = "https://api.woosmap.com/stores/search/bounds?lat=51.50976&lng=-0.145276&radius=300&key=YOUR_PUBLIC_API_KEY"
payload = {}
headers = {
'Referer': 'http://localhost'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
/zones:
get:
summary: List your Zones
operationId: listZones
servers:
- url: https://api.woosmap.com
tags:
- Zones
description: |
List all zones for the current project, sorted by `zone_id`.
security:
- PrivateApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/limit-3'
- $ref: '#/components/parameters/offset'
responses:
'200':
description: Zones successfully retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/ZonesCollectionResponse'
examples:
default:
summary: Zones data
value:
zones:
- store_id: STORE_ID_123456
zone_id: ZoneB
polygon: POLYGON ((-122.4546384 37.774656, -122.4515485 37.7595934, -122.4354306 37.7602172, -122.4333707 37.7512596, -122.423071 37.7511239, -122.4242726 37.7687665, -122.4259893 37.7691736, -122.4289075 37.7732444, -122.4306241 37.7850483, -122.4472753 37.7830133, -122.445902 37.7759581, -122.4546384 37.774656))
types:
- delivery
description: Delivery Zone for Store B
- store_id: STORE_ID_45678
zone_id: ZoneC
polygon: POLYGON ((-122.4758889 37.7524995, -122.4751594 37.7321718, -122.4688079 37.7299995, -122.4648597 37.7261979, -122.4519851 37.7228035, -122.4483802 37.7215815, -122.4458053 37.726741, -122.4365356 37.7310857, -122.4315574 37.7324433, -122.4246909 37.7312214, -122.4219444 37.731493, -122.423071 37.7511239, -122.4333707 37.7512596, -122.4354306 37.7602172, -122.4515485 37.7595934, -122.4528628 37.7582744, -122.4540375 37.7566755, -122.4565266 37.7513144, -122.4601315 37.7521288, -122.4618481 37.7514501, -122.4635648 37.7530788, -122.4758889 37.7524995))
types:
- delivery
description: Delivery Zone for Store C
status: ok
'401':
description: Unauthorized. Incorrect authentication credentials.
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
examples:
Unauthorized:
summary: Error 401
value:
detail: Incorrect authentication credentials. Please check or use a valid API Key
'403':
description: Forbidden. This Woosmap API is not enabled for this project.
content:
application/json:
schema:
$ref: '#/components/schemas/Error403'
examples:
Forbidden:
summary: Error 403
value:
detail: This Woosmap API is not enabled for this project.
'429':
description: Too Many Requests. The rate limit for this endpoint has been exceeded.
content:
application/json:
schema:
$ref: '#/components/schemas/Error429'
examples:
Forbidden:
summary: Error 429
value:
detail: The rate limit for this endpoint has been exceeded
x-codeSamples:
- lang: curl
label: cURL
source: curl -L 'https://api.woosmap.com/zones/?private_key=YOUR_PRIVATE_API_KEY&limit=2&offset=1'
- lang: javascript
label: JavaScript
source: |-
const requestOptions = {
method: "GET",
redirect: "follow"
};
fetch("https://api.woosmap.com/zones/?private_key=YOUR_PRIVATE_API_KEY&limit=2&offset=1", requestOptions)
.then((response) => response.text())
.then((result) => console.log(result))
.catch((error) => console.error(error));
- lang: python
label: Python
source: |
import requests
url = "https://api.woosmap.com/zones/?private_key=YOUR_PRIVATE_API_KEY&limit=2&offset=1"
payload = {}
headers = {}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
post:
summary: Create your Zones
operationId: createZones
servers:
- url: https://api.woosmap.com
tags:
- Zones
description: |
Used to batch create Zones to a specific project identified with the `private_key` parameter.
security:
- PrivateApiKeyAuth: []
requestBody:
description: The request body of Zones Creation must be formatted as JSON.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ZonesCollectionRequest'
examples:
default:
summary: Zones data as JSON
value:
zones:
- zone_id: ZoneA
description: Delivery Zone for Store A
store_id: STORE_ID_123456
polygon: POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))
types:
- delivery
- zone_id: ZoneB
description: Delivery Zone for Store B
store_id: STORE_ID_123456
polygon: POLYGON ((-122.4546384 37.774656,-122.4515485 37.7595934,-122.4354306 37.7602172,-122.4333707 37.7512596,-122.423071 37.7511239,-122.4242726 37.7687665,-122.4259893 37.7691736,-122.4289075 37.7732444,-122.4306241 37.7850483,-122.4472753 37.7830133,-122.445902 37.7759581,-122.4546384 37.774656))
types:
- delivery
- zone_id: ZoneC
description: Delivery Zone for Store C
store_id: STORE_ID_45678
polygon: POLYGON ((-122.4758889 37.7524995,-122.4751594 37.7321718,-122.4688079 37.7299995,-122.4648597 37.7261979,-122.4519851 37.7228035,-122.4483802 37.7215815,-122.4458053 37.726741,-122.4365356 37.7310857,-122.4315574 37.7324433,-122.4246909 37.7312214,-122.4219444 37.731493,-122.423071 37.7511239,-122.4333707 37.7512596,-122.4354306 37.7602172,-122.4515485 37.7595934,-122.4528628 37.7582744,-122.4540375 37.7566755,-122.4565266 37.7513144,-122.4601315 37.7521288,-122.4618481 37.7514501,-122.4635648 37.7530788,-122.4758889 37.7524995))
types:
- delivery
responses:
'200':
description: Zones successfully created
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessZones'
examples:
default:
summary: Success response for Zones Created
value:
status: ok
message: Zones successfully added.
'400':
description: Invalid. The data is not a valid JSON.
content:
application/json:
schema:
$ref: '#/components/schemas/Error400'
examples:
Invalid:
summary: Error 400
value:
status: error
value: The request is invalid, the data is not a valid JSON.
'401':
description: Unauthorized. Incorrect authentication credentials.
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
examples:
Unauthorized:
summary: Error 401
value:
detail: Incorrect authentication credentials. Please check or use a valid API Key
'403':
description: Forbidden. This Woosmap API is not enabled for this project.
content:
application/json:
schema:
$ref: '#/components/schemas/Error403'
examples:
Forbidden:
summary: Error 403
value:
detail: This Woosmap API is not enabled for this project.
x-codeSamples:
- lang: curl
label: cURL
source: |-
curl -L 'https://api.woosmap.com/zones?private_key=YOUR_PRIVATE_API_KEY' \
-H 'content-type: application/json' \
-d '{
"zones": [
{
"zone_id": "ZoneA",
"description": "Delivery Zone for Store A",
"store_id": "STORE_ID_123456",
"polygon": "POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))",
"types": [
"delivery"
]
},
{
"zone_id": "ZoneB",
"description": "Delivery Zone for Store B",
"store_id": "STORE_ID_123456",
"polygon": "POLYGON ((-122.4546384 37.774656,-122.4515485 37.7595934,-122.4354306 37.7602172,-122.4333707 37.7512596,-122.423071 37.7511239,-122.4242726 37.7687665,-122.4259893 37.7691736,-122.4289075 37.7732444,-122.4306241 37.7850483,-122.4472753 37.7830133,-122.445902 37.7759581,-122.4546384 37.774656))",
"types": [
"delivery"
]
},
{
"zone_id": "ZoneC",
"description": "Delivery Zone for Store C",
"store_id": "STORE_ID_45678",
"polygon": "POLYGON ((-122.4758889 37.7524995,-122.4751594 37.7321718,-122.4688079 37.7299995,-122.4648597 37.7261979,-122.4519851 37.7228035,-122.4483802 37.7215815,-122.4458053 37.726741,-122.4365356 37.7310857,-122.4315574 37.7324433,-122.4246909 37.7312214,-122.4219444 37.731493,-122.423071 37.7511239,-122.4333707 37.7512596,-122.4354306 37.7602172,-122.4515485 37.7595934,-122.4528628 37.7582744,-122.4540375 37.7566755,-122.4565266 37.7513144,-122.4601315 37.7521288,-122.4618481 37.7514501,-122.4635648 37.7530788,-122.4758889 37.7524995))",
"types": [
"delivery"
]
}
]
}'
- lang: python
label: Python
source: |
import requests
import json
url = "https://api.woosmap.com/zones?private_key=YOUR_PRIVATE_API_KEY"
payload = json.dumps({
"zones": [
{
"zone_id": "ZoneA",
"description": "Delivery Zone for Store A",
"store_id": "STORE_ID_123456",
"polygon": "POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))",
"types": [
"delivery"
]
},
{
"zone_id": "ZoneB",
"description": "Delivery Zone for Store B",
"store_id": "STORE_ID_123456",
"polygon": "POLYGON ((-122.4546384 37.774656,-122.4515485 37.7595934,-122.4354306 37.7602172,-122.4333707 37.7512596,-122.423071 37.7511239,-122.4242726 37.7687665,-122.4259893 37.7691736,-122.4289075 37.7732444,-122.4306241 37.7850483,-122.4472753 37.7830133,-122.445902 37.7759581,-122.4546384 37.774656))",
"types": [
"delivery"
]
},
{
"zone_id": "ZoneC",
"description": "Delivery Zone for Store C",
"store_id": "STORE_ID_45678",
"polygon": "POLYGON ((-122.4758889 37.7524995,-122.4751594 37.7321718,-122.4688079 37.7299995,-122.4648597 37.7261979,-122.4519851 37.7228035,-122.4483802 37.7215815,-122.4458053 37.726741,-122.4365356 37.7310857,-122.4315574 37.7324433,-122.4246909 37.7312214,-122.4219444 37.731493,-122.423071 37.7511239,-122.4333707 37.7512596,-122.4354306 37.7602172,-122.4515485 37.7595934,-122.4528628 37.7582744,-122.4540375 37.7566755,-122.4565266 37.7513144,-122.4601315 37.7521288,-122.4618481 37.7514501,-122.4635648 37.7530788,-122.4758889 37.7524995))",
"types": [
"delivery"
]
}
]
})
headers = {
'content-type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
- lang: nodejs
label: NodeJS
source: |
const axios = require('axios');
let data = JSON.stringify({
"zones": [
{
"zone_id": "ZoneA",
"description": "Delivery Zone for Store A",
"store_id": "STORE_ID_123456",
"polygon": "POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))",
"types": [
"delivery"
]
},
{
"zone_id": "ZoneB",
"description": "Delivery Zone for Store B",
"store_id": "STORE_ID_123456",
"polygon": "POLYGON ((-122.4546384 37.774656,-122.4515485 37.7595934,-122.4354306 37.7602172,-122.4333707 37.7512596,-122.423071 37.7511239,-122.4242726 37.7687665,-122.4259893 37.7691736,-122.4289075 37.7732444,-122.4306241 37.7850483,-122.4472753 37.7830133,-122.445902 37.7759581,-122.4546384 37.774656))",
"types": [
"delivery"
]
},
{
"zone_id": "ZoneC",
"description": "Delivery Zone for Store C",
"store_id": "STORE_ID_45678",
"polygon": "POLYGON ((-122.4758889 37.7524995,-122.4751594 37.7321718,-122.4688079 37.7299995,-122.4648597 37.7261979,-122.4519851 37.7228035,-122.4483802 37.7215815,-122.4458053 37.726741,-122.4365356 37.7310857,-122.4315574 37.7324433,-122.4246909 37.7312214,-122.4219444 37.731493,-122.423071 37.7511239,-122.4333707 37.7512596,-122.4354306 37.7602172,-122.4515485 37.7595934,-122.4528628 37.7582744,-122.4540375 37.7566755,-122.4565266 37.7513144,-122.4601315 37.7521288,-122.4618481 37.7514501,-122.4635648 37.7530788,-122.4758889 37.7524995))",
"types": [
"delivery"
]
}
]
});
let config = {
method: 'post',
maxBodyLength: Infinity,
url: 'https://api.woosmap.com/zones?private_key=YOUR_PRIVATE_API_KEY',
headers: {
'content-type': 'application/json'
},
data : data
};
axios.request(config)
.then((response) => {
console.log(JSON.stringify(response.data));
})
.catch((error) => {
console.log(error);
});
put:
summary: Update the Zones
operationId: updateZones
servers:
- url: https://api.woosmap.com
tags:
- Zones
description: Used to update zones in batch. `zone_id` must exists when using `PUT` method, if one zone does not exists, the batch will be refused.
security:
- PrivateApiKeyAuth: []
requestBody:
description: The request body of Zones Update must be formatted as JSON.
content:
application/json:
schema:
$ref: '#/components/schemas/ZonesCollectionRequest'
examples:
default:
summary: Zones data
value:
zones:
- zone_id: ZoneA
description: Delivery Zone for Store A
store_id: STORE_ID_123456
polygon: POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))
types:
- delivery
- zone_id: ZoneB
description: Delivery Zone for Store B
store_id: STORE_ID_123456
polygon: POLYGON ((-122.4546384 37.774656,-122.4515485 37.7595934,-122.4354306 37.7602172,-122.4333707 37.7512596,-122.423071 37.7511239,-122.4242726 37.7687665,-122.4259893 37.7691736,-122.4289075 37.7732444,-122.4306241 37.7850483,-122.4472753 37.7830133,-122.445902 37.7759581,-122.4546384 37.774656))
types:
- delivery
- zone_id: ZoneC
description: Delivery Zone for Store C
store_id: STORE_ID_45678
polygon: POLYGON ((-122.4758889 37.7524995,-122.4751594 37.7321718,-122.4688079 37.7299995,-122.4648597 37.7261979,-122.4519851 37.7228035,-122.4483802 37.7215815,-122.4458053 37.726741,-122.4365356 37.7310857,-122.4315574 37.7324433,-122.4246909 37.7312214,-122.4219444 37.731493,-122.423071 37.7511239,-122.4333707 37.7512596,-122.4354306 37.7602172,-122.4515485 37.7595934,-122.4528628 37.7582744,-122.4540375 37.7566755,-122.4565266 37.7513144,-122.4601315 37.7521288,-122.4618481 37.7514501,-122.4635648 37.7530788,-122.4758889 37.7524995))
types:
- delivery
responses:
'200':
description: Zones successfully updated
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessZones'
examples:
default:
summary: Success response for Zones updated
value:
status: ok
message: Zones successfully added.
'400':
description: Invalid. The data is not a valid JSON.
content:
application/json:
schema:
$ref: '#/components/schemas/Error400'
examples:
Invalid:
summary: Error 400
value:
status: error
value: The request is invalid, the data is not a valid JSON.
'401':
description: Unauthorized. Incorrect authentication credentials.
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
examples:
Unauthorized:
summary: Error 401
value:
detail: Incorrect authentication credentials. Please check or use a valid API Key
'403':
description: Forbidden. This Woosmap API is not enabled for this project.
content:
application/json:
schema:
$ref: '#/components/schemas/Error403'
examples:
Forbidden:
summary: Error 403
value:
detail: This Woosmap API is not enabled for this project.
x-codeSamples:
- lang: curl
label: cURL
source: |-
curl -L -X PUT 'https://api.woosmap.com/zones?private_key=YOUR_PRIVATE_API_KEY' \
-H 'content-type: application/json' \
-d '{
"zones": [
{
"zone_id": "ZoneA",
"description": "Delivery Zone for Store A",
"store_id": "STORE_ID_45678",
"polygon": "POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))",
"types": [
"delivery"
]
}
]
}'
- lang: python
label: Python
source: |
import requests
import json
url = "https://api.woosmap.com/zones?private_key=YOUR_PRIVATE_API_KEY"
payload = json.dumps({
"zones": [
{
"zone_id": "ZoneA",
"description": "Delivery Zone for Store A",
"store_id": "STORE_ID_45678",
"polygon": "POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))",
"types": [
"delivery"
]
}
]
})
headers = {
'content-type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, data=payload)
print(response.text)
- lang: nodejs
label: NodeJS
source: |
const axios = require('axios');
let data = JSON.stringify({
"zones": [
{
"zone_id": "ZoneA",
"description": "Delivery Zone for Store A",
"store_id": "STORE_ID_45678",
"polygon": "POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))",
"types": [
"delivery"
]
}
]
});
let config = {
method: 'put',
maxBodyLength: Infinity,
url: 'https://api.woosmap.com/zones?private_key=YOUR_PRIVATE_API_KEY',
headers: {
'content-type': 'application/json'
},
data : data
};
axios.request(config)
.then((response) => {
console.log(JSON.stringify(response.data));
})
.catch((error) => {
console.log(error);
});
delete:
summary: Delete the Zones
operationId: deleteZones
servers:
- url: https://api.woosmap.com
tags:
- Zones
description: Used to delete one or more Zones.
security:
- PrivateApiKeyAuth: []
responses:
'200':
description: Zones successfully deleted
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessZones'
examples:
default:
summary: Success response for Zones deleted
value:
status: ok
message: Zones deleted.
'401':
description: Unauthorized. Incorrect authentication credentials.
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
examples:
Unauthorized:
summary: Error 401
value:
detail: Incorrect authentication credentials. Please check or use a valid API Key
'403':
description: Forbidden. This Woosmap API is not enabled for this project.
content:
application/json:
schema:
$ref: '#/components/schemas/Error403'
examples:
Forbidden:
summary: Error 403
value:
detail: This Woosmap API is not enabled for this project.
x-codeSamples:
- lang: curl
label: cURL
source: curl -L -X DELETE 'https://api.woosmap.com/zones/?private_key=YOUR_PRIVATE_API_KEY'
- lang: python
label: Python
source: |
import requests
url = "https://api.woosmap.com/zones/?private_key=YOUR_PRIVATE_API_KEY"
payload = {}
headers = {}
response = requests.request("DELETE", url, headers=headers, data=payload)
print(response.text)
- lang: nodejs
label: NodeJS
source: |
const axios = require('axios');
let config = {
method: 'delete',
maxBodyLength: Infinity,
url: 'https://api.woosmap.com/zones/?private_key=YOUR_PRIVATE_API_KEY',
headers: { }
};
axios.request(config)
.then((response) => {
console.log(JSON.stringify(response.data));
})
.catch((error) => {
console.log(error);
});
/zones/{zone_id}:
get:
summary: Get Zone from ID
operationId: getZone
servers:
- url: https://api.woosmap.com
tags:
- Zones
description: |
Used to retrieve a zone from his `zone_id`
security:
- PrivateApiKeyAuth: []
parameters:
- in: path
name: zone_id
schema:
type: string
required: true
example: ZoneA
description: ID of the zone to get
responses:
'200':
description: Zone successfully retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/Zone'
examples:
default:
summary: Get a zone from its zone_id
value:
store_id: STORE_ID_123456
zone_id: ZoneA
polygon: POLYGON ((-122.496116 37.7648181, -122.4954079 37.751518, -122.4635648 37.7530788, -122.4618481 37.7514501, -122.4601315 37.7521288, -122.4565266 37.7513144, -122.4540375 37.7566755, -122.4528359 37.7583041, -122.4515485 37.7595934, -122.4546384 37.774656, -122.4718903 37.7731635, -122.472577 37.772485, -122.4755811 37.7725529, -122.4791001 37.7723493, -122.4793576 37.7713995, -122.4784993 37.769839, -122.4783276 37.7680071, -122.4774693 37.766718, -122.4772118 37.7652931, -122.496116 37.7648181))
types:
- delivery
description: Delivery Zone for Store A
status: ok
'401':
description: Unauthorized. Incorrect authentication credentials.
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
examples:
Unauthorized:
summary: Error 401
value:
detail: Incorrect authentication credentials. Please check or use a valid API Key
'403':
description: Forbidden. This Woosmap API is not enabled for this project.
content:
application/json:
schema:
$ref: '#/components/schemas/Error403'
examples:
Forbidden:
summary: Error 403
value:
detail: This Woosmap API is not enabled for this project.
'404':
description: Not Found - `zone_id` do not exist.
x-codeSamples:
- lang: curl
label: cURL
source: curl -L 'https://api.woosmap.com/zones/ZoneA/?private_key=YOUR_PRIVATE_API_KEY'
- lang: javascript
label: JavaScript
source: |-
const requestOptions = {
method: "GET",
redirect: "follow"
};
fetch("https://api.woosmap.com/zones/ZoneA/?private_key=YOUR_PRIVATE_API_KEY", requestOptions)
.then((response) => response.text())
.then((result) => console.log(result))
.catch((error) => console.error(error));
- lang: python
label: Python
source: |
import requests
url = "https://api.woosmap.com/zones/ZoneA/?private_key=YOUR_PRIVATE_API_KEY"
payload = {}
headers = {}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
delete:
summary: Delete Zone from ID
operationId: deleteZone
servers:
- url: https://api.woosmap.com
tags:
- Zones
description: Used to delete one Zone. The `zone_id` is the id of the zone to delete. To delete several zones, use the comma as a separator.
security:
- PrivateApiKeyAuth: []
parameters:
- in: path
name: zone_id
schema:
type: string
required: true
example: ZoneA
description: ID of the zone to delete
responses:
'200':
description: Zones successfully deleted
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessZones'
examples:
default:
summary: Success response for Zones deleted
value:
status: ok
message: Zone ZoneA deleted.
'401':
description: Unauthorized. Incorrect authentication credentials.
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
examples:
Unauthorized:
summary: Error 401
value:
detail: Incorrect authentication credentials. Please check or use a valid API Key
'403':
description: Forbidden. This Woosmap API is not enabled for this project.
content:
application/json:
schema:
$ref: '#/components/schemas/Error403'
examples:
Forbidden:
summary: Error 403
value:
detail: This Woosmap API is not enabled for this project.
x-codeSamples:
- lang: curl
label: cURL
source: curl -L -X DELETE 'https://api.woosmap.com/zones/ZoneA/?private_key=YOUR_PRIVATE_API_KEY'
- lang: python
label: Python
source: |
import requests
url = "https://api.woosmap.com/zones/ZoneA/?private_key=YOUR_PRIVATE_API_KEY"
payload={}
headers = {}
response = requests.request("DELETE", url, headers=headers, data=payload)
print(response.text)
- lang: nodejs
label: NodeJS
source: |
var axios = require('axios');
var config = {
method: 'delete',
url: 'https://api.woosmap.com/zones/ZoneA/?private_key=YOUR_PRIVATE_API_KEY',
headers: { }
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
components:
parameters:
ip_address:
name: ip_address
description: |
The ip_address you want to geolocate. For **server call with private_key** only. Without this parameter, the API will geolocate the IP Address attached to the raw TCP request.
in: query
schema:
type: string
example: 75.134.29.90
limit:
name: limit
description: |
To limit number of assets retrieved from an IP location.
schema:
type: integer
minimum: 1
maximum: 300
example: 10
in: query
query:
name: query
in: query
schema:
type: string
example: name:'My cool store'|type:'click_and_collect'
description: |
Search query combining one or more search clauses. Each search clause is made up of three parts structured as `field` `:` `operator` `value`. , e.g. `name:="My cool store"`
### Vocabulary
- **Field**: attribute of the Store that is searched, e.g. the attribute `name` of the store.
- **Operator**: test that is performed on the data to provide a match, e.g. `=`.
Each field has a default operator. If none operator follow the `:`, the default one is used.
- **Value**: the content of the attribute that is tested, e.g. the name of the store `"My cool store"`.
Combine clauses with the conjunctions `AND` or `OR`, and negate the query with `NOT`.
### Fields
- `type`: An element is contained within `type` collection. e.g. `type:"myType"`
- `tag`: An element is contained within `tag` collection. e.g. `tag:"myTag"`
- `city`: text matching: the value match the `city` field. e.g. `city:="Paris"`
- `country`: text matching: the value match the `countryCode` field. e.g. `country:="FR"`
- `name`: text matching: the value match the `name` field. e.g. `name:="myName"`
- `idstore`: text matching: the value match the `idstore` field. e.g. `idstore:="myIdStore"`
- `user`: concerns all fields inside `user_properties`. text matching or numerical comparison. e.g. `user.myAttribute:="myValue"`
- `localized`: used for [localizedNames](https://developers.woosmap.com/products/data-api/data-structure/#localizednames) to search in native language. text matching in collection: the value match one of the the `localizedNames`. e.g. `localized:="centro"`
> **userProperties** field has no restriction regarding the data you can put in it (Arrays, Object, Boolean, String, Numeric...) but you can only query for **text matching or numerical comparison**.
### Operators
- `:` : Default and mandatory operator. For `type` and `tag` fields, define that an element is contained within a collection.
- `=` : The content of a string or a number is equal to the other.
- `>` : A number is greater than another.
- `<` : A number is smaller than another.
- `>=` : A number is greater than or equal to another.
- `<=` : A number is smaller than or equal to another.
- `AND` : Return assets that match both clauses.
- `OR` : Return assets that match either clauses.
- `NOT` : Negates a search clause.
For compound clauses, you can use parentheses to group clauses together. For example: ```(type:"type1" OR type:"type2") AND tag:"hockey"```
You can use `NOT` operator to negates a search clause. For example: ```not type:"type1"```
lat:
name: lat
description: |
Latitude bias for the results. Must be passed with `lng`.
schema:
type: number
example: 5.2
in: query
lng:
name: lng
description: |
Longitude bias for the results. Must be passed with `lat`.
schema:
type: number
example: 3.5
in: query
radius:
name: radius
description: |
Unit in meters. Used to combine with lat/lng or polyline. To bias the results within a given circular area. 3000 means to search for Assets that are at the most far from 3kms to search area (latlng or polyline). Without `radius`, `lat`/`lng` only sort the Assets by distance.
schema:
type: number
example: 3000
in: query
polyline:
name: polyline
description: |
Find assets nearby an [encoded polyline](https://developers.google.com/maps/documentation/utilities/polylinealgorithm) and inside a defined radius. Requires `radius`.
schema:
type: string
example: _p~iF~ps|U_ulLnnqC_mqNvxq`@
in: query
bounds:
name: bounds
description: |
Restricts the results to the Assets inside a bounding box, as `west,south,east,north` in decimal degrees. Takes precedence over `lat`/`lng` and `polyline`.
schema:
type: string
example: 2.29,48.85,2.35,48.87
in: query
stores_by_page:
name: stores_by_page
description: |
If your request returns a high number of assets, the result will be paginated. If so, you can request assets by page using `page` and `stores_by_page` parameters (Default is 100, max is 300).
schema:
type: integer
minimum: 1
maximum: 300
default: 100
example: 150
in: query
page:
name: page
description: |
Page number when accessing paginated assets feature collection
schema:
type: integer
minimum: 1
default: 1
example: 2
in: query
zone:
name: zone
in: query
schema:
type: boolean
example: true
description: |
returns the stores that are linked to a zone intersecting the provided `lat`,`lng` query parameters.
enhanced:
name: enhanced
in: query
schema:
type: boolean
example: true
description: |
Skips counting all matching assets, which makes paginated searches faster. When `true`, `pagination.pageCount` is no longer a total (see `hasNext`), and requesting a page past the last one returns an empty feature collection instead of an error.
language:
name: language
description: |
The language code, using ISO 639-2 Alpha-2 country codes, indicating in which language the `localized` name property should be searched , if present, or else the default `name` property.
schema:
type: string
example: en
in: query
limit-2:
name: limit
description: |
If your request returns a high number of assets you should use the `limit` parameters to return only the firsts matching elements (Default is 5, max is 50).
schema:
type: integer
minimum: 1
maximum: 50
default: 5
example: 15
in: query
limit-3:
name: limit
description: |
To limit number of zones retrieved (Default is 10, max is 50).
schema:
type: integer
minimum: 1
maximum: 50
default: 10
example: 10
in: query
offset:
name: offset
description: |
To retrieve zones starting from an offset value.
schema:
type: integer
minimum: 0
default: 0
example: 20
in: query
schemas:
LatLngLiteral:
title: LatLngLiteral
type: object
description: An object describing a specific location with Latitude and Longitude in decimal degrees.
required:
- lat
- lng
example:
lat: 43.3
lng: 3.46
properties:
lat:
type: number
description: Latitude in decimal degrees
example: 42.3
lng:
type: number
description: Longitude in decimal degrees
example: 3.46
Bounds:
title: Bounds
type: object
description: A rectangle in geographical coordinates from points at the southwest and northeast corners.
properties:
northeast:
$ref: '#/components/schemas/LatLngLiteral'
southwest:
$ref: '#/components/schemas/LatLngLiteral'
example:
northeast:
lat: 49.315678
lng: 4.15292
southwest:
lat: 49.31073
lng: 4.145162
Timezone:
title: Timezone
description: Timezone for the Opening Hours of an Asset. It is used to compute the `open_now` property of an asset. see
type: string
example: Europe/London
GeolocationResponse:
title: GeolocationResponse
type: object
description: A successful geolocation request will return a JSON-formatted response defining a location and radius.
properties:
viewport:
$ref: '#/components/schemas/Bounds'
accuracy:
description: The accuracy of the estimated location, in kilometers. This represents the radius of a circle around the given `location` where the IP address is likely to be. If your Geolocation response shows a low value in the `accuracy` field (<=50), the IP has strong chance to be correctly located.
type: number
example: 5
latitude:
description: Approximate latitude of the geographical area associated with the IP address
type: number
example: 38.719
longitude:
description: Approximate longitude of the geographical area associated with the IP address
type: number
example: -77.1067
country_code:
description: ISO 3166-1 Alpha-2 compatible country code
type:
- string
- 'null'
example: US
country_name:
description: Country name
type: string
example: United States
continent:
description: Continent name
type: string
example: North America
region_state:
description: Region name when available
type: string
example: Virginia
city:
description: City name when available
type: string
example: Alexandria
postal_code:
description: A postal code close to the user's location, when available
type: string
example: '22309'
timezone:
$ref: '#/components/schemas/Timezone'
raw_offset:
description: The offset from utc in seconds
type: integer
example: -18000
dst_offset:
description: The daylight saving time offset in seconds
type: integer
example: 3600
example:
country_code: US
country_name: United States
continent: North America
latitude: 38.719
longitude: -77.1067
viewport:
northeast:
lat: 38.763915764205976
lng: -77.0491321464058
southwest:
lat: 38.674084235794034
lng: -77.16426785359421
accuracy: 5
city: Alexandria
region_state: Virginia
postal_code: '22309'
timezone: America/New_York
raw_offset: -18000
dst_offset: 3600
Error401:
title: Error401
type: object
description: Authentication credentials are incorrect
properties:
detail:
description: Details for the credentials error
example: Incorrect authentication credentials. Please check or use a valid API Key
type: string
Error403:
title: Error403
type: object
description: API Request is authenticated but API Key don't have permission to access the resources
properties:
detail:
description: Details for the forbidden error message
example: This Woosmap API is not enabled for this project.
type: string
Error429:
title: Error429
type: object
description: Over Query Limit. Check the API Documentation for available QPS.
properties:
detail:
description: Details for the Over Query Limit error message
example: The rate limit for this endpoint has been exceeded
type: string
AssetName:
title: AssetName
description: The asset's name.
type: string
example: My Cool Store
AssetId:
title: AssetId
description: |
A textual identifier that uniquely identifies an Asset. It must matches the following regexp `[A-Za-z0-9]+`
type: string
example: STORE_ID_12345
AssetAddressResponse:
title: AssetAddressResponse
type: object
description: An object containing the separate components applicable to this address.
required:
- lines
- country_code
- city
- zipcode
properties:
lines:
description: An Array for lines of an Asset Address
type:
- array
- 'null'
items:
type: string
example:
- Building Centre
- 26 Store Street
country_code:
description: An ISO_3166-1 Country Code where the Asset is located (see for full list)
type:
- string
- 'null'
example: UK
city:
description: A City where belongs an Asset
type:
- string
- 'null'
example: London
zipcode:
description: An Zipcode / Postal code of an Asset Address
type:
- string
- 'null'
example: WC1E 7BT
example:
lines:
- 8 Southwark St
country_code: UK
city: London
zipcode: SE1 1TL
AssetContact:
title: AssetContact
type: object
description: An object containing the asset's contact available information.
properties:
website:
description: The website contact for this Asset, such as a business' homepage.
type: string
example: https://www.woosmap.com
phone:
description: Contains the Asset's phone number in its [local format](https://en.wikipedia.org/wiki/Local_conventions_for_writing_telephone_numbers).
type: string
example: +44 20 7693 4000
email:
description: Contains the Asset's email contact.
type: string
example: contact@woosmap.com
example:
website: https://www.woosmap.com
phone: +44 20 7693 4000
email: contact@woosmap.com
AssetOpeningHoursPeriod:
title: AssetOpeningHoursPeriod
type: object
description: The hours for an opening period. To define a slice of time where the asset is open you must define a `start` and `end` keys. `start` and `end` must belong to the same day (crossing midnight may result in open_now being always false.)
example:
start: '08:30'
end: '19:30'
required:
- start
- end
properties:
start:
description: Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00–23:59
type: string
example: '08:30'
end:
description: Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00–23:59
type: string
example: '19:30'
AssetOpenResponse:
title: AssetOpenResponse
type: object
description: The Current opening status for an Asset
required:
- open_now
- open_hours
- week_day
properties:
current_slice:
$ref: '#/components/schemas/AssetOpeningHoursPeriod'
open_hours:
description: the opening hours for the day
type: array
items:
$ref: '#/components/schemas/AssetOpeningHoursPeriod'
open_now:
description: Boolean value indicating the status of the opening hours
type: boolean
next_opening:
description: the next opening hours period, returned when the asset is closed. `null` when the asset does not open in the next days.
type:
- object
- 'null'
required:
- day
properties:
end:
description: the hours of next closing
type: string
example: '17:30'
start:
description: the hours of next opening
type: string
example: '06:00'
all-day:
description: true when the asset is open all day, in place of `start` and `end`
type: boolean
day:
type: string
description: the day of next opening
example: '2021-11-16'
week_day:
description: the day of the week starting from 1 to 7
type: integer
minimum: 1
maximum: 7
example:
open_now: true
open_hours:
- end: '20:00'
start: '05:00'
week_day: 1
current_slice:
end: '20:00'
start: '05:00'
AssetWeeklyOpeningHoursPeriod:
title: AssetWeeklyOpeningHoursPeriod
type: object
description: The opening Hours for Monday
properties:
hours:
type: array
items:
$ref: '#/components/schemas/AssetOpeningHoursPeriod'
isSpecial:
type: boolean
description: Define if the hours comes from a special opening hours day.
example: false
example:
hours:
- start: '06:30'
end: '18:00'
isSpecial: false
AssetWeeklyOpeningResponse:
title: AssetWeeklyOpeningResponse
type: object
description: The current Weekly Opening taking into account the special hours
properties:
'1':
$ref: '#/components/schemas/AssetWeeklyOpeningHoursPeriod'
'2':
$ref: '#/components/schemas/AssetWeeklyOpeningHoursPeriod'
'3':
$ref: '#/components/schemas/AssetWeeklyOpeningHoursPeriod'
'4':
$ref: '#/components/schemas/AssetWeeklyOpeningHoursPeriod'
'5':
$ref: '#/components/schemas/AssetWeeklyOpeningHoursPeriod'
'6':
$ref: '#/components/schemas/AssetWeeklyOpeningHoursPeriod'
'7':
$ref: '#/components/schemas/AssetWeeklyOpeningHoursPeriod'
timezone:
$ref: '#/components/schemas/Timezone'
example:
'1':
hours: []
isSpecial: false
'2':
hours:
- end: '22:00'
start: '08:30'
isSpecial: false
'3':
hours:
- end: '22:00'
start: '08:30'
isSpecial: false
'4':
hours:
- end: '22:00'
start: '08:30'
isSpecial: false
'5':
hours:
- end: '22:00'
start: '08:30'
isSpecial: false
'6':
hours:
- end: '22:00'
start: '08:30'
isSpecial: false
'7':
hours:
- end: '22:00'
start: '08:30'
isSpecial: false
timezone: Europe/London
AssetTypes:
title: AssetTypes
description: Contains an array of types describing the Asset.
type: array
items:
type: string
example: drive
example:
- drive
- click_and_collect
AssetTags:
title: AssetTags
description: Contains an array of tags describing the Asset. For example a list of available amenities.
type: array
items:
type: string
example: wifi
example:
- wifi
- covered_parking
AssetOpeningHoursUsual:
title: AssetOpeningHoursUsual
description: An object describing the usual opening hours of an Asset.
type: object
properties:
'1':
description: The opening Hours for Monday
type: array
items:
$ref: '#/components/schemas/AssetOpeningHoursPeriod'
'2':
description: The opening Hours for Tuesday
type: array
items:
$ref: '#/components/schemas/AssetOpeningHoursPeriod'
'3':
description: The opening Hours for Wednesday
type: array
items:
$ref: '#/components/schemas/AssetOpeningHoursPeriod'
'4':
description: The opening Hours for Thursday
type: array
items:
$ref: '#/components/schemas/AssetOpeningHoursPeriod'
'5':
description: The opening Hours for Friday
type: array
items:
$ref: '#/components/schemas/AssetOpeningHoursPeriod'
'6':
description: The opening Hours for Saturday
type: array
items:
$ref: '#/components/schemas/AssetOpeningHoursPeriod'
'7':
description: The opening Hours for Sunday
type: array
items:
$ref: '#/components/schemas/AssetOpeningHoursPeriod'
default:
description: Contains the default opening hours to apply to all week days
type: array
items:
$ref: '#/components/schemas/AssetOpeningHoursPeriod'
AssetOpeningHoursSpecial:
title: AssetOpeningHoursSpecial
description: An object describing the special opening hours of an Asset.
type: object
properties:
'2015-02-07':
description: |
The format for defining opening and closing hours for a particular day is the same as the usual. Instead of using numeric week day for keys you must use a date YYYY-MM-DD like "2015-03-08" (see ISO-8601).
type: array
items:
$ref: '#/components/schemas/AssetOpeningHoursPeriod'
'2015-02-08':
type: array
items:
$ref: '#/components/schemas/AssetOpeningHoursPeriod'
AssetOpeningHours:
title: AssetOpeningHours
type:
- object
- 'null'
description: An object describing the opening hours of an Asset.
properties:
timezone:
$ref: '#/components/schemas/Timezone'
usual:
$ref: '#/components/schemas/AssetOpeningHoursUsual'
special:
$ref: '#/components/schemas/AssetOpeningHoursSpecial'
example:
timezone: Europe/London
usual:
'1': []
default:
- start: '08:30'
end: '22:00'
special:
'2015-02-07':
- start: '08:00'
end: '23:00'
AssetResponse:
title: AssetResponse
type: object
description: Attributes describing an Asset.
required:
- store_id
- name
- address
- contact
- types
- tags
- last_updated
- user_properties
properties:
name:
$ref: '#/components/schemas/AssetName'
store_id:
$ref: '#/components/schemas/AssetId'
address:
$ref: '#/components/schemas/AssetAddressResponse'
contact:
$ref: '#/components/schemas/AssetContact'
open:
$ref: '#/components/schemas/AssetOpenResponse'
weekly_opening:
$ref: '#/components/schemas/AssetWeeklyOpeningResponse'
types:
$ref: '#/components/schemas/AssetTypes'
tags:
$ref: '#/components/schemas/AssetTags'
last_updated:
type:
- string
- 'null'
description: the previous date timestamp when the asset has been updated
example: '2022-11-08T15:48:08.556803+00:00'
user_properties:
description: Contains all additional information relative to an Asset. Empty object when not set.
type: object
additionalProperties: true
example:
some_user_properties: some_value
opening_hours:
$ref: '#/components/schemas/AssetOpeningHours'
localized_names:
description: Alternate names of the Asset, keyed by language. Only returned when set.
type: object
additionalProperties:
type: string
example:
fr: Centre Commercial Velizy
it: Centro Commerciale Velizy
distance:
description: The distance in meters from the geolocated position or searched position if exist
type: number
example: 544.581
LatLngArrayString:
title: LatLngArrayString
description: An array of comma separated {latitude,longitude} strings.
example:
- 43.4
- -2.1
type: array
minItems: 2
maxItems: 2
items:
type: number
GeoJsonPoint:
title: GeoJsonPoint
type: object
description: GeoJSon Point Geometry
required:
- type
- coordinates
properties:
type:
type: string
enum:
- Point
description: the geometry type
coordinates:
$ref: '#/components/schemas/LatLngArrayString'
example:
type: Point
coordinates:
- -0.14408
- 51.5088
AssetFeatureResponse:
title: AssetFeatureResponse
type: object
description: Asset Response as a GeoJSon Feature with Asset properties
required:
- type
- properties
- geometry
properties:
type:
description: the Geojson Type (only 'Feature')
type: string
enum:
- Feature
properties:
$ref: '#/components/schemas/AssetResponse'
geometry:
$ref: '#/components/schemas/GeoJsonPoint'
example:
type: Feature
properties:
store_id: '10031'
name: Santa Rosa & Yolanda
contact:
phone: 707-527-1006
website: https://www.starbucks.com/store-locator/store/10031/santa-rosa-yolanda-2688-santa-rosa-ave-santa-rosa-ca-954077625-us
address:
lines:
- 2688 Santa Rosa Ave
- Santa Rosa, CA 95407
country_code: US
city: Santa Rosa
zipcode: '954077625'
user_properties:
take_away: available
tags:
- DT
- WA
- CD
- DR
- LB
- GO
- XO
- MX
- NB
- BE
- LU
types:
- Coffee shop
last_updated: '2022-11-10T13:26:55.066524+00:00'
open:
open_now: false
open_hours:
- end: '20:00'
start: '05:00'
week_day: 2
next_opening:
day: '2025-09-16'
start: '05:00'
end: '20:00'
weekly_opening:
'1':
hours:
- end: '20:00'
start: '05:00'
isSpecial: false
'2':
hours:
- end: '20:00'
start: '05:00'
isSpecial: false
'3':
hours:
- end: '20:00'
start: '05:00'
isSpecial: false
'4':
hours:
- end: '20:00'
start: '05:00'
isSpecial: false
'5':
hours:
- end: '20:00'
start: '05:00'
isSpecial: false
'6':
hours:
- end: '20:00'
start: '05:00'
isSpecial: false
'7':
hours:
- end: '20:00'
start: '05:00'
isSpecial: false
timezone: America/Los_Angeles
opening_hours:
usual:
'1':
- end: '20:00'
start: '05:00'
'2':
- end: '20:00'
start: '05:00'
'3':
- end: '20:00'
start: '05:00'
'4':
- end: '20:00'
start: '05:00'
'5':
- end: '20:00'
start: '05:00'
'6':
- end: '20:00'
start: '05:00'
'7':
- end: '20:00'
start: '05:00'
special: {}
timezone: America/Los_Angeles
geometry:
type: Point
coordinates:
- -122.712924
- 38.41244
Pagination:
title: Pagination
type: object
description: Pagination to reach all returned assets. max 300 assets par page.
required:
- page
- pageCount
- hasNext
properties:
page:
type: integer
description: the request page
example: 1
pageCount:
type: integer
deprecated: true
description: |
Deprecated, use `hasNext` instead. The number of available pages. When the request is `enhanced`, this is not a total: it is `page + 1` if more assets are available, otherwise `page`.
example: 10
hasNext:
type: boolean
description: whether a next page of assets is available
example: true
AssetFeatureCollectionResponse:
title: AssetFeatureCollectionResponse
type: object
description: Assets Collection Response as a GeoJSon FeatureCollection with Asset properties
required:
- type
- features
- pagination
properties:
type:
description: the Geojson Type (only 'FeatureCollection')
type: string
enum:
- FeatureCollection
features:
description: the Assets Features
type: array
items:
$ref: '#/components/schemas/AssetFeatureResponse'
pagination:
$ref: '#/components/schemas/Pagination'
example:
type: FeatureCollection
features:
- type: Feature
properties:
store_id: '2354'
name: Berkeley Street/Berkeley Square
contact:
phone: '02076295779'
website: https://www.starbucks.com/store-locator/store/2354/berkeley-street-berkeley-square-27-berkeley-st-berkeley-square-london-eng-w-1-x-5-
address:
lines:
- 27 Berkeley St
- London, ENG W1X 5AD
country_code: GB
city: London
zipcode: W1X 5AD
user_properties:
take_away: available
tags:
- WA
- WF
- CD
- DR
- XO
types:
- Coffee shop
last_updated: '2022-11-10T13:23:53.564829+00:00'
distance: 135.28682936
open:
open_now: true
open_hours:
- end: '18:00'
start: '06:30'
week_day: 2
current_slice:
end: '18:00'
start: '06:30'
weekly_opening:
'1':
hours:
- end: '18:00'
start: '06:30'
isSpecial: false
'2':
hours:
- end: '18:00'
start: '06:30'
isSpecial: false
'3':
hours:
- end: '18:00'
start: '06:30'
isSpecial: false
'4':
hours:
- end: '18:00'
start: '06:30'
isSpecial: false
'5':
hours:
- end: '18:00'
start: '06:30'
isSpecial: false
'6':
hours:
- end: '17:00'
start: '08:00'
isSpecial: false
'7':
hours:
- end: '17:00'
start: '08:00'
isSpecial: false
timezone: Europe/London
opening_hours:
usual:
'1':
- end: '18:00'
start: '06:30'
'2':
- end: '18:00'
start: '06:30'
'3':
- end: '18:00'
start: '06:30'
'4':
- end: '18:00'
start: '06:30'
'5':
- end: '18:00'
start: '06:30'
'6':
- end: '17:00'
start: '08:00'
'7':
- end: '17:00'
start: '08:00'
special: {}
timezone: Europe/London
geometry:
type: Point
coordinates:
- -0.14408
- 51.5088
pagination:
page: 1
pageCount: 1
hasNext: false
GeolocationStoresResponse:
title: GeolocationStoresResponse
description: JSON-formatted response defining a location, radius, and stores if accuracy of geocoded IP is 20km or less.
type: object
properties:
stores:
$ref: '#/components/schemas/AssetFeatureCollectionResponse'
viewport:
$ref: '#/components/schemas/Bounds'
accuracy:
description: The accuracy of the estimated location, in kilometers. This represents the radius of a circle around the given `location` where the IP address is likely to be. If your Geolocation response shows a low value in the `accuracy` field (<=50), the IP has strong chance to be correctly located.
type: number
example: 5
latitude:
description: Approximate latitude of the geographical area associated with the IP address
type: number
example: 38.719
longitude:
description: Approximate longitude of the geographical area associated with the IP address
type: number
example: -77.1067
country_code:
description: ISO 3166-1 Alpha-2 compatible country code
type:
- string
- 'null'
example: US
country_name:
description: Country name
type: string
example: United States
continent:
description: Continent name
type: string
example: North America
region_state:
description: Region name when available
type: string
example: Virginia
city:
description: City name when available
type: string
example: Alexandria
postal_code:
description: A postal code close to the user's location, when available
type: string
example: '22309'
timezone:
$ref: '#/components/schemas/Timezone'
raw_offset:
description: The offset from utc in seconds
type: integer
example: -18000
dst_offset:
description: The daylight saving time offset in seconds
type: integer
example: 3600
example:
country_code: US
country_name: United States
continent: North America
latitude: 38.719
longitude: -77.1067
viewport:
northeast:
lat: 38.763915764205976
lng: -77.0491321464058
southwest:
lat: 38.674084235794034
lng: -77.16426785359421
accuracy: 5
city: Alexandria
region_state: Virginia
postal_code: '22309'
timezone: America/New_York
raw_offset: -18000
dst_offset: 3600
stores:
type: FeatureCollection
features:
- type: Feature
properties:
store_id: STORE_ID_123456
name: My Cool Store
contact:
email: contact@woosmap.com
phone: +44 20 7693 4000
website: https://www.woosmap.com
address:
lines:
- Building Centre
- 26 Store Street
country_code: UK
city: London
zipcode: WC1E 7BT
user_properties:
some_user_properties: associated user value
tags:
- wifi
- covered_parking
types:
- drive
- click_and_collect
last_updated: '2025-09-16T08:49:42.523114+00:00'
distance: 0
open:
open_now: true
open_hours:
- end: '22:00'
start: '08:30'
week_day: 2
current_slice:
end: '22:00'
start: '08:30'
weekly_opening:
'1':
hours: []
isSpecial: false
'2':
hours:
- end: '22:00'
start: '08:30'
isSpecial: false
'3':
hours:
- end: '22:00'
start: '08:30'
isSpecial: false
'4':
hours:
- end: '22:00'
start: '08:30'
isSpecial: false
'5':
hours:
- end: '22:00'
start: '08:30'
isSpecial: false
'6':
hours:
- end: '22:00'
start: '08:30'
isSpecial: false
'7':
hours:
- end: '22:00'
start: '08:30'
isSpecial: false
timezone: Europe/London
opening_hours:
usual:
'1': []
default:
- end: '22:00'
start: '08:30'
special:
'2015-02-07':
- end: '23:00'
start: '08:00'
timezone: Europe/London
geometry:
type: Point
coordinates:
- -77.1067
- 38.719
pagination:
page: 1
pageCount: 2
hasNext: true
TimezoneResponse:
title: TimezoneResponse
type: object
description: Timezone information, name, raw offset to UTC and dst offset.
properties:
timezone:
description: The time zone identifier eg. 'Europe/Paris'. see
title: Timezone id
type: string
timezone_name:
description: The timezone name eg. `PDT`
title: Timezone name
type: string
raw_offset:
description: offset from utc in seconds.
title: Raw offset
type: integer
dst_offset:
description: The daylight saving time offset in seconds.
title: Dst offset
type: integer
required:
- timezone
- timezone_name
- raw_offset
- dst_offset
example:
timezone: Europe/Paris
timezone_name: CEST
raw_offset: 3600
dst_offset: 3600
AssetAddressLines:
title: AssetAddressLines
description: An Array for lines of an Asset Address
type: array
example:
- Building Centre
- 26 Store Street
items:
type: string
example: 26 Store Street
AssetAddressRequest:
title: AssetAddressRequest
type: object
description: An object containing the separate components applicable to this address.
properties:
lines:
$ref: '#/components/schemas/AssetAddressLines'
countryCode:
description: An ISO_3166-1 Country Code where the Asset is located (see for full list)
type:
- string
- 'null'
example: UK
city:
description: A City where belongs an Asset
type: string
example: London
zipcode:
description: An Zipcode / Postal code of an Asset Address
type: string
example: WC1E 7BT
example:
lines:
- 8 Southwark St
countryCode: UK
city: London
zipcode: WC1E 7BT
AssetRequest:
title: AssetRequest
type: object
description: Attributes describing an Asset Request.
required:
- location
- name
- storeId
properties:
location:
$ref: '#/components/schemas/LatLngLiteral'
name:
$ref: '#/components/schemas/AssetName'
storeId:
$ref: '#/components/schemas/AssetId'
address:
$ref: '#/components/schemas/AssetAddressRequest'
contact:
$ref: '#/components/schemas/AssetContact'
types:
$ref: '#/components/schemas/AssetTypes'
tags:
$ref: '#/components/schemas/AssetTags'
userProperties:
description: Contains all additional information relative to an Asset. If not set it returns null value.
type:
- object
- 'null'
additionalProperties: true
example:
some_user_properties: some_value
localizedNames:
description: Alternate names for your assets. These localized names are useful for multi-language integrations. Combined with our Autocomplete API endpoint you can let your users find your store in their native language.
type: object
example:
ar: مركز فيليتزي التجاري
fr: Centre Commercial Velizy
it: Centro Commerciale Velizy
gb: Velizy Shopping Center
openingHours:
$ref: '#/components/schemas/AssetOpeningHours'
AssetsCollectionRequest:
title: AssetsCollectionRequest
description: A Collection of Woosmap Assets as expected for Data Management Data API.
type: object
required:
- stores
properties:
stores:
description: The Assets collection
type: array
items:
$ref: '#/components/schemas/AssetRequest'
example:
stores:
- types:
- drive
- click_and_collect
tags:
- wifi
- covered_parking
location:
lat: 38.719
lng: -77.1067
storeId: STORE_ID_123456
name: My Cool Store
address:
lines:
- Building Centre
- 26 Store Street
countryCode: UK
city: London
zipcode: WC1E 7BT
contact:
website: https://www.woosmap.com
phone: +44 20 7693 4000
email: contact@woosmap.com
userProperties:
some_user_properties: associated user value
openingHours:
timezone: Europe/London
usual:
'1': []
default:
- start: '08:30'
end: '22:00'
special:
'2015-02-07':
- start: '08:00'
end: '23:00'
- types:
- drive
tags:
- covered_parking
location:
lat: 38.5239
lng: -77.0157
storeId: STORE_ID_45678
name: My Cool Store 2
address:
lines:
- 1805-1899
- Orchard St
countryCode: US
city: Alexandria
zipcode: '22309'
contact:
website: https://www.woosmap.com
phone: +44 20 7693 4000
email: contact@woosmap.com
userProperties:
some_user_properties: associated user value
openingHours:
timezone: America/New_York
usual:
'1': []
default:
- start: '08:30'
end: '22:00'
Success:
title: Success
type: object
description: Message returned to a success request
properties:
status:
type: string
description: the status of the 200 response
example: success
value:
description: The value of request for this 200 response
example: 129 stores
oneOf:
- type: string
- type: integer
Error400:
title: Error400
type: object
description: The request is invalid
properties:
status:
type: string
description: the status of the 400 response
example: error
value:
description: the value of request causing the Error
example: The request is invalid, the data is not a valid JSON.
type: string
MatchedSubstring:
title: MatchedSubstring
type: object
required:
- offset
- length
properties:
length:
description: Length of the matched substring in the prediction result text.
type: integer
offset:
description: Start location of the matched substring in the prediction result text.
type: integer
example:
offset: 0
length: 4
AssetAutocompletePrediction:
title: AssetAutocompletePrediction
type: object
description: An Asset matching the autocomplete query.
required:
- store_id
- name
- types
- matched_substrings
- highlighted
properties:
name:
description: |
The `name` property of each prediction will be filled with the localized name of your asset in the `language` you provided in your query if it exists, or else the default name property.
type: string
example: Centro Commerciale Deria
highlighted:
type: string
description: an HTML formatted string with, if it exists, the matched substring(s) in bold font.
example: Centro Commerciale Deria
store_id:
$ref: '#/components/schemas/AssetId'
types:
$ref: '#/components/schemas/AssetTypes'
matched_substrings:
type: array
items:
$ref: '#/components/schemas/MatchedSubstring'
AssetAutocompleteResponse:
title: AssetAutocompleteResponse
type: object
description: Asset Autocomplete Response with highlighted results on asset name.
required:
- predictions
properties:
predictions:
description: A list of predictions based on similarity in all the `localizedNames` passed in query (or similarity to `store_name` if no `localizedNames` exist)
type: array
items:
$ref: '#/components/schemas/AssetAutocompletePrediction'
example:
predictions:
- store_id: '2670'
name: Sun Street
types:
- Coffee shop
matched_substrings:
- offset: 4
length: 6
highlighted: Sun Street
- store_id: '16069'
name: 7th Street
types:
- Coffee shop
matched_substrings:
- offset: 4
length: 6
highlighted: 7th Street
- store_id: '1013873'
name: The Street
types:
- Coffee shop
matched_substrings:
- offset: 4
length: 6
highlighted: The Street
BoundsResponse:
title: BoundsResponse
type: object
description: Message returned to a success Search Bounds request
required:
- bounds
properties:
bounds:
description: The bounds object, empty when no asset matches.
type: object
properties:
west:
description: The west longitude of bounds
type: number
example: -0.14408
south:
description: The south latitude of bounds
type: number
example: -51.5088
east:
description: The east longitude of bounds
type: number
example: -0.14408
north:
description: The north latitude of bounds
type: number
example: 51.5088
Zone:
title: Zone
type: object
description: Attributes describing a Zone.
required:
- store_id
- zone_id
- polygon
properties:
zone_id:
description: A textual identifier that uniquely identifies a Zone.
type: string
example: ZoneA
description:
type: string
description: Textual description of your Zone
example: Delivery Zone for Store A
store_id:
$ref: '#/components/schemas/AssetId'
polygon:
type: string
description: Zone geometry polygon as **Well Known Text**. WKT defines how to represent geometry of one object (cf. https://en.wikipedia.org/wiki/Well-known_text). Your zones could be complex and multipart polygons.
example: POLYGON ((-122.4546384 37.774656,-122.4515485 37.7595934,-122.4354306 37.7602172,-122.4333707 37.7512596,-122.423071 37.7511239,-122.4242726 37.7687665,-122.4259893 37.7691736,-122.4289075 37.7732444,-122.4306241 37.7850483,-122.4472753 37.7830133,-122.445902 37.7759581,-122.4546384 37.774656))
types:
description: Contains an array of types describing the Zone.
type: array
items:
type: string
example:
- delivery
- san_francisco_west
status:
type: string
description: the status as string
example: ok
example:
store_id: STORE_ID_123456
zone_id: ZoneA
polygon: POLYGON ((-122.496116 37.7648181, -122.4954079 37.751518, -122.4635648 37.7530788, -122.4618481 37.7514501, -122.4601315 37.7521288, -122.4565266 37.7513144, -122.4540375 37.7566755, -122.4528359 37.7583041, -122.4515485 37.7595934, -122.4546384 37.774656, -122.4718903 37.7731635, -122.472577 37.772485, -122.4755811 37.7725529, -122.4791001 37.7723493, -122.4793576 37.7713995, -122.4784993 37.769839, -122.4783276 37.7680071, -122.4774693 37.766718, -122.4772118 37.7652931, -122.496116 37.7648181))
types:
- delivery
description: Delivery Zone for Store A
status: ok
ZonesCollectionResponse:
title: ZonesCollectionResponse
type: object
description: A Collection of Woosmap Zones retrieved in response to a get zones list.
properties:
zones:
description: The Zones collection
type: array
items:
$ref: '#/components/schemas/Zone'
status:
type: string
description: the status as string
example: ok
example:
zones:
- store_id: STORE_ID_123456
zone_id: ZoneB
polygon: POLYGON ((-122.4546384 37.774656, -122.4515485 37.7595934, -122.4354306 37.7602172, -122.4333707 37.7512596, -122.423071 37.7511239, -122.4242726 37.7687665, -122.4259893 37.7691736, -122.4289075 37.7732444, -122.4306241 37.7850483, -122.4472753 37.7830133, -122.445902 37.7759581, -122.4546384 37.774656))
types:
- delivery
description: Delivery Zone for Store B
- store_id: STORE_ID_45678
zone_id: ZoneC
polygon: POLYGON ((-122.4758889 37.7524995, -122.4751594 37.7321718, -122.4688079 37.7299995, -122.4648597 37.7261979, -122.4519851 37.7228035, -122.4483802 37.7215815, -122.4458053 37.726741, -122.4365356 37.7310857, -122.4315574 37.7324433, -122.4246909 37.7312214, -122.4219444 37.731493, -122.423071 37.7511239, -122.4333707 37.7512596, -122.4354306 37.7602172, -122.4515485 37.7595934, -122.4528628 37.7582744, -122.4540375 37.7566755, -122.4565266 37.7513144, -122.4601315 37.7521288, -122.4618481 37.7514501, -122.4635648 37.7530788, -122.4758889 37.7524995))
types:
- delivery
description: Delivery Zone for Store C
status: ok
ZonesCollectionRequest:
title: ZonesCollectionRequest
type: object
description: A Collection of Woosmap Zones as expected for Data Management Data API.
required:
- zones
properties:
zones:
description: The Zones collection
type: array
items:
$ref: '#/components/schemas/Zone'
example:
zones:
- zone_id: ZoneA
description: Delivery Zone for Store A
store_id: STORE_ID_123456
polygon: POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))
types:
- delivery
- zone_id: ZoneB
description: Delivery Zone for Store B
store_id: STORE_ID_123456
polygon: POLYGON ((-122.4546384 37.774656,-122.4515485 37.7595934,-122.4354306 37.7602172,-122.4333707 37.7512596,-122.423071 37.7511239,-122.4242726 37.7687665,-122.4259893 37.7691736,-122.4289075 37.7732444,-122.4306241 37.7850483,-122.4472753 37.7830133,-122.445902 37.7759581,-122.4546384 37.774656))
types:
- delivery
- zone_id: ZoneC
description: Delivery Zone for Store C
store_id: STORE_ID_45678
polygon: POLYGON ((-122.4758889 37.7524995,-122.4751594 37.7321718,-122.4688079 37.7299995,-122.4648597 37.7261979,-122.4519851 37.7228035,-122.4483802 37.7215815,-122.4458053 37.726741,-122.4365356 37.7310857,-122.4315574 37.7324433,-122.4246909 37.7312214,-122.4219444 37.731493,-122.423071 37.7511239,-122.4333707 37.7512596,-122.4354306 37.7602172,-122.4515485 37.7595934,-122.4528628 37.7582744,-122.4540375 37.7566755,-122.4565266 37.7513144,-122.4601315 37.7521288,-122.4618481 37.7514501,-122.4635648 37.7530788,-122.4758889 37.7524995))
types:
- delivery
SuccessZones:
title: SuccessZones
type: object
description: Message returned to a success Zones request
properties:
status:
type: string
description: the status of the 2OO Zones response
example: success
message:
description: message returned with the 2OO Zones request
example: Zones successfully updated.
type: string
securitySchemes:
PrivateApiKeyAuth:
description: A Private key generated specifically to authenticate API requests on server side. Required for Data management API. See how to [register a Private API Key](https://developers.woosmap.com/api-reference/authentication/#registering-a-woosmap-private-api-key).
type: apiKey
in: query
name: private_key
PublicApiKeyAuth:
description: A Public key generated specifically to authenticate API requests on the front side. See how to [register a Public API Key](https://developers.woosmap.com/api-reference/authentication/#registering-a-woosmap-public-api-key).
type: apiKey
in: query
name: key
RefererHeader:
description: The Referer HTTP request header is mandatory when using PublicApiKeyAuth. In browser environment, the Referer is set by the browser itself and cannot be overridden.
type: apiKey
in: header
name: Referer
PrivateApiKeyHeaderAuth:
description: A Private key to authenticate API requests through the Header instead of Query parameter. Use either PrivateApiKeyHeaderAuth or PrivateApiKeyAuth. See how to [register a Private API Key](https://developers.woosmap.com/api-reference/authentication/#registering-a-woosmap-private-api-key).
type: apiKey
in: header
name: X-Api-Key