Look up published recipe
curl --request GET \
--url https://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/recipes/published \
--header 'x-api-key: <x-api-key>'import requests
url = "https://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/recipes/published"
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}/recipes/published', 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}/recipes/published",
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}/recipes/published"
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}/recipes/published")
.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}/recipes/published")
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": "rec_01j5k...",
"recipe_type": "SALES_RECIPE",
"status": "PUBLISHED",
"version": 2,
"recipe_name": "Classic Burger",
"external_product_id": "prod-burger-001",
"recipe": {
"lines": [
{
"consume_by": "ITEM",
"item_id": "itm_beef_01...",
"qty_base": 180,
"base_unit_id": "unit_g_01..."
}
]
},
"published_at": "2026-08-01T10:00:00.000Z"
}
{
"error": {
"kind": "recipe_not_found",
"message": "No published recipe found for the given parameters"
}
}
Recipes
Look up published recipe
Finds the currently published recipe for a product/variant/service combination.
GET
/
api
/
v1
/
public
/
vendors
/
{vendorId}
/
recipes
/
published
Look up published recipe
curl --request GET \
--url https://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/recipes/published \
--header 'x-api-key: <x-api-key>'import requests
url = "https://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/recipes/published"
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}/recipes/published', 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}/recipes/published",
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}/recipes/published"
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}/recipes/published")
.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}/recipes/published")
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": "rec_01j5k...",
"recipe_type": "SALES_RECIPE",
"status": "PUBLISHED",
"version": 2,
"recipe_name": "Classic Burger",
"external_product_id": "prod-burger-001",
"recipe": {
"lines": [
{
"consume_by": "ITEM",
"item_id": "itm_beef_01...",
"qty_base": 180,
"base_unit_id": "unit_g_01..."
}
]
},
"published_at": "2026-08-01T10:00:00.000Z"
}
{
"error": {
"kind": "recipe_not_found",
"message": "No published recipe found for the given parameters"
}
}
string
required
BOH API key with
recipes:read scope.string
required
Vendor UUID.
string
Your POS product ID.
string
Your POS variant ID.
string
BOH store UUID.
string
Service/channel code (e.g.
DELIVERY, DINE_IN).string
Recipe UUID.
string
Recipe type.
string
PUBLISHED.string
Display name.
object
Recipe content with lines.
{
"id": "rec_01j5k...",
"recipe_type": "SALES_RECIPE",
"status": "PUBLISHED",
"version": 2,
"recipe_name": "Classic Burger",
"external_product_id": "prod-burger-001",
"recipe": {
"lines": [
{
"consume_by": "ITEM",
"item_id": "itm_beef_01...",
"qty_base": 180,
"base_unit_id": "unit_g_01..."
}
]
},
"published_at": "2026-08-01T10:00:00.000Z"
}
{
"error": {
"kind": "recipe_not_found",
"message": "No published recipe found for the given parameters"
}
}
⌘I

