Scan Item
curl --request GET \
--url https://api.decodahealth.com/inventory/items/scan \
--header 'API-KEY: <api-key>' \
--header 'TENANT: <tenant>'import requests
url = "https://api.decodahealth.com/inventory/items/scan"
headers = {
"TENANT": "<tenant>",
"API-KEY": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {TENANT: '<tenant>', 'API-KEY': '<api-key>'}};
fetch('https://api.decodahealth.com/inventory/items/scan', 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.decodahealth.com/inventory/items/scan",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>",
"TENANT: <tenant>"
],
]);
$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.decodahealth.com/inventory/items/scan"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("TENANT", "<tenant>")
req.Header.Add("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.decodahealth.com/inventory/items/scan")
.header("TENANT", "<tenant>")
.header("API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.decodahealth.com/inventory/items/scan")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["TENANT"] = '<tenant>'
request["API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"item": {
"name": "<string>",
"price": 123,
"id": "<string>",
"brandName": "<string>",
"description": "<string>",
"category": "<string>",
"isPhysical": true,
"isArchived": false,
"internalNotes": "<string>",
"sortOrder": 123,
"allowCustomPricing": false,
"showInCheckOut": true,
"type": "PRODUCT",
"externalId": "<string>",
"exemptedTaxIds": [
"<string>"
],
"cost": 123,
"cashPrice": 123,
"commissionable": true,
"tags": [
{
"id": "<string>",
"name": "<string>",
"color": "<string>"
}
],
"hiddenInPatientPortal": false,
"hiddenInOnlineShop": true,
"loyaltyPointsEarned": 1,
"defaultCptCode": "<string>",
"defaultModifiers": [
"<string>"
],
"defaultIcd10Codes": [
"<string>"
],
"defaultPlaceOfService": "<string>",
"stocks": [
{
"itemId": "<string>",
"stockId": "<string>",
"quantityUsed": 123,
"multiplyByDose": false
}
]
},
"stock": {
"name": "<string>",
"id": "<string>",
"description": "<string>",
"notes": "<string>",
"category": "<string>",
"minStockLevel": 123,
"isArchived": false,
"externalId": "<string>"
},
"kind": "auto",
"quantity": 1,
"gs1Data": {
"gtin": "<string>",
"lotNumber": "<string>",
"expiryDate": "2023-12-25",
"packagingDate": "2023-12-25",
"serialNumber": "<string>"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Items
Scan Item
Resolve a scanned barcode into a sellable item. Same auth surface as
/items/search — anyone who can search the catalog can scan it. The
optional item_type filter mirrors search: when set, the eligibility set
is intersected with it (e.g. pass MEDICATION on a meds-only flow).
GET
/
inventory
/
items
/
scan
Scan Item
curl --request GET \
--url https://api.decodahealth.com/inventory/items/scan \
--header 'API-KEY: <api-key>' \
--header 'TENANT: <tenant>'import requests
url = "https://api.decodahealth.com/inventory/items/scan"
headers = {
"TENANT": "<tenant>",
"API-KEY": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {TENANT: '<tenant>', 'API-KEY': '<api-key>'}};
fetch('https://api.decodahealth.com/inventory/items/scan', 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.decodahealth.com/inventory/items/scan",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>",
"TENANT: <tenant>"
],
]);
$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.decodahealth.com/inventory/items/scan"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("TENANT", "<tenant>")
req.Header.Add("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.decodahealth.com/inventory/items/scan")
.header("TENANT", "<tenant>")
.header("API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.decodahealth.com/inventory/items/scan")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["TENANT"] = '<tenant>'
request["API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"item": {
"name": "<string>",
"price": 123,
"id": "<string>",
"brandName": "<string>",
"description": "<string>",
"category": "<string>",
"isPhysical": true,
"isArchived": false,
"internalNotes": "<string>",
"sortOrder": 123,
"allowCustomPricing": false,
"showInCheckOut": true,
"type": "PRODUCT",
"externalId": "<string>",
"exemptedTaxIds": [
"<string>"
],
"cost": 123,
"cashPrice": 123,
"commissionable": true,
"tags": [
{
"id": "<string>",
"name": "<string>",
"color": "<string>"
}
],
"hiddenInPatientPortal": false,
"hiddenInOnlineShop": true,
"loyaltyPointsEarned": 1,
"defaultCptCode": "<string>",
"defaultModifiers": [
"<string>"
],
"defaultIcd10Codes": [
"<string>"
],
"defaultPlaceOfService": "<string>",
"stocks": [
{
"itemId": "<string>",
"stockId": "<string>",
"quantityUsed": 123,
"multiplyByDose": false
}
]
},
"stock": {
"name": "<string>",
"id": "<string>",
"description": "<string>",
"notes": "<string>",
"category": "<string>",
"minStockLevel": 123,
"isArchived": false,
"externalId": "<string>"
},
"kind": "auto",
"quantity": 1,
"gs1Data": {
"gtin": "<string>",
"lotNumber": "<string>",
"expiryDate": "2023-12-25",
"packagingDate": "2023-12-25",
"serialNumber": "<string>"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Headers
The tenant you are making this request on behalf of
Your api key
Query Parameters
Raw barcode string from scanner
Available options:
ITEM, SERVICE, PRODUCT, PACKAGE, MEMBERSHIP, MEDICATION, SERVICE_FEE, GIFT_CARD Response
Successful Response
- ItemScanResolutionAuto
- ItemScanResolutionPicker
- ItemScanResolutionEmpty
The single resolved sellable item
Show child attributes
Show child attributes
Source stock for the scan
Show child attributes
Show child attributes
Allowed value:
"auto"Default quantity to add
Show child attributes
Show child attributes
⌘I
