Skip to content

Account components

Favorite#

Customers are able to mark products as their favorites. References to these products are stored in the account of the customer and are listed by the "account favorite" component. Customers can view their list of favorite products and also remove items from the list.

Account favorite

Structure#

The "account favorite" component currently consists only of the main part but can be extended by the subpart configuration of the "account favorite" component, if you need to add further subparts.

In the "account favorite" component, the products are listed similarly to the standard product list. This list is also paged if customers save a lot of products on their favorite list. Shop owners can configure the [domain items](number of products](../../config/client-html/account-favorite.md#size) that are shown per page and the client/html/account/favorite/domains which are fetched from the database (text, media, attributes, etc.).

To be able to generate the URL for the page or route the component is available at, a few settings can be configured. They are necessary to save the favorite products in the customer account:

Templates#

You can adapt the templates for the favorite component by overwriting the templates in your own extension or configuring alternative template names:

If you want to change the HTML structure of one of the templates, please have a look at the original versions to ensure that you don't loose essential functionality.

History#

In the "account history" component, customers can see their placed orders including the order details and the latest delivery and payment status.

Aimeos account history

Structure#

At least two subparts are included in the "account history" component, the list and the order subparts. They can be controlled via the subpart configuration of the "account history" component. Both, the list subpart and the order subpart can contain custom subparts, if you need to extend the existing implementations.

The order subpart reuses the common summary partials which contains the address, service and detail sections so the same information as in the checkout summary page is available.

To be able to load the order details and to return to the list of orders, the URL of the "account history" component must be known. The generated URL can be configured via these settings:

Note

If Javascript is enabled, the order details are loaded via AJAX and dynamically added to the list entry of the order. Otherwise, the page is reloaded and only the order details are shown.

Templates#

You can adapt the templates for the subparts by overwriting the templates in your own extension or configuring alternative template names:

If you want to change the HTML structure of one of the templates, please have a look at the original versions to ensure that you don't loose essential functionality.

Profile#

The profile component offers customers the ability to change their account details including billing and delivery addresses.

Aimeos-account-profile

Structure#

Currently, the "account profile" component contains an address subpart is included in the "account profile" component. The subparts can be controlled via the subpart configuration of the "account profile" component. The address subpart can contain custom subparts, if you need to extend the existing implementations.

To generate the URL for the page or route the component is available at, these settings must be configured. They are necessary to save the changed addresses in the customer account:

Templates#

You can adapt the templates for the "account profile" component by overwriting the templates in your own extension or configuring alternative template names:

If you change the HTML structure of the templates, please have a look at the original versions to ensure that you don't loose essential functionality, e.g. the dynamic JS features.

Review#

The review component allows customers to rate and review products they have bought before and only for those products to prevent fake reviews. New reviews are stored with status "in review" and are only visible in the frontend after changing their status to "enabled" (can be configured).

Aimeos-account-review

Structure#

Up to now, the "account review" component only the todo subpart is implemented and the available suparts can be controlled via the subpart configuration of the "account review" component. The todo subpart can contain custom subparts as well if required.

To generate the URL for the page or route the component is available at, these settings must be configured. They are necessary to save the reviews the customer have written:

Templates#

You can adapt the templates for the "account review" component by overwriting the templates in your own extension or configuring alternative template names:

If you change the HTML structure of the templates, please have a look at the original versions to ensure that you don't loose essential functionality.

Configuration#

There are additional confiugration settings available to control the "account review" component:

client/html/account/review/todo/size
Max. number of products shown for review
client/html/account/review/todo/days-after
Number of days before a bought product can be reviewed
controller/frontend/review/status
Status of the review after the customer review has been stored

Subscription#

In the "account subscription" component, customers can see their placed orders including the order details and the latest delivery and payment status.

Aimeos account subscription

Structure#

At least two subparts are included in the "account subscription" component, the list and the detail subparts. They can be controlled via the subpart configuration of the "account subscription" component. Both, the list subpart and the detail subpart can contain custom subparts, if you need to extend the existing implementations.

The order subpart reuses the common summary partials which contains the address, service and detail sections so the same information as in the checkout summary page is available.

To be able to load the order details and to return to the list of orders, the URL of the "account subscription" component must be known. The generated URL can be configured via these settings:

Note

If Javascript is enabled, the order details are loaded via AJAX and dynamically added to the list entry of the order. Otherwise, the page is reloaded and only the order details are shown.

Templates#

You can adapt the templates for the subparts by overwriting the templates in your own extension or configuring alternative template names:

If you want to change the HTML structure of one of the templates, please have a look at the original versions to ensure that you don't loose essential functionality.

Watch#

Visitors who create an account can watch products and will be notified if those products are back in stock or if their price decreases - depending on what the customers have chosen. They are also able to remove watched products from this list again.

Aimeos-account-watch

Structure#

The "account watch" component currently consists only of the main part but can be extended by the subpart configuration of the "account watch" component, if you need to extend the existing implementations.

In the "account watch" component, the products are listed similarly to the standard product list. This list is also paged if customers save a lot of products on their watch list. Shop owners can configure the number for products that are shown per page and the domain items which are fetched from the database (text, media, attributes, etc.). Additionally, shop owners can limit the number of products customer can watch in parallel with the maxitems option.

To be able to generate the URL for the page or route the component is available at, a few settings can be configured. They are necessary to save the watched products in the customer account:

Templates#

You can adapt the templates for the "account watch" component by overwriting the templates in your own extension or configuring alternative template names:

If you want to change the HTML structure of one of the templates, please have a look at the original versions to ensure that you don't loose essential functionality.

Comments