Outlet - Liquid Object Reference
On this page
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.
:::
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 | Register]] 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 Register - Liquid Object Reference]] — registers attached to this outlet -
[[liquid-how-to-global-tags Using global Liquid tags]] — global context variables including current_outlet