Skip to main content

Enums

ArchivedFilter#

Represents how archived entities should be treated.

ValueDescription
EXCLUDED

Returns only non-archived entities.

INCLUDED

Returns all entities.

ONLY

Returns only archived entities.

OrderBy#

Represents the possible types of order by.

ValueDescription
DESC

descending order

ASC

ascending order

ProductColor#

Represents the colors of the product.

ValueDescription
WHITE

If applied, this product is defined with white color at the classification level, filters, etc.

BLOND

If applied, this product is defined with blond color at the classification level, filters, etc.

AMBER

If applied, this product is defined with amber color at the classification level, filters, etc.

DARK

If applied, this product is defined with dark color at the classification level, filters, etc.

BLACK

If applied, this product is defined with black color at the classification level, filters, etc.

ORANGE

If applied, this product is defined with an orange color at the classification level, filters, etc.

RED

If applied, this product is defined with red color at the classification level, filters, etc.

ROSE

If applied, this product is defined with rose color at the classification level, filters, etc.

ProductKind#

Represents the possible types of products covering specific types (spirits, wines and beers) and general types (simple).

ValueDescription
SPIRITUOUS

If applied, this product is defined as a spirituous at the classification level, filters, etc.

WINE

If applied, this product is defined as a wine at the classification level, filters, etc.

BEER

If applied, this product is defined as a beer at the classification level, filters, etc.

SIMPLE

If applied, this product is defined as a simple product at the classification level, filters, etc.

ProductStatus#

Represents the possible types of the product status

ValueDescription
ACTIVE

The product is active.

INACTIVE

The product is not active.

ARCHIVED

The product is archived.

ProductWhiteWineType#

Represents the possible types of wine to be assigned to the product, where the ProductKind attribute should favorably be wine and the ProductColor attribute should favorably be white.

ValueDescription
DRY

If applied, this product is defined with dry characteristic at the classification level, filters, etc.

SEMIDRY

If applied, this product is defined with semidry characteristic at the classification level, filters, etc.

SOFT

If applied, this product is defined with soft characteristic at the classification level, filters, etc.

SWEET

If applied, this product is defined with sweet characteristic at the classification level, filters, etc.

ProductWineType#

Represents the possible types of wine to be assigned to the product, where the ProductKind attribute should favorably be wine.

ValueDescription
STILL

If applied, this product is defined with still characteristic at the classification level, filters, etc.

EFFERVESCENT

If applied, this product is defined with effervescent characteristic at the classification level, filters, etc.

StockActivityKind#

Represents classifications of the possible activities to be done to the stock (increase or decrease) depending on its purpose.

ValueDescription
LOSS

This applies to cases as declaration of breakage, loss, tasting, etc.

SALE

This applies to sales.

REFUND

This applies to refunds of sold products.

DELIVERY

This applies to stock replenishment.

DELIVERY_RECEIPT

This applies to delivery of goods via an end customer (document linked to an invoice).

RESET

This applies to cash reset actions.

RECEPTION

This applies to cancellation of a delivery receipt.

CREDIT_MEMO

This applies to reimbursement of an invoice.

StockActivityLossReason#

Represents the possible reasons why the stock activity was classified as a LOSS.

ValueDescription
LOSS
THEFT
DAMAGE
TASTING
OUTDATED_DLUO
TRADE_IN_SUPPLIER
OTHER

VariantStatus#

Represents the possible types of the variant status

ValueDescription
ACTIVE

The variant is active.

INACTIVE

The variant is not active.

ARCHIVED

The variant is archived.

VARIABLE

The variant has different statuses according to the shops.

VariantStockState#

Represents the possible types of the stock state to be assigned to the variant schema in order to advise the warehouse on quantities.

ValueDescription
OK

The quantity in stock does not yet present a risk of stock shortage (customized for each type of variant).

ALERT

The stock quantity is on the threshold between a safe quantity and the possible stock shortage in case of an unplanned sale.

DANGER

Out of stock.