Skip to content
Log in

Register - Liquid Object Reference

On this page

Description

The Register object exposes a POS register attached to an Outlet - Liquid Object Reference to Liquid templates. It is available via current_register in POS contexts, and via the registers collection on an Outlet.

:::note current_register is available in POS Liquid templates and sync scope filters only. It is not populated in web theme templates. :::

Attributes

Attribute Type Description
active? Boolean True if this register is active
connected? Boolean True if this register is currently connected
data Map Custom data fields for this register. Access via field API name (e.g. data.lane_number__c).
id String Unique Salesforce ID (sfid) for this register
sfid String Deprecated — use id instead
name String Name of this register
outlet Outlet - Liquid Object Reference The outlet this register belongs to

Boolean attribute convention

active? and connected? use the Liquid predicate convention (trailing ?). Use these forms in templates:

```liquid

{% if current_register.active? %}Active{% endif %} {% if current_register.connected? %}Connected{% endif %} ```

The bare active and connected accessors (without ?) still work but are deprecated and emit a console warning. Use the ? form in all new templates.

Custom data

Custom fields defined on the Register Salesforce object are accessible via the data map using the field API name:

```liquid

{{ current_register.data.lane_number__c }} ```

Usage

```liquid

{{ current_register.name }} {% if current_register.connected? %}Connected{% endif %}

{{ current_register.outlet.name }}

{{ current_register.data.lane_number__c }} ```

Related articles

Documentation Outlet - Liquid Object Reference Documentation Using global Liquid tags

Was this article helpful?

Was this article helpful?