Oquira BusinessManage your physical business locations and their details.
Locations represent physical points of presence (stores, agencies, clinics) where services are provided to customers.
Define a new physical location for your organization.
POST /v1/locations
X-API-Key: your_api_key_here
Content-Type: application/json
{
"organizationId": "org_123...",
"name": "Paris Flagship Store",
"address": "123 Champs-Élysées, 75008 Paris, France",
"latitude": 48.8738,
"longitude": 2.2950,
"phone": "+33123456789",
"email": "paris@mybusiness.com",
"timezone": "Europe/Paris"
}| Property | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Name of the location. |
address | string | Yes | Full physical address. |
latitude | number | Yes | WGS84 latitude. |
longitude | number | Yes | WGS84 longitude. |
timezone | string | No | Timezone (e.g., Europe/Paris, UTC). |
Retrieve all locations belonging to your organization.
GET /v1/business/locations
X-API-Key: your_api_key_hereSearch for locations within an organization by name or address.
GET /v1/locations/search?organizationId={organizationId}&q=Paris
X-API-Key: your_api_key_hereFind locations within a specific radius of coordinates.
GET /v1/locations/nearby?lat=48.8&lon=2.3&radiusKm=5
X-API-Key: your_api_key_here| Parameter | Type | Required | Description |
|---|---|---|---|
lat | number | Yes | Center latitude. |
lon | number | Yes | Center longitude. |
radiusKm | number | Yes | Search radius in kilometers. |
limit | number | No | Max number of results. |
Modify details of an existing physical location.
PATCH /v1/locations/{locationId}
X-API-Key: your_api_key_here
Content-Type: application/json
{
"name": "Paris Gallery",
"phone": "+33100000000"
}Permanently remove a location. This will also affect services and queues linked to this location.
DELETE /v1/locations/{locationId}
X-API-Key: your_api_key_here