Get a location
curl --request GET \
--url https://api.prod.commenda.io/api/v1/partner/commenda-os/customers/{customerId}/business-entities/{businessEntityId}/locations/{locationId} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.prod.commenda.io/api/v1/partner/commenda-os/customers/{customerId}/business-entities/{businessEntityId}/locations/{locationId}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.prod.commenda.io/api/v1/partner/commenda-os/customers/{customerId}/business-entities/{businessEntityId}/locations/{locationId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.prod.commenda.io/api/v1/partner/commenda-os/customers/{customerId}/business-entities/{businessEntityId}/locations/{locationId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.prod.commenda.io/api/v1/partner/commenda-os/customers/{customerId}/business-entities/{businessEntityId}/locations/{locationId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.prod.commenda.io/api/v1/partner/commenda-os/customers/{customerId}/business-entities/{businessEntityId}/locations/{locationId}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prod.commenda.io/api/v1/partner/commenda-os/customers/{customerId}/business-entities/{businessEntityId}/locations/{locationId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"location": {
"id": "loc_123",
"businessEntityId": 44,
"locationTypes": [
"OPERATIONS"
],
"address": {
"addressLine1": "548 Market St",
"postalCode": "94104",
"country": "US",
"addressLine2": "Suite 21045",
"addressLine3": "<string>",
"city": "San Francisco",
"state": "CA"
},
"createdAt": 1735689600000,
"updatedAt": 1735776000000,
"name": "Delaware HQ",
"startDate": "2025-01-01",
"employeeCount": 12
}
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}Locations
Get a location
Retrieve a single location for a customer’s business entity.
GET
/
partner
/
commenda-os
/
customers
/
{customerId}
/
business-entities
/
{businessEntityId}
/
locations
/
{locationId}
Get a location
curl --request GET \
--url https://api.prod.commenda.io/api/v1/partner/commenda-os/customers/{customerId}/business-entities/{businessEntityId}/locations/{locationId} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.prod.commenda.io/api/v1/partner/commenda-os/customers/{customerId}/business-entities/{businessEntityId}/locations/{locationId}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.prod.commenda.io/api/v1/partner/commenda-os/customers/{customerId}/business-entities/{businessEntityId}/locations/{locationId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.prod.commenda.io/api/v1/partner/commenda-os/customers/{customerId}/business-entities/{businessEntityId}/locations/{locationId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.prod.commenda.io/api/v1/partner/commenda-os/customers/{customerId}/business-entities/{businessEntityId}/locations/{locationId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.prod.commenda.io/api/v1/partner/commenda-os/customers/{customerId}/business-entities/{businessEntityId}/locations/{locationId}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prod.commenda.io/api/v1/partner/commenda-os/customers/{customerId}/business-entities/{businessEntityId}/locations/{locationId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"location": {
"id": "loc_123",
"businessEntityId": 44,
"locationTypes": [
"OPERATIONS"
],
"address": {
"addressLine1": "548 Market St",
"postalCode": "94104",
"country": "US",
"addressLine2": "Suite 21045",
"addressLine3": "<string>",
"city": "San Francisco",
"state": "CA"
},
"createdAt": 1735689600000,
"updatedAt": 1735776000000,
"name": "Delaware HQ",
"startDate": "2025-01-01",
"employeeCount": 12
}
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}Retrieve a single location for a customer’s business entity.
Authorizations
Path Parameters
Commenda customer identifier.
Commenda business-entity identifier for the specified customer.
Commenda location identifier.
Response
Location retrieved successfully
Show child attributes
Show child attributes
Was this page helpful?
⌘I