# Orders

# Overview

As you'd expect, orders on an online system show what users have purchased. They are linked to a Cart and you can only have 1 order per cart in the database.

Field Description
user_id If this is not a guest order, this will have the users id
channel_id Which channel this was purchased through
status A status that makes sense to you as the store owner
reference Your stores own reference
customer_reference If you want customers to add their own reference, it goes here.
sub_total The sub total minus any discounts, excl. tax
discount_total Any discount amount excl. tax
shipping_total The shipping total excl. tax
tax_breakdown A json field for the tax breakdown e.g. [{"name": "VAT", "total": 123, "percentage": 20}]
tax_total The total amount of tax applied
total The grand total with tax
notes Any additional order notes
currency_code The code of the currency the order was placed in
compare_currency_code The code of the default currency at the time
exchange_rate The exchange rate between currency_code and compare_currency_code
placed_at The datetime the order was considered placed.
meta Any additional meta info you wish to store

# Create an order

You can either create an order directly, or the recommended way is via a Cart model.

$order = \GetCandy\Models\Order::create([/** .. */]);

// Recommended way
$order = Cart::first()->getManager()->createOrder();

If you are using the CartSession you can create a order via the facade, this will then handle removing the cart from the session if you want it to.

$order = CartSession::createOrder();

By default, this will create the order and remove the cart id from the session. You can, however retain the cart id if you want by passing an option boolean parameter to the method:

$order = CartSession::createOrder(false);

Now when you create the order, you will still have the cart id in the session.

So what's happening when we call createOrder on a cart, that's so different from just creating an order manually? Well there's a few steps GetCandy takes to make sure data stays consistent and valid, it also means that a lot of the columns on an order will automatically be populated based on the cart.

Here's the order things happen when you call createOrder:

  1. We check if the Cart has been calculated and it's totals are populated, if not we calculate
  2. Validation happens on the cart to ensure we have all the data we need for the order, things like billing info etc.
  3. Creation is about to happen, so before that we get any modifiers that have been set up and pass through the Cart so you can make any changes beforehand.
  4. We create the order from the Cart including CartLine models and copying CartAddress models across to the new order.
  5. We associate the newly created order to the Cart
  6. The new order is then run through a series of post creation modifiers so you can make any adjustments to the new order.

Given that there is validation taking place and there could be exceptions thrown, it makes sense to wrap this function in a try/catch.

try {
    $order = $cart->createOrder();
} catch (\GetCandy\Exceptions\CartException $e) {
    // Return back to checkout.

If you want more fine grained control of what you do under the different exceptions, here they are:


They each extend CartException so it depends on how much control you need.

If you also want to check before you attempt this if the cart is ready to create an order, you can call the helper method:


This essentially does the same as above, except we already catch the exceptions for you and just return false if any are caught.

# Order Reference Generating

By default GetCandy will generate a new order reference for you when you create an order from a cart. The format for this is:


{0..0} indicates the order id will be padded with up to four 0's for example:


# Custom Generators

If your store has a specific requirement for how references are generated, you can easily swap out the GetCandy one for your own:


return [
    'reference_generator' => App\Generators\MyCustomGenerator::class,

Or, if you don't want references at all (not recommended) you can simply set it to null

Here's the underlying class for the custom generator:

namespace App\Generators;

use GetCandy\Models\Order;

class MyCustomGenerator implements OrderReferenceGeneratorInterface
     * {@inheritDoc}
    public function generate(Order $order): string
        // ...
        return 'my-custom-reference';

# Modifying Orders

If you need to programmatically change the Order values or add in new behaviour, you will want to extend the Order system.

You can find out more in the Extending GetCandy section for Order Modifiers.

# Order Lines

Field Description
purchasable_type Class reference for the purchasable item e.g. GetCandy\Models\ProductVariant
type Whether digital,physical etc
description A description of the line item
option If this was a variant, the option info is here
identifier Something to identify the purchasable item, usually an sku
unit_price The unit price of the line
unit_quantity The line unit quantity, usually this is 1
quantity The amount of this item purchased
sub_total The sub total minus any discounts, excl. tax
discount_total Any discount amount excl. tax
tax_breakdown A json field for the tax breakdown e.g. [{"name": "VAT", "total": 123, "percentage": 20}]
tax_total The total amount of tax applied
total The grand total with tax
notes Any additional order notes
meta Any additional meta info you wish to store

# Create an order line


If you are using the createOrder method on a cart, this is all handled for you automatically.

    // ...

Or via the relationship

    // ...

# Order Addresses

An order can have many addresses, typically you would just have one for billing and one for shipping.


If you are using the createOrder method on a cart, this is all handled for you automatically.

    'order_id' => 1,
    'country_id' => 1,
    'title' => null,
    'first_name' => 'Jacob',
    'last_name' => null,
    'company_name' => null,
    'line_one' => '123 Foo Street',
    'line_two' => null,
    'line_three' => null,
    'city' => 'London',
    'state' => null,
    'postcode' => 'NW1 1WN',
    'delivery_instructions' => null,
    'contact_email' => null,
    'contact_phone' => null,
    'type' => 'shipping', // billing/shipping
    'shipping_option' => null, // A unique code for you to identify shipping

// Or via the relationship.
    // ...

You can then use some relationship helpers to fetch the address you need:


# Shipping Options


A Shipping Tables addon is planned to make setting up shipping in the admin hub easy for most scenarios.

To add Shipping Options you will need to extend GetCandy to add in your own logic.

Then in your checkout, or where ever you want, you can fetch these options:

\GetCandy\Facades\ShippingManifest::getOptions(\GetCandy\Models\Cart $cart);

This will return a collection of GetCandy\DataTypes\ShippingOption objects.

# Adding the shipping option to the cart

Once the user has selected the shipping option they want, you will need to add this to the cart so it can calculate the new totals.

$cart->getManager()->setShippingOption(\GetCandy\DataTypes\ShippingOption $option);

# Transactions

Field Description
success Whether the transaction was successful
refund true if this was a refund
driver The payment driver used e.g. stripe
amount An integer amount
reference The reference returned from the payment Provider. Used to identify the transaction with them.
status A string representation of the status, unlinked to GetCandy e.g. settled
notes Any relevant notes for the transaction
card_type e.g. visa
last_four Last 4 digits of the card
meta Any additional meta info you wish to store

# Create a transaction


Just because an order has a transaction does not mean it has been placed. GetCandy determines whether an order is considered placed when the placed_at column has a datetime, regardless if any transactions exist or not.

Most stores will likely want to store a transaction against the order, this helps determining how much has been paid, how it was paid and give a clue on the best way to issue a refund if needed.


// Or via the order

These can then be returned via the relationship.

$order->transactions; // Get all transactions.

$order->charges; // Get all transactions that are charges.

$order->refunds; // Get all transactions that are refunds.

# Payments

We will be looking to add support for the most popular payment providers, so keep an eye out here as we will list them all out.

In the meantime, you can absolutely still get a storefront working, at the end of the day GetCandy doesn't really mind if you what payment provider you use or plan to use.

In terms of an order, all it's worried about is whether or not the placed_at column is populated on the orders table, the rest is completely up to you how you want to handle that. We have some helper utilities to make such things easier for you as laid out above.

And as always, if you have any questions you can reach out on our Discord!

# Order Notifications

GetCandy allows you to specify what Laravel mailers/notifications should be available for sending when you update an order's status. These are configured in the getcandy/orders config file and are defined like so:

'statuses'     => [
    'awaiting-payment' => [
        'label' => 'Awaiting Payment',
        'color' => '#848a8c',
        'mailers' => [
        'notifications' => [],
    // ...

Now when you update an order's status in the hub, you will have these mailers available if the new status is awaiting-payment. You can then choose the email addresses which the email should be sent to and also add an additional email address if required.

Once updated, GetCandy will keep a render of the email sent out in the activity log so you have a clear history of what's been sent out.


These email notifications do not get sent out automatically if you update the status outside of the hub.

# Mailer template

When building out the template for your mailer, you should assume you have access to the $order model. When the status is updated this is passed through to the view data for the mailer, along with any additional content entered. Since you may not always have additional content when sending out the mailer, you should check the existence first.

Here's an example of what the template could look like:

<h1>It's on the way!</h1>

<p>Your order with reference {{ $order->reference }} has been dispatched!</p>

<p>{{ $order->total->formatted() }}</p>

@if($content ?? null)
    <h2>Additional notes</h2>
    <p>{{ $content }}</p>

@foreach($order->lines as $line)
    <!--  -->

# Order Invoice PDF

By default when you click "Download PDF" in the hub when viewing an order, you will get a basic PDF generated for you to download. You can publish the view that powers this to create your own PDF template.

php artisan vendor:publish --tag=getcandy-hub-views

This will create a view called resources/vendor/adminhub/pdf/order.blade.php, where you will be able to freely customise the PDF you want displayed on download.