Outlet - Liquid Object Reference

Description

The Outlet object exposes a physical retail outlet to Liquid templates. It is primarily available in POS contexts via current_outlet, where it drives sync scope, register selection, and store linking.

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

Backed by

This drop renders the s_c__Outlet__c Salesforce object. A theme writes it as outlet.

Liquid attribute	Salesforce field
address1	s_c__Address1__c
address2	s_c__Address2__c
city	s_c__City__c
phone	s_c__Phone__c
register_code	s_c__Register_Code__c
state	s_c__State__c
tax_number	s_c__Tax_Number__c
zip_code	s_c__Zip_Code__c

Every other attribute on this drop is derived by StoreConnect rather than read straight from one field. The Attributes section lists them all.

Fields you add yourself are not listed above. Expose one with a Custom Data Mapping record, then read it from outlet.data. See custom data fields in Liquid.

Attributes

Attribute	Type	Description
address1	String	First address line for this outlet
address2	String	Second address line for this outlet
city	String	City for this outlet
country	Object	Country for this outlet. In POS, only country.name is available — alpha2, alpha3, and states are not yet supported on the device.
data	Map	Custom data fields for this outlet. Access via field API name (e.g. data.region__c).
id	String	Unique Salesforce ID (sfid) for this outlet
sfid	String	Deprecated — use id instead
name	String	Name of this outlet
phone	String	Phone number for this outlet
register_code	String	Register code for this outlet
registers	Collection	Registers attached to this outlet. Each item is a Register - Liquid Object Reference object.
state	String	State for this outlet
store	Object	The store this outlet belongs to
tax_number	String	Tax number for this outlet
zip_code	String	Zip/postal code for this outlet

Custom data

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

```liquid

{{ current_outlet.data.region__c }} {{ current_outlet.data.s_c__warehouse_id__c }} ```

Usage

```liquid

{{ current_outlet.name }} {{ current_outlet.address1 }}, {{ current_outlet.city }} {{ current_outlet.state }} {{ current_outlet.zip_code }}

{% for register in current_outlet.registers %} {{ register.name }} ({{ register.id }}) {% endfor %}

{{ current_outlet.data.region__c }} ```

Related

• Register - Liquid Object Reference — registers attached to this outlet
• Using global Liquid tags — global context variables including current_outlet

Available on

• Register - Liquid Object Reference — outlet