Skip to content

Permissions

Hyvä POS is on the App Store

The free app is out for iPhone, iPad and Mac: install it from the App Store, connect your Magento store and sell. PRO, the Magento module with a license per terminal, follows shortly. News and pricing are at hyva.io/pos.

The app only works with what your API user is allowed to see. During setup it tests the connection and checks each resource it needs, and lists the permissions that are missing. This page lists what the app checks and what happens when a resource is not available.

Resources the App Checks

Magento ACL resource What it enables in the app
Magento_Backend::store Store configuration (store/storeConfigs): the store views, their currency, timezone and locale, read on connect and when the store view changes. On the free tier the register takes its first tax country from the store's locale
Magento_Sales::sales_order The Orders tab, order search, order management
Magento_Sales::invoice Invoice data on orders, email receipts via invoice email
Magento_Sales::creditmemo Refunds and exchanges (credit memo creation)
Magento_Sales::shipment Shipment data, pickup completion
Magento_Catalog::products The product catalog, search, scan-to-cart
Magento_Catalog::categories Category browsing
Magento_Customer::customer Customer search, creation, and management
Magento_SalesRule::quote Cart price rules and coupon codes. The register reads the store's cart price rules to apply them at the counter, offline too, and looks a coupon code up when the cashier enters one. Without it the register logs an authorization error on the first rule read and sells without cart rules
Magento_Tax::manage_tax Tax rates, rules and classes. The register reads them to price every line with the right tax, offline too
Magento_Catalog::attributes_attributes Product attributes: the labels of the options a configurable product is sold by, and the attributes the register reads for a product's details
Hyva_InventoryOrderReservation::capabilities The stock registration module's check: the row under Settings → Inventory, and the probe the store config sync runs. The module's own permission, listed under Sales as "Order stock registration: read capabilities"
Magento_InventoryApi::source Multi-Source Inventory stock levels and sources. Whether the register uses Multi-Source Inventory is a setting, not a runtime check: the connection test sets it once (row Inventory (Multi-Source)), and it can be changed under Settings → Inventory → Use Multi-Source Inventory. On PRO it comes from Stores → Configuration → Hyvä POS → Terminal Defaults → Stock → Use Multi-Source Inventory, per location, and Lock Use Multi-Source Inventory keeps the device from changing it
Magento_InventorySalesApi::stock The website's stock: the stock a website sells from and a product's salable quantity on it, the figure the free register checks a line against (the connection test's Inventory (website stock) row). Without it the free register shows no stock figure, and a line whose stock cannot be read stops at Pay with a Retry.

The connection test runs during guided setup and again whenever you re-test from settings. A missing permission does not block the connection: the app disables the affected area and keeps everything else working. A register without customer permission can still sell; it just cannot attach customers.

The same screen reports one row that is not a permission: Hyvä POS Module for PRO users. When the module is absent, the row reports it as not installed and the free version in use. That is not a fault: setup continues, and the register runs the free tier. When the module is present, the wizard gains its PRO steps.

Staff permissions on PRO

The resources above decide what the register can read in Magento. On PRO, what each staff member may do at the register is a separate set of role permissions under Hyvä POS → Staff → Roles, such as Apply Discounts, Price Override, Approve Returns and Issue Refunds. See staff and roles.

A Dedicated Role for the POS

This is optional, since any account with the resources above works, but we recommend a dedicated Magento role for the POS integration instead of reusing a personal admin account:

  1. System → Permissions → User Roles → Add New Role.
  2. Under Role Resources, grant the resources from the table above.
  3. Attach the role to the integration (for token or OAuth authentication) or to a dedicated admin user (for admin login).

A dedicated role keeps the register's access as small as possible, and revoking it later does not affect anyone's admin account.

Placing orders

Orders are placed through the standard Magento sales API with the same resource (Magento_Sales::sales_order) used for reading orders. There is no separate "create order" resource to grant.