Skip to main content
GET
Scan Item

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Query Parameters

raw_value
string
required

Raw barcode string from scanner

item_type
enum<string>[] | null
Available options:
ITEM,
SERVICE,
PRODUCT,
PACKAGE,
MEMBERSHIP,
MEDICATION,
SERVICE_FEE,
GIFT_CARD

Response

Successful Response

item
Item · object
required

The single resolved sellable item

stock
StockTiny · object
required

Source stock for the scan

kind
string
default:auto
Allowed value: "auto"
quantity
integer
default:1

Default quantity to add

gs1Data
GS1ParseResult · object | null