Get item
curl --request GET \
--url https://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/catalog/items/{itemId} \
--header 'x-api-key: <x-api-key>'import requests
url = "https://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/catalog/items/{itemId}"
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}/catalog/items/{itemId}', 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}/catalog/items/{itemId}",
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}/catalog/items/{itemId}"
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}/catalog/items/{itemId}")
.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}/catalog/items/{itemId}")
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": "itm_01j5k...",
"account_id": "acc_01j...",
"external_item_id": "SKU-001",
"code": "FLOUR-KG",
"name": "All-purpose flour",
"type": "INGREDIENT",
"procurement_type": "PURCHASED",
"unit_group_id": "ug_mass_01...",
"base_unit_id": "unit_g_01...",
"is_inventory_tracked": true,
"is_active": true,
"count_frequency": "WEEKLY",
"metadata": {},
"created_at": "2026-01-10T09:00:00.000Z",
"updated_at": "2026-07-01T12:00:00.000Z"
}
{
"error": {
"kind": "item_not_found",
"message": "Item not found"
}
}
Catalog Items
Get item
Returns a single inventory item with its full detail including metadata.
GET
/
api
/
v1
/
public
/
vendors
/
{vendorId}
/
catalog
/
items
/
{itemId}
Get item
curl --request GET \
--url https://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/catalog/items/{itemId} \
--header 'x-api-key: <x-api-key>'import requests
url = "https://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/catalog/items/{itemId}"
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}/catalog/items/{itemId}', 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}/catalog/items/{itemId}",
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}/catalog/items/{itemId}"
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}/catalog/items/{itemId}")
.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}/catalog/items/{itemId}")
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": "itm_01j5k...",
"account_id": "acc_01j...",
"external_item_id": "SKU-001",
"code": "FLOUR-KG",
"name": "All-purpose flour",
"type": "INGREDIENT",
"procurement_type": "PURCHASED",
"unit_group_id": "ug_mass_01...",
"base_unit_id": "unit_g_01...",
"is_inventory_tracked": true,
"is_active": true,
"count_frequency": "WEEKLY",
"metadata": {},
"created_at": "2026-01-10T09:00:00.000Z",
"updated_at": "2026-07-01T12:00:00.000Z"
}
{
"error": {
"kind": "item_not_found",
"message": "Item not found"
}
}
string
required
BOH API key with
catalog:read scope.string
required
Vendor UUID.
string
required
Item UUID.
string
BOH-assigned UUID.
string
Account UUID.
string | null
Your system’s identifier.
string | null
Short alphanumeric code.
string
Display name.
string
INGREDIENT, PACKAGING, SUPPLY, PREPARED_ITEM, FINISHED_GOOD.string
PURCHASED, PRODUCED, PURCHASED_AND_PRODUCED.string
UUID of the unit group.
string
UUID of the base unit.
boolean
Whether stock movements are recorded.
boolean
false when archived.string | null
Suggested count cycle.
object
Free-form extra data.
string
ISO 8601 creation timestamp.
string
ISO 8601 last-update timestamp.
{
"id": "itm_01j5k...",
"account_id": "acc_01j...",
"external_item_id": "SKU-001",
"code": "FLOUR-KG",
"name": "All-purpose flour",
"type": "INGREDIENT",
"procurement_type": "PURCHASED",
"unit_group_id": "ug_mass_01...",
"base_unit_id": "unit_g_01...",
"is_inventory_tracked": true,
"is_active": true,
"count_frequency": "WEEKLY",
"metadata": {},
"created_at": "2026-01-10T09:00:00.000Z",
"updated_at": "2026-07-01T12:00:00.000Z"
}
{
"error": {
"kind": "item_not_found",
"message": "Item not found"
}
}
⌘I

