Members: Track Order
The Track Order page allows your customers to check the status of their order on the Aurora Front-end.
This article describes how to access and use the track order form and provides a list of variables available to the Front-end Template.
Introduction
The Track Order page allows your customers to check the status of their order on the Aurora Front-end. The page is available for all users, whether they are logged in or not. It provides a form which allows the user to choose between its emails address and its postcode and search for the status of on order.
Where to access the Track Order Page
You can navigate to it from My Account menu in the footer and then selecting 'Tracking My Order' link from the sub menu. Please see the example provided by the Aurora Demo Store below.
http://demo.auroracommerce.com/members/track-order
Where to find the Track Order Page Templates
The templates that should be used to control the content of the Track Order Page should be placed inside your template directory and named as follows:
- templates/your-template-dir/members/track-order-form.tpl.html
- templates/your-template-dir/members/track-order.tpl.html
Track order process
There are two ways for a given user to check the status of on order:
- By entering the order id and the email address used when placing the order
- By entering the order id and the postcode used when placing the order
If both, the email and the postcode are entered, the email address takes precedence
Variables available in the Track Order page
The following is a list of variables that can be accessed by the Aurora Front-end Templates.
| Variable name | Type | Description |
|---|---|---|
| $submit_complete | bool | Whether the form was successfully submitted and validated |
| $track_order_form | <br>Object(Aurora_Form)<br> | Object of Aurora_Form with its form type property set to Aurora_Form_Frontend_TrackOrder and used for generating the html form on the page |
| $errors | Array | This variable only exists in the template after submission only if there are validation errors on the page. An array containing multiple sub-arrays with the keys being the inputs names and the values arrays containing the errors for that specific field. |
| $tracking_order_invoice_address | Array | This variable only exists in the template after submission and only on successful match. This variable contains all of your billing addresses. |
| $tracking_order_delivery_address | Array | This variable only exists in the template after submission and only on successful match. This variable contains all of your delivery addresses. |
| $tracking_order_order_status | Array | This variable only exists in the template after submission and only on successful match. Array of arrays |
| $tracking_order_order_status[0] | Array | This variable only exists in the template after submission and only on successful match. Array containing the date of the order and the status |
| $tracking_order_order_status[0].date_crated | string | Date on which the order was made in the system. Format: "Y-m-d H:i:s". |
| $tracking_order_order_status[0].status_name_frontend | string | Status of the order |
Site Text
The below are uses of Site Text that are output into the templates.
| Area | Part | Default | Usage |
|---|---|---|---|
| Form | Label: Order Number | Order Number | As label for the Order Number input field |
| Form | Label: Postcode | Postcode | As label for the Postcode input field |
| Form | Label: Email Address | Email Address | As label for the Email Address input field |
| Members Track Order | Error: Enter one field | Enter one field | Validation error. Either the postcode or the email address should be entered for the user to get results. If neither, the error message will appear. |
| Members Track Order | Error: No results found | No results found | No results are found based on the information entered |
Related Aurora Demo Example Templates
templates/example.com/members/track-order.tpl.html
templates/example.com/members/track-order-form.tpl.html
Updated over 2 years ago