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...

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 / 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, ...

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...

Developer Documentation / Validation

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

You can define logic that will be used to confirm if a shipping method is available for a specific order. By default all shipping methods that have available shipping rates (you can set a custom order validator for shipping rates too) for an order are availa...

API / Manufacturers

Create Manufacturer Endpoint

Structure Manufacturer Name Type Description Required id ...int The id for the manufacturer No name string The name of the manufacturer Yes slug string The slug ...of the manufacturer, if not present it is auto-generated from name No reference strin...

Developer Documentation / Php Traits

Aero\\Catalog\\Traits\\Taggable

This trait can be added to a model class. The trait adds the ability to add tags to the model. The trait adds the following methods: tag Method This method accepts a Aero\Catalog\Models\Tagand will attach the tag to the model without detaching any other tags. tags Metho...

Catalog Management / Collections

What is a collection?

Collections are dynamic groupings of products in you ...r storefront. Unlike tags or categories that group based on fixed properties, Collect ...ions allow greater flexibility. How to define C ...ections You define Collections based on specific rules. Rules all...

Catalog Management / Tags

How do I create a new tag?

Individual tags are tied to their group, in order ... to create a new tag you must first decide which gr ...oup you want to add this new tag to. First navigate to the tags listings page and select the group you want to add new tags or create a new tag ...

Content Management / Redirects

What is a redirect?

Within Aero, Redirects allow you to divert traffic from on URLs to another. Aero, including standard redirect codes. Among other things, this is usefu ...l for handling missing pages. Redirect Codes Aero allows you to assign the following standard HTT...

Developer Documentation / Configuration

What is the robots file and how does it differ from normal?

...provides instructions for web crawlers and bots that index your store. Aero automatically registers core parts of the store that should avoid being indexed and visited by bots. In order to ...extend this file and add modules or store specific res...

API / Attribute Groups

View Attribute Group Endpoint

Structure Attribute Group Name Type Description name string The name of the attribute group (e.g., Size or Co ...lour) display_as string The display as of the attribute group (e.g.: dropdown, ...color_swatches, image_swatches, swatches) reference strin...

Order Management / Orders

What are orders?

Within Aero when a customer purchases items from your store an order is created. Orders are stored in the system and will start out with the status of “Successful” (providing t ...he payment was successfully taken). Any fulfillments, returns or refu ...nds actioned on an order will alter t...

Developer Documentation / Response Builders

How do I redirect a response?

Sometimes you may wish to redirect the user to another location, either to an external site or within the store. To d ...o so, pass the URL, route(), or an Illuminate\Http\RedirectResponseinstance to the **setRedirect()**meth ...od. For example, if you stored the age of c...

Content Management / Redirects

How do I create a new redirect?

Redirects are slighly different to how you ...create a new one, when compared with the other elements in t ...e store. Redirects require only a small amount of information therefor the create form is part of the listing page. In order to create a new red...

Developer Documentation / Configuration

How do I change how order references are generated?

You can set an order reference generator to define how order referenc ...es are generated. To do this you need to use ...the static setReferenceGeneratormethod on the Aero\Cart\Models\Ordermodel. The method ... accepts a closure that accepts the order ...

Developer Documentation / Payment Drivers

How do I refund a payment in my payment driver?

If the payment gateway provides the ability to externally make refund requests, the payment driver can use the Aero\Payment\SupportsRefundingtrait. The refundmethod should the ...n be implemented, which returns an instance of Aero\Payment\Responses\P...