Carts

Overview

Carts are a collection of products (or other custom purchasable types) that you would like to order. Carts belong to Users (which relate to Customers).

Cart prices are dynamically calculated and are not stored (unlike Orders).

Lunar\Models\Cart

Field	Description
id	Unique ID for the cart.
user_id	Can be `null` for guest users.
customer_id	Can be `null`.
merged_id	If a cart was merged with another cart, it defines the cart it was merged into.
currency_id	Carts can only be for a single currency.
channel_id
coupon_code	Can be `null`, stores a promotional coupon code, e.g. `SALE20`.
created_at
updated_at	When an order was created from the basket, via a checkout.
meta	JSON data for saving any custom information.

Creating a cart

$cart = \Lunar\Models\Cart::create([
    'currency_id' => 1,
    'channel_id' => 2,
]);

Cart Lines

Lunar\Models\CartLine

Field	Description
id
cart_id
purchasable_type	e.g. `product_variant`
purchasable_id
quantity
created_at
updated_at
meta	JSON data for saving any custom information.

$purchasable = \Lunar\Models\ProductVariant::create([/** ... */]);
$cartLine = new \Lunar\Models\CartLine([
    'cart_id' => 1,
    'purchasable_type' => $purchasable->getMorphClass(),
    'purchasable_id' => $purchasable->id,
    'quantity' => 2,
    'meta' => [
        'personalization' => 'Love you mum xxx',
    ]
]);

// Or you can use the relationship on the cart.
$cart->lines()->create([/* .. */]);

Validation

When adding items to a cart there are a series of validation actions which are run, which are defined in the config/lunar/cart.php config file. These actions will throw a Lunar\Exceptions\Carts\CartException.

try {
    $cart->add($purchasable, 500);
} catch (\Lunar\Exceptions\Carts\CartException $e) {
    $error = $e->getMessage();
}

Now you have a basic Cart up and running, it’s time to show you how you would use the cart to get all the calculated totals and tax. We’ve also tried to make Carts extendable as much as possible so, depending on what your stores requirements are, you are free to chop and change things as much as you need to.

Hydrating the cart totals

$cart->calculate();

This will create a “hydrated” version of your cart with the following:

All values will return a Lunar\Datatypes\Price object. So you have access to the following: value, formatted, decimal

$cart->total; // The total price value for the cart
$cart->subTotal; // The cart sub total, excluding tax
$cart->subTotalDiscounted; // The cart sub total, minus the discount amount.
$cart->shippingTotal; // The monetary value for the shipping total. (if applicable)
$cart->taxTotal; // The monetary value for the amount of tax applied.
$cart->taxBreakdown; // This is a collection of all taxes applied across all lines.
$cart->discountTotal; // The monetary value for the discount total.
$cart->discountBreakdown; // This is a collection of how discounts were calculated
$cart->shippingSubTotal; // The shipping total, excluding tax.
$cart->shippingTotal; // The shipping total including tax.
$cart->shippingBreakdown; // This is a collection of the shipping breakdown for the cart.

foreach ($cart->taxBreakdown as $taxRate) {
    $taxRate->name
    $taxRate->total->value
}

foreach ($cart->shippingBreakdown->items as $shippingBreakdown) {
    $shippingBreakdown->name;
    $shippingBreakdown->identifier;
    $shippingBreakdown->price->formatted();
}


foreach ($cart->discountBreakdown as $discountBreakdown) {
    $discountBreakdown->discount_id
    foreach ($discountBreakdown->lines as $discountLine) {
        $discountLine->quantity
        $discountLine->line
    }
    $discountBreakdown->total->value
}

foreach ($cart->lines as $cartLine) {
    $cartLine->unitPrice; // The monetary value for a single item.
    $cartLine->unitPriceInclTax; // The monetary value for a single item, including tax amount.
    $cartLine->total; // The total price value for the cart
    $cartLine->subTotal; // The sub total, excluding tax
    $cartLine->subTotalDiscounted; // The sub total, minus the discount amount.
    $cartLine->taxAmount; // The monetary value for the amount of tax applied.
    $cartLine->taxBreakdown; // This is a collection of all taxes applied across all lines.
    $cartLine->discountTotal; // The monetary value for the discount total.
}

Modifying Carts

If you need to programmatically change the Cart values, e.g. custom discounts or prices, you will want to extend the Cart. You can find out more in the Extending Lunar section for Cart Extending.

Calculating Tax

During the cart’s lifetime, it’s unlikely you will have access to any address information, which can be a pain when you want to accurately display the amount of tax applied to the basket. Moreover, some countries don’t even show tax until they reach the checkout. We’ve tried to make this as easy and extendable as possible for you as the developer to build your store. When you calculate the cart totals, you will be able to set the billing and/or shipping address on the cart, which will then be used when we calculate which tax breakdowns should be applied.

$shippingAddress = [
    'country_id' => null,
    'title' => null,
    'first_name' => null,
    'last_name' => null,
    'company_name' => null,
    'line_one' => null,
    'line_two' => null,
    'line_three' => null,
    'city' => null,
    'state' => null,
    'postcode' => 'H0H 0H0',
    'delivery_instructions' => null,
    'contact_email' => null,
    'contact_phone' => null,
    'meta' => null,
];

$billingAddress = /** .. */;

$cart->setShippingAddress($shippingAddress);
$cart->setBillingAddress($billingAddress);

You can also pass through a \Lunar\Models\Address model, or even another \Lunar\Models\CartAddress

$shippingAddress = \Lunar\Models\Address::first();

$cart->setShippingAddress($shippingAddress);

$cart->setBillingAddress(
    $cart->shippingAddress
);

Cart Session Manager

When building a store, you’re going to want an easy way to fetch the cart for the current user (or guest user) by retrieving it from their current session. Lunar provides an easy to use class to make this easier for you, so you don’t have to keep reinventing the wheel.

Available config

Configuration for your cart is handled in lunar/cart.php

Field	Description	Default
`auth_policy`	When a user logs in, how should we handle merging of the basket?	`merge`
`eager_load`	Which relationships should be eager loaded by default when calculating the cart totals

There is additional, separate, config specifically for when using the CartSession located in lunar/cart_session.php.

Field	Description	Default
`session_key`	What key to use when storing the cart id in the session	`lunar_cart`
`auto_create`	If no current basket exists, should we create one in the database?	`false`
`allow_multiple_orders_per_cart`	Whether carts can have multiple orders associated to them.	`false`

Getting the cart session instance

You can either use the facade or inject the CartSession into your code.

$cart = \Lunar\Facades\CartSession::current();

public function __construct(
    protected \Lunar\Base\CartSessionInterface $cartSession
) {
    // ...
}

Fetching the current cart

$cart = \Lunar\Facades\CartSession::current();

When you call current, you have two options, you either return null if they don’t have a cart, or you want to create one straight away. By default, we do not create them initially as this could lead to a ton of cart models being created for no good reason. If you want to enable this functionality, you can adjust the config in lunar/cart_session.php

Forgetting the cart

Forgetting the cart will remove it from the user session and also soft-delete the cart in the database.

CartSession::forget();

If you don’t want to delete the cart, you can pass the following parameter.

CartSession::forget(delete: false);

Using a specific cart

You may want to manually specify which cart should be used for the session.

$cart = \Lunar\Models\Cart::first();
CartSessionManager::use($cart);

The other available methods are as follows:

Add a cart line

CartSession::add($purchasable, $quantity);

Add multiple lines

CartSession::addLines([
    [
        'purchasable' => \Lunar\Models\ProductVariant::find(123),
        'quantity' => 25,
        'meta' => ['foo' => 'bar'],
    ],
    // ...
]);

Accepts a collection or an array

Update a single line

CartSession::updateLine($cartLineId, $quantity, $meta);

Update multiple lines

CartSession::updateLines(collect([
    [
        'id' => 1,
        'quantity' => 25,
        'meta' => ['foo' => 'bar'],
    ],
    // ...
]));

Remove a line

CartSession::remove($cartLineId);

Clear a cart

This will remove all lines from the cart.

CartSession::clear();

Associating a cart to a user

You can easily associate a cart to a user.

CartSession::associate($user, 'merge');

Associating a cart to a customer

You can easily associate a cart to a customer.

CartSession::setCustomer($customer);

Adding shipping/billing address

As outlined above, you can add shipping / billing addresses to the cart using the following methods:

$cart->setShippingAddress([
    'first_name' => null,
    'last_name' => null,
    'line_one' => null,
    'line_two' => null,
    'line_three' => null,
    'city' => null,
    'state' => null,
    'postcode' => null,
    'country_id' => null,
]);
$cart->setBillingAddress([
    'first_name' => null,
    'last_name' => null,
    'line_one' => null,
    'line_two' => null,
    'line_three' => null,
    'city' => null,
    'state' => null,
    'postcode' => null,
    'country_id' => null,
]);

You can easily retrieve these addresses by accessing the appropriate property:

$cart->shippingAddress;
$cart->billingAddress;

ShippingOption override

In some cases you might want to present an estimated shipping cost without users having to fill out a full shipping address, this is where the ShippingOptionOverride comes in, if set on the cart it can be used to calculate shipping for a single request.

$shippingOption = $cart->getEstimatedShipping([
    'postcode' => '123456',
    'state' => 'Essex',
    'country' => Country::first(),
]);

This will return an estimated (cheapest) shipping option for the cart, based on it’s current totals. By default this will not be taken into account when calculating shipping in the cart pipelines, in order to enable that we need to pass an extra parameter.

$shippingOption = $cart->getEstimatedShipping([
    'postcode' => '123456',
    'state' => 'Essex',
    'country' => Country::first(),
], setOverride: true);

Now when the pipelines are run, the option which was returned by getEstimatedShipping will be used when calculating shipping totals, bypassing any other logic, note this will only happen for that one request. If you are using the CartSession manager, you can easily set the parameters you want to estimate shipping so you don’t need to pass them each time:

CartSession::estimateShippingUsing([
    'postcode' => '123456',
    'state' => 'Essex',
    'country' => Country::first(),
]);

You can also manually set the shipping method override directly on the cart.

$cart->shippingOptionOverride = new \Lunar\DataTypes\ShippingOption(/* .. */);

Calling CartSession::current() by itself won’t trigger the shipping override, but you can pass the estimateShipping parameter to enable it:

// Will not use the shipping override, default behaviour.
CartSession::current();

// Will use the shipping override, based on what is set using `estimateShippingUsing`
CartSession::current(estimateShipping: true);

When a user logs in, you will likely want to check if they have a cart associated to their account and use that, or if they have started a cart as a guest and logged in, you will likely want to be able to handle this. Lunar takes the pain out of this by listening to the authentication events and responding automatically by associating any previous guest cart they may have had and, depending on your auth_policy merge or override the basket on their account.

Determining cart changes

Carts by nature are dynamic, which means anything can change at any moment. This means it can be quite challenging to determine whether a card has changed from the one currently loaded, for example, if the user goes to check out and changes their cart on another tab, how does the checkout know there has been a change? To help this, a cart will have a fingerprint generated which you can check to determine whether there has been any changes and if so, refresh the cart.

$cart->fingerprint();

try {
    $cart->checkFingerprint('4dfAW33awd');
} catch (\Lunar\Exceptions\FingerprintMismatchException $e) {
    //... Refresh the cart.
}

Changing the underlying class.

The class which generates the fingerprint is referenced in config/lunar/cart.php.

return [
    // ...
    'fingerprint_generator' => Lunar\Actions\Carts\GenerateFingerprint::class,
];

In most cases you won’t need to change this.

Pruning cart data

Over time you will experience a build up of carts in your database that you may want to regularly remove. You can enable automatic removal of these carts using the lunar.carts.prune_tables.enabled config. By setting this to true any carts without an order associated will be removed after 90 days. You can change the number of days carts are retained for using the lunar.carts.prune_tables. prune_interval config. If you have specific needs around pruning you can also change the lunar.carts.prune_tables.pipelines array to determine what carts should be removed.

return [
    // ...
    'prune_tables' => [

        'enabled' => false,

        'pipelines' => [
            Lunar\Pipelines\CartPrune\PruneAfter::class,
            Lunar\Pipelines\CartPrune\WithoutOrders::class,
        ],

        'prune_interval' => 90, // days

    ],
];

Core

Storefront

Extending

Carts

Overview

Carts

Creating a cart

Cart Lines

Validation

Hydrating the cart totals

Modifying Carts

Calculating Tax

Cart Session Manager

Available config

Getting the cart session instance

Fetching the current cart

Forgetting the cart

Using a specific cart

Add a cart line

Add multiple lines

Update a single line

Update multiple lines

Remove a line

Clear a cart

Associating a cart to a user

Associating a cart to a customer

Adding shipping/billing address

ShippingOption override

Determining cart changes

Changing the underlying class.

Pruning cart data

​Overview

​Carts

​Creating a cart

​Cart Lines

​Validation

​Hydrating the cart totals

​Modifying Carts

​Calculating Tax

​Cart Session Manager

​Available config

​Getting the cart session instance

​Fetching the current cart

​Forgetting the cart

​Using a specific cart

​Add a cart line

​Add multiple lines

​Update a single line

​Update multiple lines

​Remove a line

​Clear a cart

​Associating a cart to a user

​Associating a cart to a customer

​Adding shipping/billing address

​ShippingOption override

​Handling User Login

​Determining cart changes

​Changing the underlying class.

​Pruning cart data

Overview

Carts

Creating a cart

Cart Lines

Validation

Hydrating the cart totals

Modifying Carts

Calculating Tax

Cart Session Manager

Available config

Getting the cart session instance

Fetching the current cart

Forgetting the cart

Using a specific cart

Add a cart line

Add multiple lines

Update a single line

Update multiple lines

Remove a line

Clear a cart

Associating a cart to a user

Associating a cart to a customer

Adding shipping/billing address

ShippingOption override

Handling User Login

Determining cart changes

Changing the underlying class.

Pruning cart data