Skip to content
  • Documentation >
  • API >
  • PHP API >
  • Shop API

Shop API

Shop business API is the layer between the application entry points (like controllers or CLI commands) and the particular shop-related services.

To access the Shop business API, you have to use the Business API invocation service. This service is the access point to the Business API and is defined by a service with the ID ses_eshop.business_api.invocation.

To call the operation service, use the call() method.

The method takes two parameters:

  • string $operationIdentifier
  • ValueObject $operationInput

The following example shows how to use the Business API basket operation service.

1
2
3
4
5
6
7
8
use Ibexa\Platform\Commerce\Checkout\Entities\BusinessLayer\InputValueObjects\GetBasket as InputGetBasket;
use Ibexa\Platform\Commerce\Checkout\Entities\BusinessLayer\InputValueObjects\GetBasket as OutputGetBasket;

/** @var InputGetBasket $input */
$input = new InputGetBasket(array('request' => $request));

/** @var OutputGetBasket $output */
$output = $this->get('ses_eshop.business_api.invocation')->call('basket.get_basket', $input);

Methods

Method Parameters Returns Description Operation identifier
addProducts InputAddItemToBasket $operationInput OutputAddItemToBasket $operationOutput Adds products to the basket. basket.add_products
getBasket InputGetBasket $input OutputGetBasket $output Returns current basket. basket.get_basket
loadProducts InputLoadList $input OutputLoadList $input Loads products from catalog. catalog.load_products

addProducts

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

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
25
26
27
$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);

getBasket

basket.get_basket gets the current basket.

Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
use Ibexa\Platform\Commerce\Checkout\Entities\BusinessLayer\InputValueObjects\GetBasket as InputGetBasket;
use Ibexa\Platform\Commerce\Checkout\Entities\BusinessLayer\OutputValueObjects\GetBasket as OutputGetBasket;

/** @var InputGetBasket $inputGetBasket */
$inputGetBasket = new InputGetBasket(array('request' => $request));

/** @var OutputGetBasket $outputGetBasket */
$outputGetBasket = $this->getBusinessApi()->call('basket.get_basket', $inputGetBasket);

$message = $this->getBasketMessage($outputGetBasket->basket);

loadProducts

catalog.load_products loads products from storage.

Example call to Business API

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
/** @var InputLoadList $input */
$input = new InputLoadList(
    array(
        'locationId' => 136,
        'limit' => 3,
        'offset' => 3,
        'language' => 'de_DE',
        'filterType' => 'productList',
    )
);

/** @var OutputLoadList $output */
$output = $this->getBusinessApi()->call('catalog.load_products', $input);

$html = $this->renderView(
    '@SilversolutionsEshopBundle/Catalog/listProductNodes.html.twig',
    array(
        'catalogList' => $output->catalogList,
        'params' => $data,
        'locationId' => $output->locationId,
    )
);