Extending Ibexa Commerce - Shipping cost calculator

Jérémy J.

21 Aug 2024

How to dynamically calculate shipping costs?

The official documentation that explains how to create shipping methods in Ibexa Commerce omits a crucial explanation: how to calculate the fees for the method in question?

So I'm going to fill this gap and explain how to create a fee calculator for a shipping method. I'll take as an example a simple case where we have products with free shipping:

if all the products in the order have free shipping, the shipping cost of the order will be 0;
otherwise the shipping cost will be the amount configured in the shipping method.

Like many other things in Ibexa or Symfony in general, this calculator will be a tagged service.

Here is the class src/Commerce/Attribute/String/StringStorageDefinition.php :

   1
2
3<?php 
4declare(strict_types=1); 
5namespace App\Commerce\Shipping; 
6use Ibexa\Contracts\Cart\Value\CartInterface;
7use Ibexa\Contracts\ProductCatalog\CurrencyServiceInterface;
8use Ibexa\Contracts\ProductCatalog\Values\AttributeInterface;
9use Ibexa\Contracts\Shipping\ShippingMethod\CostCalculatorInterface;
10use Ibexa\Contracts\Shipping\Value\ShippingMethod\ShippingMethodInterface;
11use Ibexa\ProductCatalog\Money\DecimalMoneyFactory;
12use Money\Currency;
13use Money\Money; 
14class CostCalculator implements CostCalculatorInterface
15{
16   public function __construct(
17       private readonly DecimalMoneyFactory $decimalMoneyFactory,
18       private readonly CurrencyServiceInterface $currencyService
19   ) {
20   } 
21   public function calculate(ShippingMethodInterface $method, CartInterface $cart): Money
22   {
23       $isFree = true; 
24       // Check for each item in the cart if it has free shipping
25       foreach ($cart->getEntries() as $entry) {
26           /** @var array<AttributeInterface> $attributes */
27           $attributes = iterator_to_array($entry->getProduct()->getAttributes());
28           if (!$attributes['free_shipping']->getValue()) {
29               $isFree = false;
30               break;
31           }
32       } 
33       // Get shipping method configuration
34       $price = $method->getOptions()->get('price');
35       $currencyId = $method->getOptions()->get('currency'); 
36       $currency = $this->currencyService->getCurrency($currencyId); 
37       // All items have free shipping, return a amount of 0
38       if ($isFree) {
39           return new Money('0', new Currency($currency->getCode()));
40       } 
41       return $this->decimalMoneyFactory->getMoneyParser()->parse(
42           $price,
43           new Currency($currency->getCode())
44       );
45   }
46} 
47

All that remains is to tag our service in configuration file config/services.yaml :

   1
2
3    App\Commerce\Shipping\CostCalculator:
4       tags:
5           - name: ibexa.shipping.shipping.cost_calculator
6             method: custom_method # custom_method à remplacer par l'identifiant de la méthode de livraison 
7