iikoFront Api V8 Code Reference
iikoFront Api V8 Code Reference
Resto.Front.Api.Data.Assortment
IProduct Interface
IProduct Properties
IProduct Methods

# IProduct Interface

Namespace: Resto.Front.Api.Data.Assortment
Assembly: Resto.Front.Api.V8 (in Resto.Front.Api.V8.dll) Version: 1ca4876affdd3bc5359a98b321fc115a647d2251
Syntax
C#
Copy

    public interface IProduct : ISerializable,
    	IEntity

The IProduct type exposes the following members.

Properties

| Name | Description
--- | --- | ---
| BackgroundColor | Background color of a menu button for the product. If the product has a menu image (HasMenuImage, TryGetProductMenuImage(IProduct)) and UI supports images in menu, image should be used as a background instead of solid BackgroundColor
| BarcodeContainers | Returns all barcode containers assigned to product.
| CanSetOpenPrice | Gets a value that indicates whether the product possible to set an open price.
| Category |
| DefaultCourse | Default course of the product.
| Description |
| DescriptionForeign |
| ExpirationTime |
| FastCode | Quick type product code
| FontColor | Font color of a menu button for the product's name.
| FoodValueCaloricity |
| FoodValueCarbohydrate |
| FoodValueFat |
| FoodValueProtein |
| ForeignName |
| FullName |
| HasMenuImage | Whether the product has an image to be used as a background in menu. If true, call TryGetProductMenuImage(IProduct) to get an image. If the product doesn't have an image or UI doesn't support images in menu, use BackgroundColor as a menu button background.
| Id | (Inherited from IEntity.)
| ImmediateCookingStart | Indicates whether the product cooking or time pay service execution should be started immediately after adding into the order. It is expected that plugin will check this flag and apply appropriate action.
| IsActive | Gets a value that indicates whether this product is active in assortment base. Product can be activated or deactivated via iikoOffice.
| KitchenName |
| MeasuringUnitName | Measurement unit of product to be displayed
| MenuIndex | Gets an index of product in hierarchical menu, can be used to sort products inside the same product group.
| Name |
| Number | Nomenclature article of product.
| Price |
| RateSchedule | For products of type Service is a schedule of a service rates. null for other product types.
| Scale | Scale of the current product sizes or null for product without sizes.
| TaxPercent | Tax percent or null for not taxed products.
| Template | Template of the current product or null for product without template.
| Type |

Top
Methods

| Name | Description
--- | --- | ---
| GetObjectData | Populates a SerializationInfo with the data needed to serialize the target object. (Inherited from ISerializable.)

Top
Extension Methods

| Name | Description
--- | --- | ---
| GetDisabledSizes | Returns disabledSizes of the specified product. (Defined by ProductExtensions.)
| GetGroupModifiers | Returns group modifiers of the specified product. (Defined by OperationArgumentExtensions.)
| GetIncludedInMenuSections | Returns includedInMenuSections of the specified product. (Defined by ProductExtensions.)
| GetSimpleModifiers | Returns simple modifiers of the specified product. (Defined by OperationArgumentExtensions.)
| GetTemplatedModifiersParams | Returns templatedModifiersParams of the specified product. (Defined by ProductExtensions.)
| TryGetDisabledSizes | Returns disabledSizes of the specified product or null if product doesn't exist. (Defined by ProductExtensions.)
| TryGetIncludedInMenuSections | Returns includedInMenuSections of the specified product or null if product doesn't exist. (Defined by ProductExtensions.)
| TryGetParent | Returns parent of the specified product or null if product doesn't exist. (Defined by ProductExtensions.)
| TryGetProductMenuBitmap | Returns a bitmap image to be shown as a background on a menu button for the specified product. If the product doesn't have an image, null will be returned. (Defined by ProductExtensions.)
| TryGetProductMenuImage | Returns a byte sequence presenting an image to be shown as a background on a menu button for the specified product. If the product doesn't have an image, null will be returned. (Defined by OperationArgumentExtensions.)
| TryGetTemplatedModifiersParams | Returns templatedModifiersParams of the specified product or null if product doesn't exist. (Defined by ProductExtensions.)

Top
See Also

#### Reference

Resto.Front.Api.Data.Assortment Namespace