20Tabs

Link a child device to a parent device (e.g. attach a printer or customer-facing display to a register). The link is rejected if the child's kind is not in the parent's allowed_linked_device_kinds (see devices_show). Idempotent.

device_links_create

Unlink a child device from a parent device. The devices themselves are not deleted.

device_links_destroy

Create a device. The 'kind' determines required fields and the shape of 'settings': register (subtype: register|handheld) — settings: timeout_seconds, default_view, enable_direct_sales, enable_future_orders, skip_cash_register_bump (default false; set true so cash payments made on this device do not open the linked cash register, e.g. for a handheld used on a terrace). Requires quickselect_page_id. customer_facing_display — no settings. preparation_display (subtype: preparation|runner) — settings: preparation_chime, undock_state. Requires preparation_location_ids. kiosk — settings: timeout_seconds, success_timeout_seconds, fail_timeout_seconds, touchscreen, split_direction, start_message, pin, qr_after_checkout. backoffice_display — no settings. network_printer — settings: host, port, characters_per_line (>=40). bluetooth_printer — settings: characters_per_line (>=40).

devices_create

List the organization's devices (POS registers, kitchen displays, printers, customer-facing screens). Filter by kind to narrow down. The returned settings hash is type-specific.

devices_list

Show a single device with its type-specific settings and the list of devices it has linked as children (e.g. printers and customer-facing displays attached to a register).

devices_show

Update a device. The kind (STI type) cannot be changed after creation. The settings hash is merged into the existing settings, not replaced — pass an explicit null to clear a key.

devices_update

Return the current authentication context: organization, app, granted scopes. Useful for debugging or branching tool usage on available permissions.

me

Returns revenue totals for a date range, grouped by category, employee, device, or tax rate.

orders_revenue

Returns daily revenue per category of revenue for a date range, useful for trend charts.

orders_revenue_timeseries

List payment methods. Use the returned id as payment_method_id in reports_payments / payments_search.

payment_methods_list

Track down a specific payment. Filter by date range, payment method, customer, receipt, or amount range (in EUR).

payments_search

Create a preparation location. preparation_states must include the required states 'unrequested', 'requested', and 'delivered'. Defaults to the standard kitchen flow if omitted.

preparation_locations_create

Permanently delete a preparation location. Fails if it is still routing products or linked to a device.

preparation_locations_destroy

List preparation locations (kitchens, bars, prep stations). Each location has a set of preparation states it tracks and an optional set of states that trigger printing. Use the returned id as preparation_location_id elsewhere.

preparation_locations_list

Show a single preparation location along with counts of products routed to it and devices linked to it.

preparation_locations_show

Update a preparation location. When changing preparation_states the new list must still include 'unrequested', 'requested', and 'delivered'.

preparation_locations_update

List the organization's preparation states (one row per canonical state: unrequested, requested, ready_to_prepare, preparing, prepared, ready_to_deliver, delivered). Each row carries the display label, button label, color, and visibility flag for kitchen displays.

preparation_states_list

Update a preparation state's display attributes (color, label, button label, visibility). Preparation states are seeded one-per-organization and cannot be created or deleted via this API.

preparation_states_update

Create a product category. Assign it to products with products_create / products_update.

product_categories_create

List product categories. Use the returned id as product_category_ids in products_create / products_update, or as product_category_ids in reports_sales.

product_categories_list

Show a single product category.

product_categories_show

Update a product category's name.

product_categories_update

Archive a product option group so it no longer appears in unarchived lists. Fails if the group is still attached to any product.

product_option_groups_archive

Create a product option group. The 'kind' determines how its options behave: add_on/product_add_on append additional items to a receipt; option/product_option substitute or modify the parent product.

product_option_groups_create

List product option groups. Each group bundles a set of options (modifiers, side dishes, sizes) that can be attached to one or more products.

product_option_groups_list

Show a single product option group and the options it contains.

product_option_groups_show

Update a product option group. The kind (STI type) cannot be changed after creation.

product_option_groups_update

Add an option to a product option group. 'custom' options are free-form (name + price). 'product' options reference an existing product (price, tax, category, preparation location are inherited from that product unless overridden).

product_options_create

Permanently delete a product option. Receipt items keep their snapshot price/name, so historical receipts are unaffected, but the option will disappear from any group it was part of.

product_options_destroy

Update an option within a product option group. The kind (STI type) cannot be changed after creation.

product_options_update

Create a new product.

products_create

Attach a product option group to a product. Idempotent: returns the existing join row if the group is already attached.

products_option_groups_create

Detach a product option group from a product. The option group itself is not deleted.

products_option_groups_destroy

Search products by name or PLU/barcode.

products_search

Returns the best-selling products for a date range, ordered by number of times sold.

products_top_selling

Update an existing product's attributes.

products_update

Create a category (tab) inside a quickselect page. Position is auto-assigned to the end.

quickselect_categories_create

Delete a quickselect category. Cascades to its buttons.

quickselect_categories_destroy

Update a quickselect category's name or position.

quickselect_categories_update

Create a new quickselect page. Position is auto-assigned to the end.

quickselect_pages_create