Developer Documentation / Payment Drivers

How do I return a payment response in my payment driver?

To unify all payment gateway driver communication, an Aero\Payment\Responses\PaymentResponseclass is used. This common class must be returned from the re ...gister, complete, capture, refundand cancelmethods. Setting the payment view Many payment gateways...

Search / Listings

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\Builder class (for name-az the method sortByNameAz is called). You can find the default sort by methods in the Aero...

Developer Documentation / Php Traits

Aero\\Admin\\Traits\\HasPermissions

This trait adds the ability to add permissions to a class easily. The trait adds the following methods: permi ...ssions Method This method accepts an array that will set the permissions requi ...red. allowed Method This method optionally accepts a user and will retu...

Storefront Developer Documentation / Themes

How do I use a custom Vue component in the storefront?

This repo (https://github.com/aerocargo/example-vue You need to make your component .vuefile(s) and your main .jsfile that will register all of the components. An example javascript structure can be found here in the repo (htt ...ps://github.com/aerocargo/example-vue/tree/master...

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 proa product's stock level changes the document is updated to reflect the current versi ...on. Adding and removing documents is also taken care of for you, sparing the need to schedule in dai...

Developer Documentation / Response Builders

How do I pass data to a response?

The most common task performed when extending resp ...onses, is setting additional data. Typically, for HTML responses that render from a view, this involves sending data to the view to be used as a variable. If the response returns JSO ...N, it may be adding additional key/value...

Catalog Management / Tags

What is a tag?

Tags are a convenient way to group products together. Th ...ey allow you to associate products for customers conven ...ience, this includes: Creating selected lists - E.g. edito ...rs picks or seasonal recommendations - Associating similar colours - E.g...

Developer Documentation / Admin Reports

How do I add lenses to my custom report?

You need to create a class for your lens that extends Aero\Admin\Reports\ReportLensand implements the required publi ...c value function. The value function will return a string used to display your lens. <?php namespace Acme\MyModule\Reports\Lenses;...

Developer Documentation / General

How to Set the Page Title for the Admin

By default the page title for every admin page is generated from the route name. If you would like to manually set the page title you can set a title specifically for your route or you can return an adminPageTitlevariable to your view (this includes ...

Order Management / Orders

How do I change the status of an order?

We can change the status of an order at any time. To do so there are a couple of ways we can do it. Firstly we could click ...into the order, locate the “Order Information” section and click the ellipsis (...) butt ...on to be presented with the statuses available. Next click the ...

Getting Started / Intro To Aero

How much does Aero cost?

Commercials overview There is a single fee for using Aero, based on the revenue of the retailer: Revenue (per annum) Aero Monthly Fee Up to £250k £50 ...250 £3m + £500 The fee is only payable on launch of the store - Not subject ...to any minimum contract period (roll...

Developer Documentation / Events

How do I create a new event listener?

To create a new listener class for one of our events, we can use Artisan to scaffold the listener from the proj ...ect root directory: php artisan make:listener UpdateDetails After adding all the necessary functionality for our listener, we have to make Aero aware of it by a...

Developer Documentation / General

What queues does Aero use?

Queues are used so that HTTP requests can remain snappy and more intensive code can be executed later. You can learn more about queues here Queue Descripti ...on search This queue has search jobs. The majority of these jobs will be res ...ible for reindexing listings. email This queue has email jobs. Wh...

API / Attribute Groups

Create Attribute Group Endpoint

Structure Attribute Group Name Type Description Required id ...int The id for the attribute group No name string The name of the attribute group (e.g., Size or Co ...lour) Yes display_as string The display as of the attribute group (e.g.: dropdown, ...

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()**meth...

API / General

What conventions does the API use?

Attribute Conventions Keys generally match the attribute name on their respective models. E ...xception: Attributes ending in "_code" shou ...ld omit the suffix when passed to the API, e.g.  currency_code =>  curr ...ency Relationship Conventions Nested data...

Blueprint / Configs

What is a config?

A config stores a JSON representation of the page layout created via the theme editor. Location Configs should be created at the following location in your local storage dage disk: "themes/{$theme}/bluepr ...s/config/{$key}.json" When you have made unsaved changes to the c...

Catalog Management / Products

What is a product marker?

As well as providing your customers with ...detailed product information and photographs, you can add additional useful markers to your products: Attributes allow you to create variant products - Manufacturers allow you to group products under ... a manufacturer or brand - Categor...