CompuDime API docs

Reference / Schemas

LiveProduct

One live product as the register resolves it right now. Sale prices are the effective prices (a percent-off sale is already applied), so salePrice / caseSalePrice / packageSalePrice are what the register charges while the matching *Active flag is true and 0 otherwise.

Type: object.

NameTypeDescription
activePricenumberWhat the register charges now: the sale price while a sale window is open, else price; on a price-embedded barcode, the price decoded from the barcode.
autoTarebooleanThe register applies the tare automatically.
brandstring
casePricenumberRegular case price (for unitsPerCase units).
caseSaleActivebooleanA case sale is in its window right now.
caseSalePricenumberEffective case sale price while caseSaleActive, else 0.
categorystring
departmentstring
descriptionstring
foodStampbooleanSNAP / food-stamp eligible.
inactivebooleanFlagged inactive in the product file (PrdMstr.InActive). The register still sells an inactive item.
lastModifiedUtcstring (date-time) or nullWhen the product's row in the store's product file last changed (PrdMstr.UpdatedOn, stamped by the store's database on every write to the row, reported in UTC), read at the moment of the call; the same value as lastModifiedUtc on /v1/products. null when the store could not read it within the lookup's time budget, and until the store's agent reports it; the lookup itself still answers.
lastSoldstring (date) or nullThe day the register last finished a sale with this item on it (PrdMstr.LastSold, a date without a time, the store's calendar day). Register sales only: the register stamps it on each item of a completed sale ticket with a nonzero quantity on its line, so a voided line, a voided, held or training ticket, an account charge and an order or delivery invoice never stamp it; a return rung on a sale ticket does. null when the item has never been stamped (or the store turned the stamp off) and until the store's agent reports it. Read at the moment of the call. null as well when the store could not read it within the lookup's time budget; the lookup itself still answers.
matchFieldstringThe POS field that matched: Prdmstr->Code, PrdAlias->AliasCode, Prdmstr->CaseCode or Prdmstr->PrdctSku; empty only when the POS sent no label.
matchTypestringHow the code resolved, as the POS labels it: Exact or Not Exact (product code, with or without check-digit normalization), Alias Exact / Alias Not Exact, CaseCode Exact / CaseCode Not Exact, SKU Exact / SKU Not Exact; empty only when the POS sent no label.
matchedCodestringThe base product code that answered; equals productCode.
noSalebooleanThe register refuses to sell the item.
onHandnumber or nullCurrent on-hand quantity; null when the store has never counted or received the item. Reported as is, including negative values.
packstring
packagePricenumberRegular price for packageQty units; 0 when the item has no package price.
packageQtyintegerUnits the package price covers; 0 when none.
packageSaleActivebooleanA package sale is in its window right now.
packageSalePricenumberEffective price for packageSaleQty units while packageSaleActive, else 0.
packageSaleQtyintegerUnits the package sale price covers; 0 unless packageSaleActive.
pricenumberRegular unit price.
priceEmbeddedbooleanThe code scanned carried its own price or weight; activePrice came from the barcode.
productCodestringThe resolved base product code (Prdmstr.Code).
saleActivebooleanA unit sale is in its window right now.
salePricenumberEffective unit sale price while saleActive, else 0.
scalebooleanSold by weight.
sizestring
smallDescriptionstring
subCategorystring
tarenumberTare weight for scale items (0 when none).
taxablebooleanTaxable.
unitsPerCaseintegerUnits per case (PrdMstr.UPC). Not a barcode.
upc deprecatedintegerDeprecated: use unitsPerCase, which carries the same value. upc keeps working and is not removed before a later, announced date. Units per case. Deprecated.
wicbooleanWIC eligible.

No other fields appear.