SEOshop Documentation

Global variables

shop

The shop variable contains all data associated to the shop.

Variable Description
shop.domain Domain name of the shop
shop.canonical Canonical of the shop
shop.name Name of the shop
shop.title Title of the shop
shop.description Description of the shop, used for meta description
shop.keywords Keywords of the shop, used for meta tags
shop.languages.{{ language.code }}.code Language code of selected language
shop.languages.{{ language.code }}.url URL of selected language
shop.languages.{{ language.code }}.title Full title of selected language
shop.languages.{{ language.code }}.active Expresses boolean if selected language is active
shop.language The language that's active for the visitor
shop.language2.code Language code of active language for the visitor
shop.language2.url URL of active language for the visitor
shop.language2.title Full title of active language for the visitor
shop.language2.active Expresses boolean of active language for the visitor
shop.currencies.{{ currency.code }}.url URL of selected currency
shop.currencies.{{ currency.code }}.symbol Symbol of selected currency
shop.currencies.{{ currency.code }}.code Currency code of selected currency
shop.currencies.{{ currency.code }}.title Full title of selected currency
shop.currencies.{{ currency.code }}.active Expresses boolean of selected currency
shop.currency The currency that's active for the visitor
shop.currency2.url URL of active currency for the visitor
shop.currency2.code Currency code of active currency for the visitor
shop.currency2.title Full title of active currency for the visitor
shop.currency2.active Expresses boolean of active currency for the visitor
shop.base_currency This is the basic currency
shop.domains.normal URL of the shop
shop.domains.secure SSL location of the shop
shop.domains.assets Asset location
shop.domains.files Storage location for files
shop.hallmarks.{{ hallmark.id }}.new_window Expresses boolean for selected hallmark should open in a new window
shop.hallmarks.{{ hallmark.id }}.url URL of the selected hallmark
shop.hallmarks.{{ hallmark.id }}.image Image URL of the selected hallmark
shop.hallmarks.{{ hallmark.id }}.title Full title of selected hallmark
shop.blogs.{{ blog.title }} The selected blog
shop.blogs.{{ blog.title }}.id ID of the selected blog
shop.blogs.{{ blog.title }}.url URL of the selected blog
shop.blogs.{{ blog.title }}.title Title of the selected blog
shop.blogs.{{ blog.title }}.articles.{{ articles.id }}.id ID of the articles in the selected blog
shop.blogs.{{ blog.title }}.articles.{{ articles.id }}.image Image of the articles in the selected blog
shop.blogs.{{ blog.title }}.articles.{{ articles.id }}.url URL of the articles in the selected blog
shop.blogs.{{ blog.title }}.articles.{{ articles.id }}.title Title of the articles in the selected blog
shop.blogs.{{ blog.title }}.articles.{{ articles.id }}.summary Summary of the articles in the selected blog
shop.blogs.{{ blog.title }}.articles.{{ articles.id }}.date Date of the articles in the selected blog
shop.links.service These are the different service links
shop.links.service.{{ service.id }}.new_window Expresses boolean for selected service link should open in a new window
shop.links.service.{{ service.id }}.url URL of the selected service link
shop.links.service.{{ service.id }}.title Full title of selected service link
shop.categories.{{ category.id }}.id ID of the selected category
shop.categories.{{ category.id }}.parent ID of the selected parent category
shop.categories.{{ category.id }}.path Path of the selected category
shop.categories.{{ category.id }}.depth Amount of path of the selected category
shop.categories.{{ category.id }}.image Image of the selected category, if uploaded
shop.categories.{{ category.id }}.type Type of the selected category: 'category', 'text'
shop.categories.{{ category.id }}.url URL of the selected category
shop.categories.{{ category.id }}.title Full title of the selected category
shop.categories.{{ category.id }}.description Description of the selected category
shop.categories.{{ category.id }}.count Count of products in the selected category
shop.categories.{{ category.id }}.subs These are all sub categories in the selected category
shop.brands.{{ brand.id }}.id ID of the selected brand
shop.brands.{{ brand.id }}.image Image ID of the selected brand
shop.brands.{{ brand.id }}.url URL of the selected brand
shop.brands.{{ brand.id }}.title Full title of the selected brand
shop.brands.{{ brand.id }}.count Count of products in the selected brand
shop.brands.{{ brand.id }}.feat Boolean for the products in the selected brand that are featured
shop.tags.{{ tag.id }}.id ID of the selected tag
shop.tags.{{ tag.id }}.url URL of the selected tag
shop.tags.{{ tag.id }}.title Title of the selected tag
shop.tags.{{ tag.id }}.count Amount of products with the selected tag
shop.tags.{{ tag.id }}.index Absolute figure of the tag rank.
shop.payments.{{ payment.title }}.id ID of the selected payment method
shop.payments.{{ payment.title }}.icon Image URL of the selected payment method
shop.payments.{{ payment.title }}.title Full title of the selected payment method
shop.express These are the distributors
shop.settings These are the different settings
shop.settings.catalog These are the catalog settings
shop.settings.catalog.prices Price options for the selected catalog
shop.settings.catalog.variants Variant options for the selected catalog
shop.settings.catalog.collection These are the collection catalog settings
shop.settings.catalog.collection.mode Mode options for the collection catalog settings: 'grid', 'list'
shop.settings.catalog.collection.sort Sort options for the collection catalog settings: 'default', 'popular', 'newest', 'lowest', 'highest'
shop.settings.catalog.collection.limit Limit options for the collection catalog settings (maximum of 24)
shop.settings.checkout These are the checkout options
shop.settings.checkout.minimum_amount Minimum amount options for the checkout
shop.settings.checkout.register Register options for the checkout
shop.settings.checkout.related_products Related products options for the checkout
shop.settings.checkout.coupons Coupons options for the checkout
shop.settings.checkout.calculate_shipping Calculate shipping options for the checkout
shop.settings.checkout.newsletter Newsletter options for the checkout
shop.settings.checkout.create Create options for the checkout
shop.settings.customer These are the customer options
shop.settings.customer.gender Gender options for the customers: 'false', 'optional', 'required'
shop.settings.customer.birthdate Birthdate options for the customers: 'false', 'optional', 'required'
shop.settings.customer.national_id National id options for the customers: 'false', 'optional', 'required'
shop.settings.customer.middlename Middlename options for the customers: 'false', 'optional', 'required'
shop.settings.customer.email Email options for the customers: 'false', 'optional', 'required'
shop.settings.customer.phone Phone options for the customers: 'false', 'optional', 'required'
shop.settings.customer.mobile Mobile options for the customers: 'false', 'optional', 'required'
shop.settings.customer.region Region options for the customers: 'false', 'optional', 'required'
shop.settings.customer.social Expresses boolean if Social Media registration is activated
shop.settings.customer.company These are the company options
shop.settings.customer.company.mode Mode options for companies: 'false', 'optional', 'required'
shop.settings.customer.company.coc CoC option for companies: 'false', 'optional', 'required'
shop.settings.customer.company.vat VAT option for companies: 'false', 'optional', 'required'
shop.settings.legal.mode Legal mode concerned German legalisation: 'normal', 'strict'
shop.settings.script Scripts added in the Backoffice
shop.settings.social These are the social settings
shop.settings.social.facebook Expresses boolean if Facebook setting is activated
shop.settings.social.twitter Expresses boolean if Twitter setting is activated
shop.settings.social.google Expresses boolean if Google+ setting is activated
shop.settings.social.addthis Expresses boolean if AddThis setting is activated
shop.settings.social.vk Expresses boolean if VK setting is activated
shop.settings.stats These are the stats settings
shop.settings.stats.google Google Analytics setting
shop.settings.stats.clicky Clicky stats setting
shop.settings.verify.google Verify google settings

page

The page variable contains all data associated with the current page.

Variable Description
page This is a single page
page.key Key of the page
page.title Title of the page
page.breadcrumbs The breadcrumb path
page.back The previous page
page.cart If you have products in your cart
page.cart.products If you have products in your cart
page.cart.total.price If you have products in your cart
page.account If your user is logged in
page.account.id User ID of the user that is logged in
page.account.gender Gender of the user that is logged in
page.account.email Email of the user that is logged in
page.account.firstname First name of the user that is logged in
page.account.middlename Middle name of the user that is logged in
page.account.lastname Last name of the user that is logged in
page.account.fulllastname Combination of the middle and last name of the user that is logged in
page.account.fullname Combintation of all names of the user that is logged in
page.recent This is the recent page
page.recent.id ID of the recently viewed product
page.recent.vid Variant ID of the recently viewed product
page.recent.image Image ID of the recently viewed product
page.recent.brand Brand of the recently viewed product
page.recent.brand.id Brand ID of the selected brand
page.recent.brand.image Brand image ID of the selected brand
page.recent.brand.url Brand URL of the selected brand
page.recent.brand.title Brand title of the selected brand
page.recent.brand.count Count of products in the selected brand
page.recent.brand.feat Boolean for the products in the selected brand that are featured.
page.recent.code Code of the recently viewed product
page.recent.ean EAN code of the recently viewed product
page.recent.sku SKU code of the recently viewed product
page.recent.score Score of the recently viewed product
page.recent.price Price of the recently viewed product
page.recent.price.price Price of the recently viewed product
page.recent.price.price_incl Price incl. VAT of the recently viewed product
page.recent.price.price_excl Price excl. VAT of the recently viewed product
page.recent.price.price_old Old price of the recently viewed product
page.recent.price.price_old_incl Old price incl. VAT of the recently viewed product
page.recent.price.price_old_excl Old price excl. VAT of the recently viewed product
page.recent.available Availability of the recently viewed product
page.recent.url URL of the recently viewed product
page.recent.title Title of the recently viewed product
page.recent.fulltitle Fulltitle (Brand + Title) of the recently viewed product
page.recent.variant Variant name of the recently viewed product
page.recent.description Description of the recently viewed product
page.recent.data_01 Data_01 field of the recently viewed product
page.compare The products containing the users comparison list
page.messages These are the messages on the page

request

The request variable contains a list of all kind of requests.

Variable Description
request For doing requests
request.method For selecting a request method
request.ssl For the SSL request
request.get Get request
request.post Post request
request.device Device request
request.device.platform Platform request
request.device.type Device type request
request.device.mobile Mobile device request
request.template Template request
request.renderer Renderer request
Was this article helpful? Yes No
One moment please
Thanks for your feedback.