Product
Type: object.
| Name | Type | Description |
|---|---|---|
active | boolean | false when the store marks the item not for sale (PrdMstr.NoSale): the register refuses to ring it. It does not reflect the product file's inactive flag, which is inactive. |
brand | string | |
category | string | |
department | string | |
description | string | |
inactive | boolean or null | Flagged inactive in the product file (PrdMstr.InActive): the store's back office hides it from its lists, but the register still sells it. null until the store's agent reports the flag. GET /v1/products leaves out the products where it is true unless the call passes includeInactive=true. |
lastModifiedUtc | string | When the product's row in the store's product file last changed (PrdMstr.UpdatedOn, which the store's database stamps on every write to the row, in the store's time zone, reported here in UTC). Any write moves it, including the register's daily last-sold stamp and receiving updates to columns this API does not return, so modifiedSince also returns products whose visible fields did not change. Like lastSold it is refreshed at least once a day, and with every snapshot that carries another change. Empty ("") until the store's agent reports it. |
lastSold | string (date) or null | The 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. On the snapshot it is refreshed at least once a day, not every hour: a change to lastSold alone reaches the snapshot with the store's first snapshot of the next day. Use the live lookup for today's value. |
pack | string | |
price | string | |
priceQty | integer | |
productCode | string | The product's code at the store: the code the register scans and sells by (for most items the barcode). |
size | string | |
smallDescription | string | |
taxable | boolean | |
unitsPerCase | string | Units per case (PrdMstr.UPC). Not a barcode. |
upc deprecated | string | Deprecated: use unitsPerCase, which carries the same value. upc keeps working and is not removed before a later, announced date. Units per case, as the POS stores it (its column is named UPC). This is NOT a barcode; the scannable code is productCode. Deprecated. |
No other fields appear.