API / Products

View Product Endpoint

Structure Product Name Type Description model string ...del identifier for the product name string The display name of the product manufacturer object The Manufacturer object (null when none) s ...ummary string A short summary of the product description st...

Developer Documentation / Account Area

What are the available slots in the account area?

The following slots can be injected into. orders.order ....card.header- orders.order.card.dispatched- orders.order.card.not-dispatched- orders.order.card.footer- addresses.address.card.footer

API / Orders

View Order Endpoint

Structure Order Name Type Description reference st ...nique reference for the order status object The Order Status of the order ( null if none) ... of the order ( null if none) email string The email of the customer that placed the order subtotal.amou...

Developer Documentation / Module Development

Anatomy of a custom module

└─ module └─ database └─ migrations └─ public └─ ... └─ views └─ admin └─ store ...gitignore composer.json README.md Database The database folder is only required for p ...urposes of migrating, seeding, or storing data i...

Developer Documentation / Payment Gateways

What are the available payment gateways?

A cash payment method is provided out of ...the box, which allows developers to complete ord ...s through the checkout without having to worry about installing and configuring a payment gateway. The cash payment method should be disabled before the store is put liv...

Account Area / Pages

What are the default pages in the account area?

Class Route Description AccountLoginPage login A page where users can log in. AccountRegisterPage register A page where guests can register. AccountPasswordForgotPage password.forgot A page where users can send a password reset email to their email. AccountPasswo...

Admin / Resource Lists

How do I add a bulk action to an existing resource list?

\Aero\Admin\BulkAction::create( \Aero\Admin\BulkActions\DeleteProductsBulkAction::class, \Aero\Admin\ResourceLists\ProductsResou ...rceList::class ) ->title('Delete products') ...nfirm(); See here for how to create a custom bulk action. Methods...

Developer Documentation / Module Development

How do I create a custom module?

When interacting with the admin, especially when making a custom module, it is important to require aerocommerce/adminin the modules’ composer.js ...onfile. Scaffolding modules Modules can be created using artisan, a command line interface supplied...

API / Products

Create Product Endpoint

Structure Product Name Type Description Required id ...identifier for the product Yes name string The display name of the product Yes manufacturer string The manufacturer/brand of the product No summary string A short summary of the product No description...

Account Area / General

How do I add a Custom CSS File to the account area?

You can add a custom CSS file to the account area by creating a file named  account-area.css in your public directory. E ...xample contents where we're overri ...ding the default colours: :root { --bpa-color-primary: deepskyblue; --bpa-color-success: forestgreen; ...

Developer Documentation / Account Area

How do I create a new form for the account area?

To create a form you need to create a class that extends the AccountAreaFormclass. The $sectionsarray lists the views used to render ...thodmethod defines the method that the form will use (this should ...ld return the URL for the form. A $datavariable is accessible in...

Developer Documentation / Account Area

How do I create a custom set in the account area?

Sets are used for POST/PUT/DELETE requ ...ests. To create and register a custom account area set you need to use the Aero\AccountArea\AccountArea::registerPost(), Aero\AccountArea\AccountArea::registerPut(), or Aero\AccountArea\AccountArea::registerDelete(...

Catalog Management / Products

How do I create a single product?

Please see how do I create a product in the admin? In order to set up the basic product information. After the product type has been selected and product information completed the next part of the data is pricing. Pricing The pricing ... section is where you enter all of the information related to...

Developer Documentation / Admin Dashboard Lenses

How do I add a custom dashboard lens to the dashboard?

To add your custom dashboard lens to the dashboard you need to register it with ...the admin and the admin dashboard. To register your dashboard lens with the admin you need to call the Aero\Admin\Facades\Adminfacade registerLensmethod and pass in your dashboard lens c...

Developer Documentation / Extending Core Functionality

How do I add settings to my model?

This tutorial will explain the steps required to add settings to your model and assumes you have your model setup with create and edit pages. Adding a Trait to your Model The first step ...is to add the Aero\Common\Traits\CanHaveSettingstrait to your...

Order Management / Orders

What are the payment and allocation indicators?

All orders have a few different statuses associated with them. These statuses are shown on the order page with an indicator. Indicators are displayed at the top of the order page and give you a quick overview of any actions that could be needed for a given or...

Account Area / Slots

What are the available account area slots?

Navbar navbar.info Addresses addresses.address.card.footer Orders orders.order.card.dispatched orders.order.card.not-dispatched order.header.buttons orders.order.card.header orders.order.card.footer Subscriptions subscrip ...tions.subscription.card.header subscriptions.subscrip...

Account Area / Pages

How do I create a custom page in the account area?

To create and register a custom account area page you need to use the Aero\AccountArea\AccountArea::registerPage() helper method. This method ...expects you to pass a class that extends  Aero\AccountArea\AccountAreaPage: \Aero\AccountArea\AccountArea\Account...