System Pages
System pages are a set of predefined pages and routes that some Square Online sites may expect. If you are building a fully-featured theme it is highly recommended that you implement all of these pages with the recommended routes. These pages support some of the features that Square Online provides.
System pages are regular pages that occupy special paths, here is an overview of the system pages and their recommended routes:
| System page | Route | Page File Name | Template File Name |
|---|---|---|---|
| Shop All | /s/shop | site/pages/shop.json | theme/templates/store/shop.html.twig |
| Item Detail Page | /product/:name*/:id | site/pages/item.json | theme/templates/store/item.html.twig |
| Category Detail Page | /shop/:name*/:id | site/pages/category.json | theme/templates/store/category.html.twig |
| Search | /s/search | site/pages/search.json | theme/templates/store/search.html.twig |
| Order Online | /s/order | site/pages/order.json | theme/templates/store/order.html.twig |
| Customer Account Page | /s/customer-accounts | site/pages/customer.json | theme/templates/store/customer.html.twig |
| Store Locations Page | /s/store-locator | site/pages/locations.json | theme/templates/store/locations.html.twig |
| 404 Page Not Found | /404 | site/pages/404.json † | theme/templates/store/404.html.twig |
| 500 Internal Server Error | /500 | site/pages/500.json † | theme/templates/store/500.html.twig |
The suggested routes for these pages are highly recommended to be used.
† Page files are optional for 400 and 500 pages, you may exclude this if you do not want to customize the content of these pages. All that is required is the template to render.
Shop All
A suggested pge that shows the main catalog which displays all the products and categories of the store.
Order Online Page
A suggested page that shows the order online page.
Item Detail Page
A suggested page that shows the details of a specific item.
Category Detail Page
A suggested page that shows the details of a specific category.
Search Page
A suggested page that shows the search results for a specific query.
Customer Account Page
A suggested page that shows the customer account details.
Store Locations Page
A suggested page that shows the store locations
404 Page Not Found
The 404 page is rendered when a visitor requests a page that cannot be found, or when a resource referenced does not exist.
Note: it is not required to create a Page JSON file for this page, you can simply create the template file and it will be rendered when a 404 error occurs. Adding a Page JSON file will optionally allow you to utilize Editor Controls and allow for resource fetching through the schema.
500 Internal Server Error
The 500 page is rendered when there’s an unexpected error that prevents a page from being rendered. This may be due to a syntax error on the page or an unexpected error in the platform.
Note: it is not required to create a Page JSON file for this page, you can simply create the template file and it will be rendered when a 500 error occurs. Adding a Page JSON file will optionally allow you to utilize Editor Controls and allow for resource fetching through the schema.