Store - Liquid Object Reference - 0.11.3
Object Name | Store |
Version | 0.11.3 |
Description
The Store object contains information about the Store
Attributes
Attribute | Type | Description |
---|---|---|
campaigns | List[Campaign] | Returns a list of Campaigns for this Store |
code | String | Returns the value of the Code attribute |
currency_code | String | Returns the currency code of the Store, eg: AUD |
currency_symbol | String | Returns the currency symbol of the Store, eg: $ |
domain | String | Returns the Store’s domain |
id | String | Returns the Store’s unique id |
locale | String | Returns the Store’s locale |
logo | Image | Returns the Store’s logo Image |
name | String | Returns the Store’s name |
scripts | List[Script] | Returns a list of global Scripts for the Store |
styles | List[Style] | Returns a list of global Styles for the Store |
terms_conditions_page | Page | Returns the Page that has been set up as the Terms and Conditions page |
timezone | String | Returns the Store’s Timezone |
zone | Zone | Returns the Store’s Zone |
Customizations
The site can be customized using various attributes
Attribute | Type | Description |
---|---|---|
body_content | ContentBlock | Returns a ContentBlock to be rendered just before the closing <body> tag |
footer | ContentBlock | Returns a ContentBlock to be rendered as the footer |
footer_menu | Menu | Returns a Menu to be rendered in the footer |
global_css | String | Returns global CSS for the site. This should be output in the site template inside <style> tags in the header |
global_javascript | String | Returns global Javascript for the site. This should be output in the site template inside <script> tags in the header |
head_content | ContentBlock | Returns a ContentBlock to be rendered just before the closing <head> tag |
header | ContentBlock | Returns a ContentBlock to be rendered as the header |
header_menu | Menu | Returns a Menu to be rendered in the header |
Related Objects
Various objects related to the Store
Attribute | Type | Description |
---|---|---|
authentication_providers | List[AuthenticationProvider] | Returns a list of AuthenticationProviders that can be used to login to the Store |
navigation_categories | List[ProductCategory] | Returns a list of top level Product Categories that can be shown in the navigation menu |
SEO
These are some attributes that are useful for SEO purposes
Attribute | Type | Description |
---|---|---|
meta_description | String | Returns the value of the Meta Description attribute |
meta_keywords | String | Returns the value of the Meta Keywords attribute |
meta_title | String | Returns the value of the Meta Title attribute |
social_image | Image | Returns the image to be used when sharing pages from this Store |
Settings
Various settings for the Store
Attribute | Type | Description |
---|---|---|
display_currency? | Boolean | Returns true if this Store is configured to display prices in currency (ie normal prices) |
display_points? | Boolean | Returns true if this Store is configured to display prices in points |
geolocation | Geolocation | Returns an Object with the Geolocation settings |
has_vouchers? | Boolean | Returns true if this Store has vouchers that can be used |
shipping_enabled? | Boolean | Returns true if this Store has Shipping enabled |
tax_inclusive? | Boolean | Indicates whether this Store’s pricing is tax inclusive |
SSO
Settings for single sign on
Attribute | Type | Description |
---|---|---|
local_login? | Boolean | Returns true if this Store uses username/password for customer login |
sso_login? | Boolean | Returns true if this Store uses SSO for customer login |
sso_reset_password? | Boolean | Returns true if this Store has an SSO provider that allows password resets |
Store Account Links
A set of links to other Account related pages
Attribute | Type | Description |
---|---|---|
account_credits_path | String | Returns the link path for the Account’s Account Credits page |
account_path | String | Returns the link path for the Account’s Summary page |
account_points_path | String | Returns the link path for the Account’s Account Points page |
orders_path | String | Returns the link path for the Account’s Order page |
product_approvals_path | String | Returns the link path for the Account’s Product Approvals pages |
subscriptions_path | String | Returns the link path for the Account’s Subscriptions pages |
Store Links
A set of links to other pages on the Store
Attribute | Type | Description |
---|---|---|
cart_path | String | Returns the link path for the Cart |
checkout_path | String | Returns the link path for the Checkout |
forgot_password_path | String | Returns the link path to start the Forgot Password process |
home_path | String | Returns the link path for the Home page |
login_path | String | Returns the link path for the Login page |
logout_path | String | Returns the link path for the Logout page |
path | String | Returns the url path for this Store |
resend_confirmation_path | String | Returns the link path to start the Resend Confirmation process |
search_path | String | Returns the link path for the Search page |
url | String | Returns the complete url for this Store |
Objects that return Stores
Back to Liquid Reference for 0.11.3
Back to Documentation