Obter um estabelecimento
curl --request GET \
--url https://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/identity/stores/{storeId} \
--header 'x-api-key: <x-api-key>'import requests
url = "https://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/identity/stores/{storeId}"
headers = {"x-api-key": "<x-api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};
fetch('https://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/identity/stores/{storeId}', 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://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/identity/stores/{storeId}",
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: <x-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://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/identity/stores/{storeId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<x-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://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/identity/stores/{storeId}")
.header("x-api-key", "<x-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/identity/stores/{storeId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<x-api-key>'
response = http.request(request)
puts response.read_body{
"id": "str_principal_01...",
"account_id": "acc_01j5k...",
"code": "EST-001",
"name": "Cozinha Principal",
"timezone": "America/Sao_Paulo",
"status": "ACTIVE",
"external_store_id": "loja-principal",
"tax_id": "12.345.678/0001-90",
"metadata": {}
}
{
"error": {
"kind": "store_not_found",
"message": "Store not found"
}
}
Estabelecimentos
Obter um estabelecimento
Retorna um único estabelecimento com detalhes completos incluindo metadata.
GET
/
api
/
v1
/
public
/
vendors
/
{vendorId}
/
identity
/
stores
/
{storeId}
Obter um estabelecimento
curl --request GET \
--url https://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/identity/stores/{storeId} \
--header 'x-api-key: <x-api-key>'import requests
url = "https://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/identity/stores/{storeId}"
headers = {"x-api-key": "<x-api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};
fetch('https://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/identity/stores/{storeId}', 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://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/identity/stores/{storeId}",
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: <x-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://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/identity/stores/{storeId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<x-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://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/identity/stores/{storeId}")
.header("x-api-key", "<x-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/identity/stores/{storeId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<x-api-key>'
response = http.request(request)
puts response.read_body{
"id": "str_principal_01...",
"account_id": "acc_01j5k...",
"code": "EST-001",
"name": "Cozinha Principal",
"timezone": "America/Sao_Paulo",
"status": "ACTIVE",
"external_store_id": "loja-principal",
"tax_id": "12.345.678/0001-90",
"metadata": {}
}
{
"error": {
"kind": "store_not_found",
"message": "Store not found"
}
}
string
obrigatório
API key do BOH com escopo
catalog:read.string
obrigatório
UUID do vendor.
string
obrigatório
UUID do estabelecimento.
string
UUID do estabelecimento.
string
UUID da conta.
string
Código alfanumérico curto.
string
Nome de exibição.
string
Identificador de fuso horário IANA.
string
ACTIVE ou INACTIVE.string
Identificador no seu sistema.
string
Identificador fiscal do estabelecimento (RUC, CNPJ, CUIT…).
null se não configurado.object
Dados adicionais livres.
{
"id": "str_principal_01...",
"account_id": "acc_01j5k...",
"code": "EST-001",
"name": "Cozinha Principal",
"timezone": "America/Sao_Paulo",
"status": "ACTIVE",
"external_store_id": "loja-principal",
"tax_id": "12.345.678/0001-90",
"metadata": {}
}
{
"error": {
"kind": "store_not_found",
"message": "Store not found"
}
}
⌘I

