Reclamations feature integration
Edit on GitHubInstall feature core
Prerequisites
Install the required features:
NAME | VERSION |
---|---|
Order Management | 202307.0 |
Spryker Core | 202307.0 |
1) Install the required modules
Install the required modules using Composer:
composer require spryker-feature/reclamations: "202307.0" --update-with-dependencies`
“Verification”
Make sure that the following modules have been installed:
MODULE | EXPECTED DIRECTORY |
---|---|
SalesReclamation | vendor/spryker/sales-reclamation |
SalesReclamationGui | vendor/spryker/sales-reclamation-gui |
2) Set up the database schema and transfer objects
Apply database changes and generate entity and transfer changes:
console propel:install
console transfer:generate
“Verification”
Make sure that the following changes have been applied by checking your database:
DATABASE ENTITY | TYPE |
---|---|
spy_sales_reclamation | table |
spy_sales_reclamation_item | table |
“Verification”
Make sure that the following changes were implemented in the transfer objects:
TRANSFER | TYPE | PATH |
---|---|---|
Reclamation | class | src/Generated/Shared/Transfer/ReclamationTransfer |
ReclamationItem | class | src/Generated/Shared/Transfer/ReclamationItemTransfer |
ReclamationCreateRequest | class | src/Generated/Shared/Transfer/ReclamationCreateRequestTransfer |
SpySalesReclamationEntity | class | src/Generated/Shared/Transfer/SpySalesReclamationEntityTransfer |
SpySalesReclamationItemEntity | class | src/Generated/Shared/SpySalesReclamationItemEntityTransfer |
3) Set up behavior
Enable the following behaviors by registering the plugins:
PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE |
---|---|---|---|
ReclamationSalesTablePlugin | Expands sales order table with a “Claim” button, that redirects to “Create Reclamation” page, where the whole order or its specific items can be reclaimed. | None | Spryker\Zed\SalesReclamationGui\Communication\Plugin\Sales |
src/Pyz/Zed/Sales/SalesDependencyProvider.php
<?php
namespace Pyz\Zed\Sales;
use Spryker\Zed\Sales\SalesDependencyProvider as SprykerSalesDependencyProvider;
use Spryker\Zed\SalesReclamationGui\Communication\Plugin\Sales\ReclamationSalesTablePlugin;
class SalesDependencyProvider extends SprykerSalesDependencyProvider
{
/**
* @return \Spryker\Zed\SalesExtension\Dependency\Plugin\SalesTablePluginInterface[]
*/
protected function getSalesTablePlugins()
{
return [
new ReclamationSalesTablePlugin(),
];
}
}
Verification
Make sure that the sales order table in the back office has a “Claim” button for each order, clicking on which will redirect you to create reclamation page.
Thank you!
For submitting the form