Skip to main content

Recently Updated Pages

Product Index Endpoint

API Products

Structure See View Product Endpoint for the structure of the order payload inside the data array....

Updated 3 weeks ago by Ethan Payne

Order Status Index Endpoint

API Order Statuses

Structure See  View Order Status Endpoint for the structure of the order status payload inside th...

Updated 3 weeks ago by Ethan Payne

View Order Status Endpoint

API Order Statuses

Structure Order Status Name Type Description id int The id of the order status name string The na...

Updated 3 weeks ago by Ethan Payne

Delete Fulfillment Endpoint

API Fulfillments

Example Request DELETE /api/orders/{id|reference}/fulfillments/{id|reference} Example Response 20...

Updated 3 weeks ago by Ethan Payne

Create Fulfillment Endpoint

API Fulfillments

Structure Fulfillment Name Type Description Required id int The id for the fulfillment No referen...

Updated 3 weeks ago by Ethan Payne

Order Comments Endpoint

API Orders

Structure Name Type Description Required id int The id for the comment No admin int|string The id...

Updated 3 weeks ago by Ethan Payne

Flag Order Endpoints

API Orders

Examples Adding a Flag Request POST /api/orders/{id|reference}/flags/{id|name} Response { "or...

Updated 3 weeks ago by Ethan Payne

Create Order Endpoint

API Orders

Structure Order Name Type Description Required id int The id for the order No reference string Th...

Updated 3 weeks ago by Ethan Payne

View Order Endpoint

API Orders

Structure Order Name Type Description reference string The unique reference for the order status ...

Updated 3 weeks ago by Ethan Payne

Order Index Endpoint

API Orders

Structure See  View Order Endpoint for the structure of the order payload inside the  data array....

Updated 3 weeks ago by Ethan Payne

What responses does the API return?

API General

Code Scenario 200 Success The request was processed successfully. 201 Created One (or multiple) r...

Updated 3 weeks ago by Ethan Payne

What conventions does the API use?

API General

Attribute Conventions Keys generally match the attribute name on their respective models. Excepti...

Updated 3 weeks ago by Ethan Payne

What are the available endpoints?

API General

Orders Method Endpoint Permission Description GET /api/orders orders.index List orders GET /api/o...

Updated 3 weeks ago by Ethan Payne

How do I register a custom Vue component for my module?

Modules Vue

To register a Vue component for our module, we will need to create a JavaScript file for our comp...

Updated 3 weeks ago by Ethan Payne

How do I create a custom module?

Modules General

When interacting with the admin, especially when making a custom module, it is important to requi...

Updated 3 weeks ago by Ethan Payne

What is a config?

Blueprint Configs

A config stores a JSON representation of the page layout created via the theme editor. Location C...

Updated 3 weeks ago by Ethan Payne

How do I change where the schema is loaded from?

Blueprint Schema

Fallback Schema Location The default fallback schema location is: themes/{$theme}/blueprint/sche...

Updated 3 weeks ago by Ethan Payne

What is the schema?

Blueprint Schema

The schema defines all the components that are available to the theme: Component Description Temp...

Updated 3 weeks ago by Ethan Payne

What are the available events?

Events General

Order Events Class Mail Notifications? \Aero\Cart\Events\AbstractOrderEvent - ↳  \Aero\Admin\Even...

Updated 3 weeks ago by Ethan Payne

What setting types are available?

Settings General

As of 15/09/2026, there are ten setting types available: Type Description String Stores text valu...

Updated 3 weeks ago by Ethan Payne