Glossary
The words of the Wino API, in alphabetical order.
| Term | Meaning |
|---|---|
| Active / inactive | Whether a variant is on sale (Variant.active, changed with activateVariant / deactivateVariant). An inactive variant isn't archived: it still appears in lists. |
| Archived | Hidden from lists but kept. The API has no delete: records are archived instead. |
| Bulk variant | A variant sold by weight or volume instead of per unit, such as wine sold by the liter. |
| Capacity | The size of one item, for example 0.75 L. |
| Cash register report | The closing report of a cash register for a period: sales, payments, taxes. |
| Cash flow | A manual cash movement into or out of a cash register's drawer (CashFlow), separate from sale payments. |
| Category | A group of products, which can have sub-categories. |
| CKU | Centralized keeping unit: an identifier shared by the copies of the same variant across shops, once Wino links them. |
| Client state | A value you set on a webhook subscription and receive back in every notification. |
| Connection, edge, node | How lists are returned. See Pagination. |
| Credit note | A document that cancels all or part of an invoice. |
| Customer | A customer of a shop: a private individual or a company. |
| Delivery note | A document for goods delivered to a customer. |
| Device | What a change comes from: a cash register, the web back-office, or an integration like yours. |
| EAN-13 | The barcode of a variant (ean13). |
| Invoice | A sales invoice issued by a shop. |
| Loyalty activity | Points earned or spent by a customer in a shop's loyalty program. |
| Order | A supplier order of a shop. Webhooks notify it (Order), but the GraphQL API doesn't expose it. |
| Price list | A list of selling prices in a shop (type Price), such as retail or professional. A variant can have a price in each list, or several with quantity tiers. |
| Product | A catalog product, such as a wine cuvée. It holds shared information (producer, origin, tax, category). What's actually sold are its variants. |
| Reward | A reward in a shop's loyalty program: a free product or a discount, usually unlocked with points. |
| Quote | A price proposal to a customer, which can become an invoice. |
| Refund receipt | A receipt for a refund at the cash register. |
| Sales receipt | A receipt for a sale at the cash register. |
| Shop | A store or warehouse of a Wino account. Most data belongs to a shop. |
| SKU | The merchant's own reference for a variant (stockKeepingUnit). |
| Staff | A staff member of a shop: a cash register user who signs in with a PIN code. |
| Stock activity | One stock movement of a variant in a shop. Its kind says what it is (see below). |
| Supplier | A supplier of a shop. |
| Tax | A tax rate of a shop, such as 20 % VAT. Every product has one. |
| Voucher | A reward given to a specific customer, with its status (unlocked, used). |
| Variant | A sellable item of a product, such as a vintage and a bottle size, with its own codes, stock and prices. Called an "article" in the Wino app. |
| Variant price | The price of a variant in one price list, including and excluding tax. With quantity tiers, a list has one variant price per tier. |
| Vintage | The year of a wine variant: Variant.year. |
Stock activity kinds
An integration sends only the first five kinds. The others come from Wino's own documents and flows (delivery notes, supplier orders, credit notes, transfers): don't send them with createStockActivity.
| Kind | Used for | Stock |
|---|---|---|
SALE | A sale | Removes |
REFUND | A refund or return of sold products | Adds |
LOSS | Breakage, loss, theft, tasting… reason gives the cause; comment is free text, for any kind | Removes |
DELIVERY | A manual restock | Adds |
RESET | A stock count: its quantity becomes the new stock level | Sets |
DELIVERY_RECEIPT | Goods delivered to a customer on a delivery note | Removes |
RECEPTION | A supplier order received | Adds |
CREDIT_MEMO | Goods returned on an invoice credit note | Adds |
INCOMING_TRANSFER | A transfer between shops, on the receiving shop | Adds |
OUTGOING_TRANSFER | A transfer between shops, on the sending shop | Removes |