Storefront Developer Documentation / Themes

How do I give split listings names generated from their attributes?

This code example extends the Aero\Search\Elastic\Documents\ListingDocumentdo ...cument to generate names for split listings from the attributes that the variant is made up of. You can learn more about extending the listing docum ...ent here It’s important to note that you need to rein...

Order Management / Shipping

How do I set a custom order validator for shipping rates?

Shipping rates can define an order validator to determine whether they are available for a particular order. For example, you may only want to offer a shipping rate only for certain customer groups. First, defin ...e an availability setting to allow ...

Order Management / Orders

How do I fulfill an order?

Once your customers start placing orders you’ll need to fulfi ...l them, unless you want a lot of unhappy customers. Fulfilments – wit ...h the exception of some digital products – usually require actions taken outside of the Aero platform, such as packing an...

Storefront / Vue

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

You need to add the  assetLinks function to your modul ...es service provider so that your modules assets are publicly linkable. An example module service provider can be found here: https://github ....com/aerocargo/admin-example-vue/blob/master/src...

API / Addresses

Create Address Endpoint

Structure Name Type Description Required id ...int The id for the address No name string The name of the address No first_name string The first name for the address Yes last_name string The last name for the address Yes company string The company for the ad...

API / Addresses

Update Address Endpoint

Structure Name Type Description Required id ...int The id for the address No name string The name of the address No first_name string The first name for the address No last_name string The last name for the address No company string The company for the ad...

API / Collections

Create Collection Endpoint

Structure Collection Name Type Description Required id ...t The id for the collection No name string The name of the collection Yes slug st ...ollection, if not present it is auto-generated from name No reference string The refer ...f the rules for the collection, and/or (defaults to or if not pro...

General / 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 / Introduction

Introduction to Attributes

Attributes allow you to create variant products within your ecommerc ...e store. Attributes are your product options such as size and cand colour. See "What is an attribute? A typical attributes list;

Developer Documentation / Google Shopping Feed

How do I assign Google categories?

Google categories can be assigned to categories, or directly to the pro ...duct. It can be set up either way as the mapping tool automatically detects the ones that have been set up. There is also a way of mapping whether a google category is grabbed from...

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 proc ...ess can be achieved using the following command: php artisan aero:search:rebuild Be careful running t...

Developer Documentation / Resource Lists

What are the default resource lists?

The following classes are in the Aero\Admin\ResourceListsnamespace and any class that doesn’t have a view uses the admin::resource-lists.indexview. ...Class View AttributeGroupsResourceList – Blo ...cksResourceList – CategoriesResourceList admin::cata...

Developer Documentation / Settings

How do I add settings to the product model?

Using the same syntax as as when you createate settings <?php namespace Acme\MyModule; use Aero\Catalog\Models\Product; use Aero\Common\Providers\ModuleServi ...ceProvider; use Aero\Common\Settings\SettingGroup ...; class ServiceProvider extends Modul ... $group->encrypted('password'); $group->boo...

API / General

What responses does the API return?

Code Scenario 200 Success The request was processed successfully. 201 Cr ...eated One (or multiple) resources ...were created. 400 Bad Request  Cannot process request due to clie ...nt error. 401 Unauthorised Invalid bearer token provided. 404 Not Foun...

Developer Documentation / Admin Dashboard Lenses

What is a dashboard lens?

Dashboard lenses are the blocks of content that make up the interactive part of the admin dashboard. They provide an overview of various stats such as your total revenue, orders, and your top selling products. Th ...ere are a number of default lenses an...

Developer Documentation / Admin Dashboard Lenses

How do I remove a dashboard lens from the dashboard?

You are able to extend Aero\Admin\Http\Responses\AdminDashboardPageand use the removeLensmethod. You ... will need to pass in the key of the lens that you wantant to remove. <?php namespace Acme\MyModule; use Aero\Admin\Http\Responses\AdminDashboardPage; use Aero\Admi...

Developer Documentation / Payment Drivers

What are the capturing methods in my payment driver?

here are two types of capturing methods: Automatic– the payment is both authorised and captured when the customer clicks ...the pay button - Manual– the payment is authorised when the customer clic ...ks the pay button, the funds are ring-fenced and captured at a...

Developer Documentation / Response Builders

How do I access the properties of the response builder?

All response builders hold proper ...ties that were assigned to them upon creation from the request. These pro ...perties are typically the arguments that would be passed to a conventional Laravel controller and subsequently used in the code ... within the controller. For example on the ProductPage, the Aer...