Skip to main content
Orders · Revision #2

How do I customize the order reference?

How do I customize the order reference?

The order reference generator can be customized to control the format of order references that are generated when an order is created.

For example, to use the order reference prefix followed by the order ID:

\Aero\Cart\Models\Order::setReferenceGenerator(function (\Aero\Cart\Models\Order $order) {
    $prefix = setting('order_reference_prefix');

    return "{$prefix}{$order->getKey()}";
});

The generator receives the order and should return a string to be used as the order reference.


Parameters

Parameter Type Description
$order
\Aero\Cart\Models\Order
The order to generate a reference for.