Purchasable Types

Purchasables should be extended to add useful attributes like Commerce’s included product variant and donation purchasables. Plugins and modules can provide their own purchasables.

# Custom Purchasables

If you’d like to introduce your own purchasable in a custom module or plugin, you can either implement craft\commerce\base\PurchasableInterface (opens new window) or extend craft\commerce\base\Purchasable (opens new window).

We recommend extending the base Purchasable (opens new window) because you’ll automatically get...

  • getSalePrice() calculation
  • getSales() to see the details of each sale applied in that calculation
  • a standard Yii model that includes everything in attributes() and extraFields()
  • automatic sku validation

You may alternatively choose to implement PurchasableInterface (opens new window), but you’ll need to handle these and any additional features yourself.

# Implementation

To implement the Purchasable Interface, inherit from the base Purchasable and implement these methods:

# getId()

The ID of the element.

# getDescription()

This is the description of the purchasable. It would often be the title or name of the product. This is used for display in the order even if the purchasable is deleted later.

# getPrice()

The default price of the item.

# getSalePrice()

The base price of the item, adjusted by any applicable sales.

# getSku()

The stock keeping unit number of the purchasable. Must be unique based on the commerce_purchasables table.

When you inherit from craft\commerce\base\Purchasable, a unique validation rule for the sku attribute is added to the rules() method. This ignores soft-deleted purchasables; uniqueness if only checked for non-trashed purchasables.

# getSnapshot()

An array of data that is serialized as JSON on the line item when the purchasable is added to the cart. This is useful when the purchasable is later deleted, but the cart can still have all relevant data about the purchasable stored within it.

# getTaxCategoryId()

The tax category ID of the purchasable.

Defaults to the default tax category ID.

# getShippingCategoryId()

The shipping category ID of the purchasable.

Defaults to the default shipping category ID.

# hasFreeShipping()

Stops the shipping engine from adding shipping cost adjustment to a line item containing this purchasable.

# getIsPromotable()

Whether the purchasable can be subject to discounts or sales.

# getIsAvailable()

Whether the purchasable can be added to a cart.

Should return true or false if the purchasable can be added to, or exist on, the cart.

Base Purchasable defaults to true always.

# populateLineItem(LineItem $lineItem)

Gives the purchasable the chance to change the saleAmount and price of the line item when it’s added to the cart or when the cart recalculates.

# afterOrderComplete(Order $order, LineItem $lineItem)

Runs any logic needed for this purchasable after it was on an order that was just completed—not necessarily when an order was paid, although paying an order will complete it.

This is called for each line item that contains the purchasable.

For example, variants use this method to deduct stock.

# getPromotionRelationSource()

Returns the source param value for an element relation query, for use with promotions. For example, a sale promotion on a category needs to know if the purchasable is related.

Defaults to the ID of the purchasable element, which would be sufficient for most purchasables.

# Purchasable deletion

Craft CMS includes soft delete support for all element types, including purchasables. You might want to familiarize yourself with soft deletion before adding delete and restore capabilities for your purchasable element.

When you inherit from craft\commerce\base\Purchasable and your element is saved, Commerce automatically updates the commerce_purchasables table with the purchasable’s sku so that all purchasables have a central location to check their sku uniqueness.

The uniqueness of your sku is automatically validated for you when extending craft\commerce\base\Purchasable.

Commerce only validates non-trashed purchasables. Trashed purchasables will still be in the commerce_purchasables table until garbage collection is run.

# Restoring soft-deleted purchasables

If you decide to support restoration of your purchasable element, you need to make sure your its restored sku is unique.

You would do this by overriding the beforeRestore() method in your purchasable element.

Within that method, you would first see if any non-trashed purchasables have the same sku as the purchasable to be restored:

if (!parent::beforeDelete()) {
    return false;

$found = (new Query())->select(['[[p.sku]]', '[[e.id]]'])
    ->from('{{%commerce_purchasables}} p')
    ->leftJoin(Table::ELEMENTS . ' e', '[[p.id]]=[[e.id]]')
    ->where(['[[e.dateDeleted]]' => null, '[[p.sku]]' => $this->getSku()])
    ->andWhere(['not', ['[[e.id]]' => $this->getId()]])

If $found is greater than zero, meaning there’s another live (non-trashed) purchasable with the same sku, make your purchasable’s sku unique and update the relevant tables:

if ($found) {

    $this->sku = $this->getSku() . '-1'; // make unique

    // Update variant table with new SKU
        ['sku' => $this->sku],
        ['id' => $this->getId()]

    if ($this->isDefault) {
            ['defaultSku' => $this->sku],
            ['id' => $this->productId]

    // Update purchasable table with new SKU
        ['sku' => $this->sku],
        ['id' => $this->getId()]

It’s important to update your own tables in addition to the commerce_purchasables table.