Account Area / Forms

What are the default forms in the account area?

Class Description AccountAddressEditForm The edit address form. AccountAddressNewForm The new address form. AccountDetailsForm The account details form. AccountLoginForm The login form. AccountPasswordForgotForm The forgotten password form. AccountPasswordRese...

Account Area

Sets

Account Area / Sets

What are the default sets in the account area?

Class Method Route AccountLoginSet Post login AccountLogoutSet Post logout AccountRegisterSet Post register AccountPasswordForgotSet Post password.forgot AccountPasswordResetSet Post password.reset AccountAddressNewSet Post account.new-address AccountAddressEd...

Account Area

Forms

Account Area / Pages

What are the default pages in the account area?

Class Route Description AccountLoginPage login A page where users can log in. AccountRegisterPage register A page where guests can register. AccountPasswordForgotPage password.forgot A page where users can send a password reset email to their email. AccountPas...

Account Area / Pages

How do I create a custom page in the account area?

To create and register a custom account area page you need to use the Aero\AccountArea\AccountArea::registerPage() helper method. This method expects you to pass a class that extends  Aero\AccountArea\AccountAreaPage: \Aero\AccountArea\AccountArea\AccountArea...

Account Area / Sets

How do I create a custom set in the account area?

Sets are used for POST/PUT/DELETE requests. To create and register a custom account area set you need to use on of the following methods: Aero\AccountArea\AccountArea::registerPost() Aero\AccountArea\AccountArea::registerPut() Aero\AccountArea\AccountArea::reg...

Account Area / Forms

How do I create a custom form in the account area?

To create a form you need to create a class that extends the  \Aero\AccountArea\AccountAreaForm class: The  $sections array lists the views used to render the form. The  method() method defines the method that the form will use (this should be post,  get,  pu...

Account Area / Pages

How do I add a section to an existing account area page?

You can use the  addSection() method(s) to add a section to an existing form: \Aero\AccountArea\Http\Responses\AccountLoginPage::extend(function (\Aero\AccountArea\Http\Responses\AccountLoginPage $page, \Closure $next) { // Add it as the first section ...

Search

Tutorials

Search / Tutorials

How can I distribute search jobs across multiple queues?

You can use the  setQueueResolver() method to distribute search jobs across multiple queues: For example, let's say you have 10 search queues you want to utilise, you could distribute search jobs between them randomly: \Aero\Search\Jobs\SearchJob::setQueueReso...

Book

API

API

General

API / General

What are the available endpoints?

Orders Method Endpoint Permission Description GET /api/orders orders.index List orders GET /api/orders/{id} orders.view Get an order POST /api/orders orders.store Create an order POST /api/orders/{id}/flags/{id} orders.flags.store Attach a flag DELETE /api/ord...

API / General

What conventions does the API use?

Attribute Conventions Keys generally match the attribute name on their respective models. Exception: Attributes ending in "_code" should omit the suffix when passed to the API, e.g.  currency_code =>  currency Relationship Conventions Nested data should use a ...

API / General

What responses does the API return?

Code Scenario 200 Success The request was processed successfully. 201 Created One (or multiple) resources were created. 400 Bad Request  Cannot process request due to client error. 401 Unauthorised Invalid bearer token provided. 404 Not Found Endpoint not foun...

API

Orders

API / Orders

Order Index Endpoint

Structure See  View Order Endpoint for the structure of the order payload inside the  data array. Scopes Name Description Example visible Only return visible orders (those which have been ordered) ?scope=visible outstanding Only return outstanding orders ?scop...