Developer Documentation / Introduction

Introduction to response builders

Response builders are Aero's unique solution to serving storefront pages. Based on the concept of pipelines used in Laravel middleware See our section on response builders for more information.

Developer Documentation / Introduction

Introduction to listings and search

Aero offers out-of-the-box listings and search system which is powered by Elasticsearch Please note the Elasticsearch version is 6.8. See our section on listings and search for more information.

Developer Documentation / Introduction

Introduction to payment drivers

A payment driver is the brain behind the payment method and serves as a bridge to the payment gateway. Whilst there are several integrations that are maintained by the Aero team, a store may require a bespoke integration in order to meet the requirements of a ...

Developer Documentation / Introduction

What is an Aero Commerce Agora account and why do I need it?

To get started you'll need an Agora account. Your Agora account is used to download the platform and create projects. You can register for an account here Projects are assigned unique credentials which allows them to purchase themes and modules. These credenti...

Developer Documentation / Introduction

How do I obtain package repository credentials?

Once logged in to Agora, head over to the projects section and click the New project button. You'll need to give the project a name, for example, the website name or your client's company. In the example below, we've used a fictional company of "Acme Inc". A d...

Developer Documentation / Introduction

Introduction to the admin

The backend admin (the "admin") is the password-protected back office where administrative tasks can be performed. This includes managing the store's catalog (products, categories, manufacturers, etc.), viewing and processing orders, managing discounts, viewin...

Developer Documentation / Introduction

Introduction to resource lists

Resource lists allow a table to be extended through additional columns, filters, or sort bys and for bulk actions to be applied. Please see our section on resource lists for more information.

Developer Documentation / Introduction

Introduction to Laravel PHP Framework

The Aero platform is built using the Laravel PHP framework Before developing with Aero, we recommend that you become acquainted with the core concepts of Laravel. We recommend the following resources: The official Laravel documentation is a great place to star...

Developer Documentation / Listings And Search

How do I create a custom sort order for the listings pages?

When you set the sort get parameter in a listing pages url (e.g. ?sort=name-az), a method is called on the \Aero\Search\Elastic\Query\Builderclass (for name-az the method sortByNameAzis called). You can find the default sort by methods in the Aero\Search\Elast...

Developer Documentation / Listings And Search

What are the available documents for listings and search?

There are 2 documents available: Aero\Search\Elastic\Documents\ListingsDocument This document is used to hold information about the listings that are shown on the storefront. Aero\Search\Elastic\Documents\ProductDocument This document is used to hold informati...

Developer Documentation / Listings And Search

How do I re-index listing and search documents?

Aero automatically manages indexing changes to documents. For example, if a product's stock level changes the document is updated to reflect the current version. Adding and removing documents is also taken care of for you, sparing the need to schedule in daily...

Developer Documentation / Listings And Search

How do I add custom facets to listing and search?

Faceted navigation in eCommerce allows customers the ability to refine down a catalog of products based on their filter criteria. In order to define facets against a document, you must first register the facet group. This should be done within the **boot()**me...

Developer Documentation / Listings And Search

How do I setup the search index?

Firstly, you should ensure that the Elasticsearch host information is defined in the store's .env. If you're running the service directly on your machine (either natively or through Docker), you'll most likely use the following details: ELASTICSEARCH_HOST=loca...

Developer Documentation / Listings And Search

How do I re-build the listings and search index?

At times (especially during the development phase of a store build), it may be necessary to delete and documents and freshly index them. This process can be achieved using the following command: php artisan aero:search:rebuild Be careful running the re-build c...

Developer Documentation / Listings And Search

How do I extend the document structure for listings and seach?

One of the most useful features of the listings and search system is the ability to add custom data into the document. Typically, this will be data to be consumed in the code that forms the storefront listings page. To extend a document, use the **add()**metho...

Developer Documentation / Listings And Search

How do I filter listings?

There may be occasions where you need to pre-filter listings. For example, you may want to ensure that all listings are connected to a certain sub-store or Dropship provider, or all share a tag that is set by your application rather than applied by the custome...

Developer Documentation / Listings And Search

How to Extend the Elastic Search Listing Model

The Aero\Search\Elastic\Models\Listingmodel is built up from an array of data returned from elastic search. You can modify the model's attributes through the Aero\Search\Elastic\Pipelines\ListingAttributespipeline. For example you can change every listing’s ...

Developer Documentation / Module Development

How do I register a custom Vue component for my module

To register a Vue component for our module, we will need to create a JavaScript file for our components and in order to initialize Vue. Link assets In order to link all the assets, which is a necessary step of registering a Vue component, we need to add a func...