`routes` object

Last updated Oct 6, 2026 View as Markdown

Allows you to generate standard URLs for the store front.

Properties

All URLs are root-relative paths (e.g. /cart), so they resolve against the current store domain.

Name	Type	Description
`root_url`	string	The URL to the store home page
`cart_add_url`	string	The URL to add to cart
`cart_clear_url`	string	The URL to clear cart
`cart_update_url`	string	The URL to update cart
`cart_url`	string	The URL to list cart items
`store_shipping_url`	string	The URL to store checkout shipping details
`apply_coupon_url`	string	The URL to apply a coupon at checkout
`collections_url`	string	The URL to the collections listing page
`search_url`	string	The URL to the store search page
`account_url`	string	The URL to the customer account page
`account_login_url`	string	The URL to the login page
`account_logout_url`	string	The URL to log out. A link or a form post
`account_register_url`	string	The URL to the register page
`account_recover_url`	string	The URL to the password recovery page
`account_addresses_url`	string	The URL to the customer addresses page