CompuDime API docs

Reference / Schemas

PosBrand

One brand the store's products carry. Each row is a value the store's products carry, exactly as they carry it in the matching product field (brand, department, category, subCategory, or one of a product's tags), with the number of products carrying it (inactive products included). The POS keeps these lists itself from the product file and removes a value when no product carries it any more; modifiedSince cannot report a removal, so re-read the whole list now and then to drop the values that are gone. The POS keeps them from TisWin3 database version 1.308 (GET /v1/store says the store's version). Where a store's POS keeps no such list, or keeps it empty, the list is built from the products themselves at the moment of the call: the same rows in the same shape, each count taken then, and as modifiedAt the newest change of any product carrying the value.

Type: object.

NameTypeDescription
name requiredstringThe brand exactly as the products carry it in the product field brand.
modifiedAtstring (date-time)When the POS last changed the row (UTC); what modifiedSince filters on. It changes with every product that gains or loses the value. On a list built from the products it is the newest change of any product carrying the value, so it also moves when such a product changes for another reason. Absent when the store's list keeps no modification time.
productCountintegerThe number of products carrying the value (inactive products included): the POS's own count as it keeps it, or, on a list built from the products, the count at the moment of the call. Absent when the store's list keeps no count.

No other fields appear.