Terminals

Endpoints of the Terminals section of the iikoCloud API documentation.

Terminals.Terminals

iiko.terminals.terminals.list() async

list(
    *,
    organization_id: str,
    include_anonymous: bool | None = None,
    search: str | None = None,
    timeout: float | None = None,
) -> TerminalListResponse

List of terminals.

POST /api/terminals/v1/terminals/list

Returns a list of terminals

Parameters:

Name	Type	Description	Default
organization_id	str	Organization identifier (GUID)	required
include_anonymous	bool | None	Include anonymous terminals. Default value: false	None
search	str | None	Filter by terminal name	None
timeout	float | None	Server-side timeout in seconds (Timeout header). Defaults to the client setting.	None

Returns:

Type	Description
TerminalListResponse	The TerminalListResponse response.

iikoCloud API reference

Terminals.CashRegisters

iiko.terminals.cash_registers.list() async

list(
    *,
    organization_id: str,
    limit: int | None = None,
    offset: int | None = None,
    search: str | None = None,
    terminal_group_ids: Sequence[str] | None = None,
    timeout: float | None = None,
) -> CashRegisterListResponse

List of cash registers.

POST /api/terminals/v1/cash-registers/list

Returns the list of cash registers of the organization

Parameters:

Name	Type	Description	Default
organization_id	str	Organization identifier (GUID)	required
limit	int | None	Items per page. Default value: 50, from 1 to 1000	None
offset	int | None	Offset. Default value: 0, non-negative	None
search	str | None	Case-insensitive substring search by name or number	None
terminal_group_ids	Sequence[str] | None	Filter by terminal group identifiers (UUID). Duplicates do not affect the result	None
timeout	float | None	Server-side timeout in seconds (Timeout header). Defaults to the client setting.	None

Returns:

Type	Description
CashRegisterListResponse	The CashRegisterListResponse response.

iikoCloud API reference