Skip to main content

Glossary

The words of the Wino API, in alphabetical order.

TermMeaning
Active / inactiveWhether a variant is on sale (Variant.active, changed with activateVariant / deactivateVariant). An inactive variant isn't archived: it still appears in lists.
ArchivedHidden from lists but kept. The API has no delete: records are archived instead.
Bulk variantA variant sold by weight or volume instead of per unit, such as wine sold by the liter.
CapacityThe size of one item, for example 0.75 L.
Cash register reportThe closing report of a cash register for a period: sales, payments, taxes.
Cash flowA manual cash movement into or out of a cash register's drawer (CashFlow), separate from sale payments.
CategoryA group of products, which can have sub-categories.
CKUCentralized keeping unit: an identifier shared by the copies of the same variant across shops, once Wino links them.
Client stateA value you set on a webhook subscription and receive back in every notification.
Connection, edge, nodeHow lists are returned. See Pagination.
Credit noteA document that cancels all or part of an invoice.
CustomerA customer of a shop: a private individual or a company.
Delivery noteA document for goods delivered to a customer.
DeviceWhat a change comes from: a cash register, the web back-office, or an integration like yours.
EAN-13The barcode of a variant (ean13).
InvoiceA sales invoice issued by a shop.
Loyalty activityPoints earned or spent by a customer in a shop's loyalty program.
OrderA supplier order of a shop. Webhooks notify it (Order), but the GraphQL API doesn't expose it.
Price listA 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.
ProductA catalog product, such as a wine cuvée. It holds shared information (producer, origin, tax, category). What's actually sold are its variants.
RewardA reward in a shop's loyalty program: a free product or a discount, usually unlocked with points.
QuoteA price proposal to a customer, which can become an invoice.
Refund receiptA receipt for a refund at the cash register.
Sales receiptA receipt for a sale at the cash register.
ShopA store or warehouse of a Wino account. Most data belongs to a shop.
SKUThe merchant's own reference for a variant (stockKeepingUnit).
StaffA staff member of a shop: a cash register user who signs in with a PIN code.
Stock activityOne stock movement of a variant in a shop. Its kind says what it is (see below).
SupplierA supplier of a shop.
TaxA tax rate of a shop, such as 20 % VAT. Every product has one.
VoucherA reward given to a specific customer, with its status (unlocked, used).
VariantA 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 priceThe price of a variant in one price list, including and excluding tax. With quantity tiers, a list has one variant price per tier.
VintageThe 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.

KindUsed forStock
SALEA saleRemoves
REFUNDA refund or return of sold productsAdds
LOSSBreakage, loss, theft, tasting… reason gives the cause; comment is free text, for any kindRemoves
DELIVERYA manual restockAdds
RESETA stock count: its quantity becomes the new stock levelSets
DELIVERY_RECEIPTGoods delivered to a customer on a delivery noteRemoves
RECEPTIONA supplier order receivedAdds
CREDIT_MEMOGoods returned on an invoice credit noteAdds
INCOMING_TRANSFERA transfer between shops, on the receiving shopAdds
OUTGOING_TRANSFERA transfer between shops, on the sending shopRemoves