Catalog and Pricing

# Placeholders: PS_URL is the shop, PS_API_TOKEN a bearer token with the scopes shown below
export PS_URL=http://localhost:8080
export PS_API_TOKEN=<token from POST ${PS_URL}/admin-api/access_token, scopes: attribute_group_write attribute_write product_write>
AUTH="Authorization: Bearer ${PS_API_TOKEN}"
JSON="Content-Type: application/json"

# Three attribute groups (names are keyed by language id: 1 = English, 2 = Spanish)
curl -s -X POST "${PS_URL}/admin-api/attributes/groups" -H "$AUTH" -H "$JSON" -d '{
  "names":{"1":"PCFF Origin","2":"PCFF Origen"},"publicNames":{"1":"Origin","2":"Origen"},"type":"select","shopIds":[1]}'
curl -s -X POST "${PS_URL}/admin-api/attributes/groups" -H "$AUTH" -H "$JSON" -d '{
  "names":{"1":"PCFF Grind","2":"PCFF Molienda"},"publicNames":{"1":"Grind","2":"Molienda"},"type":"select","shopIds":[1]}'
curl -s -X POST "${PS_URL}/admin-api/attributes/groups" -H "$AUTH" -H "$JSON" -d '{
  "names":{"1":"PCFF Size","2":"PCFF Tamano"},"publicNames":{"1":"Size","2":"Tamaño"},"type":"select","shopIds":[1]}'
# -> {"attributeGroupId":5,...} {"attributeGroupId":6,...} {"attributeGroupId":7,...}

# Eight values; "color" is required by the command even when the group is not a color group
curl -s -X POST "${PS_URL}/admin-api/attributes/attributes" -H "$AUTH" -H "$JSON" -d '{
  "attributeGroupId":5,"names":{"1":"Ethiopia Yirgacheffe","2":"Etiopía Yirgacheffe"},"color":"","shopIds":[1]}'
# ... Colombia Huila and Brazil Cerrado (group 5), Whole bean, Espresso, Filter (group 6), 250 g and 1 kg (group 7)
# -> attribute ids 26-28 (origin), 29-31 (grind), 32-33 (size)

# The product: a "combinations" product with an English and a Spanish name, tax rules group 1 and the 250 g base price
curl -s -X POST "${PS_URL}/admin-api/products" -H "$AUTH" -H "$JSON" -d '{
  "type":"combinations","names":{"1":"PCFF Single-origin beans","2":"PCFF Café de origen"}}'
# -> {"productId":20,"type":"combinations","enabled":false,...}
curl -s -X PATCH "${PS_URL}/admin-api/products/20" -H "$AUTH" -H "Content-Type: application/merge-patch+json" -d '{
  "descriptions":{"1":"Freshly roasted single-origin coffee beans.","2":"Café de origen recién tostado."},
  "priceTaxExcluded":8.90,"taxRulesGroupId":1,"reference":"PC-BEANS","weight":0.25,"enabled":true}'

# 3 x 3 x 2 = 18 combinations in one call
curl -s -X POST "${PS_URL}/admin-api/products/20/generate-combinations" -H "$AUTH" -H "$JSON" -d '{
  "groupedAttributes":[
    {"attributeGroupId":5,"attributeIds":[26,27,28]},
    {"attributeGroupId":6,"attributeIds":[29,30,31]},
    {"attributeGroupId":7,"attributeIds":[32,33]}]}'
# -> {"productId":20,"newCombinationIds":[40,41,42,...,57]}

# A tax is a name and a rate (the rate must be a JSON number, not a string)
curl -s -X POST "${PS_URL}/admin-api/taxes" -H "$AUTH" -H "$JSON" -d '{"names":{"1":"PCFF IVA 10%","2":"PCFF IVA 10%"},"rate":10.0,"enabled":true}'
curl -s -X POST "${PS_URL}/admin-api/taxes" -H "$AUTH" -H "$JSON" -d '{"names":{"1":"PCFF IVA 21%","2":"PCFF IVA 21%"},"rate":21.0,"enabled":true}'

# A tax rules group is what a product (or a carrier) points to
curl -s -X POST "${PS_URL}/admin-api/tax-rules-groups" -H "$AUTH" -H "$JSON" -d '{"name":"PCFF ES reduced VAT","enabled":true,"shopIds":[1]}'
curl -s -X POST "${PS_URL}/admin-api/tax-rules-groups" -H "$AUTH" -H "$JSON" -d '{"name":"PCFF ES standard VAT","enabled":true,"shopIds":[1]}'

# A rule: in this group, for country 6 (Spain), apply tax 1 only (behavior 0)
curl -s -X POST "${PS_URL}/admin-api/tax-rules" -H "$AUTH" -H "$JSON" -d '{"taxRulesGroupId":1,"countryId":6,"taxId":1,"behavior":0,"description":"Spain reduced"}'
curl -s -X POST "${PS_URL}/admin-api/tax-rules" -H "$AUTH" -H "$JSON" -d '{"taxRulesGroupId":2,"countryId":6,"taxId":2,"behavior":0,"description":"Spain standard"}'

<?php

declare(strict_types=1);

namespace PrestaShop\Module\Pcffcatalog\Command;

use Combination;
use DateTimeImmutable;
use PrestaShop\PrestaShop\Core\CommandBus\CommandBusInterface;
use PrestaShop\PrestaShop\Core\Domain\Product\Combination\Command\UpdateCombinationCommand;
use PrestaShop\PrestaShop\Core\Domain\Product\Combination\Command\UpdateCombinationStockAvailableCommand;
use PrestaShop\PrestaShop\Core\Domain\Product\SpecificPrice\Command\AddSpecificPriceCommand;
use PrestaShop\PrestaShop\Core\Domain\Product\Stock\Command\UpdateProductStockAvailableCommand;
use PrestaShop\PrestaShop\Core\Domain\Shop\ValueObject\ShopConstraint;
use PrestaShop\PrestaShop\Core\Domain\ValueObject\Reduction;
use Product;
use Symfony\Component\Console\Attribute\AsCommand;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;

#[AsCommand(name: 'pcffcatalog:seed', description: 'Fills the Pocket Coffee beans product with references, price impacts, stock and specific prices')]
final class SeedCommand extends Command
{
    private const ORIGIN = ['Ethiopia Yirgacheffe' => 'ETH', 'Colombia Huila' => 'COL', 'Brazil Cerrado' => 'BRA'];
    private const GRIND = ['Whole bean' => 'WHL', 'Espresso' => 'ESP', 'Filter' => 'FIL'];
    private const SIZE = ['250 g' => '250', '1 kg' => '1KG'];

    public function __construct(private readonly CommandBusInterface $commandBus)
    {
        parent::__construct();
    }

    protected function configure(): void
    {
        $this->addArgument('product-id', InputArgument::REQUIRED, 'Id of the product with the 18 generated combinations');
        $this->addOption('kit-id', null, InputOption::VALUE_REQUIRED, 'Id of the simple Starter kit product that receives 20 units of stock');
    }

    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        $productId = (int) $input->getArgument('product-id');
        $shop = ShopConstraint::shop(1);
        $product = new Product($productId, false, 1);

        // 1. One row per combination: attribute names -> SKU, price impact and weight impact
        $byCombination = [];
        foreach ($product->getAttributeCombinations(1) as $row) {
            $byCombination[(int) $row['id_product_attribute']][$row['group_name']] = $row['attribute_name'];
        }

        foreach ($byCombination as $combinationId => $attributes) {
            $origin = $attributes['PCFF Origin'];
            $grind = $attributes['PCFF Grind'];
            $size = $attributes['PCFF Size'];

            // Base product price 8.90 is the 250 g price; 1 kg costs 29.90 (+21.00); Ethiopia costs +1.00 per 250 g
            $impact = ('1 kg' === $size ? 21.0 : 0.0) + ('Ethiopia Yirgacheffe' === $origin ? ('1 kg' === $size ? 4.0 : 1.0) : 0.0);
            $weight = '1 kg' === $size ? '0.75' : '0';

            $command = (new UpdateCombinationCommand($combinationId, $shop))
                ->setReference(sprintf('PC-%s-%s-%s', self::ORIGIN[$origin], self::GRIND[$grind], self::SIZE[$size]))
                ->setImpactOnPrice(number_format($impact, 2, '.', ''))
                ->setImpactOnWeight($weight);
            $this->commandBus->handle($command);

            $this->commandBus->handle((new UpdateCombinationStockAvailableCommand($combinationId, $shop))->setFixedQuantity(50));
            $output->writeln(sprintf('combination %d -> %s', $combinationId, (new Combination($combinationId))->reference));
        }

        if (null !== $input->getOption('kit-id')) {
            $this->commandBus->handle((new UpdateProductStockAvailableCommand((int) $input->getOption('kit-id'), $shop))->setDeltaQuantity(20));
            $output->writeln('kit stock: +20');
        }

        // 2. Specific price: 5% off from the third bag, valid for every customer until the end of the year
        $volume = new AddSpecificPriceCommand(
            $productId,
            Reduction::TYPE_PERCENTAGE,
            '5',
            false,
            '-1',
            3,
            new DateTimeImmutable('2026-10-01 00:00:00'),
            new DateTimeImmutable('2026-12-31 23:59:59')
        );
        $volume->setShopId(1);
        $this->commandBus->handle($volume);
        $output->writeln('specific price: 5% from quantity 3');

        return Command::SUCCESS;
    }
}

services:
  _defaults:
    public: false
    autowire: true
    autoconfigure: true

  PrestaShop\Module\Pcffcatalog\Command\SeedCommand: ~
  PrestaShop\Module\Pcffcatalog\Command\ClubCommand: ~
  PrestaShop\Module\Pcffcatalog\Command\ReportCommand: ~
  PrestaShop\Module\Pcffcatalog\Command\WorkshopCommand: ~

php bin/console prestashop:module install pcffcatalog
php bin/console pcffcatalog:seed 20 --kit-id=22
# combination 40 -> PC-ETH-WHL-250
# combination 41 -> PC-ETH-WHL-1KG
# combination 42 -> PC-ETH-ESP-250
# ... 18 lines up to PC-BRA-FIL-1KG
# kit stock: +20
# specific price: 5% from quantity 3

<?php

declare(strict_types=1);

namespace PrestaShop\Module\Pcffcatalog\Command;

use Address;
use Category;
use Customer;
use Db;
use Group;
use PrestaShop\PrestaShop\Core\CommandBus\CommandBusInterface;
use PrestaShop\PrestaShop\Core\Domain\Product\Command\SetAssociatedProductCategoriesCommand;
use PrestaShop\PrestaShop\Core\Domain\Shop\ValueObject\ShopConstraint;
use CartRule;
use State;
use Symfony\Component\Console\Attribute\AsCommand;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Tools;
use Validate;

#[AsCommand(name: 'pcffcatalog:club', description: 'Creates the Beans category, the Coffee Club group, two customers and the automatic Coffee Club cart rule')]
final class ClubCommand extends Command
{
    public function __construct(private readonly CommandBusInterface $commandBus)
    {
        parent::__construct();
    }

    protected function configure(): void
    {
        $this->addArgument('product-id', InputArgument::REQUIRED, 'Id of the beans product');
    }

    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        $productId = (int) $input->getArgument('product-id');

        // Category "Beans" below Home (id 2), and the product assigned to it
        $category = new Category();
        $category->name = [1 => 'PCFF Beans', 2 => 'PCFF Granos'];
        $category->link_rewrite = [1 => 'pcff-beans', 2 => 'pcff-granos'];
        $category->id_parent = 2;
        $category->active = true;
        $category->add();
        $this->commandBus->handle(new SetAssociatedProductCategoriesCommand($productId, (int) $category->id, [(int) $category->id], ShopConstraint::shop(1)));
        $output->writeln('category ' . $category->id);

        // Customer group "Coffee Club" (membership only, the 10% lives in a cart rule)
        $group = new Group();
        $group->name = [1 => 'PCFF Coffee Club', 2 => 'PCFF Club del Café'];
        $group->reduction = 0;
        $group->price_display_method = 0;
        $group->add();
        $output->writeln('group ' . $group->id);

        // Customers: ada is a member and lives in Madrid, grace is a guest-type customer in Berlin
        $ada = $this->customer('Ada', 'Lovelace', 'pcff-ada@example.test', (int) $group->id, [(int) $group->id, 3]);
        $grace = $this->customer('Grace', 'Hopper', 'pcff-grace@example.test', 3, [3]);
        $this->address($ada, 'Calle de Alcalá 1', '28014', 'Madrid', 6, 'M');
        $this->address($grace, 'Unter den Linden 1', '10117', 'Berlin', 1, null);

        // Automatic cart rule (no code): members get 10% off products of the Beans category
        $rule = new CartRule();
        $rule->name = [1 => 'PCFF Coffee Club 10% on beans', 2 => 'PCFF Club del Café 10% en granos'];
        $rule->description = 'Members of the Coffee Club get 10% off beans';
        $rule->code = '';
        $rule->date_from = '2026-10-01 00:00:00';
        $rule->date_to = '2027-12-31 23:59:59';
        $rule->quantity = 1000;
        $rule->quantity_per_user = 1000;
        $rule->priority = 1;
        $rule->partial_use = false;
        $rule->minimum_amount = 0;
        $rule->minimum_amount_currency = 1;
        $rule->group_restriction = true;
        $rule->product_restriction = true;
        $rule->reduction_percent = 10;
        // 0 = whole order, -1 = cheapest product, -2 = the products selected by the product restriction
        $rule->reduction_product = -2;
        $rule->active = true;
        $rule->add();

        Db::getInstance()->insert('cart_rule_group', ['id_cart_rule' => (int) $rule->id, 'id_group' => (int) $group->id]);
        Db::getInstance()->insert('cart_rule_product_rule_group', ['id_cart_rule' => (int) $rule->id, 'quantity' => 1]);
        $ruleGroupId = (int) Db::getInstance()->Insert_ID();
        Db::getInstance()->insert('cart_rule_product_rule', ['id_product_rule_group' => $ruleGroupId, 'type' => 'categories']);
        $productRuleId = (int) Db::getInstance()->Insert_ID();
        Db::getInstance()->insert('cart_rule_product_rule_value', ['id_product_rule' => $productRuleId, 'id_item' => (int) $category->id]);
        Db::getInstance()->update('configuration', ['value' => 1], "name = 'PS_CART_RULE_FEATURE_ACTIVE'");
        $output->writeln('cart rule ' . $rule->id);

        return Command::SUCCESS;
    }

    /** @param int[] $groups */
    private function customer(string $first, string $last, string $email, int $defaultGroup, array $groups): Customer
    {
        $customer = new Customer();
        $customer->firstname = $first;
        $customer->lastname = $last;
        $customer->email = $email;
        $customer->passwd = Tools::hash(Tools::passwdGen(24));
        $customer->id_default_group = $defaultGroup;
        $customer->id_lang = 1;
        $customer->active = true;
        $customer->add();
        $customer->updateGroup($groups);

        return $customer;
    }

    private function address(Customer $customer, string $street, string $zip, string $city, int $countryId, ?string $stateIso): void
    {
        $address = new Address();
        $address->id_customer = (int) $customer->id;
        $address->alias = 'Home';
        $address->firstname = $customer->firstname;
        $address->lastname = $customer->lastname;
        $address->address1 = $street;
        $address->postcode = $zip;
        $address->city = $city;
        $address->id_country = $countryId;
        $address->dni = 6 === $countryId ? '00000000T' : '';
        if (null !== $stateIso) {
            $address->id_state = (int) State::getIdByIso($stateIso, $countryId);
        }
        $address->add();
    }
}

php bin/console pcffcatalog:club 20
# category 11
# group 7
# cart rule 1

<?php

declare(strict_types=1);

namespace PrestaShop\Module\Pcffcatalog\Command;

use Address;
use Cart;
use CartRule;
use Context;
use Customer;
use Product;
use Symfony\Component\Console\Attribute\AsCommand;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

#[AsCommand(name: 'pcffcatalog:report', description: 'Prints the price of the Pocket Coffee beans for different customers, quantities and carts')]
final class ReportCommand extends Command
{
    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        $ada = new Customer((int) Customer::customerExists('pcff-ada@example.test', true));
        $grace = new Customer((int) Customer::customerExists('pcff-grace@example.test', true));
        $adaAddress = (int) (new Customer($ada->id))->getAddresses(1)[0]['id_address'];
        $graceAddress = (int) (new Customer($grace->id))->getAddresses(1)[0]['id_address'];
        $productId = (int) Product::getIdByReference('PC-BEANS');
        $ethiopia250 = (int) \Combination::getIdByReference($productId, 'PC-ETH-WHL-250');
        $colombia1kg = (int) \Combination::getIdByReference($productId, 'PC-COL-FIL-1KG');

        $context = Context::getContext();
        $context->currency = new \Currency(1);
        $context->language = new \Language(1);
        $context->employee = new \Employee(1);

        $output->writeln('product ' . $productId . ', combinations ' . $ethiopia250 . ' and ' . $colombia1kg);
        $rows = [
            ['ETH-WHL-250, 1 unit, tax excl., guest', $ethiopia250, false, 1, null, null],
            ['ETH-WHL-250, 1 unit, tax incl. ES, ada', $ethiopia250, true, 1, $ada, $adaAddress],
            ['ETH-WHL-250, 3 units, tax excl., ada', $ethiopia250, false, 3, $ada, $adaAddress],
            ['COL-FIL-1KG, 1 unit, tax excl., grace', $colombia1kg, false, 1, $grace, $graceAddress],
            ['COL-FIL-1KG, 1 unit, tax incl. ES, ada', $colombia1kg, true, 1, $ada, $adaAddress],
        ];
        foreach ($rows as [$label, $combination, $tax, $qty, $customer, $addressId]) {
            $specific = null;
            $price = Product::getPriceStatic($productId, $tax, $combination, 6, null, false, true, $qty, false, $customer?->id, null, $addressId, $specific);
            $output->writeln(sprintf('%-45s %9.4f  specific price: %s', $label, $price, $specific ? $specific['id_specific_price'] . ' (' . $specific['reduction'] . ')' : 'none'));
        }

        // Same combination in the second currency (conversion rate of the shop currency table)
        $context->currency = new \Currency(2);
        $usd = Product::getPriceStatic($productId, false, $ethiopia250, 6, null, false, true, 1, false, null, null, null);
        $output->writeln(sprintf('%-45s %9.4f  (conversion rate %.6f)', 'ETH-WHL-250, 1 unit, tax excl., USD', $usd, $context->currency->conversion_rate));
        $context->currency = new \Currency(1);

        // A cart for each customer: three bags of ETH-WHL-250, one COL-FIL-1KG and one starter kit
        foreach ([[$ada, $adaAddress], [$grace, $graceAddress]] as [$customer, $addressId]) {
            $cart = new Cart();
            $cart->id_customer = (int) $customer->id;
            $cart->id_address_delivery = $addressId;
            $cart->id_address_invoice = $addressId;
            $cart->id_currency = 1;
            $cart->id_lang = 1;
            $cart->id_shop = 1;
            $cart->id_shop_group = 1;
            $cart->secure_key = $customer->secure_key;
            $cart->add();
            $context->customer = $customer;
            $context->cart = $cart;
            $cart->updateQty(3, $productId, $ethiopia250);
            $cart->updateQty(1, $productId, $colombia1kg);
            $cart->updateQty(1, (int) Product::getIdByReference('PC-KIT'));
            CartRule::autoAddToCart($context);
            $cart = new Cart((int) $cart->id);
            $context->cart = $cart;
            $output->writeln('--- cart of ' . $customer->email);
            foreach ($cart->getCartRules() as $rule) {
                $output->writeln(sprintf('cart rule %d "%s": %.4f tax excl. / %.4f tax incl.', $rule['id_cart_rule'], $rule['name'], $rule['value_tax_exc'], $rule['value_real']));
            }
            foreach ($cart->getProducts(true) as $line) {
                $output->writeln(sprintf('line %s x%d unit tax excl. %.4f, total tax excl. %.4f', $line['reference'], $line['cart_quantity'], $line['price'], $line['total']));
            }
            $output->writeln(sprintf('products before discounts, tax excl.: %.2f', $cart->getOrderTotal(false, Cart::ONLY_PRODUCTS)));
            $output->writeln(sprintf('discounts, tax incl.: %.2f', $cart->getOrderTotal(true, Cart::ONLY_DISCOUNTS)));
            $output->writeln(sprintf('total without shipping, tax excl.: %.2f, tax incl.: %.2f', $cart->getOrderTotal(false, Cart::BOTH_WITHOUT_SHIPPING), $cart->getOrderTotal(true, Cart::BOTH_WITHOUT_SHIPPING)));
            $cart->delete();
        }

        return Command::SUCCESS;
    }
}

product 20, combinations 40 and 51
ETH-WHL-250, 1 unit, tax excl., guest            9.9000  specific price: none
ETH-WHL-250, 1 unit, tax incl. ES, ada          10.8900  specific price: none
ETH-WHL-250, 3 units, tax excl., ada             9.4050  specific price: 4 (0.050000)
COL-FIL-1KG, 1 unit, tax excl., grace           29.9000  specific price: none
COL-FIL-1KG, 1 unit, tax incl. ES, ada          32.8900  specific price: none
ETH-WHL-250, 1 unit, tax excl., USD             11.0612  (conversion rate 1.117294)
--- cart of pcff-ada@example.test
cart rule 1 "PCFF Coffee Club 10% on beans": 5.6620 tax excl. / 6.2282 tax incl.
cart rule 2 "PCFF Club 5% on starter kits": 1.2000 tax excl. / 1.4520 tax incl.
line PC-ETH-WHL-250 x3 unit tax excl. 9.4050, total tax excl. 28.2100
line PC-COL-FIL-1KG x1 unit tax excl. 28.4050, total tax excl. 28.4100
line PC-KIT x1 unit tax excl. 24.0000, total tax excl. 24.0000
products before discounts, tax excl.: 80.62
discounts, tax incl.: 7.68
total without shipping, tax excl.: 73.76, tax incl.: 83.65
--- cart of pcff-grace@example.test
line PC-ETH-WHL-250 x3 unit tax excl. 9.4050, total tax excl. 28.2100
line PC-COL-FIL-1KG x1 unit tax excl. 28.4050, total tax excl. 28.4100
line PC-KIT x1 unit tax excl. 24.0000, total tax excl. 24.0000
products before discounts, tax excl.: 80.62
discounts, tax incl.: 0.00
total without shipping, tax excl.: 80.62, tax incl.: 80.62