General¶

Endpoints of the General section of the iikoCloud API documentation.

Authorization¶

Authorization API.

iiko.access_token() `async` ¶

access_token(
    *,
    api_key: str,
    app_id: str,
    client_secret: str,
    timeout: float | None = None,
) -> GetAccessTokenV2Response

Retrieve session key for API access (v2).

POST /api/v2/access_token

Authenticates an application and returns a short-lived JWT token for subsequent API calls.

Getting started: 1. Register at https://public-api.iikoweb.ru/portal and fill in your company details. 2. Create an application — you will receive an appId and a one-time clientSecret. 3. In iikoWeb → "Integrations" → "API Keys", generate an API key. 4. Call this method with all three credentials. 5. Use the returned token as a Bearer token in the Authorization header of all subsequent API requests: Authorization: Bearer {token}. Token lifetime: the token is valid for 1 hour. The exact expiration is encoded in the JWT exp claim. Request a new token before the current one expires — there is no refresh token flow.

Parameters:

Name	Type	Description	Default
`api_key`	`str`	API key generated in iikoWeb under "Integrations → API Keys". The key determines which restaurant organizations the token grants access to.	required
`app_id`	`str`	Unique application identifier issued by the iiko Developer Portal (https://public-api.iikoweb.ru/portal). You receive it when you register a new application in your developer account. The `appId` never changes for the lifetime of the application.	required
`client_secret`	`str`	Application secret key issued by the iiko Developer Portal (https://public-api.iikoweb.ru/portal). The secret is shown only once — right after the application is created. Store it securely. If the secret is lost or compromised, regenerate it in the Developer Portal; the previous secret will be revoked immediately.	required
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Returns:

Type	Description
`GetAccessTokenV2Response`	The `GetAccessTokenV2Response` response.

Name	Type	Description	Default
`body`	`SendNotificationRequest \| Mapping[str, Any]`	Request body.	required
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Name	Type	Description	Default
`organization_ids`	`Sequence[str] \| None`	Organizations IDs which have to be returned. By default - all organizations from apiLogin. Can be obtained by `/api/1/organizations` operation.	`None`
`return_additional_info`	`bool \| None`	A sign whether additional information about the organization should be returned (RMS version, country, restaurantAddress, etc.), or only minimal information should be returned (id and name).	`None`
`include_disabled`	`bool \| None`	Attribute that shows that response contains disabled organizations.	`None`
`return_external_data`	`Sequence[str] \| None`	External data keys that have to be returned.	`None`
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Name	Type	Description	Default
`organization_ids`	`Sequence[str]`	Organizations IDs for which information is requested. Can be obtained by `/api/1/organizations` operation.	required
`include_disabled`	`bool \| None`	Attribute that shows that response contains disabled terminal groups.	`None`
`return_external_data`	`Sequence[str] \| None`	External data keys that have to be returned.	`None`
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Name	Type	Description	Default
`organization_ids`	`Sequence[str]`	Organization IDs. Can be obtained by `/api/1/organizations` operation.	required
`terminal_group_ids`	`Sequence[str]`	List of terminal groups IDs. Can be obtained by `/api/1/terminal_groups` operation.	required
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Name	Type	Description	Default
`organization_ids`	`Sequence[str]`	Organizations ids which delivery cancel causes needs to be returned. Can be obtained by `/api/1/organizations` operation.	required
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Name	Type	Description	Default
`organization_ids`	`Sequence[str]`	Organizations IDs which payment types have to be returned. Can be obtained by `/api/1/organizations` operation.	required
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Name	Type	Description	Default
`organization_ids`	`Sequence[str]`	Organization IDs that require discounts return. Can be obtained by `/api/1/organizations` operation.	required
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Name	Type	Description	Default
`organization_ids`	`Sequence[str]`	Organizations ids which removal types needs to be returned. Can be obtained by `/api/1/organizations` operation.	required
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Name	Type	Description	Default
`organization_id`	`str`	Organization id.	required
`extra_data`	`bool \| None`	Extra data.	`None`
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Name	Type	Description	Default
`items`	`Sequence[OrderItem \| Mapping[str, Any]]`	Items with modifiers included in combo.	required
`organization_id`	`str`	Organization id.	required
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Name	Type	Description	Default
`external_menu_id`	`str`	External menu id Can be obtained by `api/2/menu` operation.	required
`organization_id`	`str`	Organization ID. Can be obtained by `/api/1/organizations` operation.	required
`price_category_id`	`str \| None`	Price category id. Can be obtained by `api/2/menu` operation.	`None`
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Name	Type	Description	Default
`organization_ids`	`Sequence[str]`	Organizations for which out-of-stock lists will be requested. Can be obtained by `/api/1/organizations` operation.	required
`return_size`	`bool \| None`	Flag indicating the need to return the sizes of the dish.	`None`
`terminal_groups_ids`	`Sequence[str] \| None`	List of terminal groups for which you need to get out-of-stock lists. Can be obtained by `/api/1/terminal_groups` operation.	`None`
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Name	Type	Description	Default
`organization_id`	`str`	Organization id which "correlationId" belongs to. Can be obtained by `/api/1/organizations` operation.	required
`correlation_id`	`str`	Operation ID obtained from any command supporting operations.	required
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Name	Type	Description	Default
`organization_ids`	`Sequence[str]`	List of organizations.	required
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Name	Type	Description	Default
`organization_ids`	`Sequence[str]`	List of organizations. Can be obtained by `/api/1/organizations` operation.	required
`roles_to_check`	`Sequence[str]`	Employee's roles for check. The short name of employee's position.	required
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Name	Type	Description	Default
`organization_ids`	`Sequence[str]`	List of organizations for drivers coordinates of which will be retrieved.	required
`offset_in_seconds`	`int \| None`	Interval in seconds from current server time. If driver coordinates were recorded in server storage within interval: ("current server time" - OffsetInSeconds, "current server time"], driver and their coordinates will be retrieved.	`None`
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Name	Type	Description	Default
`employee_id`	`str`	See the API reference.	required
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

General¶

Authorization¶

iiko.access_token() async ¶

Notifications¶

iiko.notifications.send() async ¶

Organizations¶

iiko.organizations() async ¶

iiko.organizations.settings() async ¶

Terminal groups¶

iiko.terminal_groups() async ¶

iiko.terminal_groups.awake() async ¶

iiko.terminal_groups.is_alive() async ¶

Dictionaries¶

iiko.cancel_causes() async ¶

iiko.deliveries.order_types() async ¶

iiko.discounts() async ¶

iiko.payment_types() async ¶

iiko.removal_types() async ¶

iiko.tips_types() async ¶

Menu¶

iiko.combo() async ¶

iiko.combo.calculate() async ¶

iiko.menu() async ¶

iiko.menu.by_id() async ¶

iiko.nomenclature() async ¶

iiko.stop_lists() async ¶

iiko.stop_lists.add() async ¶

iiko.stop_lists.check() async ¶

iiko.stop_lists.clear() async ¶

iiko.stop_lists.remove() async ¶

Operations¶

iiko.commands.status() async ¶

Employees¶

iiko.employees.couriers() async ¶

iiko.employees.couriers.active_location() async ¶

iiko.employees.couriers.active_location.by_terminal() async ¶

iiko.employees.couriers.by_role() async ¶

iiko.employees.couriers.locations.by_time_offset() async ¶

iiko.employees.info() async ¶

iiko.employees.shift.clockin() async ¶

iiko.employees.shift.clockout() async ¶

iiko.employees.shift.is_open() async ¶

iiko.employees.shifts.by_courier() async ¶

iiko.access_token() `async` ¶

iiko.notifications.send() `async` ¶

iiko.organizations() `async` ¶

iiko.organizations.settings() `async` ¶

iiko.terminal_groups() `async` ¶

iiko.terminal_groups.awake() `async` ¶

iiko.terminal_groups.is_alive() `async` ¶

iiko.cancel_causes() `async` ¶

iiko.deliveries.order_types() `async` ¶

iiko.discounts() `async` ¶

iiko.payment_types() `async` ¶

iiko.removal_types() `async` ¶

iiko.tips_types() `async` ¶

iiko.combo() `async` ¶

iiko.combo.calculate() `async` ¶

iiko.menu() `async` ¶

iiko.menu.by_id() `async` ¶

iiko.nomenclature() `async` ¶

iiko.stop_lists() `async` ¶

iiko.stop_lists.add() `async` ¶

iiko.stop_lists.check() `async` ¶

iiko.stop_lists.clear() `async` ¶

iiko.stop_lists.remove() `async` ¶

iiko.commands.status() `async` ¶

iiko.employees.couriers() `async` ¶

iiko.employees.couriers.active_location() `async` ¶

iiko.employees.couriers.active_location.by_terminal() `async` ¶

iiko.employees.couriers.by_role() `async` ¶

iiko.employees.couriers.locations.by_time_offset() `async` ¶

iiko.employees.info() `async` ¶

iiko.employees.shift.clockin() `async` ¶

iiko.employees.shift.clockout() `async` ¶

iiko.employees.shift.is_open() `async` ¶

iiko.employees.shifts.by_courier() `async` ¶