Store Functions

The Store and all of their content is accessible using a small family of Smarty functions.

This article offers a brief overview of the functions available in the Aurora front-end for accessing the Store data and how to use them.

Introduction

The store configured in Aurora can be accessed using a simple Smarty Function designed to allow you to get it's data whenever you need it in the Aurora front-end.

Store (get_store)

With this function the data for the store can be retrieved.

Accepted Parameters

Parameter	Value	Default	Description	Required
item	String	aurora_store	The name of the Smart Template Variable into which you would like to load the data being requested.	No
store_id	Integer		The Internal ID Aurora uses to identify a Store.	One of store_reference or store_id must be provided.
store_reference	String		The unique Store Reference set against a Store.	One of store_reference or store_id must be provided.

Data Returned

Field	Values	Description
[ item ].x	Array( )	The data returned by this function is saved to the variable named in the item parameter.
item.store_reference	String	The Store Reference of the Store.
item.id	Integer	Unique Internal Aurora ID used to identify a Store.
item.active	Integer	Is the Store considered active by Aurora. Values [ 1 \| 0 ]
item.name	String	The name of the Store.
item.filename	String	The URL safe name of the Store.
item.address_1	String	The address 1 set for the Store.
item.address_2	String	The address 2 set for the Store.
item.town	String	The town set for the Store’s address.
item.county	String	The county set for the Store’s address.
item.opening_hours	String	This field is free-form, but will contain any configured opening times set for the Store.
item.telephone	String	The telephone number for the Store.
item.latitude	Float	The location of the Store by latitude.
item.longitude	Float	The location of the Store by longitude.
item.collect_in_store	Integer	Does the Store allow collection of orders? Values [ 1 \| 0 ]
item.country_id	Integer	Unique Internal Aurora ID used to identify a Country.
item.country_name	String	The name of the country as configured in Aurora.
item.store_type_id	Integer	Unique Internal Aurora ID used to identify a Store Type.
item.store_type_name	String	The name of the store type as configured in Aurora.
item.fields	Array( )	This will be a key/value pairing of Store Additional Fields, by Safe Field Name / Field Value.

Example template code

{get_store store_id="13"}

{$aurora_store.name}

{get_store store_reference="0001S"}

{$aurora_store.name}

{get_store store_reference="0001S" item="store"}

{$store.name}

Updated 2 months ago