Skip to content
  • Documentation >
  • API >
  • Commerce API >
  • Business API >
  • addProducts

addProducts

basket.add_products adds one or more products to the basket.

Exceptions:

  • \InvalidArgumentException - thrown if variant without variantCode is chosen

Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
$outputGetBasket = $this->getBusinessApi()->call('basket.get_basket', $inputGetBasket);
//clear all messages for each request
$outputGetBasket->basket->clearAllMessages();
$itemData = new ItemData(
    array(
        'quantity'    => '1',
        'isVariant'   => '',
        'variantCode' =>  '',
        'sku'         => '1000',
    )
);
/** @var InputAddItemToBasket $inputAddItemToBasket */
$inputAddItemToBasket = new InputAddItemToBasket(
   array(
       'itemData' => $itemData,
       'basket'   => $outputGetBasket->basket,
   )
);
try {
    $outputGetBasket = $this->getBusinessApi()->call('basket.add_products', $inputAddItemToBasket);
} catch (\InvalidArgumentException $e) {
    // ....
}
$message = $this->getBasketMessage($outputGetBasket->basket);

Input parameters

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
namespace Silversolutions\Bundle\EshopBundle\Entities\BusinessLayer\InputValueObjects;

class AddItemToBasket extends ValueObject
{

    /**
     * @var \Ibexa\Platform\Commerce\Checkout\Entities\BusinessLayer\InputValueObjects\AddItemToBasket\ItemData
     */
    protected $itemData;
    /**
     * @var \Ibexa\Platform\Bundle\Commerce\Checkout\Entity\Basket $basket
     */
    protected $basket;
    /**
     * @var array
     */
    protected $checkProperties = array(
        array(
            'name' => 'itemData',
            'mandatory' => true,
            'type' => '\Ibexa\Platform\Commerce\Checkout\Entities\BusinessLayer\InputValueObjects\AddItemToBasket\ItemData',
            'isObject' => true,
        ),
        array(
            'name' => 'basket',
            'mandatory' => true,
            'type' => '\Ibexa\Platform\Bundle\Commerce\Checkout\Entity\Basket',
            'isObject' => true
        )
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
namespace Ibexa\Platform\Commerce\Checkout\Entities\BusinessLayer\InputValueObjects\AddItemToBasket;

use Silversolutions\Bundle\EshopBundle\Content\ValueObject;

/**
 * This class bundles all data, which is necessary for a basket item line.
 *
 * @property-read float $quantity
 * @property-read string $isVariant
 * @property-read string $variantCode
 * @property-read string $sku
 */
class ItemData extends ValueObject
{
    /**
     * @var string
     */
    protected $quantity;
    /**
     * @var string
     */
    protected $isVariant;
    /**
     * @var string
     */
    protected $variantCode;
    /**
     * @var string
     */
    protected $sku;
    /**
     * @var array
     */
    protected $checkProperties = array(
        array('name' => 'quantity', 'mandatory' => true, 'type' => 'string'),
        array('name' => 'isVariant', 'mandatory' => false, 'type' => 'string'),
        array('name' => 'variantCode', 'mandatory' => false, 'type' => 'string'),
        array('name' => 'sku', 'mandatory' => true, 'type' => 'string'),
    );
}

Returns output

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
namespace Silversolutions\Bundle\EshopBundle\Entities\BusinessLayer\OutputValueObjects;
use Silversolutions\Bundle\EshopBundle\Content\ValueObject;
/**
 * Class AddItemToBasket
 *
 * This class is used as an output parameter for an appropriate business method
 *
 * @property-read \Ibexa\Platform\Bundle\Commerce\Checkout\Entity\Basket $basket
 */
class AddItemToBasket extends ValueObject
{
    /**
     * @var \Ibexa\Platform\Bundle\Commerce\Checkout\Entity\Basket $basket
     */
    protected $basket;
    /** @var array $checkProperties */
    protected $checkProperties = array(
        array(
            'name' => 'basket',
            'mandatory' => true,
            'type' => '\Ibexa\Platform\Bundle\Commerce\Checkout\Entity\Basket',
            'isObject' => true
        )
    );
}