Nomenclature

Endpoints of the Nomenclature section of the iikoCloud API documentation.

Nomenclature.NomenclatureGroup

A nomenclature group is a hierarchical container for organising products and dishes.

iiko.nomenclature.group.create() async

create(
    *,
    code: str,
    name: str,
    accounting_category_id: str | None = None,
    category_id: str | None = None,
    color: NomenclatureGroupRGBColor
    | Mapping[str, Any]
    | None = None,
    custom_categories: Sequence[
        NomenclatureGroupCustomCategory | Mapping[str, Any]
    ]
    | None = None,
    default_course: int | None = None,
    default_maximum_store_balance_level: Decimal
    | float
    | None = None,
    default_minimum_store_balance_level: Decimal
    | float
    | None = None,
    description: str | None = None,
    font_color: NomenclatureGroupRGBColor
    | Mapping[str, Any]
    | None = None,
    front_image_id: str | None = None,
    group_article: str | None = None,
    group_id: str | None = None,
    include_in_report: bool | None = None,
    is_fixed_price: bool | None = None,
    markup_settings: Sequence[
        NomenclatureGroupMarkupSetting | Mapping[str, Any]
    ]
    | None = None,
    maximum_store_balance_levels: Sequence[
        NomenclatureGroupStoreBalanceLevel
        | Mapping[str, Any]
    ]
    | None = None,
    minimum_store_balance_levels: Sequence[
        NomenclatureGroupStoreBalanceLevel
        | Mapping[str, Any]
    ]
    | None = None,
    parent_id: str | None = None,
    position: int | None = None,
    price_markup_percent: Decimal | float | None = None,
    tax_category_id: str | None = None,
    visibility_filter: NomenclatureGroupOrganizationFilter
    | Mapping[str, Any]
    | None = None,
    timeout: float | None = None,
) -> NomenclatureGroupCreateResponse

Create a nomenclature group (v2).

POST /api/nomenclature/v2/group/create

Creates a new nomenclature group. Only the name field is required. All other fields are optional - if not provided or sent as null, default values are applied. The groupArticle field must be unique within the organisation.

Parameters:

Name	Type	Description	Default
code	str	Group code: 0–8 digits. Used for quick search on the order editing screen. Required when creating or updating a group	required
name	str	Group name	required
accounting_category_id	str | None	UUID of the accounting category (as configured in the accounting settings)	None
category_id	str | None	UUID of the product (custom) category. The list of values can be retrieved via the "Get a list of product categories" method in the "Product categories" category	None
color	NomenclatureGroupRGBColor | Mapping[str, Any] | None	Background button colour for POS	None
custom_categories	Sequence[NomenclatureGroupCustomCategory | Mapping[str, Any]] | None	Custom nomenclature categories. Empty array or null - no categories set	None
default_course	int | None	Default serving course. null - not set; 0 - VIP course; otherwise - course number	None
default_maximum_store_balance_level	Decimal | float | None	Default maximum stock level	None
default_minimum_store_balance_level	Decimal | float | None	Default minimum stock level	None
description	str | None	Group description	None
font_color	NomenclatureGroupRGBColor | Mapping[str, Any] | None	Font colour on the button for POS	None
front_image_id	str | None	UUID of the image for POS	None
group_article	str | None	Group article. If null or not provided, the field remains empty	None
group_id	str | None	UUID of the group to create. If not specified, the UUID will be generated automatically.	None
include_in_report	bool | None	Include in the price list print form	None
is_fixed_price	bool | None	Price is set explicitly and does not depend on markup	None
markup_settings	Sequence[NomenclatureGroupMarkupSetting | Mapping[str, Any]] | None	Markup settings by organization (structural unit). If not set for an organization, priceMarkupPercent is used	None
maximum_store_balance_levels	Sequence[NomenclatureGroupStoreBalanceLevel | Mapping[str, Any]] | None	Maximum stock levels by warehouse. For warehouses without an explicit entry, defaultMaximumStoreBalanceLevel is used	None
minimum_store_balance_levels	Sequence[NomenclatureGroupStoreBalanceLevel | Mapping[str, Any]] | None	Minimum stock levels by warehouse. For warehouses without an explicit entry, defaultMinimumStoreBalanceLevel is used	None
parent_id	str | None	UUID of the parent group. The list of values can be retrieved via the "Get a list of nomenclature groups" method. null - the group belongs to the root level	None
position	int | None	Menu position. 0 - sort by Code+Name; otherwise - sort by this value	None
price_markup_percent	Decimal | float | None	Fixed markup (%). Stored with up to 9 decimal places	None
tax_category_id	str | None	UUID of the tax category used for the group (VAT/tax calculation). The list of values can be retrieved via the "Get a list of tax categories" method in the "Directories" category in "Finance" section	None
visibility_filter	NomenclatureGroupOrganizationFilter | Mapping[str, Any] | None	Organization (structural unit) visibility filter. null - the group is visible in all organisations. Applies only to root groups	None
timeout	float | None	Server-side timeout in seconds (Timeout header). Defaults to the client setting.	None

Returns:

Type	Description
NomenclatureGroupCreateResponse	The NomenclatureGroupCreateResponse response.

iikoCloud API reference

iiko.nomenclature.group.delete() async

delete(
    *,
    group_ids: Sequence[str],
    timeout: float | None = None,
) -> NomenclatureGroupDeleteResponse

Delete nomenclature groups (v2).

POST /api/nomenclature/v2/group/delete

Marks the specified nomenclature groups as deleted. Deletion is recursive: each group's child groups and products are deleted together with it.

Parameters:

Name	Type	Description	Default
group_ids	Sequence[str]	List of nomenclature group UUIDs for recursive deletion	required
timeout	float | None	Server-side timeout in seconds (Timeout header). Defaults to the client setting.	None

Returns:

Type	Description
NomenclatureGroupDeleteResponse	The NomenclatureGroupDeleteResponse response.

iikoCloud API reference

iiko.nomenclature.group.list() async

list(
    *,
    filters: Sequence[
        NomenclatureGroupFilter | Mapping[str, Any]
    ],
    limit: int,
    offset: int,
    timeout: float | None = None,
) -> NomenclatureGroupListResponse

Get a list of nomenclature groups (v2).

POST /api/nomenclature/v2/group/list

Returns a list of nomenclature groups of the current organisation with filtering and pagination support. Only groups of the PRODUCTS type are returned (the type filter is applied internally and cannot be overridden). Deleted groups are returned unless the isDeleted eq false filter is passed. Filter fields: id / groupId, name, code, groupArticle, parentId, isDeleted, system, description, includeInReport, isChainRoot, revision, categoryId, accountingCategoryId, taxCategoryId, franchiseUniqueId, franchiseMasterId. All the standard operators (eq, ne, in, nin, like, blank, notblank, gt, gte, lt, lte) are accepted for every listed field; their applicability depends on the field type: eq/in for UUID fields, eq for boolean fields, range operators (gt, gte, lt, lte) for the numeric revision field. All filters are combined with AND. Pagination via limit/offset.

Parameters:

Name	Type	Description	Default
filters	Sequence[NomenclatureGroupFilter | Mapping[str, Any]]	Request filters. All filters are applied simultaneously (AND). See the method description for the list of supported filter fields	required
limit	int	Maximum number of records in the response. Allowed values: 1 to 1000	required
offset	int	Number of records to skip from the beginning of the list (0-based). Use together with limit for pagination	required
timeout	float | None	Server-side timeout in seconds (Timeout header). Defaults to the client setting.	None

Returns:

Type	Description
NomenclatureGroupListResponse	The NomenclatureGroupListResponse response.

iikoCloud API reference

iiko.nomenclature.group.restore() async

restore(
    *,
    group_ids: Sequence[str],
    recursively: bool | None = None,
    timeout: float | None = None,
) -> NomenclatureGroupUndeleteResponse

Restore nomenclature groups (v2).

POST /api/nomenclature/v2/group/restore

Restores previously deleted nomenclature groups. When recursively: true, all child groups and their products are also restored.

Parameters:

Name	Type	Description	Default
group_ids	Sequence[str]	List of nomenclature group UUIDs to restore	required
recursively	bool | None	true - recursively restore all child groups and their products; false - restore only the specified top-level groups	None
timeout	float | None	Server-side timeout in seconds (Timeout header). Defaults to the client setting.	None

Returns:

Type	Description
NomenclatureGroupUndeleteResponse	The NomenclatureGroupUndeleteResponse response.

iikoCloud API reference

iiko.nomenclature.group.update() async

update(
    *,
    code: str,
    group_id: str,
    name: str,
    accounting_category_id: str | None = None,
    category_id: str | None = None,
    color: NomenclatureGroupRGBColor
    | Mapping[str, Any]
    | None = None,
    custom_categories: Sequence[
        NomenclatureGroupCustomCategory | Mapping[str, Any]
    ]
    | None = None,
    default_course: int | None = None,
    default_maximum_store_balance_level: Decimal
    | float
    | None = None,
    default_minimum_store_balance_level: Decimal
    | float
    | None = None,
    description: str | None = None,
    font_color: NomenclatureGroupRGBColor
    | Mapping[str, Any]
    | None = None,
    front_image_id: str | None = None,
    group_article: str | None = None,
    include_in_report: bool | None = None,
    is_fixed_price: bool | None = None,
    markup_settings: Sequence[
        NomenclatureGroupMarkupSetting | Mapping[str, Any]
    ]
    | None = None,
    maximum_store_balance_levels: Sequence[
        NomenclatureGroupStoreBalanceLevel
        | Mapping[str, Any]
    ]
    | None = None,
    minimum_store_balance_levels: Sequence[
        NomenclatureGroupStoreBalanceLevel
        | Mapping[str, Any]
    ]
    | None = None,
    parent_id: str | None = None,
    price_markup_percent: Decimal | float | None = None,
    tax_category_id: str | None = None,
    visibility_filter: NomenclatureGroupOrganizationFilter
    | Mapping[str, Any]
    | None = None,
    timeout: float | None = None,
) -> NomenclatureGroupUpdateResponse

Update a nomenclature group (v2).

POST /api/nomenclature/v2/group/update

Updates an existing nomenclature group. The groupId (UUID of the group to update) and name fields are required. The position (position) is not changed during an update. The groupArticle field must be unique within the organisation (a match with the current record is allowed).

Parameters:

Name	Type	Description	Default
code	str	Group code: 0–8 digits. Used for quick search on the order editing screen. Required when creating or updating a group	required
group_id	str	UUID of the group to update	required
name	str	Group name	required
accounting_category_id	str | None	UUID of the accounting category (as configured in the accounting settings)	None
category_id	str | None	UUID of the product (custom) category. The list of values can be retrieved via the "Get a list of product categories" method in the "Product categories" category	None
color	NomenclatureGroupRGBColor | Mapping[str, Any] | None	Background button colour for POS	None
custom_categories	Sequence[NomenclatureGroupCustomCategory | Mapping[str, Any]] | None	Custom nomenclature categories. Empty array or null - no categories set	None
default_course	int | None	Default serving course. null - not set; 0 - VIP course; otherwise - course number	None
default_maximum_store_balance_level	Decimal | float | None	Default maximum stock level	None
default_minimum_store_balance_level	Decimal | float | None	Default minimum stock level	None
description	str | None	Group description	None
font_color	NomenclatureGroupRGBColor | Mapping[str, Any] | None	Font colour on the button for POS	None
front_image_id	str | None	UUID of the image for POS	None
group_article	str | None	Group article. If null or not provided, the field remains empty	None
include_in_report	bool | None	Include in the price list print form	None
is_fixed_price	bool | None	Price is set explicitly and does not depend on markup	None
markup_settings	Sequence[NomenclatureGroupMarkupSetting | Mapping[str, Any]] | None	Markup settings by organization (structural unit). If not set for an organization, priceMarkupPercent is used	None
maximum_store_balance_levels	Sequence[NomenclatureGroupStoreBalanceLevel | Mapping[str, Any]] | None	Maximum stock levels by warehouse. For warehouses without an explicit entry, defaultMaximumStoreBalanceLevel is used	None
minimum_store_balance_levels	Sequence[NomenclatureGroupStoreBalanceLevel | Mapping[str, Any]] | None	Minimum stock levels by warehouse. For warehouses without an explicit entry, defaultMinimumStoreBalanceLevel is used	None
parent_id	str | None	UUID of the parent group. The list of values can be retrieved via the "Get a list of nomenclature groups" method. null - the group belongs to the root level	None
price_markup_percent	Decimal | float | None	Fixed markup (%). Stored with up to 9 decimal places	None
tax_category_id	str | None	UUID of the tax category used for the group (VAT/tax calculation). The list of values can be retrieved via the "Get a list of tax categories" method in the "Directories" category in "Finance" section	None
visibility_filter	NomenclatureGroupOrganizationFilter | Mapping[str, Any] | None	Organization (structural unit) visibility filter. null - the group is visible in all organisations. Applies only to root groups	None
timeout	float | None	Server-side timeout in seconds (Timeout header). Defaults to the client setting.	None

Returns:

Type	Description
NomenclatureGroupUpdateResponse	The NomenclatureGroupUpdateResponse response.

iikoCloud API reference

Nomenclature.NomenclatureProduct

A nomenclature product is one of: a dish, a good, a service or a modifier.

iiko.nomenclature.product.create() async

create(
    *,
    amount_unit_id: str,
    code: str,
    name: str,
    type: str,
    accounting_category_id: str | None = None,
    alcohol_class: str | None = None,
    allergen_group_ids: Sequence[str] | None = None,
    amount_independent_of_parent_amount: bool | None = None,
    barcodes: Sequence[
        NomenclatureProductBarcode | Mapping[str, Any]
    ]
    | None = None,
    can_buy_from_cashdesk: bool | None = None,
    can_change_amount_cooked_dish: bool | None = None,
    can_set_open_price: bool | None = None,
    category_id: str | None = None,
    cheque_printable: bool | None = None,
    cold_loss_percent: Decimal | float | None = None,
    color: NomenclatureProductRGBColor
    | Mapping[str, Any]
    | None = None,
    containers: Sequence[
        NomenclatureProductContainer | Mapping[str, Any]
    ]
    | None = None,
    cook_with_main_dish: bool | None = None,
    cooking_time_normal: int | None = None,
    cooking_time_peak: int | None = None,
    cooking_type: str | None = None,
    custom_categories: Sequence[
        NomenclatureProductCustomCategory
        | Mapping[str, Any]
    ]
    | None = None,
    default_container_id: str | None = None,
    default_course: int | None = None,
    default_included_in_menu: bool | None = None,
    default_maximum_store_balance_level: Decimal
    | float
    | None = None,
    default_minimum_store_balance_level: Decimal
    | float
    | None = None,
    default_sale_price: Decimal | float | None = None,
    description: str | None = None,
    description_english: str | None = None,
    disabled_product_size_ids: Sequence[str] | None = None,
    egais_alc_code: str | None = None,
    estimated_purchase_price: Decimal | float | None = None,
    excluded_section_ids: Sequence[str] | None = None,
    expiration_date: int | None = None,
    font_color: NomenclatureProductRGBColor
    | Mapping[str, Any]
    | None = None,
    front_image_id: str | None = None,
    full_name: str | None = None,
    full_name_english: str | None = None,
    gtin: str | None = None,
    hot_loss_percent: Decimal | float | None = None,
    images: Sequence[
        NomenclatureProductImage | Mapping[str, Any]
    ]
    | None = None,
    invoice_supplier_id: str | None = None,
    is_calculate_unit_weight: bool | None = None,
    is_dish_of_day: bool | None = None,
    is_fixed_price: bool | None = None,
    is_flyer_program: bool | None = None,
    is_not_in_store_movement: bool | None = None,
    is_nutrition_value_auto_calculated: bool | None = None,
    is_percentage_of_alcohol_applicable: bool | None = None,
    is_time_pay_product: bool | None = None,
    item_category_id: str | None = None,
    markup_settings: Sequence[
        NomenclatureProductMarkupSetting | Mapping[str, Any]
    ]
    | None = None,
    maximum_store_balance_levels: Sequence[
        NomenclatureProductStoreBalanceLevel
        | Mapping[str, Any]
    ]
    | None = None,
    minimum_store_balance_levels: Sequence[
        NomenclatureProductStoreBalanceLevel
        | Mapping[str, Any]
    ]
    | None = None,
    minimum_time_pay_product_duration_minutes: int
    | None = None,
    modifier_schema_id: str | None = None,
    modifier_schema_redefinitions: Sequence[
        NomenclatureProductModifierSchemaRedefinition
        | Mapping[str, Any]
    ]
    | None = None,
    modifiers: Sequence[
        NomenclatureProductModifier | Mapping[str, Any]
    ]
    | None = None,
    name_english: str | None = None,
    name_kitchen: str | None = None,
    nutrition_values: Sequence[
        NomenclatureProductNutritionValue
        | Mapping[str, Any]
    ]
    | None = None,
    outer_economic_activity_nomenclature_code: str
    | None = None,
    parent_group_id: str | None = None,
    percentage_of_alcohol: Decimal | float | None = None,
    place_type_id: str | None = None,
    position: int | None = None,
    precheque_printable: bool | None = None,
    price_markup_percent: Decimal | float | None = None,
    print_on_add: bool | None = None,
    producer_ids: Sequence[str] | None = None,
    product_article: str | None = None,
    product_id: str | None = None,
    product_scale_id: str | None = None,
    product_size_factors: NomenclatureProductSizeFactors
    | Mapping[str, Any]
    | None = None,
    product_tag_ids: Sequence[str] | None = None,
    product_type_for_cooking: str | None = None,
    rate_schedule: NomenclatureProductRateSchedule
    | Mapping[str, Any]
    | None = None,
    relative_rate_schedule: bool | None = None,
    source_nature: str | None = None,
    tax_category_id: str | None = None,
    time_pay_product_duration_step_minutes: int
    | None = None,
    transfer_type: str | None = None,
    unit_capacity: Decimal | float | None = None,
    unit_weight: Decimal | float | None = None,
    use_balance_for_inventory: bool | None = None,
    use_balance_for_sell: bool | None = None,
    use_default_cooking_time: bool | None = None,
    use_range_for_invoices: bool | None = None,
    uz_fiscal_code: str | None = None,
    timeout: float | None = None,
) -> NomenclatureProductCreateResponse

Create a product (v2).

POST /api/nomenclature/v2/product/create

Creates a new nomenclature product. The name, type and amountUnitId fields are required. All other fields are optional - if not provided or sent as null, default values are applied. If code or productArticle are not provided explicitly, API server assigns them automatically. The write is synchronous, while reads through the list method use an asynchronously updated catalogue snapshot (eventual consistency): a created item does not appear in the list immediately. Before using the product (for example, creating an assembly chart for it), wait until it appears — poll the list with a filter by the returned productId or code.

Parameters:

Name	Type	Description	Default
amount_unit_id	str	UUID of the product's unit of measure (mainUnit). The list of values can be retrieved via the "Get a list of amount units" method in the "Directories" category	required
code	str	Product code: 0–8 digits. Used for quick search on the order editing screen. Required when creating or updating a product	required
name	str	Product name	required
type	str	Product type: GOODS (goods/ingredients), DISH (dishes), PREPARED (semi-prepared items), SERVICE (services), MODIFIER (modifiers), OUTER, RATE, PETROL	required
accounting_category_id	str | None	UUID of the accounting category (as configured in the accounting settings)	None
alcohol_class	str | None	Alcohol product class	None
allergen_group_ids	Sequence[str] | None	UUIDs of allergen groups. The list of values can be retrieved via the "Get a list of allergen groups" method in the "Directories" category	None
amount_independent_of_parent_amount	bool | None	The amount does not depend on the parent dish's amount	None
barcodes	Sequence[NomenclatureProductBarcode | Mapping[str, Any]] | None	Product barcodes	None
can_buy_from_cashdesk	bool | None	Can be sold directly from the cash desk	None
can_change_amount_cooked_dish	bool | None	The amount of the cooked dish can be changed	None
can_set_open_price	bool | None	An open price can be set manually	None
category_id	str | None	UUID of the product (custom) category. The list of values can be retrieved via the "Get a list of product categories" method in the "Product categories" category	None
cheque_printable	bool | None	Print on the cheque	None
cold_loss_percent	Decimal | float | None	Weight loss percentage during cold processing	None
color	NomenclatureProductRGBColor | Mapping[str, Any] | None	Background button colour for POS	None
containers	Sequence[NomenclatureProductContainer | Mapping[str, Any]] | None	Product containers/packagings	None
cook_with_main_dish	bool | None	Cook together with the main dish	None
cooking_time_normal	int | None	Cooking time in normal mode, minutes	None
cooking_time_peak	int | None	Cooking time in peak mode, minutes	None
cooking_type	str | None	Cooking method	None
custom_categories	Sequence[NomenclatureProductCustomCategory | Mapping[str, Any]] | None	Custom nomenclature categories. Empty array or null - no categories set	None
default_container_id	str | None	UUID of the default container. The list of values can be retrieved via the "Get a list of containers" method in the "Directories" category	None
default_course	int | None	Default serving course. null - not set; 0 - VIP course; otherwise - course number	None
default_included_in_menu	bool | None	Include the product in the menu by default	None
default_maximum_store_balance_level	Decimal | float | None	Default maximum stock level	None
default_minimum_store_balance_level	Decimal | float | None	Default minimum stock level	None
default_sale_price	Decimal | float | None	Default sale price	None
description	str | None	Product description	None
description_english	str | None	Product description in English	None
disabled_product_size_ids	Sequence[str] | None	UUIDs of the dish sizes disabled for this product. The list of values can be retrieved via the "Get a list of product sizes" method in the "Directories" category	None
egais_alc_code	str | None	EGAIS product type code	None
estimated_purchase_price	Decimal | float | None	Estimated purchase price	None
excluded_section_ids	Sequence[str] | None	UUIDs of the menu sections the product is excluded from. The list of values can be retrieved via the "Get a list of menu sections" method in the "Directories" category	None
expiration_date	int | None	Shelf life, days	None
font_color	NomenclatureProductRGBColor | Mapping[str, Any] | None	Font colour on the button for POS	None
front_image_id	str | None	UUID of the image for POS	None
full_name	str | None	Full product name	None
full_name_english	str | None	Full product name in English	None
gtin	str | None	Global Trade Item Number (GTIN)	None
hot_loss_percent	Decimal | float | None	Weight loss percentage during hot processing	None
images	Sequence[NomenclatureProductImage | Mapping[str, Any]] | None	Product quality certificates	None
invoice_supplier_id	str | None	UUID of the default supplier (counterparty) for incoming invoices of this product. The list of values can be retrieved via the "Get counteragents list" method in the "Counteragents" category in "Inventory" section	None
is_calculate_unit_weight	bool | None	Calculate unit weight automatically	None
is_dish_of_day	bool | None	Dish of the day	None
is_fixed_price	bool | None	Price is set explicitly and does not depend on markup	None
is_flyer_program	bool | None	Participates in the flyer programme	None
is_not_in_store_movement	bool | None	Not included in warehouse stock movement	None
is_nutrition_value_auto_calculated	bool | None	Nutrition value is calculated automatically	None
is_percentage_of_alcohol_applicable	bool | None	Alcohol content is applicable to this product	None
is_time_pay_product	bool | None	Time-pay service product (time-based billing)	None
item_category_id	str | None	Item category (for fiscalisation/accounting) of the product. The list of values can be retrieved via the "Get a list of fiscal categories" method in the "Directories" category in "Finance" section	None
markup_settings	Sequence[NomenclatureProductMarkupSetting | Mapping[str, Any]] | None	Markup settings by organization (structural unit). If not set for an organization, priceMarkupPercent is used	None
maximum_store_balance_levels	Sequence[NomenclatureProductStoreBalanceLevel | Mapping[str, Any]] | None	Maximum stock levels by warehouse. For warehouses without an explicit entry, defaultMaximumStoreBalanceLevel is used	None
minimum_store_balance_levels	Sequence[NomenclatureProductStoreBalanceLevel | Mapping[str, Any]] | None	Minimum stock levels by warehouse. For warehouses without an explicit entry, defaultMinimumStoreBalanceLevel is used	None
minimum_time_pay_product_duration_minutes	int | None	Minimum duration of the time-pay service, minutes	None
modifier_schema_id	str | None	UUID of the modifier schema. The list of values can be retrieved via the "Get a list of modifier schemas" method in the "Directories" category	None
modifier_schema_redefinitions	Sequence[NomenclatureProductModifierSchemaRedefinition | Mapping[str, Any]] | None	Modifier schema value redefinitions for this product	None
modifiers	Sequence[NomenclatureProductModifier | Mapping[str, Any]] | None	Top-level dish modifiers	None
name_english	str | None	Product name in English	None
name_kitchen	str | None	Name for the kitchen screen/printer	None
nutrition_values	Sequence[NomenclatureProductNutritionValue | Mapping[str, Any]] | None	Nutrition values by organization (structural unit) and dish size	None
outer_economic_activity_nomenclature_code	str | None	Foreign economic activity commodity nomenclature code (TN VED)	None
parent_group_id	str | None	UUID of the parent nomenclature group. The list of values can be retrieved via the "Get a list of nomenclature groups" method. null - the product belongs to the root level	None
percentage_of_alcohol	Decimal | float | None	Alcohol content, %	None
place_type_id	str | None	Place of preparation/sale type. The list of values can be retrieved via the "Get a list of preparation place types" method in the "Directories" category	None
position	int | None	Menu position. 0 - sort by Code+Name; otherwise - sort by this value	None
precheque_printable	bool | None	Print on the pre-cheque	None
price_markup_percent	Decimal | float | None	Fixed markup (%). Stored with up to 9 decimal places	None
print_on_add	bool | None	Print when added to the order	None
producer_ids	Sequence[str] | None	UUIDs of the product's manufacturers. The list of values can be retrieved via the "Get a list of producers" method in the "Directories" category	None
product_article	str | None	Product article (num). If null or not provided, it will be assigned automatically by the API server	None
product_id	str | None	UUID of the product to create. If not specified, the UUID will be generated automatically.	None
product_scale_id	str | None	UUID of the dish size scale. The list of values can be retrieved via the "Get a list of product size scales" method in the "Size scales" category	None
product_size_factors	NomenclatureProductSizeFactors | Mapping[str, Any] | None	Write-off factor table by dish size	None
product_tag_ids	Sequence[str] | None	UUIDs of product tags. The list of values can be retrieved via the "Get a list of product tags" method in the "Directories" category	None
product_type_for_cooking	str | None	Product type for kitchen preparation	None
rate_schedule	NomenclatureProductRateSchedule | Mapping[str, Any] | None	Time-pay service rate schedule	None
relative_rate_schedule	bool | None	The rate schedule is relative (anchored to the start of the service rather than the time of day)	None
source_nature	str | None	Raw material nature	None
tax_category_id	str | None	UUID of the tax category used for the product (VAT/tax calculation). The list of values can be retrieved via the "Get a list of tax categories" method in the "Directories" category in "Finance" section	None
time_pay_product_duration_step_minutes	int | None	Billing step of the time-pay service, minutes	None
transfer_type	str | None	Item transfer type	None
unit_capacity	Decimal | float | None	Volume of a product unit	None
unit_weight	Decimal | float | None	Weight of a product unit	None
use_balance_for_inventory	bool | None	Use stock balance during inventory	None
use_balance_for_sell	bool | None	Use stock balance when selling	None
use_default_cooking_time	bool | None	Use the default cooking time	None
use_range_for_invoices	bool | None	Use a price range in invoices	None
uz_fiscal_code	str | None	Fiscal code of the product for Uzbekistan	None
timeout	float | None	Server-side timeout in seconds (Timeout header). Defaults to the client setting.	None

Returns:

Type	Description
NomenclatureProductCreateResponse	The NomenclatureProductCreateResponse response.

iikoCloud API reference

iiko.nomenclature.product.delete() async

delete(
    *,
    product_ids: Sequence[str],
    timeout: float | None = None,
) -> NomenclatureProductDeleteResponse

Delete products (v2).

POST /api/nomenclature/v2/product/delete

Marks the specified nomenclature products as deleted.

Parameters:

Name	Type	Description	Default
product_ids	Sequence[str]	List of nomenclature product UUIDs to delete	required
timeout	float | None	Server-side timeout in seconds (Timeout header). Defaults to the client setting.	None

Returns:

Type	Description
NomenclatureProductDeleteResponse	The NomenclatureProductDeleteResponse response.

iikoCloud API reference

iiko.nomenclature.product.list() async

list(
    *,
    filters: Sequence[
        NomenclatureProductFilter | Mapping[str, Any]
    ]
    | None = None,
    limit: int | None = None,
    offset: int | None = None,
    timeout: float | None = None,
) -> NomenclatureProductListResponse

Get a list of products (v2).

POST /api/nomenclature/v2/product/list

Returns the organisation's nomenclature — the catalogue of items used to build the menu, run warehouse accounting and generate sales reports. Supports filtering and pagination, which speeds up menu and reference synchronisation on the partner side. By default (when no type filter is set) the method returns nomenclature items of all types available in the organisation's nomenclature. The following base nomenclature types are supported: GOODS (goods/ingredients), DISH (dishes), PREPARED (semi-prepared items), SERVICE (services), MODIFIER (modifiers). To narrow the result to specific types, apply a filter on the type field (for example op: "in"). Filter fields: id / productId, type, name, code, productArticle, description, parentId, categoryId, accountingCategoryId, taxCategoryId, isDeleted, system, revision, deletedAt, createdAt, updatedAt, lastModifyNode, franchiseUniqueId, franchiseMasterId. Allowed operators: id / productId, parentId, categoryId, accountingCategoryId, taxCategoryId, franchiseUniqueId, franchiseMasterId — eq, in; type — eq, ne, in, nin; name, code, productArticle, description — eq, ne, in, nin, like, blank, notblank; isDeleted, system — eq (boolean); revision, createdAt, updatedAt — eq, ne, gt, gte, lt, lte; deletedAt — eq, ne, gt, gte, lt, lte, blank, notblank; lastModifyNode — eq, in, blank, notblank. All filters are combined with AND. Pagination via limit/offset. Nomenclature groups are returned by a separate method /api/nomenclature/v1/group/list. The list is read from an asynchronously updated snapshot of the catalogue (eventual consistency): newly created or modified items may be missing from the response for a short time.

Parameters:

Name	Type	Description	Default
filters	Sequence[NomenclatureProductFilter | Mapping[str, Any]] | None	Request filters. All filters are applied simultaneously (AND). See the method description for the list of supported filter fields	None
limit	int | None	Maximum number of records in the response. Allowed values: 1 to 1000	None
offset	int | None	Number of records to skip from the beginning of the list (0-based). Use together with limit for pagination	None
timeout	float | None	Server-side timeout in seconds (Timeout header). Defaults to the client setting.	None

Returns:

Type	Description
NomenclatureProductListResponse	The NomenclatureProductListResponse response.

iikoCloud API reference

iiko.nomenclature.product.restore() async

restore(
    *,
    product_ids: Sequence[str],
    timeout: float | None = None,
) -> NomenclatureProductUndeleteResponse

Restore products (v2).

POST /api/nomenclature/v2/product/restore

Restores previously deleted nomenclature products. The endpoint is named restore as specified.

Parameters:

Name	Type	Description	Default
product_ids	Sequence[str]	List of nomenclature product UUIDs to restore	required
timeout	float | None	Server-side timeout in seconds (Timeout header). Defaults to the client setting.	None

Returns:

Type	Description
NomenclatureProductUndeleteResponse	The NomenclatureProductUndeleteResponse response.

iikoCloud API reference

iiko.nomenclature.product.update() async

update(
    *,
    amount_unit_id: str,
    code: str,
    name: str,
    product_id: str,
    type: str,
    accounting_category_id: str | None = None,
    alcohol_class: str | None = None,
    allergen_group_ids: Sequence[str] | None = None,
    amount_independent_of_parent_amount: bool | None = None,
    barcodes: Sequence[
        NomenclatureProductBarcode | Mapping[str, Any]
    ]
    | None = None,
    can_buy_from_cashdesk: bool | None = None,
    can_change_amount_cooked_dish: bool | None = None,
    can_set_open_price: bool | None = None,
    category_id: str | None = None,
    cheque_printable: bool | None = None,
    cold_loss_percent: Decimal | float | None = None,
    color: NomenclatureProductRGBColor
    | Mapping[str, Any]
    | None = None,
    containers: Sequence[
        NomenclatureProductContainer | Mapping[str, Any]
    ]
    | None = None,
    cook_with_main_dish: bool | None = None,
    cooking_time_normal: int | None = None,
    cooking_time_peak: int | None = None,
    cooking_type: str | None = None,
    custom_categories: Sequence[
        NomenclatureProductCustomCategory
        | Mapping[str, Any]
    ]
    | None = None,
    default_container_id: str | None = None,
    default_course: int | None = None,
    default_included_in_menu: bool | None = None,
    default_maximum_store_balance_level: Decimal
    | float
    | None = None,
    default_minimum_store_balance_level: Decimal
    | float
    | None = None,
    default_sale_price: Decimal | float | None = None,
    description: str | None = None,
    description_english: str | None = None,
    disabled_product_size_ids: Sequence[str] | None = None,
    egais_alc_code: str | None = None,
    estimated_purchase_price: Decimal | float | None = None,
    excluded_section_ids: Sequence[str] | None = None,
    expiration_date: int | None = None,
    font_color: NomenclatureProductRGBColor
    | Mapping[str, Any]
    | None = None,
    front_image_id: str | None = None,
    full_name: str | None = None,
    full_name_english: str | None = None,
    gtin: str | None = None,
    hot_loss_percent: Decimal | float | None = None,
    images: Sequence[
        NomenclatureProductImage | Mapping[str, Any]
    ]
    | None = None,
    invoice_supplier_id: str | None = None,
    is_calculate_unit_weight: bool | None = None,
    is_dish_of_day: bool | None = None,
    is_fixed_price: bool | None = None,
    is_flyer_program: bool | None = None,
    is_not_in_store_movement: bool | None = None,
    is_nutrition_value_auto_calculated: bool | None = None,
    is_percentage_of_alcohol_applicable: bool | None = None,
    is_time_pay_product: bool | None = None,
    item_category_id: str | None = None,
    markup_settings: Sequence[
        NomenclatureProductMarkupSetting | Mapping[str, Any]
    ]
    | None = None,
    maximum_store_balance_levels: Sequence[
        NomenclatureProductStoreBalanceLevel
        | Mapping[str, Any]
    ]
    | None = None,
    minimum_store_balance_levels: Sequence[
        NomenclatureProductStoreBalanceLevel
        | Mapping[str, Any]
    ]
    | None = None,
    minimum_time_pay_product_duration_minutes: int
    | None = None,
    modifier_schema_id: str | None = None,
    modifier_schema_redefinitions: Sequence[
        NomenclatureProductModifierSchemaRedefinition
        | Mapping[str, Any]
    ]
    | None = None,
    modifiers: Sequence[
        NomenclatureProductModifier | Mapping[str, Any]
    ]
    | None = None,
    name_english: str | None = None,
    name_kitchen: str | None = None,
    nutrition_values: Sequence[
        NomenclatureProductNutritionValue
        | Mapping[str, Any]
    ]
    | None = None,
    outer_economic_activity_nomenclature_code: str
    | None = None,
    parent_group_id: str | None = None,
    percentage_of_alcohol: Decimal | float | None = None,
    place_type_id: str | None = None,
    position: int | None = None,
    precheque_printable: bool | None = None,
    price_markup_percent: Decimal | float | None = None,
    print_on_add: bool | None = None,
    producer_ids: Sequence[str] | None = None,
    product_article: str | None = None,
    product_scale_id: str | None = None,
    product_size_factors: NomenclatureProductSizeFactors
    | Mapping[str, Any]
    | None = None,
    product_tag_ids: Sequence[str] | None = None,
    product_type_for_cooking: str | None = None,
    rate_schedule: NomenclatureProductRateSchedule
    | Mapping[str, Any]
    | None = None,
    relative_rate_schedule: bool | None = None,
    source_nature: str | None = None,
    tax_category_id: str | None = None,
    time_pay_product_duration_step_minutes: int
    | None = None,
    transfer_type: str | None = None,
    unit_capacity: Decimal | float | None = None,
    unit_weight: Decimal | float | None = None,
    use_balance_for_inventory: bool | None = None,
    use_balance_for_sell: bool | None = None,
    use_default_cooking_time: bool | None = None,
    use_range_for_invoices: bool | None = None,
    uz_fiscal_code: str | None = None,
    timeout: float | None = None,
) -> NomenclatureProductUpdateResponse

Update a product (v2).

POST /api/nomenclature/v2/product/update

Updates an existing nomenclature product. The productId (UUID of the product to update), name, type and amountUnitId fields are required.

Parameters:

Name	Type	Description	Default
amount_unit_id	str	UUID of the product's unit of measure (mainUnit). The list of values can be retrieved via the "Get a list of amount units" method in the "Directories" category	required
code	str	Product code: 0–8 digits. Used for quick search on the order editing screen. Required when creating or updating a product	required
name	str	Product name	required
product_id	str	UUID of the product to update	required
type	str	Product type: GOODS (goods/ingredients), DISH (dishes), PREPARED (semi-prepared items), SERVICE (services), MODIFIER (modifiers), OUTER, RATE, PETROL	required
accounting_category_id	str | None	UUID of the accounting category (as configured in the accounting settings)	None
alcohol_class	str | None	Alcohol product class	None
allergen_group_ids	Sequence[str] | None	UUIDs of allergen groups. The list of values can be retrieved via the "Get a list of allergen groups" method in the "Directories" category	None
amount_independent_of_parent_amount	bool | None	The amount does not depend on the parent dish's amount	None
barcodes	Sequence[NomenclatureProductBarcode | Mapping[str, Any]] | None	Product barcodes	None
can_buy_from_cashdesk	bool | None	Can be sold directly from the cash desk	None
can_change_amount_cooked_dish	bool | None	The amount of the cooked dish can be changed	None
can_set_open_price	bool | None	An open price can be set manually	None
category_id	str | None	UUID of the product (custom) category. The list of values can be retrieved via the "Get a list of product categories" method in the "Product categories" category	None
cheque_printable	bool | None	Print on the cheque	None
cold_loss_percent	Decimal | float | None	Weight loss percentage during cold processing	None
color	NomenclatureProductRGBColor | Mapping[str, Any] | None	Background button colour for POS	None
containers	Sequence[NomenclatureProductContainer | Mapping[str, Any]] | None	Product containers/packagings	None
cook_with_main_dish	bool | None	Cook together with the main dish	None
cooking_time_normal	int | None	Cooking time in normal mode, minutes	None
cooking_time_peak	int | None	Cooking time in peak mode, minutes	None
cooking_type	str | None	Cooking method	None
custom_categories	Sequence[NomenclatureProductCustomCategory | Mapping[str, Any]] | None	Custom nomenclature categories. Empty array or null - no categories set	None
default_container_id	str | None	UUID of the default container. The list of values can be retrieved via the "Get a list of containers" method in the "Directories" category	None
default_course	int | None	Default serving course. null - not set; 0 - VIP course; otherwise - course number	None
default_included_in_menu	bool | None	Include the product in the menu by default	None
default_maximum_store_balance_level	Decimal | float | None	Default maximum stock level	None
default_minimum_store_balance_level	Decimal | float | None	Default minimum stock level	None
default_sale_price	Decimal | float | None	Default sale price	None
description	str | None	Product description	None
description_english	str | None	Product description in English	None
disabled_product_size_ids	Sequence[str] | None	UUIDs of the dish sizes disabled for this product. The list of values can be retrieved via the "Get a list of product sizes" method in the "Directories" category	None
egais_alc_code	str | None	EGAIS product type code	None
estimated_purchase_price	Decimal | float | None	Estimated purchase price	None
excluded_section_ids	Sequence[str] | None	UUIDs of the menu sections the product is excluded from. The list of values can be retrieved via the "Get a list of menu sections" method in the "Directories" category	None
expiration_date	int | None	Shelf life, days	None
font_color	NomenclatureProductRGBColor | Mapping[str, Any] | None	Font colour on the button for POS	None
front_image_id	str | None	UUID of the image for POS	None
full_name	str | None	Full product name	None
full_name_english	str | None	Full product name in English	None
gtin	str | None	Global Trade Item Number (GTIN)	None
hot_loss_percent	Decimal | float | None	Weight loss percentage during hot processing	None
images	Sequence[NomenclatureProductImage | Mapping[str, Any]] | None	Product quality certificates	None
invoice_supplier_id	str | None	UUID of the default supplier (counterparty) for incoming invoices of this product. The list of values can be retrieved via the "Get counteragents list" method in the "Counteragents" category in "Inventory" section	None
is_calculate_unit_weight	bool | None	Calculate unit weight automatically	None
is_dish_of_day	bool | None	Dish of the day	None
is_fixed_price	bool | None	Price is set explicitly and does not depend on markup	None
is_flyer_program	bool | None	Participates in the flyer programme	None
is_not_in_store_movement	bool | None	Not included in warehouse stock movement	None
is_nutrition_value_auto_calculated	bool | None	Nutrition value is calculated automatically	None
is_percentage_of_alcohol_applicable	bool | None	Alcohol content is applicable to this product	None
is_time_pay_product	bool | None	Time-pay service product (time-based billing)	None
item_category_id	str | None	Item category (for fiscalisation/accounting) of the product. The list of values can be retrieved via the "Get a list of fiscal categories" method in the "Directories" category in "Finance" section	None
markup_settings	Sequence[NomenclatureProductMarkupSetting | Mapping[str, Any]] | None	Markup settings by organization (structural unit). If not set for an organization, priceMarkupPercent is used	None
maximum_store_balance_levels	Sequence[NomenclatureProductStoreBalanceLevel | Mapping[str, Any]] | None	Maximum stock levels by warehouse. For warehouses without an explicit entry, defaultMaximumStoreBalanceLevel is used	None
minimum_store_balance_levels	Sequence[NomenclatureProductStoreBalanceLevel | Mapping[str, Any]] | None	Minimum stock levels by warehouse. For warehouses without an explicit entry, defaultMinimumStoreBalanceLevel is used	None
minimum_time_pay_product_duration_minutes	int | None	Minimum duration of the time-pay service, minutes	None
modifier_schema_id	str | None	UUID of the modifier schema. The list of values can be retrieved via the "Get a list of modifier schemas" method in the "Directories" category	None
modifier_schema_redefinitions	Sequence[NomenclatureProductModifierSchemaRedefinition | Mapping[str, Any]] | None	Modifier schema value redefinitions for this product	None
modifiers	Sequence[NomenclatureProductModifier | Mapping[str, Any]] | None	Top-level dish modifiers	None
name_english	str | None	Product name in English	None
name_kitchen	str | None	Name for the kitchen screen/printer	None
nutrition_values	Sequence[NomenclatureProductNutritionValue | Mapping[str, Any]] | None	Nutrition values by organization (structural unit) and dish size	None
outer_economic_activity_nomenclature_code	str | None	Foreign economic activity commodity nomenclature code (TN VED)	None
parent_group_id	str | None	UUID of the parent nomenclature group. The list of values can be retrieved via the "Get a list of nomenclature groups" method. null - the product belongs to the root level	None
percentage_of_alcohol	Decimal | float | None	Alcohol content, %	None
place_type_id	str | None	Place of preparation/sale type. The list of values can be retrieved via the "Get a list of preparation place types" method in the "Directories" category	None
position	int | None	Menu position. 0 - sort by Code+Name; otherwise - sort by this value	None
precheque_printable	bool | None	Print on the pre-cheque	None
price_markup_percent	Decimal | float | None	Fixed markup (%). Stored with up to 9 decimal places	None
print_on_add	bool | None	Print when added to the order	None
producer_ids	Sequence[str] | None	UUIDs of the product's manufacturers. The list of values can be retrieved via the "Get a list of producers" method in the "Directories" category	None
product_article	str | None	Product article (num). If null or not provided, it will be assigned automatically by the API server	None
product_scale_id	str | None	UUID of the dish size scale. The list of values can be retrieved via the "Get a list of product size scales" method in the "Size scales" category	None
product_size_factors	NomenclatureProductSizeFactors | Mapping[str, Any] | None	Write-off factor table by dish size	None
product_tag_ids	Sequence[str] | None	UUIDs of product tags. The list of values can be retrieved via the "Get a list of product tags" method in the "Directories" category	None
product_type_for_cooking	str | None	Product type for kitchen preparation	None
rate_schedule	NomenclatureProductRateSchedule | Mapping[str, Any] | None	Time-pay service rate schedule	None
relative_rate_schedule	bool | None	The rate schedule is relative (anchored to the start of the service rather than the time of day)	None
source_nature	str | None	Raw material nature	None
tax_category_id	str | None	UUID of the tax category used for the product (VAT/tax calculation). The list of values can be retrieved via the "Get a list of tax categories" method in the "Directories" category in "Finance" section	None
time_pay_product_duration_step_minutes	int | None	Billing step of the time-pay service, minutes	None
transfer_type	str | None	Item transfer type	None
unit_capacity	Decimal | float | None	Volume of a product unit	None
unit_weight	Decimal | float | None	Weight of a product unit	None
use_balance_for_inventory	bool | None	Use stock balance during inventory	None
use_balance_for_sell	bool | None	Use stock balance when selling	None
use_default_cooking_time	bool | None	Use the default cooking time	None
use_range_for_invoices	bool | None	Use a price range in invoices	None
uz_fiscal_code	str | None	Fiscal code of the product for Uzbekistan	None
timeout	float | None	Server-side timeout in seconds (Timeout header). Defaults to the client setting.	None

Returns:

Type	Description
NomenclatureProductUpdateResponse	The NomenclatureProductUpdateResponse response.

iikoCloud API reference

iiko.nomenclature.product.update_barcodes() async

update_barcodes(
    *,
    barcodes: Sequence[
        NomenclatureProductBarcode | Mapping[str, Any]
    ],
    product_id: str,
    timeout: float | None = None,
) -> NomenclatureProductUpdateBarcodesResponse

Update product barcodes (v2).

POST /api/nomenclature/v2/product/update_barcodes

Replaces all existing barcodes for a specified nomenclature item with a new set. Note: This is a full replacement operation. Any previously assigned barcode values are permanently removed and overwritten by the values provided in the request

Parameters:

Name	Type	Description	Default
barcodes	Sequence[NomenclatureProductBarcode | Mapping[str, Any]]	Barcodes	required
product_id	str	Product ID	required
timeout	float | None	Server-side timeout in seconds (Timeout header). Defaults to the client setting.	None

Returns:

Type	Description
NomenclatureProductUpdateBarcodesResponse	The NomenclatureProductUpdateBarcodesResponse response.

iikoCloud API reference

Nomenclature.AssemblyChart

An assembly chart (technology card) defines the recipe of a dish: its ingredients, amounts, write-off strategy and validity period.

iiko.nomenclature.assembly_chart.assembled() async

assembled(
    *,
    date_from: str | None = None,
    organization_id: str | None = None,
    product_id: str | None = None,
    timeout: float | None = None,
) -> AssemblyChartResponse

Get an assembled chart.

POST /api/nomenclature/v2/assembly-chart/assembled

Returns the top-level assembly chart (without resolving nested ingredient charts) effective for the product on the given date. If no chart is found, returns 200 with an empty body.

Parameters:

Name	Type	Description	Default
date_from	str | None	Date to retrieve the assembly chart for (YYYY-MM-DD)	None
organization_id	str | None	UUID of the organization (department) to build the assembly chart in the context of. Optional	None
product_id	str | None	UUID of the product to retrieve the assembly chart for	None
timeout	float | None	Server-side timeout in seconds (Timeout header). Defaults to the client setting.	None

Returns:

Type	Description
AssemblyChartResponse	The AssemblyChartResponse response.

iikoCloud API reference

iiko.nomenclature.assembly_chart.create() async

create(
    *,
    date_to: str,
    appearance: str | None = None,
    assembled_quantity: Decimal | float | None = None,
    date_from: str | None = None,
    description: str | None = None,
    direct_writeoff_store_specification: StoreSpecification
    | Mapping[str, Any]
    | None = None,
    franchise_master_id: str | None = None,
    franchise_original_id: str | None = None,
    franchise_unique_id: str | None = None,
    id: str | None = None,
    items: Sequence[AssemblyChartItem | Mapping[str, Any]]
    | None = None,
    organoleptic: str | None = None,
    output_comment: str | None = None,
    picture: str | None = None,
    product_id: str | None = None,
    product_size_assembly_strategy: str | None = None,
    technology_description: str | None = None,
    version_compatibility: str | None = None,
    writeoff_strategy: str | None = None,
    timeout: float | None = None,
) -> AssemblyChartCommonResponse

Create an assembly chart (v2).

POST /api/nomenclature/v2/assembly-chart/create

Saves a new assembly chart for a product. If the product was created recently and has not yet appeared in the nomenclature list (eventual consistency), the method may fail with a 502 error. Wait until the product appears in the nomenclature list before creating an assembly chart for it.

Parameters:

Name	Type	Description	Default
date_to	str	End date of the validity period (YYYY-MM-DD)	required
appearance	str | None	Presentation and serving requirements (up to 2000 characters)	None
assembled_quantity	Decimal | float | None	Assembled quantity (bookmark rate). Must be greater than 0	None
date_from	str | None	Start date of the validity period (YYYY-MM-DD)	None
description	str | None	Free-text description field (up to 2000 characters)	None
direct_writeoff_store_specification	StoreSpecification | Mapping[str, Any] | None	Organization (structural unit) filter for DIRECT write-off strategy. null — applies to all organizations	None
franchise_master_id	str | None	Franchise master UUID. null — not a franchise object	None
franchise_original_id	str | None	Franchise original UUID. null — not a franchise object	None
franchise_unique_id	str | None	Franchise unique UUID. Required when franchiseMasterId is set	None
id	str | None	UUID of the assembly chart	None
items	Sequence[AssemblyChartItem | Mapping[str, Any]] | None	Ingredient lines of the assembly chart	None
organoleptic	str | None	Organoleptic quality indicators (up to 2000 characters)	None
output_comment	str | None	Output comment / yield note (up to 2000 characters)	None
picture	str | None	UUID of the technology image. null — no image	None
product_id	str | None	UUID of the product this assembly chart belongs to	None
product_size_assembly_strategy	str | None	Size strategy: COMMON (one chart for all sizes) or SPECIFIC (per-size ingredients)	None
technology_description	str | None	Preparation technology description (up to 2000 characters)	None
version_compatibility	str | None	Version compatibility tag. Only V_7_0 is currently accepted	None
writeoff_strategy	str | None	Write-off strategy: ASSEMBLE (write off ingredients) or DIRECT (write off the product itself)	None
timeout	float | None	Server-side timeout in seconds (Timeout header). Defaults to the client setting.	None

Returns:

Type	Description
AssemblyChartCommonResponse	The AssemblyChartCommonResponse response.

iikoCloud API reference

iiko.nomenclature.assembly_chart.delete() async

delete(
    *, id: str | None = None, timeout: float | None = None
) -> AssemblyChartCommonResponse

Delete an assembly chart (v2).

POST /api/nomenclature/v2/assembly-chart/delete

Deletes an assembly chart by UUID.

Parameters:

Name	Type	Description	Default
id	str | None	UUID of the assembly chart	None
timeout	float | None	Server-side timeout in seconds (Timeout header). Defaults to the client setting.	None

Returns:

Type	Description
AssemblyChartCommonResponse	The AssemblyChartCommonResponse response.

iikoCloud API reference

iiko.nomenclature.assembly_chart.get() async

get(
    *, id: str | None = None, timeout: float | None = None
) -> AssemblyChartResponse

Get an assembly chart by ID (v2).

POST /api/nomenclature/v2/assembly-chart/get

Returns a single assembly chart by its UUID.

Parameters:

Name	Type	Description	Default
id	str | None	UUID of the assembly chart	None
timeout	float | None	Server-side timeout in seconds (Timeout header). Defaults to the client setting.	None

Returns:

Type	Description
AssemblyChartResponse	The AssemblyChartResponse response.

iikoCloud API reference

iiko.nomenclature.assembly_chart.list() async

list(
    *,
    date_from: str | None = None,
    date_to: str | None = None,
    include_deleted_products: bool | None = None,
    include_prepared_charts: bool | None = None,
    known_revision: int | None = None,
    product_id: str | None = None,
    timeout: float | None = None,
) -> AssemblyChartListResponse

Get a list of assembly charts by product (v2).

POST /api/nomenclature/v2/assembly-chart/list

Returns the history of assembly charts for a product. The filter product eq is required. The optional department eq filter restricts results to a specific department. Pagination (limit / offset) is applied client-side. Data is returned from an asynchronously updated snapshot (eventual consistency): recently created or modified assembly charts may be missing from the response for a short time.

Parameters:

Name	Type	Description	Default
date_from	str | None	Start of the sample period (YYYY-MM-DD). Required when productId is not set, or when knownRevision is set	None
date_to	str | None	End of the sample period (YYYY-MM-DD). Optional	None
include_deleted_products	bool | None	Whether to include assembly charts of deleted products. Defaults to true	None
include_prepared_charts	bool | None	Whether to include the breakdown to store items (preparedCharts) in the response. Defaults to false	None
known_revision	int | None	Known revision for incremental synchronization (getAllUpdate). Cannot be combined with productId	None
product_id	str | None	UUID of the product to retrieve assembly charts for	None
timeout	float | None	Server-side timeout in seconds (Timeout header). Defaults to the client setting.	None

Returns:

Type	Description
AssemblyChartListResponse	The AssemblyChartListResponse response.

iikoCloud API reference

iiko.nomenclature.assembly_chart.prepared() async

prepared(
    *,
    date_from: str | None = None,
    organization_id: str | None = None,
    product_id: str | None = None,
    timeout: float | None = None,
) -> PreparedChartDto

Get a prepared chart (breakdown to store items).

POST /api/nomenclature/v2/assembly-chart/prepared

Returns the recipe breakdown of the product down to elementary store items (ingredients written off from stock) for the given date. If no chart is found, returns 200 with an empty body.

Parameters:

Name	Type	Description	Default
date_from	str | None	Date to retrieve the assembly chart for (YYYY-MM-DD)	None
organization_id	str | None	UUID of the organization (department) to build the assembly chart in the context of. Optional	None
product_id	str | None	UUID of the product to retrieve the assembly chart for	None
timeout	float | None	Server-side timeout in seconds (Timeout header). Defaults to the client setting.	None

Returns:

Type	Description
PreparedChartDto	The PreparedChartDto response.

iikoCloud API reference

iiko.nomenclature.assembly_chart.tree() async

tree(
    *,
    date_from: str | None = None,
    organization_id: str | None = None,
    product_id: str | None = None,
    timeout: float | None = None,
) -> ChartTreeNodeDto

Get an assembly chart tree.

POST /api/nomenclature/v2/assembly-chart/tree

Returns the assembly chart tree of the product for the given date: for every ingredient that has its own assembly chart, its composition is recursively resolved. If no chart is found, returns 200 with an empty body.

Parameters:

Name	Type	Description	Default
date_from	str | None	Date to retrieve the assembly chart for (YYYY-MM-DD)	None
organization_id	str | None	UUID of the organization (department) to build the assembly chart in the context of. Optional	None
product_id	str | None	UUID of the product to retrieve the assembly chart for	None
timeout	float | None	Server-side timeout in seconds (Timeout header). Defaults to the client setting.	None

Returns:

Type	Description
ChartTreeNodeDto	The ChartTreeNodeDto response.

iikoCloud API reference

iiko.nomenclature.assembly_chart.update() async

update(
    *,
    date_to: str,
    appearance: str | None = None,
    assembled_quantity: Decimal | float | None = None,
    date_from: str | None = None,
    description: str | None = None,
    direct_writeoff_store_specification: StoreSpecification
    | Mapping[str, Any]
    | None = None,
    franchise_master_id: str | None = None,
    franchise_original_id: str | None = None,
    franchise_unique_id: str | None = None,
    id: str | None = None,
    items: Sequence[AssemblyChartItem | Mapping[str, Any]]
    | None = None,
    organoleptic: str | None = None,
    output_comment: str | None = None,
    picture: str | None = None,
    product_id: str | None = None,
    product_size_assembly_strategy: str | None = None,
    technology_description: str | None = None,
    version_compatibility: str | None = None,
    writeoff_strategy: str | None = None,
    timeout: float | None = None,
) -> AssemblyChartCommonResponse

Update an assembly chart (v2).

POST /api/nomenclature/v2/assembly-chart/update

Updates an existing assembly chart.

Parameters:

Name	Type	Description	Default
date_to	str	End date of the validity period (YYYY-MM-DD)	required
appearance	str | None	Presentation and serving requirements (up to 2000 characters)	None
assembled_quantity	Decimal | float | None	Assembled quantity (bookmark rate). Must be greater than 0	None
date_from	str | None	Start date of the validity period (YYYY-MM-DD)	None
description	str | None	Free-text description field (up to 2000 characters)	None
direct_writeoff_store_specification	StoreSpecification | Mapping[str, Any] | None	Organization (structural unit) filter for DIRECT write-off strategy. null — applies to all organizations	None
franchise_master_id	str | None	Franchise master UUID. null — not a franchise object	None
franchise_original_id	str | None	Franchise original UUID. null — not a franchise object	None
franchise_unique_id	str | None	Franchise unique UUID. Required when franchiseMasterId is set	None
id	str | None	UUID of the assembly chart	None
items	Sequence[AssemblyChartItem | Mapping[str, Any]] | None	Ingredient lines of the assembly chart	None
organoleptic	str | None	Organoleptic quality indicators (up to 2000 characters)	None
output_comment	str | None	Output comment / yield note (up to 2000 characters)	None
picture	str | None	UUID of the technology image. null — no image	None
product_id	str | None	UUID of the product this assembly chart belongs to	None
product_size_assembly_strategy	str | None	Size strategy: COMMON (one chart for all sizes) or SPECIFIC (per-size ingredients)	None
technology_description	str | None	Preparation technology description (up to 2000 characters)	None
version_compatibility	str | None	Version compatibility tag. Only V_7_0 is currently accepted	None
writeoff_strategy	str | None	Write-off strategy: ASSEMBLE (write off ingredients) or DIRECT (write off the product itself)	None
timeout	float | None	Server-side timeout in seconds (Timeout header). Defaults to the client setting.	None

Returns:

Type	Description
AssemblyChartCommonResponse	The AssemblyChartCommonResponse response.

iikoCloud API reference

Nomenclature.NomenclatureProductScale

iiko.nomenclature.product_scale.create() async

create(
    *,
    name: str | None = None,
    product_sizes: Sequence[
        ProductSizeCreateFields | Mapping[str, Any]
    ]
    | None = None,
    timeout: float | None = None,
) -> ProductScaleResponse

Create a product size scale.

POST /api/nomenclature/v1/product-scale/create

Creates a new product size scale (ProductScale) together with the full set of sizes (productSizes[]).

Parameters:

Name	Type	Description	Default
name	str | None	Name of the product size scale	None
product_sizes	Sequence[ProductSizeCreateFields | Mapping[str, Any]] | None	List of sizes in this scale	None
timeout	float | None	Server-side timeout in seconds (Timeout header). Defaults to the client setting.	None

Returns:

Type	Description
ProductScaleResponse	The ProductScaleResponse response.

iikoCloud API reference

iiko.nomenclature.product_scale.delete() async

delete(
    *, id: str | None = None, timeout: float | None = None
) -> ProductScaleResponse

Delete a product size scale.

POST /api/nomenclature/v1/product-scale/delete

Marks the specified product size scale as deleted. The scale must not be in use by any products or modifier schemas.

Parameters:

Name	Type	Description	Default
id	str | None	UUID of the product size scale	None
timeout	float | None	Server-side timeout in seconds (Timeout header). Defaults to the client setting.	None

Returns:

Type	Description
ProductScaleResponse	The ProductScaleResponse response.

iikoCloud API reference

iiko.nomenclature.product_scale.get() async

get(
    *, id: str | None = None, timeout: float | None = None
) -> ProductScaleResponse

Get a product size scale by ID.

POST /api/nomenclature/v1/product-scale/get

Returns a single product size scale (ProductScale) by UUID together with its nested sizes.

Parameters:

Name	Type	Description	Default
id	str | None	UUID of the product size scale	None
timeout	float | None	Server-side timeout in seconds (Timeout header). Defaults to the client setting.	None

Returns:

Type	Description
ProductScaleResponse	The ProductScaleResponse response.

iikoCloud API reference

iiko.nomenclature.product_scale.list() async

list(
    *,
    filters: Sequence[ProductSizeFilter | Mapping[str, Any]]
    | None = None,
    limit: int | None = None,
    offset: int | None = None,
    timeout: float | None = None,
) -> ProductScaleListResponse

Get a list of product size scales.

POST /api/nomenclature/v1/product-scale/list

Returns a list of product size scales (ProductScale) with nested sizes (productSizes[]). Filter fields: id, name, deleted, revision. Allowed operators: id, name, deleted — eq, ne, like, blank, notblank, in, nin; revision — eq only (integer). A revision filter with eq limits the result to scales changed after the specified revision; other operators are not supported for revision. All filters are combined with AND. Pagination via limit/offset.

Parameters:

Name	Type	Description	Default
filters	Sequence[ProductSizeFilter | Mapping[str, Any]] | None	Request filters. All filters are applied simultaneously (AND). See the method description for the list of supported filter fields	None
limit	int | None	Maximum number of records in the response. Allowed values: 1 to 1000	None
offset	int | None	Number of records to skip from the beginning of the list (0-based). Use together with limit for pagination	None
timeout	float | None	Server-side timeout in seconds (Timeout header). Defaults to the client setting.	None

Returns:

Type	Description
ProductScaleListResponse	The ProductScaleListResponse response.

iikoCloud API reference

iiko.nomenclature.product_scale.update() async

update(
    *,
    id: str | None = None,
    name: str | None = None,
    product_sizes: Sequence[
        ProductSizeUpdateFields | Mapping[str, Any]
    ]
    | None = None,
    timeout: float | None = None,
) -> ProductScaleResponse

Update a product size scale.

POST /api/nomenclature/v1/product-scale/update

Updates a product size scale and the complete list of sizes inside it. Sizes absent from the request will be marked deleted.

Parameters:

Name	Type	Description	Default
id	str | None	UUID of the product size scale	None
name	str | None	Name of the product size scale	None
product_sizes	Sequence[ProductSizeUpdateFields | Mapping[str, Any]] | None	List of sizes in this scale	None
timeout	float | None	Server-side timeout in seconds (Timeout header). Defaults to the client setting.	None

Returns:

Type	Description
ProductScaleResponse	The ProductScaleResponse response.

iikoCloud API reference

Nomenclature.NomenclatureCategory

Product categories are user-defined labels for grouping products.

iiko.nomenclature.nomenclature.category.create() async

create(
    *, name: str | None = None, timeout: float | None = None
) -> NomenclatureCategoryWriteResponse

Create a product category.

POST /api/nomenclature/v1/nomenclature/category/create

Creates a new product category. Only the name field is required.

Parameters:

Name	Type	Description	Default
name	str | None	Name of the product category	None
timeout	float | None	Server-side timeout in seconds (Timeout header). Defaults to the client setting.	None

Returns:

Type	Description
NomenclatureCategoryWriteResponse	The NomenclatureCategoryWriteResponse response.

iikoCloud API reference

iiko.nomenclature.nomenclature.category.delete() async

delete(
    *, id: str | None = None, timeout: float | None = None
) -> NomenclatureCategoryWriteResponse

Delete a product category.

POST /api/nomenclature/v1/nomenclature/category/delete

Soft-deletes a product category by UUID. Already deleted categories cannot be deleted again.

Parameters:

Name	Type	Description	Default
id	str | None	UUID of the category to delete	None
timeout	float | None	Server-side timeout in seconds (Timeout header). Defaults to the client setting.	None

Returns:

Type	Description
NomenclatureCategoryWriteResponse	The NomenclatureCategoryWriteResponse response.

iikoCloud API reference

iiko.nomenclature.nomenclature.category.list() async

list(
    *,
    ids: Sequence[str] | None = None,
    include_deleted: bool | None = None,
    limit: int | None = None,
    offset: int | None = None,
    timeout: float | None = None,
) -> NomenclatureCategoryListResponse

Get a list of product categories.

POST /api/nomenclature/v1/nomenclature/category/list

Returns a list of product categories. The list can be narrowed by passing the ids array; pass includeDeleted: true to include soft-deleted categories. Pagination is supported via limit / offset: limit is the maximum number of categories in the response page, offset is the number of categories to skip from the beginning. If limit is not passed or is <= 0, all matching categories are returned. The totalCount field always contains the total number of matching categories (before pagination).

Parameters:

Name	Type	Description	Default
ids	Sequence[str] | None	UUIDs of categories to filter by	None
include_deleted	bool | None	Include deleted categories in the response. Default false	None
limit	int | None	Maximum number of records in the response. limit <= 0 - no limit, all records are returned	None
offset	int | None	Number of records to skip from the beginning of the list (0-based). Use together with limit for pagination	None
timeout	float | None	Server-side timeout in seconds (Timeout header). Defaults to the client setting.	None

Returns:

Type	Description
NomenclatureCategoryListResponse	The NomenclatureCategoryListResponse response.

iikoCloud API reference

iiko.nomenclature.nomenclature.category.restore() async

restore(
    *, id: str | None = None, timeout: float | None = None
) -> NomenclatureCategoryWriteResponse

Restore a product category.

POST /api/nomenclature/v1/nomenclature/category/restore

Restores a previously deleted product category by UUID. Only deleted categories can be restored.

Parameters:

Name	Type	Description	Default
id	str | None	UUID of the category to restore	None
timeout	float | None	Server-side timeout in seconds (Timeout header). Defaults to the client setting.	None

Returns:

Type	Description
NomenclatureCategoryWriteResponse	The NomenclatureCategoryWriteResponse response.

iikoCloud API reference

iiko.nomenclature.nomenclature.category.update() async

update(
    *,
    id: str | None = None,
    name: str | None = None,
    timeout: float | None = None,
) -> NomenclatureCategoryWriteResponse

Update a product category.

POST /api/nomenclature/v1/nomenclature/category/update

Updates an existing product category. Both id (UUID of the category to update) and name (new name) are required.

Parameters:

Name	Type	Description	Default
id	str | None	UUID of the category to update	None
name	str | None	Name of the product category	None
timeout	float | None	Server-side timeout in seconds (Timeout header). Defaults to the client setting.	None

Returns:

Type	Description
NomenclatureCategoryWriteResponse	The NomenclatureCategoryWriteResponse response.

iikoCloud API reference

Nomenclature.Directories

Nomenclature reference data: amount units, containers, producers, product tags and sizes, preparation place types, menu sections, modifier schemas, allergen groups and custom categories.

iiko.nomenclature.allergen_group.list() async

list(
    *,
    filters: Sequence[
        AllergenGroupFilter | Mapping[str, Any]
    ]
    | None = None,
    limit: int | None = None,
    offset: int | None = None,
    timeout: float | None = None,
) -> AllergenGroupListResponse

Get a list of allergen groups.

POST /api/nomenclature/v1/allergen-group/list

Returns a list of allergen groups with filtering and pagination support. Filter fields: id, name, code, isDeleted. Allowed operators: id — eq, in; name, code — eq, ne, in, nin, like, blank, notblank; isDeleted — eq (boolean). All filters are combined with AND. Pagination via limit/offset.

Parameters:

Name	Type	Description	Default
filters	Sequence[AllergenGroupFilter | Mapping[str, Any]] | None	Request filters. All filters are applied simultaneously (AND). See the method description for the list of supported filter fields	None
limit	int | None	Maximum number of records in the response. Allowed values: 1 to 1000	None
offset	int | None	Number of records to skip from the beginning of the list (0-based). Use together with limit for pagination	None
timeout	float | None	Server-side timeout in seconds (Timeout header). Defaults to the client setting.	None

Returns:

Type	Description
AllergenGroupListResponse	The AllergenGroupListResponse response.

iikoCloud API reference

iiko.nomenclature.amount_unit.list() async

list(
    *,
    filters: Sequence[AmountUnitFilter | Mapping[str, Any]]
    | None = None,
    limit: int | None = None,
    offset: int | None = None,
    timeout: float | None = None,
) -> AmountUnitListResponse

Get a list of amount units.

POST /api/nomenclature/v1/amount-unit/list

Returns a list of amount units with filtering and pagination support. Filter fields: id, name, code, isDeleted. Allowed operators: id — eq, in; name, code — eq, ne, in, nin, like, blank, notblank; isDeleted — eq (boolean). All filters are combined with AND. Pagination via limit/offset.

Parameters:

Name	Type	Description	Default
filters	Sequence[AmountUnitFilter | Mapping[str, Any]] | None	Request filters. All filters are applied simultaneously (AND). See the method description for the list of supported filter fields	None
limit	int | None	Maximum number of records in the response. Allowed values: 1 to 1000	None
offset	int | None	Number of records to skip from the beginning of the list (0-based). Use together with limit for pagination	None
timeout	float | None	Server-side timeout in seconds (Timeout header). Defaults to the client setting.	None

Returns:

Type	Description
AmountUnitListResponse	The AmountUnitListResponse response.

iikoCloud API reference

iiko.nomenclature.container.list() async

list(
    *,
    filters: Sequence[ContainerFilter | Mapping[str, Any]]
    | None = None,
    limit: int | None = None,
    offset: int | None = None,
    timeout: float | None = None,
) -> ContainerListResponse

Get a list of containers.

POST /api/nomenclature/v1/container/list

Returns a list of containers with filtering and pagination support. Filter fields: id, name, isDeleted. Allowed operators: id — eq, in; name — eq, ne, in, nin, like, blank, notblank; isDeleted — eq (boolean). All filters are combined with AND. Pagination via limit/offset.

Parameters:

Name	Type	Description	Default
filters	Sequence[ContainerFilter | Mapping[str, Any]] | None	Request filters. All filters are applied simultaneously (AND). See the method description for the list of supported filter fields	None
limit	int | None	Maximum number of records in the response. Allowed values: 1 to 1000	None
offset	int | None	Number of records to skip from the beginning of the list (0-based). Use together with limit for pagination	None
timeout	float | None	Server-side timeout in seconds (Timeout header). Defaults to the client setting.	None

Returns:

Type	Description
ContainerListResponse	The ContainerListResponse response.

iikoCloud API reference

iiko.nomenclature.custom_category.list() async

list(
    *,
    filters: Sequence[
        CustomCategoryFilter | Mapping[str, Any]
    ]
    | None = None,
    limit: int | None = None,
    offset: int | None = None,
    timeout: float | None = None,
) -> CustomCategoryListResponse

Get a list of custom categories.

POST /api/nomenclature/v1/custom-category/list

Returns a list of custom categories with filtering and pagination support. Filter fields: id, name, isDeleted. Allowed operators: id — eq, in; name — eq, ne, in, nin, like, blank, notblank; isDeleted — eq (boolean). All filters are combined with AND. Pagination via limit/offset.

Parameters:

Name	Type	Description	Default
filters	Sequence[CustomCategoryFilter | Mapping[str, Any]] | None	Request filters. All filters are applied simultaneously (AND). See the method description for the list of supported filter fields	None
limit	int | None	Maximum number of records in the response. Allowed values: 1 to 1000	None
offset	int | None	Number of records to skip from the beginning of the list (0-based). Use together with limit for pagination	None
timeout	float | None	Server-side timeout in seconds (Timeout header). Defaults to the client setting.	None

Returns:

Type	Description
CustomCategoryListResponse	The CustomCategoryListResponse response.

iikoCloud API reference

iiko.nomenclature.menu.list() async

list(
    *,
    filters: Sequence[MenuSectionFilter | Mapping[str, Any]]
    | None = None,
    limit: int | None = None,
    offset: int | None = None,
    timeout: float | None = None,
) -> MenuSectionListResponse

Get a list of menu sections.

POST /api/nomenclature/v1/menu/list

Returns a list of menu sections with filtering and pagination support. Filter fields: id, name, isDeleted. Allowed operators: id — eq, in; name — eq, ne, in, nin, like, blank, notblank; isDeleted — eq (boolean). All filters are combined with AND. Pagination via limit/offset.

Parameters:

Name	Type	Description	Default
filters	Sequence[MenuSectionFilter | Mapping[str, Any]] | None	Request filters. All filters are applied simultaneously (AND). See the method description for the list of supported filter fields	None
limit	int | None	Maximum number of records in the response. Allowed values: 1 to 1000	None
offset	int | None	Number of records to skip from the beginning of the list (0-based). Use together with limit for pagination	None
timeout	float | None	Server-side timeout in seconds (Timeout header). Defaults to the client setting.	None

Returns:

Type	Description
MenuSectionListResponse	The MenuSectionListResponse response.

iikoCloud API reference

iiko.nomenclature.modifier_schema.list() async

list(
    *,
    filters: Sequence[
        ModifierSchemaFilter | Mapping[str, Any]
    ]
    | None = None,
    limit: int | None = None,
    offset: int | None = None,
    timeout: float | None = None,
) -> ModifierSchemaListResponse

Get a list of modifier schemas.

POST /api/nomenclature/v1/modifier-schema/list

Returns a list of modifier schemas with filtering and pagination support. Filter fields: id, name, isDeleted. Allowed operators: id — eq, in; name — eq, ne, in, nin, like, blank, notblank; isDeleted — eq (boolean). All filters are combined with AND. Pagination via limit/offset.

Parameters:

Name	Type	Description	Default
filters	Sequence[ModifierSchemaFilter | Mapping[str, Any]] | None	Request filters. All filters are applied simultaneously (AND). See the method description for the list of supported filter fields	None
limit	int | None	Maximum number of records in the response. Allowed values: 1 to 1000	None
offset	int | None	Number of records to skip from the beginning of the list (0-based). Use together with limit for pagination	None
timeout	float | None	Server-side timeout in seconds (Timeout header). Defaults to the client setting.	None

Returns:

Type	Description
ModifierSchemaListResponse	The ModifierSchemaListResponse response.

iikoCloud API reference

iiko.nomenclature.outer_economic_activity_nomenclature_codes.get() async

get(
    *, id: str | None = None, timeout: float | None = None
) -> OuterEconomicActivityNomenclatureCode

Get a foreign economic activity commodity code by ID.

POST /api/nomenclature/v1/outer_economic_activity_nomenclature_codes/get

Returns a foreign economic activity commodity code by UUID. The id field is required. If no code with the given identifier exists, a 404 error is returned.

Parameters:

Name	Type	Description	Default
id	str | None	UUID of the requested foreign economic activity commodity code	None
timeout	float | None	Server-side timeout in seconds (Timeout header). Defaults to the client setting.	None

Returns:

Type	Description
OuterEconomicActivityNomenclatureCode	The OuterEconomicActivityNomenclatureCode response.

iikoCloud API reference

iiko.nomenclature.outer_economic_activity_nomenclature_codes.list() async

list(
    *,
    include_deleted: bool | None = None,
    timeout: float | None = None,
) -> OuterEconomicActivityNomenclatureCodeListResponse

Get the foreign economic activity commodity code directory.

POST /api/nomenclature/v1/outer_economic_activity_nomenclature_codes/list

Returns the entire foreign economic activity commodity code directory. To include soft-deleted codes, pass includeDeleted: true (default false).

Parameters:

Name	Type	Description	Default
include_deleted	bool | None	Include deleted codes in the response. Default false	None
timeout	float | None	Server-side timeout in seconds (Timeout header). Defaults to the client setting.	None

Returns:

Type	Description
OuterEconomicActivityNomenclatureCodeListResponse	The OuterEconomicActivityNomenclatureCodeListResponse response.

iikoCloud API reference

iiko.nomenclature.place_type.list() async

list(
    *,
    filters: Sequence[PlaceTypeFilter | Mapping[str, Any]]
    | None = None,
    limit: int | None = None,
    offset: int | None = None,
    timeout: float | None = None,
) -> PlaceTypeListResponse

Get a list of preparation place types.

POST /api/nomenclature/v1/place-type/list

Returns a list of preparation place types with filtering and pagination support. Filter fields: id, name, isDeleted. Allowed operators: id — eq, in; name — eq, ne, in, nin, like, blank, notblank; isDeleted — eq (boolean). All filters are combined with AND. Pagination via limit/offset.

Parameters:

Name	Type	Description	Default
filters	Sequence[PlaceTypeFilter | Mapping[str, Any]] | None	Request filters. All filters are applied simultaneously (AND). See the method description for the list of supported filter fields	None
limit	int | None	Maximum number of records in the response. Allowed values: 1 to 1000	None
offset	int | None	Number of records to skip from the beginning of the list (0-based). Use together with limit for pagination	None
timeout	float | None	Server-side timeout in seconds (Timeout header). Defaults to the client setting.	None

Returns:

Type	Description
PlaceTypeListResponse	The PlaceTypeListResponse response.

iikoCloud API reference

iiko.nomenclature.producer.list() async

list(
    *,
    filters: Sequence[ProducerFilter | Mapping[str, Any]]
    | None = None,
    limit: int | None = None,
    offset: int | None = None,
    timeout: float | None = None,
) -> ProducerListResponse

Get a list of producers.

POST /api/nomenclature/v1/producer/list

Returns a list of producers with filtering and pagination support. Filter fields: id, name, code, isDeleted. Allowed operators: id — eq, in; name, code — eq, ne, in, nin, like, blank, notblank; isDeleted — eq (boolean). All filters are combined with AND. Pagination via limit/offset.

Parameters:

Name	Type	Description	Default
filters	Sequence[ProducerFilter | Mapping[str, Any]] | None	Request filters. All filters are applied simultaneously (AND). See the method description for the list of supported filter fields	None
limit	int | None	Maximum number of records in the response. Allowed values: 1 to 1000	None
offset	int | None	Number of records to skip from the beginning of the list (0-based). Use together with limit for pagination	None
timeout	float | None	Server-side timeout in seconds (Timeout header). Defaults to the client setting.	None

Returns:

Type	Description
ProducerListResponse	The ProducerListResponse response.

iikoCloud API reference

iiko.nomenclature.product_size.list() async

list(
    *,
    filters: Sequence[ProductSizeFilter | Mapping[str, Any]]
    | None = None,
    limit: int | None = None,
    offset: int | None = None,
    timeout: float | None = None,
) -> ProductSizeListResponse

Get a list of product sizes.

POST /api/nomenclature/v1/product-size/list

Returns a list of product sizes with filtering and pagination support. Filter fields: id, name, isDeleted. Allowed operators: id — eq, in; name — eq, ne, in, nin, like, blank, notblank; isDeleted — eq (boolean). All filters are combined with AND. Pagination via limit/offset.

Parameters:

Name	Type	Description	Default
filters	Sequence[ProductSizeFilter | Mapping[str, Any]] | None	Request filters. All filters are applied simultaneously (AND). See the method description for the list of supported filter fields	None
limit	int | None	Maximum number of records in the response. Allowed values: 1 to 1000	None
offset	int | None	Number of records to skip from the beginning of the list (0-based). Use together with limit for pagination	None
timeout	float | None	Server-side timeout in seconds (Timeout header). Defaults to the client setting.	None

Returns:

Type	Description
ProductSizeListResponse	The ProductSizeListResponse response.

iikoCloud API reference

iiko.nomenclature.product_tag.list() async

list(
    *,
    filters: Sequence[ProductTagFilter | Mapping[str, Any]]
    | None = None,
    limit: int | None = None,
    offset: int | None = None,
    timeout: float | None = None,
) -> ProductTagListResponse

Get a list of product tags.

POST /api/nomenclature/v1/product-tag/list

Returns a list of product tags with filtering and pagination support. Filter fields: id, name, isDeleted. Allowed operators: id — eq, in; name — eq, ne, in, nin, like, blank, notblank; isDeleted — eq (boolean). All filters are combined with AND. Pagination via limit/offset.

Parameters:

Name	Type	Description	Default
filters	Sequence[ProductTagFilter | Mapping[str, Any]] | None	Request filters. All filters are applied simultaneously (AND). See the method description for the list of supported filter fields	None
limit	int | None	Maximum number of records in the response. Allowed values: 1 to 1000	None
offset	int | None	Number of records to skip from the beginning of the list (0-based). Use together with limit for pagination	None
timeout	float | None	Server-side timeout in seconds (Timeout header). Defaults to the client setting.	None

Returns:

Type	Description
ProductTagListResponse	The ProductTagListResponse response.

iikoCloud API reference