Modules

Module Placement in Template

To incorporate any module into your webstore template:

Text

{{ modules | raw }}

This placeholder auto-populates with modules you’ve configured in the module section.

File Name: module.giftcard_balance.html
Directory: Root

Name	Type	Description
`settings.header`	`string`	Header of the module
`error`	`string`	Error text if something went wrong
`giftCard`	`giftcard lookup object`	Gift card data object

File Name: module.recent_payments.html
Directory: Root

Name	Type	Description
`settings.header`	string	Header of the module
`settings.displayLimit`	int64	Number of payments to display
`settings.displayFreePayments`	bool	Display free payments
`settings.displayTimeOfPurchase`	bool	Display time of payment
`settings.displayPriceOfPurchase`	bool	Display price of purchase
`settings.displayPurchasedProduct`	bool	Display purchased product details
`orders`	order[]	List of recent orders

Name	Type	Description
`total_amount`	number	Total amount of the order
`completed_at`	string	Completion date of the order
`customer`	customer	Customer who made the payment
`lines`	line[]	Order lines (if product display enabled)

File Name: module.text_box.html
Directory: Root

Name	Type	Description
`settings.header`	string	Header of the module
`content`	string	HTML content of the box

File Name: module.payment_goal.html
Directory: Root

Name	Type	Description
`settings.header`	string	Header of the module
`settings.period`	string	Time period for the goal
`settings.goalTarget`	int64	Goal amount in store’s default currency
`settings.displayAbsoluteGoalAmount`	boolean	Display the absolute goal amount
`settings.allowPercentageOverflow`	boolean	Allow % to go above 100%
`settings.animateGoalBar`	boolean	Animate the progress bar
`settings.barStyle`	string	`striped` or `normal`
`revenue`	string	Current revenue value toward the goal

File Name: module.top_customers.html
Directory: Root

Name	Type	Description
`settings.header`	string	Header of the module
`settings.period`	string	Time period used to calculate top customers
`settings.field`	enum	Field to sort customers by
`settings.limit`	int64	Max number of customers to display
`settings.displayCustomerSpendAmount`	bool	Show spend amount per customer
`customers`	customer[]	List of top customers

Allowed Enum Values

Name	Type	Description
`id`	flake	Customer ID
`steam.name`	string	Steam name
`steam.avatar_url`	string	Steam avatar
`name`	string	Customer name
`stats.total_spend_amount_gross`	int64	Total gross spend amount
`stats.total_spend_amount_net`	int64	Total net spend amount
`stats.average_spend_amount_gross`	int64	Average gross spend
`stats.average_spend_amount_net`	int64	Average net spend
`stats.total_payments`	int64	Total number of payments

File Name: module.featured_product.html
Directory: Root

Name	Type	Description
`settings.header`	string	Header of the module
`product`	StorefrontProductDto	The featured product object