From d6b4d5cf8716b01527e020665ae55888c02ed0df Mon Sep 17 00:00:00 2001 From: Ivan Shakuta Date: Fri, 14 Jul 2023 09:49:31 +0200 Subject: [PATCH 01/10] HowTo guide - one worker for all stores and it's benefits --- ...ins-execution-costs-without-refactoring.md | 93 +++++++++++++++++++ 1 file changed, 93 insertions(+) create mode 100644 docs/scos/dev/tutorials-and-howtos/howtos/howto-reduce-jenkins-execution-costs-without-refactoring.md diff --git a/docs/scos/dev/tutorials-and-howtos/howtos/howto-reduce-jenkins-execution-costs-without-refactoring.md b/docs/scos/dev/tutorials-and-howtos/howtos/howto-reduce-jenkins-execution-costs-without-refactoring.md new file mode 100644 index 00000000000..868e23e5a71 --- /dev/null +++ b/docs/scos/dev/tutorials-and-howtos/howtos/howto-reduce-jenkins-execution-costs-without-refactoring.md @@ -0,0 +1,93 @@ +--- +title: "HowTo: Reduce Jenkins execution by up to 80% without P&S and Data importers refactoring" +description: Save Jenkins related costs or speedup background jobs processing by implementing a custom single Worker for all stores. +last_updated: Jul 15, 2023 +template: howto-guide-template +originalLink: ?? +originalArticleId: ?? +redirect_from: +--- + + +# The Challenge + +Our out-of-the-box (OOTB) system requires a specific command (Worker - `queue:worker:start`) to be continuously running for each store to process queues and ensure propagation of information. In addition to this command, there are other commands such as OMS processing, import, export, etc. When these processes are not functioning or running slowly, there is a delay in data changes being reflected on the frontend, causing dissatisfaction among customers and leading to disruption of business processes. + +# Explanation + +By default, our system has a limit of two Jenkins executors for each environment. This limit is usually not a problem for single-store setups, but it becomes critical when there are multiple stores. Without increasing this limit, processing becomes slow because only two Workers are scanning queues and running tasks at a time, while other Workers for different stores have to wait. Moreover, even when some stores don't have messages to process, we still need to run a Worker just for scanning purposes, which occupies Jenkins executors, CPU time, and memory. + +Increasing the number of processes per queue can lead to issues such as Jenkins hanging, crashing, or becoming unresponsive. Although memory consumption and CPU utilisation are not generally high (around 20-30%), there can be spikes in memory consumption due to a random combination of several workers processing heavy messages for multiple stores simultaneously. + +There are two potential solutions to address this problem: application optimisation and better background job orchestration. + +# Proposed Solution + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/dev/tutorials-and-howtos/howtos/howto-reduce-jenkins-execution-cost-without-refactoring/OneWorker-diagram.png) + +The solution described here is targeted at small to medium projects but can be improved and applied universally, but it hasn't been tested fully in such conditions yet. + +The proposed solution is to use one Worker (`queue:worker:start`) for all stores, regardless of the number of stores. Instead of executing these steps for one store within one process and having multiple processes for multiple stores, we can have one process that scans all queues for all stores and spawns child processes the same way as the OOTB solution. However, instead of determining the number of processes based on the presence of a single message, we can analyse the total number of messages in the queue to make an informed decision on how many processes should be launched at any given moment. + +## The Process Pool + +In computer science, a pool refers to a collection of resources that are kept in memory and ready to use. In this context, we have a fixed-sized pool (fixed-size array) where new processes are only run if there is space available among the other running processes. This approach allows us to have better control over the number of processes launched by the OOTB solution, resulting in more predictable memory consumption. + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/dev/tutorials-and-howtos/howtos/howto-reduce-jenkins-execution-cost-without-refactoring/NewWorker+Flow.png) + +We define the total number of simultaneously running processes for the entire setup on the EC2 instance level. This makes it easier to manage, as we can monitor the average memory consumption for the process pool. If it's too low, we can increase the pool size, and if it's too high, we can decrease it. Additionally, we check the available memory (RAM) and prevent spawning additional processes if it is too low, ensuring system stability. Execution statistics provide valuable insights for decision-making, including adjusting the pool size or scaling up/down the EC2 instance. + +The following params exist: + +- pool size (default 5-10) +- free mem buffer - min amount of RAM (MB) system should have in order to spawn a new child process (default 750mb) + +## Worker Statistics and Logs + +With the proposed solution, we gather better statistics to understand the "health" of the worker and make informed decisions. We can track the number of tasks executed per queue/store, distribution of error codes, cycles, and various metrics related to skipping cycles, cooldown, available slots, and memory limitations. These statistics help us monitor performance, identify bottlenecks, and optimize resource allocation. + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/dev/tutorials-and-howtos/howtos/howto-reduce-jenkins-execution-cost-without-refactoring/stats-log.png) + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/dev/tutorials-and-howtos/howtos/howto-reduce-jenkins-execution-cost-without-refactoring/stats-summary.png) + +## Error Logging + +In addition to statistics, we also capture the output of children's processes in the standard output of the main worker process. This simplifies troubleshooting by providing logs with store and queue names. + +![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/dev/tutorials-and-howtos/howtos/howto-reduce-jenkins-execution-cost-without-refactoring/stats-error-log.png) + +## Edge Cases/Limitation + +Child processes are killed at the end of each minute, which means those batches that were in progress - will be abandoned and return to the source queue to be processed during the next run. While we didn’t notice any issues with this approach, please note that this is still experimental approach and may or may not improve in future. The recommendation to mitigate this is to use smaller batches to ensure children processes are running within seconds or up to 10s (rough estimate) - to reduce the number of messages that will be retried. + +## Implementation + + +Two ways are possible + +1. Applying a patch, although it may require conflict resolution, since it is applied on project level and each project may have unique customisations already in place. + +```bash +git apply one-worker.diff +``` + +2. Integrating it manually, using the patch as a source. + + +Please see attached diffs fror an example implementation. [Here's a diff](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/dev/tutorials-and-howtos/howtos/howto-reduce-jenkins-execution-cost-without-refactoring/one-worker.diff). + +In the project the functionality can be activated and deactivated using the following configuration flag: + +```php +$config[QueueConstants::QUEUE_ONE_WORKER_ALL_STORES] = (bool)getenv('QUEUE_ONE_WORKER_ALL_STORES') ?? false; +``` + +You can set the flag by setting the following environment variable: + +``` +QUEUE_ONE_WORKER_ALL_STORES +``` + +# Summary + +The proposed solution was developed was tested in a project environment. It has shown positive results, with significant improvements in data-import processing time. While this solution is suitable for small to medium projects, it has the potential to be applied universally. Code Examples can be found in the attached diff files that show the implementation in a project. From 0caa9eeb51bb94f245043de0ff20b5675fdd47e6 Mon Sep 17 00:00:00 2001 From: Ivan Shakuta Date: Wed, 19 Jul 2023 11:47:27 +0200 Subject: [PATCH 02/10] update doc with implementation code and configuration section --- ...ins-execution-costs-without-refactoring.md | 399 +++++++++++++++++- 1 file changed, 396 insertions(+), 3 deletions(-) diff --git a/docs/scos/dev/tutorials-and-howtos/howtos/howto-reduce-jenkins-execution-costs-without-refactoring.md b/docs/scos/dev/tutorials-and-howtos/howtos/howto-reduce-jenkins-execution-costs-without-refactoring.md index 868e23e5a71..9b3dbe6d2a4 100644 --- a/docs/scos/dev/tutorials-and-howtos/howtos/howto-reduce-jenkins-execution-costs-without-refactoring.md +++ b/docs/scos/dev/tutorials-and-howtos/howtos/howto-reduce-jenkins-execution-costs-without-refactoring.md @@ -65,16 +65,345 @@ Child processes are killed at the end of each minute, which means those batches Two ways are possible -1. Applying a patch, although it may require conflict resolution, since it is applied on project level and each project may have unique customisations already in place. +1. Applying a patch, although it may require conflict resolution, since it is applied on project level and each project may have unique customisations already in place. Please see attached diffs fror an example implementation. [Here's a diff](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/dev/tutorials-and-howtos/howtos/howto-reduce-jenkins-execution-cost-without-refactoring/one-worker.diff). ```bash git apply one-worker.diff ``` -2. Integrating it manually, using the patch as a source. +2. Integrating it manually, using the patch as a source and the following sections as guide. -Please see attached diffs fror an example implementation. [Here's a diff](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/dev/tutorials-and-howtos/howtos/howto-reduce-jenkins-execution-cost-without-refactoring/one-worker.diff). +### A new Worker implementation + +This is a completely custom implementation, which doesn't extend anything and built based on the ideas described above. + +Mainly, new implementation provides such features as: +- spawns only single process per loop iteration +- checks free system memory before each launch +- ignores processes limits per queue in favour of one limit of simultaneously running processes (process pool size) +- doesn't wait for child processes to finish, this is not elegant solution, but it works and there are few recommendations how to mitigate potential risks related to that +- it also gathers statistics and processes output for build a summary report at the end of each Worker invokation + +
+src/Pyz/Zed/Queue/Business/Worker/NewWorker.php + +```php + + */ + protected array $queueNames; + + /** + * @var \Spryker\Zed\Queue\Business\SignalHandler\SignalDispatcherInterface + */ + protected SignalDispatcherInterface $signalDispatcher; + + /** + * @var \Psr\Log\LoggerInterface + */ + protected LoggerInterface $logger; + + /** + * @var \Pyz\Zed\Queue\Business\Strategy\QueueProcessingStrategyInterface + */ + protected QueueProcessingStrategyInterface $queueProcessingStrategy; + + /** + * @var \SplFixedArray<\Symfony\Component\Process\Process> + */ + protected SplFixedArray $processes; + + /** + * @var int + */ + private int $runningProcessesCount = 0; + + /** + * @var \Pyz\Zed\Queue\Business\Worker\WorkerStats + */ + private WorkerStats $stats; + + /** + * @var \Pyz\Zed\Queue\Business\SystemResources\SystemResourcesManagerInterface + */ + private SystemResourcesManagerInterface $sysResManager; + + /** + * @var array + */ + private array $timers = []; + + public function __construct( + ProcessManagerInterface $processManager, + QueueConfig $queueConfig, + QueueClientInterface $queueClient, + array $queueNames, + QueueProcessingStrategyInterface $queueProcessingStrategy, + SignalDispatcherInterface $signalDispatcher, + SystemResourcesManagerInterface $sysResManager, + LoggerInterface $logger + ) { + $this->processManager = $processManager; + $this->queueConfig = $queueConfig; + $this->queueClient = $queueClient; + $this->queueNames = $queueNames; + $this->queueProcessingStrategy = $queueProcessingStrategy; + $this->signalDispatcher = $signalDispatcher; + $this->signalDispatcher->dispatch($this->queueConfig->getSignalsForGracefulWorkerShutdown()); + $this->sysResManager = $sysResManager; + $this->logger = $logger; + + $this->processes = new SplFixedArray($this->queueConfig->getQueueWorkerMaxProcesses()); + $this->stats = new WorkerStats(); + } + + /** + * @param string $timerName + * @param string $message + * @param string $level + * @param int $intervalSec + * + * @return void + */ + protected function logNotOftenThan(string $timerName, string $message, string $level = 'debug', int $intervalSec = 1): void + { + if (microtime(true) - ($this->timers[$timerName] ?? 0) >= $intervalSec) { + $this->timers[$timerName] = microtime(true); + $this->logger->$level($message); + } + } + + /** + * @param string $command + * @param array $options + * + * @return void + */ + public function start(string $command, array $options = []): void + { + $maxThreshold = $this->queueConfig->getQueueWorkerMaxThreshold(); + $delayIntervalMilliseconds = $this->queueConfig->getQueueWorkerInterval(); + $shouldIgnoreZeroMemory = $this->queueConfig->shouldIgnoreNotDetectedFreeMemory(); + + $startTime = microtime(true); + $lastStart = 0; + $maxMemGrowthFactor = 0; + + while (microtime(true) - $startTime < $maxThreshold) { + $this->stats->addCycle(); + + if (!$this->sysResManager->enoughResources($shouldIgnoreZeroMemory)) { + $this->logNotOftenThan('no-mem', 'NO MEMORY'); + $this->stats->addNoMemCycle()->addSkipCycle(); + + continue; + } + + $freeIndex = $this->removeFinishedProcesses(); + if ($freeIndex === null) { + $this->logNotOftenThan( + 'no-proc', + sprintf('BUSY: no free slots available for a new process, waiting'), + ); + + $this->stats + ->addNoSlotCycle() + ->addSkipCycle(); + } elseif ((microtime(true) - $lastStart) * 1000 > $delayIntervalMilliseconds) { + $lastStart = microtime(true); + $this->executeQueueProcessingStrategy($freeIndex); + } else { + $this->stats + ->addCooldownCycle() + ->addSkipCycle(); + } + + $this->logNotOftenThan( + 'time-mem', + sprintf('TIME: %0.2f sec' . "\n", microtime(true) - $startTime) . + sprintf('FREE MEM = %d MB', $this->sysResManager->getFreeMemory()), + 'info', + ); + + $ownMemGrowthFactor = $this->sysResManager->getOwnPeakMemoryGrowth(); + $maxMemGrowthFactor = max($ownMemGrowthFactor, $maxMemGrowthFactor); + $this->logNotOftenThan( + 'own-mem', + sprintf('OWN MEM: GROWTH FACTOR = %d%%', $ownMemGrowthFactor), + 'info', + ); + if ($ownMemGrowthFactor > $this->queueConfig->maxAllowedWorkerMemoryGrowthFactor()) { + $this->logger->emergency(sprintf('Worker memory grew more than %d%%, probably a memory leak, exiting', $ownMemGrowthFactor)); + + break; + } + } + + // to re-scan previously logged processes and update stats + $this->removeFinishedProcesses(); + $this->processManager->flushIdleProcesses(); + + $this->logger->info('DONE'); + $this->logger->info(var_export($this->stats->getStats(), true)); + $this->logger->info(sprintf('Success Rate = %d%%', $this->stats->getSuccessRate())); + $this->logger->info(var_export($this->stats->getCycleEfficiency(), true)); + $this->logger->info(sprintf('Worker memory growth factor = %d%%', $maxMemGrowthFactor)); + } + + /** + * Runs as many times as it can per X minutes + * + * Strategy defines: + * - what to run and how many + * - what is current and next proc + * - what it needs to make a decision + * + * Strategy can be different, later on we can inject some + * smart strategy that will delegate actual processing to another one + * depending on something + * + * @param int $freeIndex + * + * @return void + */ + protected function executeQueueProcessingStrategy(int $freeIndex): void + { + $queueTransfer = $this->queueProcessingStrategy->getNextQueue(); + if (!$queueTransfer) { + $this->logger->debug('EMPTY: no more queues to process'); + $this->stats->addEmptyCycle()->addSkipCycle(); + + return; + } + + $this->logger->info(sprintf( + 'RUN [%d +1] %s:%s', + $this->runningProcessesCount, + $queueTransfer->getStoreName(), + $queueTransfer->getQueueName(), + )); + + $process = $this->processManager->triggerQueueProcess( + sprintf( + 'APPLICATION_STORE=%s %s %s', + $queueTransfer->getStoreName(), + QueueWorkerConsole::QUEUE_RUNNER_COMMAND, + $queueTransfer->getQueueName(), + ), + sprintf('%s.%s', $queueTransfer->getStoreName(), $queueTransfer->getQueueName()), + ); + + $this->processes[$freeIndex] = $process; + $this->runningProcessesCount++; + + $this->stats->addProcQty('new'); + $this->stats->addQueueQty($queueTransfer->getQueueName()); + $this->stats->addStoreQty($queueTransfer->getStoreName()); + $this->stats->addQueueQty(sprintf('%s:%s', $queueTransfer->getStoreName(), $queueTransfer->getQueueName())); + } + + /** + * Removes finished processes from the processes array + * Returns the first index of the array that is available for new processes + * + * @return int|null + */ + protected function removeFinishedProcesses(): ?int + { + $freeIndex = -1; + $runningProcCount = 0; + + foreach ($this->processes as $idx => $process) { + if (!$process) { + $freeIndex = $freeIndex >= 0 ? $freeIndex : $idx; + + continue; + } + + if ($process->isRunning()) { + $runningProcCount++; + + continue; + } + + unset($this->processes[$idx]); // won't affect foreach + + $freeIndex = $freeIndex >= 0 ? $freeIndex : $idx; + + $this->logger->debug(sprintf('DONE %s', $process->getExitCodeText())); + if ($process->getExitCode() !== 0) { + $this->stats->addProcQty('failed'); + + $this->logger->error(sprintf('> --- FREE: %d MB', $this->sysResManager->getFreeMemory())); + $this->logger->error($process->getCommandLine()); + $this->logger->error('Std output:' . $process->getOutput()); + $this->logger->error('Error output: ' . $process->getErrorOutput()); + $this->logger->error('< ---'); + } + + $this->stats->addErrorQty($process->getExitCodeText()); + } + + if ($this->runningProcessesCount !== $runningProcCount) { + $this->logger->info(sprintf('RUNNING PROC = %d', $runningProcCount)); + } + + // current vs previous + $this->stats->addProcQty('max', (int)max($this->runningProcessesCount, $runningProcCount)); + + $this->runningProcessesCount = $runningProcCount; // current + + return $runningProcCount === $this->processes->count() ? + null : + $freeIndex; + } +} +``` +
+ +### Configuration + +#### Enable/Disable custom Worker In the project the functionality can be activated and deactivated using the following configuration flag: @@ -88,6 +417,70 @@ You can set the flag by setting the following environment variable: QUEUE_ONE_WORKER_ALL_STORES ``` +#### The Pool Size + +```php +$config[QueueConstants::QUEUE_WORKER_MAX_PROCESSES] = (int)getenv('QUEUE_ONE_WORKER_POOL_SIZE') ?? 10; +``` + +Defines how many PHP processes (`queue:task:start QUEUE-NAME`) allowed to run simultaneously within Worker regardless of number of stores or queuues. + + +#### Free Memory Buffer + +```php +$config[QueueConstants::QUEUE_WORKER_FREE_MEMORY_BUFFER] = (int)getenv('QUEUE_WORKER_FREE_MEMORY_BUFFER') ?: 750; +``` + +Defines amount of free memory (in megabytes) which must be available in EC2 instance in order to spawn a new child process for a queue. Measured before spawning each child process. + +- we should always allow system to have spare resources, because each `queue:task:start ...` command can consume different amount of resources, which is not easily predictable, therefore - this buffer must be set with such ideas in mind + + - to accomodate a new process it is going to launch + - to leave a space for sporadic memory consumption change of already running processes + +- when there's not enough memory - Worker will wait (non-blocking, while doing other things like queue scanning, etc) with corresponding logging and statistic accumulation for further CLI report generation (as mentioned in the sections above) + +- we can decide what to do when there was a rare error when the Worker could not detect available memory: either assume it is zero and wait until it can read this info, meaning no processes will be launched during this period of time, or to throw an exception considering this is a critical information for further processing, this behaviour can be configured with the following flag + + +```php +$config[QueueConstants::QUEUE_WORKER_IGNORE_MEM_READ_FAILURE] = false; // default false - meaning there will be exception if Worker can't read system memory info +``` + +#### Other Important Parameters + +```php +$config[QueueConstants::QUEUE_WORKER_MAX_THRESHOLD_SECONDS] = 3600; // default is 60 seconds, 1 minute, it is safe to have it 1h instead +``` + +How much more memory Worker can consume compared to its starting memory consumption, before it is considered critical, this setting is useful to detect a memory leak, if such a thing happens during a period of long running Worker execution. + +In such case Worker will finish it's execution and Jenkins will be responsible for spawning a new instance. + +```php +$config[QueueConstants::QUEUE_WORKER_MEMORY_MAX_GROWTH_FACTOR] = 50; // in percent % +``` + + +# When to use and when not to use it? + +Currently this solution proved to be useful for multi-store setup environments with more than 2 stores operated within single AWS region, although projects with only 2 stores can benefit with this solution as well. + +At the same time it worth mentioning that for single store setup - it doesn't make sense to apply this customisation. Because it won't hurt, but also won't provide any significant benefits in performance, only better logging. + +To summarise + +- this HowTo can be applied to multi-store setup with at least 2 stores within one AWS region to gain such benefits as potential cost reduction from scaling down Jenkins instance or to speed Publish and Synchronise processing instead. + +- it can't help much for single store setups or for multi-store setup where each store is hosted in a different AWS region. + + # Summary The proposed solution was developed was tested in a project environment. It has shown positive results, with significant improvements in data-import processing time. While this solution is suitable for small to medium projects, it has the potential to be applied universally. Code Examples can be found in the attached diff files that show the implementation in a project. + + +{% info_block warningBox "Important Note" %} +While this solution can be used to either save cloud costs because of down-scaling Jenkins instance or speed up background processing, it is not guaranteed, because each project is unique and EC2 ("Jenkins" jobs) instance performance also depends on other jobs like data import and custom plugins which may affect performance significantly. +{% endinfo_block %} From b96bff59466c34b8ce45caa7aada9d31e9880cb9 Mon Sep 17 00:00:00 2001 From: AlexSlawinski Date: Thu, 20 Jul 2023 12:03:41 +0200 Subject: [PATCH 03/10] Apply suggestions from code review --- ...ins-execution-costs-without-refactoring.md | 65 +++++++++---------- 1 file changed, 31 insertions(+), 34 deletions(-) diff --git a/docs/scos/dev/tutorials-and-howtos/howtos/howto-reduce-jenkins-execution-costs-without-refactoring.md b/docs/scos/dev/tutorials-and-howtos/howtos/howto-reduce-jenkins-execution-costs-without-refactoring.md index 9b3dbe6d2a4..f4774fd90aa 100644 --- a/docs/scos/dev/tutorials-and-howtos/howtos/howto-reduce-jenkins-execution-costs-without-refactoring.md +++ b/docs/scos/dev/tutorials-and-howtos/howtos/howto-reduce-jenkins-execution-costs-without-refactoring.md @@ -1,50 +1,48 @@ --- title: "HowTo: Reduce Jenkins execution by up to 80% without P&S and Data importers refactoring" -description: Save Jenkins related costs or speedup background jobs processing by implementing a custom single Worker for all stores. +description: Save Jenkins related costs or speed up background jobs processing by implementing a single custom Worker for all stores. last_updated: Jul 15, 2023 template: howto-guide-template -originalLink: ?? -originalArticleId: ?? redirect_from: --- # The Challenge -Our out-of-the-box (OOTB) system requires a specific command (Worker - `queue:worker:start`) to be continuously running for each store to process queues and ensure propagation of information. In addition to this command, there are other commands such as OMS processing, import, export, etc. When these processes are not functioning or running slowly, there is a delay in data changes being reflected on the frontend, causing dissatisfaction among customers and leading to disruption of business processes. +Our out-of-the-box (OOTB) system requires a specific command (Worker - `queue:worker:start`) to be continuously running for each store to process queues and ensure the propagation of information. In addition to this command, there are other commands such as OMS processing, import, export, and more. When these processes are not functioning or running slowly, there is a delay in data changes being reflected on the frontend, causing dissatisfaction among customers and leading to disruption of business processes. # Explanation -By default, our system has a limit of two Jenkins executors for each environment. This limit is usually not a problem for single-store setups, but it becomes critical when there are multiple stores. Without increasing this limit, processing becomes slow because only two Workers are scanning queues and running tasks at a time, while other Workers for different stores have to wait. Moreover, even when some stores don't have messages to process, we still need to run a Worker just for scanning purposes, which occupies Jenkins executors, CPU time, and memory. +By default, our system has a limit of two Jenkins executors for each environment. This limit is usually not a problem for single-store setups, but it becomes a potentially critical issue when there are multiple stores. Without increasing this limit, processing becomes slow because only two Workers are scanning queues and running tasks at a time, while other Workers for different stores have to wait. On top of this, even when some stores don't have messages to process, we still need to run a Worker just for scanning purposes, which occupies Jenkins executors, CPU time, and memory. -Increasing the number of processes per queue can lead to issues such as Jenkins hanging, crashing, or becoming unresponsive. Although memory consumption and CPU utilisation are not generally high (around 20-30%), there can be spikes in memory consumption due to a random combination of several workers processing heavy messages for multiple stores simultaneously. +Increasing the number of processes per queue can lead to issues such as Jenkins hanging, crashing, or becoming unresponsive. Although memory consumption and CPU utilization are not generally high (around 20-30%), there can be spikes in memory consumption due to a random combination of several workers simultaneously processing heavy messages for multiple stores. -There are two potential solutions to address this problem: application optimisation and better background job orchestration. +There are two potential solutions to address this problem: application optimization and better background job orchestration. # Proposed Solution ![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/dev/tutorials-and-howtos/howtos/howto-reduce-jenkins-execution-cost-without-refactoring/OneWorker-diagram.png) -The solution described here is targeted at small to medium projects but can be improved and applied universally, but it hasn't been tested fully in such conditions yet. +The solution described here is targeted at small to medium projects but can be improved and applied universally. However, it hasn't been fully tested in such conditions yet. The proposed solution is to use one Worker (`queue:worker:start`) for all stores, regardless of the number of stores. Instead of executing these steps for one store within one process and having multiple processes for multiple stores, we can have one process that scans all queues for all stores and spawns child processes the same way as the OOTB solution. However, instead of determining the number of processes based on the presence of a single message, we can analyse the total number of messages in the queue to make an informed decision on how many processes should be launched at any given moment. ## The Process Pool -In computer science, a pool refers to a collection of resources that are kept in memory and ready to use. In this context, we have a fixed-sized pool (fixed-size array) where new processes are only run if there is space available among the other running processes. This approach allows us to have better control over the number of processes launched by the OOTB solution, resulting in more predictable memory consumption. +In computer science, a pool refers to a collection of resources that are kept in memory and ready to use. In this context, we have a fixed-sized pool (fixed-size array) where new processes are only ran if there is space available among the other running processes. This approach allows us to have better control over the number of processes launched by the OOTB solution, resulting in more predictable memory consumption. ![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/dev/tutorials-and-howtos/howtos/howto-reduce-jenkins-execution-cost-without-refactoring/NewWorker+Flow.png) -We define the total number of simultaneously running processes for the entire setup on the EC2 instance level. This makes it easier to manage, as we can monitor the average memory consumption for the process pool. If it's too low, we can increase the pool size, and if it's too high, we can decrease it. Additionally, we check the available memory (RAM) and prevent spawning additional processes if it is too low, ensuring system stability. Execution statistics provide valuable insights for decision-making, including adjusting the pool size or scaling up/down the EC2 instance. +We define the total number of simultaneously running processes for the entire setup on the EC2 instance level. This makes it easier to manage, as we can monitor the average memory consumption for the process pool. If it's too low, we can increase the pool size, and if it's too high, we can decrease it. Additionally, we check the available memory (RAM) and prevent spawning additional processes if it is too low, ensuring system stability. Execution statistics provide valuable insights for decision-making, including adjusting the pool size or scaling the EC2 instance up or down. -The following params exist: +The following parameters exist: - pool size (default 5-10) -- free mem buffer - min amount of RAM (MB) system should have in order to spawn a new child process (default 750mb) +- free memory buffer - minimum amount of RAM (MB) the system should have in order to spawn a new child process (default 750mb) ## Worker Statistics and Logs -With the proposed solution, we gather better statistics to understand the "health" of the worker and make informed decisions. We can track the number of tasks executed per queue/store, distribution of error codes, cycles, and various metrics related to skipping cycles, cooldown, available slots, and memory limitations. These statistics help us monitor performance, identify bottlenecks, and optimize resource allocation. +With the proposed solution, we gather better statistics to understand the health of the worker and make informed decisions. We can track the number of tasks executed per queue/store, the distribution of error codes, cycles, and various metrics related to skipping cycles, cooldown, available slots, and memory limitations. These statistics help us monitor performance, identify bottlenecks, and optimize resource allocation. ![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/dev/tutorials-and-howtos/howtos/howto-reduce-jenkins-execution-cost-without-refactoring/stats-log.png) @@ -58,14 +56,14 @@ In addition to statistics, we also capture the output of children's processes in ## Edge Cases/Limitation -Child processes are killed at the end of each minute, which means those batches that were in progress - will be abandoned and return to the source queue to be processed during the next run. While we didn’t notice any issues with this approach, please note that this is still experimental approach and may or may not improve in future. The recommendation to mitigate this is to use smaller batches to ensure children processes are running within seconds or up to 10s (rough estimate) - to reduce the number of messages that will be retried. +Child processes are killed at the end of each minute, which means those batches that were in progress will be abandoned and will return to the source queue to be processed during the next run. While we didn’t notice any issues with this approach, please note that this is still an experimental approach and may or may not change in the future. The recommendation to mitigate this is to use smaller batches to ensure children processes are running within seconds or up to 10s (rough estimate), to reduce the number of messages that will be retried. ## Implementation -Two ways are possible +There are two methods possible for implementing this: -1. Applying a patch, although it may require conflict resolution, since it is applied on project level and each project may have unique customisations already in place. Please see attached diffs fror an example implementation. [Here's a diff](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/dev/tutorials-and-howtos/howtos/howto-reduce-jenkins-execution-cost-without-refactoring/one-worker.diff). +1. Applying a patch, although it may require conflict resolution, since it is applied on project level and each project may have unique customizations already in place. See attached diffs for an example implementation. [Here's a diff](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/dev/tutorials-and-howtos/howtos/howto-reduce-jenkins-execution-cost-without-refactoring/one-worker.diff). ```bash git apply one-worker.diff @@ -76,14 +74,14 @@ git apply one-worker.diff ### A new Worker implementation -This is a completely custom implementation, which doesn't extend anything and built based on the ideas described above. +This is a completely custom implementation, which doesn't extend anything and is built based on the ideas described above. -Mainly, new implementation provides such features as: +The new implementation provides such features as: - spawns only single process per loop iteration - checks free system memory before each launch - ignores processes limits per queue in favour of one limit of simultaneously running processes (process pool size) -- doesn't wait for child processes to finish, this is not elegant solution, but it works and there are few recommendations how to mitigate potential risks related to that -- it also gathers statistics and processes output for build a summary report at the end of each Worker invokation +- doesn't wait for child processes to finish. This is not elegant solution, but it works and there are few recommendations on how to mitigate potential risks related to that +- it also gathers statistics and processes output for build a summary report at the end of each Worker invocation
src/Pyz/Zed/Queue/Business/Worker/NewWorker.php @@ -405,7 +403,7 @@ class NewWorker implements WorkerInterface #### Enable/Disable custom Worker -In the project the functionality can be activated and deactivated using the following configuration flag: +In the project, the functionality can be activated and deactivated using the following configuration flag: ```php $config[QueueConstants::QUEUE_ONE_WORKER_ALL_STORES] = (bool)getenv('QUEUE_ONE_WORKER_ALL_STORES') ?? false; @@ -432,31 +430,31 @@ Defines how many PHP processes (`queue:task:start QUEUE-NAME`) allowed to run si $config[QueueConstants::QUEUE_WORKER_FREE_MEMORY_BUFFER] = (int)getenv('QUEUE_WORKER_FREE_MEMORY_BUFFER') ?: 750; ``` -Defines amount of free memory (in megabytes) which must be available in EC2 instance in order to spawn a new child process for a queue. Measured before spawning each child process. +Defines the minimum amount of free memory (in megabytes) which must be available in the EC2 instance in order to spawn a new child process for a queue. Measured before spawning each child process. -- we should always allow system to have spare resources, because each `queue:task:start ...` command can consume different amount of resources, which is not easily predictable, therefore - this buffer must be set with such ideas in mind +- The system should always have spare resources, because each `queue:task:start ...` command can consume different amount of resources, which is not easily predictable. Due to this, this buffer must be set with such limitations in mind. - to accomodate a new process it is going to launch - - to leave a space for sporadic memory consumption change of already running processes + - to leave space for any sporadic memory consumption change of already running processes -- when there's not enough memory - Worker will wait (non-blocking, while doing other things like queue scanning, etc) with corresponding logging and statistic accumulation for further CLI report generation (as mentioned in the sections above) +- when there's not enough memory, the Worker will wait (non-blocking, while doing other things like queue scanning, etc) with corresponding logging and statistic accumulation for further CLI report generation (as mentioned in the sections above) -- we can decide what to do when there was a rare error when the Worker could not detect available memory: either assume it is zero and wait until it can read this info, meaning no processes will be launched during this period of time, or to throw an exception considering this is a critical information for further processing, this behaviour can be configured with the following flag +- There are two options for when the Worker cannot detect the available memory: either assume it is zero and wait until it can read this info, meaning no processes will be launched during this period of time, or to throw an exception, considering this is critical information for further processing. This behavior can be configured with the following flag ```php -$config[QueueConstants::QUEUE_WORKER_IGNORE_MEM_READ_FAILURE] = false; // default false - meaning there will be exception if Worker can't read system memory info +$config[QueueConstants::QUEUE_WORKER_IGNORE_MEM_READ_FAILURE] = false; // default false - meaning there will be an exception if the Worker can't read the system memory info ``` #### Other Important Parameters ```php -$config[QueueConstants::QUEUE_WORKER_MAX_THRESHOLD_SECONDS] = 3600; // default is 60 seconds, 1 minute, it is safe to have it 1h instead +$config[QueueConstants::QUEUE_WORKER_MAX_THRESHOLD_SECONDS] = 3600; // default is 60 seconds, 1 minute, it is safe to have it as 1 hour instead ``` -How much more memory Worker can consume compared to its starting memory consumption, before it is considered critical, this setting is useful to detect a memory leak, if such a thing happens during a period of long running Worker execution. +How much more memory Worker can consume compared to its starting memory consumption, before it is considered critical. This setting is useful to detect a memory leak, if such a thing happens during a period of long running Worker execution. -In such case Worker will finish it's execution and Jenkins will be responsible for spawning a new instance. +In this case, the Worker will finish its execution and Jenkins will be responsible for spawning a new instance. ```php $config[QueueConstants::QUEUE_WORKER_MEMORY_MAX_GROWTH_FACTOR] = 50; // in percent % @@ -465,13 +463,12 @@ $config[QueueConstants::QUEUE_WORKER_MEMORY_MAX_GROWTH_FACTOR] = 50; // in perce # When to use and when not to use it? -Currently this solution proved to be useful for multi-store setup environments with more than 2 stores operated within single AWS region, although projects with only 2 stores can benefit with this solution as well. +Currently this solution proved to be useful for multi-store setup environments with more than 2 stores operated within a single AWS region, although projects with only 2 stores can benefit with this solution as well. -At the same time it worth mentioning that for single store setup - it doesn't make sense to apply this customisation. Because it won't hurt, but also won't provide any significant benefits in performance, only better logging. +At the same time it worth mentioning that for single store setup - it doesn't make sense to apply this customization. Although there are no drawbacks, it won't provide any significant benefits in performance, just better logging. -To summarise -- this HowTo can be applied to multi-store setup with at least 2 stores within one AWS region to gain such benefits as potential cost reduction from scaling down Jenkins instance or to speed Publish and Synchronise processing instead. +- In summary, this HowTo can be applied to multi-store setup with at least 2 stores within one AWS region to gain such benefits as potential cost reduction from scaling down a Jenkins instance, or to speed Publish and Synchronize processing instead. - it can't help much for single store setups or for multi-store setup where each store is hosted in a different AWS region. From fec97912068f92d70fea45316df786ccefbb4dfc Mon Sep 17 00:00:00 2001 From: AlexSlawinski Date: Thu, 20 Jul 2023 12:05:57 +0200 Subject: [PATCH 04/10] Update docs/scos/dev/tutorials-and-howtos/howtos/howto-reduce-jenkins-execution-costs-without-refactoring.md --- .../howto-reduce-jenkins-execution-costs-without-refactoring.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/scos/dev/tutorials-and-howtos/howtos/howto-reduce-jenkins-execution-costs-without-refactoring.md b/docs/scos/dev/tutorials-and-howtos/howtos/howto-reduce-jenkins-execution-costs-without-refactoring.md index f4774fd90aa..62bfd5f1783 100644 --- a/docs/scos/dev/tutorials-and-howtos/howtos/howto-reduce-jenkins-execution-costs-without-refactoring.md +++ b/docs/scos/dev/tutorials-and-howtos/howtos/howto-reduce-jenkins-execution-costs-without-refactoring.md @@ -465,7 +465,7 @@ $config[QueueConstants::QUEUE_WORKER_MEMORY_MAX_GROWTH_FACTOR] = 50; // in perce Currently this solution proved to be useful for multi-store setup environments with more than 2 stores operated within a single AWS region, although projects with only 2 stores can benefit with this solution as well. -At the same time it worth mentioning that for single store setup - it doesn't make sense to apply this customization. Although there are no drawbacks, it won't provide any significant benefits in performance, just better logging. +At the same time it worth mentioning that for it does not make sense to apply this customization for a single store setup. Although there are no drawbacks, it won't provide any significant benefits in performance, just better logging. - In summary, this HowTo can be applied to multi-store setup with at least 2 stores within one AWS region to gain such benefits as potential cost reduction from scaling down a Jenkins instance, or to speed Publish and Synchronize processing instead. From de849934787fac3f0096d3746367a13eea971f6e Mon Sep 17 00:00:00 2001 From: Ivan Shakuta Date: Thu, 20 Jul 2023 17:21:12 +0200 Subject: [PATCH 05/10] update docs with more code examples and less details --- ...ins-execution-costs-without-refactoring.md | 528 +++++++++--------- 1 file changed, 272 insertions(+), 256 deletions(-) diff --git a/docs/scos/dev/tutorials-and-howtos/howtos/howto-reduce-jenkins-execution-costs-without-refactoring.md b/docs/scos/dev/tutorials-and-howtos/howtos/howto-reduce-jenkins-execution-costs-without-refactoring.md index 62bfd5f1783..fa1a2a762c0 100644 --- a/docs/scos/dev/tutorials-and-howtos/howtos/howto-reduce-jenkins-execution-costs-without-refactoring.md +++ b/docs/scos/dev/tutorials-and-howtos/howtos/howto-reduce-jenkins-execution-costs-without-refactoring.md @@ -74,153 +74,63 @@ git apply one-worker.diff ### A new Worker implementation -This is a completely custom implementation, which doesn't extend anything and is built based on the ideas described above. +This is a custom implementation, which doesn't extend anything and is built based on the ideas described above. The new implementation provides such features as: - spawns only single process per loop iteration - checks free system memory before each launch - ignores processes limits per queue in favour of one limit of simultaneously running processes (process pool size) - doesn't wait for child processes to finish. This is not elegant solution, but it works and there are few recommendations on how to mitigate potential risks related to that -- it also gathers statistics and processes output for build a summary report at the end of each Worker invocation +- it also gathers statistics and processes output for build a summary report at the end of each Worker invocation (check the patch for details) + +The main components of the solution are + +- NewWorker custom worker implementation +- SystemResourcesManager - a class to provide system and worker's own memory information +- Strategy - several implementations possible, a class decides which queue will be next for processing, depending on any custom logic, we have implemented two + - `\Pyz\Zed\Queue\Business\Strategy\OrderedQueuesStrategy` strategy which processes queues in the order these were defined in `\Pyz\Zed\Queue\QueueDependencyProvider::getProcessorMessagePlugins`, + - `\Pyz\Zed\Queue\Business\Strategy\BiggestFirstStrategy` - processes those queues which have the biggest amount of messages first +- QueueScanner component - scannes queues to get such information as amount of messages to provide this info to a Strategy +- custom RabbitMQ client to expose `queue_declare` (https://www.rabbitmq.com/amqp-0-9-1-reference.html#queue.declare) method to the Business layer code, this method returns queue statistics for existing queue and does not change anything in a queue. +- slightly modified `\Spryker\Zed\Queue\Business\Process\ProcessManager` - to store information about a queue in a context of store
src/Pyz/Zed/Queue/Business/Worker/NewWorker.php ```php - - */ - protected array $queueNames; - - /** - * @var \Spryker\Zed\Queue\Business\SignalHandler\SignalDispatcherInterface - */ - protected SignalDispatcherInterface $signalDispatcher; - - /** - * @var \Psr\Log\LoggerInterface - */ - protected LoggerInterface $logger; - - /** - * @var \Pyz\Zed\Queue\Business\Strategy\QueueProcessingStrategyInterface - */ - protected QueueProcessingStrategyInterface $queueProcessingStrategy; - + // ... /** * @var \SplFixedArray<\Symfony\Component\Process\Process> */ protected SplFixedArray $processes; + // ... - /** - * @var int - */ - private int $runningProcessesCount = 0; - - /** - * @var \Pyz\Zed\Queue\Business\Worker\WorkerStats - */ - private WorkerStats $stats; - - /** - * @var \Pyz\Zed\Queue\Business\SystemResources\SystemResourcesManagerInterface - */ - private SystemResourcesManagerInterface $sysResManager; - - /** - * @var array - */ - private array $timers = []; - - public function __construct( - ProcessManagerInterface $processManager, - QueueConfig $queueConfig, - QueueClientInterface $queueClient, - array $queueNames, - QueueProcessingStrategyInterface $queueProcessingStrategy, - SignalDispatcherInterface $signalDispatcher, - SystemResourcesManagerInterface $sysResManager, - LoggerInterface $logger - ) { - $this->processManager = $processManager; - $this->queueConfig = $queueConfig; - $this->queueClient = $queueClient; - $this->queueNames = $queueNames; - $this->queueProcessingStrategy = $queueProcessingStrategy; - $this->signalDispatcher = $signalDispatcher; - $this->signalDispatcher->dispatch($this->queueConfig->getSignalsForGracefulWorkerShutdown()); - $this->sysResManager = $sysResManager; - $this->logger = $logger; - - $this->processes = new SplFixedArray($this->queueConfig->getQueueWorkerMaxProcesses()); - $this->stats = new WorkerStats(); - } - - /** - * @param string $timerName - * @param string $message - * @param string $level - * @param int $intervalSec - * - * @return void - */ - protected function logNotOftenThan(string $timerName, string $message, string $level = 'debug', int $intervalSec = 1): void + public function __construct(...) { - if (microtime(true) - ($this->timers[$timerName] ?? 0) >= $intervalSec) { - $this->timers[$timerName] = microtime(true); - $this->logger->$level($message); - } + // ... + // can be configured in config and/or using environment variable QUEUE_ONE_WORKER_POOL_SIZE, + // average recommended values are 5-10 + // defines how many PHP processes (`queue:task:start QUEUE-NAME`) allowed to run simultaneously + // within NewWorker regardless of number of stores or queuues + $this->processes = new SplFixedArray($this->queueConfig->getQueueWorkerMaxProcesses()); } - /** - * @param string $command - * @param array $options - * - * @return void - */ public function start(string $command, array $options = []): void { + // env var - QUEUE_WORKER_MAX_THRESHOLD_SECONDS + // default is 60 seconds, 1 minute, it is safe to have it as 1 hour instead $maxThreshold = $this->queueConfig->getQueueWorkerMaxThreshold(); + + // minimum interval after starting one process before executing another + // config - QUEUE_WORKER_INTERVAL_MILLISECONDS, default is 1000 - 1s, recommended value = 100, 0.1s $delayIntervalMilliseconds = $this->queueConfig->getQueueWorkerInterval(); + + // when false - there will be an exception thrown if the Worker can't read the system memory info + // otherwise - memory info will be returned as 0, so the system will continue to work, but not launching processes + // because it'll think there is no memory available + // QUEUE_WORKER_IGNORE_MEM_READ_FAILURE, default = false $shouldIgnoreZeroMemory = $this->queueConfig->shouldIgnoreNotDetectedFreeMemory(); $startTime = microtime(true); @@ -228,51 +138,30 @@ class NewWorker implements WorkerInterface $maxMemGrowthFactor = 0; while (microtime(true) - $startTime < $maxThreshold) { - $this->stats->addCycle(); - - if (!$this->sysResManager->enoughResources($shouldIgnoreZeroMemory)) { - $this->logNotOftenThan('no-mem', 'NO MEMORY'); - $this->stats->addNoMemCycle()->addSkipCycle(); - + if (!$this->sysResManager->isEnoughResources($shouldIgnoreZeroMemory)) { + // optional logging here continue; } $freeIndex = $this->removeFinishedProcesses(); if ($freeIndex === null) { - $this->logNotOftenThan( - 'no-proc', - sprintf('BUSY: no free slots available for a new process, waiting'), - ); - - $this->stats - ->addNoSlotCycle() - ->addSkipCycle(); + // any optional logging here for the case when there are no slots available } elseif ((microtime(true) - $lastStart) * 1000 > $delayIntervalMilliseconds) { $lastStart = microtime(true); $this->executeQueueProcessingStrategy($freeIndex); } else { - $this->stats - ->addCooldownCycle() - ->addSkipCycle(); + // any optional logging for cooldown period } - $this->logNotOftenThan( - 'time-mem', - sprintf('TIME: %0.2f sec' . "\n", microtime(true) - $startTime) . - sprintf('FREE MEM = %d MB', $this->sysResManager->getFreeMemory()), - 'info', - ); - $ownMemGrowthFactor = $this->sysResManager->getOwnPeakMemoryGrowth(); $maxMemGrowthFactor = max($ownMemGrowthFactor, $maxMemGrowthFactor); - $this->logNotOftenThan( - 'own-mem', - sprintf('OWN MEM: GROWTH FACTOR = %d%%', $ownMemGrowthFactor), - 'info', - ); + + // QUEUE_WORKER_MEMORY_MAX_GROWTH_FACTOR, 50 by default + // measures how much Worker own memory consumption increased after first iteration + // when more than 50% - it is considered a memory leak and Worker will finish its operation + // allowing Jenkins to run Worker again if ($ownMemGrowthFactor > $this->queueConfig->maxAllowedWorkerMemoryGrowthFactor()) { $this->logger->emergency(sprintf('Worker memory grew more than %d%%, probably a memory leak, exiting', $ownMemGrowthFactor)); - break; } } @@ -281,24 +170,50 @@ class NewWorker implements WorkerInterface $this->removeFinishedProcesses(); $this->processManager->flushIdleProcesses(); - $this->logger->info('DONE'); - $this->logger->info(var_export($this->stats->getStats(), true)); - $this->logger->info(sprintf('Success Rate = %d%%', $this->stats->getSuccessRate())); - $this->logger->info(var_export($this->stats->getCycleEfficiency(), true)); - $this->logger->info(sprintf('Worker memory growth factor = %d%%', $maxMemGrowthFactor)); + // here you can have any summary logging/stats, similar as we have in the patch } + // ... + /** - * Runs as many times as it can per X minutes + * Removes finished processes from the processes fixed array + * Returns the first index of the array that is available for new processes * - * Strategy defines: - * - what to run and how many - * - what is current and next proc - * - what it needs to make a decision + * @return int|null + */ + protected function removeFinishedProcesses(): ?int + { + $freeIndex = -1; + $runningProcCount = 0; + + foreach ($this->processes as $idx => $process) { + if (!$process) { + $freeIndex = $freeIndex >= 0 ? $freeIndex : $idx; + continue; + } + + if ($process->isRunning()) { + $runningProcCount++; + continue; + } + + unset($this->processes[$idx]); // won't affect foreach + $freeIndex = $freeIndex >= 0 ? $freeIndex : $idx; + + // any custom logging here + } + + return $runningProcCount === $this->processes->count() ? null : $freeIndex; + } + + // ... + + /** + * Strategy defines which queue to return for processing, + * it can have any other custom dependencies to make a decision. * - * Strategy can be different, later on we can inject some - * smart strategy that will delegate actual processing to another one - * depending on something + * Strategy can be different, we can inject some smart strategy + * which will delegate actual processing to another one depending on something, e.g. store operation times or time zones, etc. * * @param int $freeIndex * @@ -308,19 +223,10 @@ class NewWorker implements WorkerInterface { $queueTransfer = $this->queueProcessingStrategy->getNextQueue(); if (!$queueTransfer) { - $this->logger->debug('EMPTY: no more queues to process'); - $this->stats->addEmptyCycle()->addSkipCycle(); - + // logging return; } - $this->logger->info(sprintf( - 'RUN [%d +1] %s:%s', - $this->runningProcessesCount, - $queueTransfer->getStoreName(), - $queueTransfer->getQueueName(), - )); - $process = $this->processManager->triggerQueueProcess( sprintf( 'APPLICATION_STORE=%s %s %s', @@ -332,133 +238,244 @@ class NewWorker implements WorkerInterface ); $this->processes[$freeIndex] = $process; - $this->runningProcessesCount++; - - $this->stats->addProcQty('new'); - $this->stats->addQueueQty($queueTransfer->getQueueName()); - $this->stats->addStoreQty($queueTransfer->getStoreName()); - $this->stats->addQueueQty(sprintf('%s:%s', $queueTransfer->getStoreName(), $queueTransfer->getQueueName())); } - /** - * Removes finished processes from the processes array - * Returns the first index of the array that is available for new processes - * - * @return int|null - */ - protected function removeFinishedProcesses(): ?int - { - $freeIndex = -1; - $runningProcCount = 0; + // ... +``` +
- foreach ($this->processes as $idx => $process) { - if (!$process) { - $freeIndex = $freeIndex >= 0 ? $freeIndex : $idx; +### System Resource Manager - continue; - } +Available free system memory measured before spawning each child process. +The system should always have spare resources, because each `queue:task:start ...` command can consume different amount of resources, which is not easily predictable. +Because of this, this buffer must be set with such limitations in mind. + +- to accomodate a new process it is going to launch +- to leave space for any sporadic memory consumption change of already running processes - if ($process->isRunning()) { - $runningProcCount++; +
+src/Pyz/Zed/Queue/Business/SystemResources/SystemResourcesManager.php - continue; - } +```php +class SystemResourcesManager implements SystemResourcesManagerInterface +{ + // ... - unset($this->processes[$idx]); // won't affect foreach + /** + * Executed frequently in a loop within X minutes + * We have a choice on what to do in case we failed to determine free memory (e.g. 0) + * A. consider we have NO free memory, so no processes will run + * B. consider it as a critical issue and throw an error + * ... + */ + public function enoughResources(bool $shouldIgnore = false): bool + { + $freeMemory = $this->getFreeMemory(); + if ($freeMemory === 0 && !$shouldIgnore) { + throw new RuntimeException('Could not detect free memory and configured not to ignore that.'); + } - $freeIndex = $freeIndex >= 0 ? $freeIndex : $idx; + // can be configured from config and/or environment variable - QUEUE_WORKER_FREE_MEMORY_BUFFER, in megabytes + // default recommended value - 750 MB + return $freeMemory > $this->queueConfig->getFreeMemoryBuffer(); + } - $this->logger->debug(sprintf('DONE %s', $process->getExitCodeText())); - if ($process->getExitCode() !== 0) { - $this->stats->addProcQty('failed'); + /** + * Read and parse system memory info + */ + public function getFreeMemory(): int + { + $memory = $this->readSystemMemoryInfo(); + if (!preg_match_all('/(Mem\w+[l|e]):\s+(\d+)/msi', $memory, $matches, PREG_SET_ORDER)) { + return 0; + } - $this->logger->error(sprintf('> --- FREE: %d MB', $this->sysResManager->getFreeMemory())); - $this->logger->error($process->getCommandLine()); - $this->logger->error('Std output:' . $process->getOutput()); - $this->logger->error('Error output: ' . $process->getErrorOutput()); - $this->logger->error('< ---'); - } + $free = round((int)$matches[1][2] ?? 0) / 1024; + $available = round((int)$matches[2][2] ?? 0) / 1024; - $this->stats->addErrorQty($process->getExitCodeText()); - } + return (int)max($free, $available); + } - if ($this->runningProcessesCount !== $runningProcCount) { - $this->logger->info(sprintf('RUNNING PROC = %d', $runningProcCount)); + /** + * By how much own Worker memory consumption increased after first method invocation + * @return int % of initial Worker consumption + */ + public function getOwnPeakMemoryGrowth(): int + { + if (!$this->ownInitialMemoryConsumption) { + $this->ownInitialMemoryConsumption = memory_get_peak_usage(true); } - // current vs previous - $this->stats->addProcQty('max', (int)max($this->runningProcessesCount, $runningProcCount)); + $diffNow = memory_get_peak_usage(true) - $this->ownInitialMemoryConsumption; - $this->runningProcessesCount = $runningProcCount; // current + return $diffNow <= 0 ? 0 : (int)round(100 * $diffNow / $this->ownInitialMemoryConsumption); + } - return $runningProcCount === $this->processes->count() ? - null : - $freeIndex; + /** + * @return string + */ + private function readSystemMemoryInfo(): string + { + // + $memoryReadProcessTimeout = $this->queueConfig->memoryReadProcessTimeout(); + $memory = @file_get_contents('/proc/meminfo') ?? ''; + + return $memory ?? 0; } -} ```
-### Configuration +### QueueScanner -#### Enable/Disable custom Worker +This component is responsible for reading information about queues, mainly - amount of messages. -In the project, the functionality can be activated and deactivated using the following configuration flag: +
+src/Pyz/Zed/Queue/Business/QueueScanner.php ```php -$config[QueueConstants::QUEUE_ONE_WORKER_ALL_STORES] = (bool)getenv('QUEUE_ONE_WORKER_ALL_STORES') ?? false; -``` +class QueueScanner implements QueueScannerInterface +{ + // ... + + public function scanQueues(array $storeTransfers = [], int $emptyScanCooldownSeconds = 5): ArrayObject + { + if (!static::$storeTransfers) { + static::$storeTransfers = $this->storeFacade->getAllStores(); + } + $storeTransfers = $storeTransfers ?: static::$storeTransfers; -You can set the flag by setting the following environment variable: + $sinceLastScan = microtime(true) - $this->lastScanAt; + $lastEmptyScanTimeoutPassed = $this->lastScanWasEmpty && ($sinceLastScan > $emptyScanCooldownSeconds); -``` -QUEUE_ONE_WORKER_ALL_STORES -``` + if (!$this->lastScanWasEmpty || $lastEmptyScanTimeoutPassed) { + $queueList = $this->directScanQueues($storeTransfers); -#### The Pool Size + $this->lastScanAt = microtime(true); + $this->lastScanWasEmpty = $queueList->count() === 0; -```php -$config[QueueConstants::QUEUE_WORKER_MAX_PROCESSES] = (int)getenv('QUEUE_ONE_WORKER_POOL_SIZE') ?? 10; -``` + return $queueList; + } -Defines how many PHP processes (`queue:task:start QUEUE-NAME`) allowed to run simultaneously within Worker regardless of number of stores or queuues. + return new ArrayObject(); + } + /** + * @param array<\Generated\Shared\Transfer\StoreTransfer> $storeTransfers + * + * @return \ArrayObject<\Generated\Shared\Transfer\QueueTransfer> + */ + protected function directScanQueues(array $storeTransfers): ArrayObject + { + // ... + $queuesPerStore = new ArrayObject(); + foreach ($storeTransfers as $storeTransfer) { + foreach ($this->queueNames as $queueName) { + + $queueMessageCount = $this->mqClient->getQueueMetrics( + $queueName, + $storeTransfer->getName(), + )['messageCount'] ?? 0; + + if ($queueMessageCount === 0) { + continue; + } + + $queuesPerStore->append((new QueueTransfer()) + ->setQueueName($queueName) + ->setStoreName($storeTransfer->getName()) + ->setMsgCount($queueMessageCount) + ->setMsgToChunkSizeRatio(1), // default value + ); -#### Free Memory Buffer + // ... + } + } -```php -$config[QueueConstants::QUEUE_WORKER_FREE_MEMORY_BUFFER] = (int)getenv('QUEUE_WORKER_FREE_MEMORY_BUFFER') ?: 750; + return $queuesPerStore; + } + + // ... ``` +
-Defines the minimum amount of free memory (in megabytes) which must be available in the EC2 instance in order to spawn a new child process for a queue. Measured before spawning each child process. +### Customised Process Manager -- The system should always have spare resources, because each `queue:task:start ...` command can consume different amount of resources, which is not easily predictable. Due to this, this buffer must be set with such limitations in mind. - - - to accomodate a new process it is going to launch - - to leave space for any sporadic memory consumption change of already running processes +The idea here is simple - just to add store code as a prefix to a queue name, and without additional code modifications - it'll work with all queues/stores combinations correctly within one Worker. -- when there's not enough memory, the Worker will wait (non-blocking, while doing other things like queue scanning, etc) with corresponding logging and statistic accumulation for further CLI report generation (as mentioned in the sections above) +
+src/Pyz/Zed/Queue/Business/Process/ProcessManager.php -- There are two options for when the Worker cannot detect the available memory: either assume it is zero and wait until it can read this info, meaning no processes will be launched during this period of time, or to throw an exception, considering this is critical information for further processing. This behavior can be configured with the following flag +```php +class ProcessManager extends SprykerProcessManager implements ProcessManagerInterface +{ + public function triggerQueueProcessForStore(string $storeCode, string $command, string $queue): Process + { + return $this->triggerQueueProcess($command, $this->getStoreBasedQueueName($storeCode, $queue)); + } + public function getBusyProcessNumberForStore(string $storeCode, string $queueName): int + { + return $this->getBusyProcessNumber($this->getStoreBasedQueueName($storeCode, $queueName)); + } -```php -$config[QueueConstants::QUEUE_WORKER_IGNORE_MEM_READ_FAILURE] = false; // default false - meaning there will be an exception if the Worker can't read the system memory info + protected function getStoreBasedQueueName(string $storeCode, string $queueName): string + { + return sprintf('%s.%s', $storeCode, $queueName); + } +} ``` +
-#### Other Important Parameters +### Simple Ordered Strategy -```php -$config[QueueConstants::QUEUE_WORKER_MAX_THRESHOLD_SECONDS] = 3600; // default is 60 seconds, 1 minute, it is safe to have it as 1 hour instead -``` +And really simple, yet useful - a simple ordered strategy to define any logic to return a next queue to process. It uses a custom `\Pyz\Zed\Queue\Business\Strategy\CountBasedIterator` which provides some additional optional sorting/repeating benefits for more complex strategies, but without additional configuration - works as a simple [ArrayIterator](https://www.php.net/manual/en/class.arrayiterator.php). -How much more memory Worker can consume compared to its starting memory consumption, before it is considered critical. This setting is useful to detect a memory leak, if such a thing happens during a period of long running Worker execution. +To discover alternative use-cases for a Strategy component, feel free to investigate previously mentioned `\Pyz\Zed\Queue\Business\Strategy\BiggestFirstStrategy` which you can find in the patch attached. -In this case, the Worker will finish its execution and Jenkins will be responsible for spawning a new instance. +
+src/Pyz/Zed/Queue/Business/Strategy/OrderedQueuesStrategy.php ```php -$config[QueueConstants::QUEUE_WORKER_MEMORY_MAX_GROWTH_FACTOR] = 50; // in percent % +class OrderedQueuesStrategy implements QueueProcessingStrategyInterface +{ + // ... + + /** + * @param \Pyz\Zed\Queue\Business\QueueScannerInterface $queueScanner + * @param \Psr\Log\LoggerInterface $logger + */ + public function __construct(QueueScannerInterface $queueScanner, LoggerInterface $logger) + { + $this->queueScanner = $queueScanner; + $this->currentIterator = new CountBasedIterator(new ArrayIterator()); + } + + /** + * @return \Generated\Shared\Transfer\QueueTransfer|null + */ + public function getNextQueue(): ?QueueTransfer + { + if (!$this->currentIterator->valid()) { + $queuesPerStore = $this->getQueuesWithMessages(); + $this->currentIterator = new CountBasedIterator($queuesPerStore->getIterator()); + } + + /** @var \Generated\Shared\Transfer\QueueTransfer|null $queueTransfer */ + $queueTransfer = $this->currentIterator->current(); + $this->currentIterator->next(); + + return $queueTransfer; + } + + /** + * @return \ArrayObject + */ + protected function getQueuesWithMessages(): ArrayObject + { + return $this->queueScanner->scanQueues(); + } ``` +
# When to use and when not to use it? @@ -467,7 +484,6 @@ Currently this solution proved to be useful for multi-store setup environments w At the same time it worth mentioning that for it does not make sense to apply this customization for a single store setup. Although there are no drawbacks, it won't provide any significant benefits in performance, just better logging. - - In summary, this HowTo can be applied to multi-store setup with at least 2 stores within one AWS region to gain such benefits as potential cost reduction from scaling down a Jenkins instance, or to speed Publish and Synchronize processing instead. - it can't help much for single store setups or for multi-store setup where each store is hosted in a different AWS region. From b7297498ced514d77af48778daa5100538a06314 Mon Sep 17 00:00:00 2001 From: Ivan Shakuta Date: Fri, 21 Jul 2023 12:07:43 +0200 Subject: [PATCH 06/10] add link to sidebar (howtos section), typos fix --- _data/sidebars/scos_dev_sidebar.yml | 2 ++ ...-reduce-jenkins-execution-costs-without-refactoring.md | 8 +++----- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/_data/sidebars/scos_dev_sidebar.yml b/_data/sidebars/scos_dev_sidebar.yml index b123d92decd..1cce9088a4e 100644 --- a/_data/sidebars/scos_dev_sidebar.yml +++ b/_data/sidebars/scos_dev_sidebar.yml @@ -3819,6 +3819,8 @@ entries: url: /docs/scos/dev/tutorials-and-howtos/howtos/howto-allow-zed-css-js-on-a-project-for-oryx-for-zed-2.12.0-and-earlier.html - title: "HowTo: Allow Zed SCSS/JS on a project level for `oryx-for-zed` version 2.13.0 and later" url: /docs/scos/dev/tutorials-and-howtos/howtos/howto-allow-zed-css-js-on-a-project-for-oryx-for-zed-2.13.0-and-later.html + - title: "HowTo: Reduce Jenkins execution by up to 80% without P&S and Data importers refactoring" + url: /docs/scos/dev/tutorials-and-howtos/howtos/howto-reduce-jenkins-execution-by-up-to-80-percent-without-ps-and-data-import-refactoring.html - title: Technology partner guides url: /docs/scos/dev/technology-partner-guides/technology-partner-guides.html include_versions: diff --git a/docs/scos/dev/tutorials-and-howtos/howtos/howto-reduce-jenkins-execution-costs-without-refactoring.md b/docs/scos/dev/tutorials-and-howtos/howtos/howto-reduce-jenkins-execution-costs-without-refactoring.md index fa1a2a762c0..9877c99bda0 100644 --- a/docs/scos/dev/tutorials-and-howtos/howtos/howto-reduce-jenkins-execution-costs-without-refactoring.md +++ b/docs/scos/dev/tutorials-and-howtos/howtos/howto-reduce-jenkins-execution-costs-without-refactoring.md @@ -113,7 +113,7 @@ class NewWorker implements WorkerInterface // can be configured in config and/or using environment variable QUEUE_ONE_WORKER_POOL_SIZE, // average recommended values are 5-10 // defines how many PHP processes (`queue:task:start QUEUE-NAME`) allowed to run simultaneously - // within NewWorker regardless of number of stores or queuues + // within NewWorker regardless of number of stores or queues $this->processes = new SplFixedArray($this->queueConfig->getQueueWorkerMaxProcesses()); } @@ -328,6 +328,7 @@ class SystemResourcesManager implements SystemResourcesManagerInterface ### QueueScanner This component is responsible for reading information about queues, mainly - amount of messages. +Key feature here - is cooldown period of default 5 seconds, it means that if all queues are empty, it won't re-scan those right await but will wait (non blocking) until cooldown timeout passes. Obviously it'll add up to 5s delay when new messages appear, but it won't be noticable, and as soon as there are always some messages present - the cooldown timeout is not applied.
src/Pyz/Zed/Queue/Business/QueueScanner.php @@ -339,10 +340,7 @@ class QueueScanner implements QueueScannerInterface public function scanQueues(array $storeTransfers = [], int $emptyScanCooldownSeconds = 5): ArrayObject { - if (!static::$storeTransfers) { - static::$storeTransfers = $this->storeFacade->getAllStores(); - } - $storeTransfers = $storeTransfers ?: static::$storeTransfers; + // ... $sinceLastScan = microtime(true) - $this->lastScanAt; $lastEmptyScanTimeoutPassed = $this->lastScanWasEmpty && ($sinceLastScan > $emptyScanCooldownSeconds); From ce1be11191fef74b5b169a63d2c384b1f8e6cdb5 Mon Sep 17 00:00:00 2001 From: AlexSlawinski Date: Thu, 27 Jul 2023 04:37:20 +0200 Subject: [PATCH 07/10] Revert "Sidebar fix" This reverts commit 44b23b1b73eca2e88b0a36b7bcb3a54aad34b1ae, reversing changes made to b7297498ced514d77af48778daa5100538a06314. --- Rakefile | 15 +- _config.yml | 6 +- _data/sidebars/cloud_dev_sidebar.yml | 5 - _data/sidebars/marketplace_dev_sidebar.yml | 119 +++- _data/sidebars/pbc_all_sidebar.yml | 648 +++++++++--------- _data/sidebars/scos_dev_sidebar.yml | 170 +---- _data/sidebars/scos_user_sidebar.yml | 2 + .../install-the-checkout-glue-api.md | 6 +- .../install-the-order-management-glue-api.md | 2 +- .../install-the-payments-glue-api.md | 2 +- .../install-the-shared-carts-glue-api.md | 2 +- .../install-the-shopping-lists-glue-api.md | 2 +- ...l-the-marketplace-dummy-payment-feature.md | 9 +- ...the-product-rating-and-reviews-glue-api.md | 614 ----------------- .../install-the-gift-cards-feature.md | 2 +- ...nstall-the-inventory-management-feature.md | 20 +- ...management-inventory-management-feature.md | 8 +- .../install-the-picker-user-login-feature.md | 4 +- ...he-product-offer-service-points-feature.md | 2 +- ...tall-the-product-offer-shipment-feature.md | 6 +- .../install-the-push-notification-feature.md | 2 +- .../install-the-service-points-feature.md | 0 .../install-the-shipment-feature.md | 263 +------ ...all-the-shipment-service-points-feature.md | 4 +- ...ffice-warehouse-user-management-feature.md | 2 +- .../install-the-spryker-core-feature.md | 5 - .../install-the-warehouse-picking-feature.md | 14 +- ...se-picking-inventory-management-feature.md | 6 +- ...ehouse-picking-order-management-feature.md | 6 +- ...l-the-warehouse-picking-product-feature.md | 4 +- ...-the-warehouse-picking-shipment-feature.md | 2 +- ...icking-spryker-core-back-office-feature.md | 6 +- ...l-the-warehouse-user-management-feature.md | 8 +- ...ce-product-offer-service-points-feature.md | 2 +- _internal/faq-migration-to-opensearch.md | 128 ---- _scripts/sidebar_checker/sidebar_checker.sh | 2 +- algolia_config/_cloud_dev.yml | 2 +- algolia_config/_sdk_dev.yml | 2 +- .../app-composition-platform-installation.md | 66 +- docs/acp/user/app-manifest.md | 2 +- docs/acp/user/developing-an-app.md | 2 +- .../best-practices/best-practices.md | 1 - .../best-practises-jenkins-stability.md | 26 - ...ormance-testing-in-staging-enivronments.md | 591 +--------------- .../data-import/202108.0/marketplace-setup.md | 2 +- .../file-details-merchant-stock.csv.md | 2 +- .../file-details-product-offer-stock.csv.md | 2 +- .../data-import/202204.0/marketplace-setup.md | 2 +- .../dev/data-import/202212.0/data-import.md | 10 + .../file-details-merchant-store.csv.md | 44 ++ .../202212.0/marketplace-setup.md} | 8 +- .../202212.0/feature-integration-guides.md | 8 + ...place-dummy-payment-feature-integration.md | 8 + ...place-product-cart-feature-integration.md} | 4 +- ...account-management-feature-integration.md} | 2 +- .../merchant-switcher-feature-integration.md} | 2 +- ...-switcher-wishlist-feature-integration.md} | 2 +- ...product-management-feature-walkthrough.md} | 13 +- .../dev/front-end/202212.0/web-components.md | 2 +- .../resolving-search-engine-friendly-urls.md | 2 +- ...ing-autocomplete-and-search-suggestions.md | 4 +- .../how-to-add-new-guitable-column-type.md} | 4 +- ...-a-new-angular-module-with-application.md} | 4 +- .../how-to-split-products-by-stores.md} | 4 +- ...pgrade-spryker-instance-to-marketplace.md} | 17 +- docs/marketplace/dev/howtos/howtos.md | 10 + .../marketplace-supported-browsers.md | 14 + docs/marketplace/dev/setup/202212.0/setup.md | 10 + .../dev/setup/202212.0/system-requirements.md | 26 + .../dev/setup/202304.0/system-requirements.md | 28 + ...migration-guide-upgrade-to-angular-v12.md} | 11 +- .../202212.0/technical-enhancement.md | 9 + ...migration-guide-upgrade-to-angular-v15.md} | 34 +- ...omotions-and-discounts-feature-overview.md | 13 +- ...e-inventory-management-feature-overview.md | 2 +- ...omotions-and-discounts-feature-overview.md | 38 +- .../logging-in-to-the-merchant-portal.md | 11 +- ...fice-warehouse-user-management-feature.md} | 1 - .../retrieve-shipments-in-orders.md | 2 +- ...tails-shipment-method-shipment-type.csv.md | 2 - .../file-details-shipment-type-store.csv.md | 2 - .../file-details-shipment-type.csv.md | 2 - .../install-the-shipment-feature.md | 2 +- ...all-the-shipment-service-points-feature.md | 10 - .../check-out/update-payment-data.md | 4 +- .../manage-carts-of-registered-users.md | 2 +- ...nage-items-in-carts-of-registered-users.md | 2 +- .../manage-guest-cart-items.md | 2 +- .../manage-guest-carts/manage-guest-carts.md | 2 +- .../retrieve-customer-carts.md | 2 +- .../upgrade-the-checkoutrestapi-module.md | 2 +- .../check-out/update-payment-data.md | 4 +- .../manage-carts-of-registered-users.md | 2 +- ...nage-items-in-carts-of-registered-users.md | 2 +- .../manage-guest-cart-items.md | 2 +- .../manage-guest-carts/manage-guest-carts.md | 2 +- .../retrieve-customer-carts.md | 2 +- ...ll-the-cart-marketplace-product-feature.md | 8 - .../manage-carts-of-registered-users.md | 2 +- ...nage-items-in-carts-of-registered-users.md | 2 +- .../guest-carts/manage-guest-cart-items.md | 2 +- .../guest-carts/manage-guest-carts.md | 2 +- .../import-content-management-system-data.md | 2 +- ...eve-abstract-product-list-content-items.md | 2 +- .../retrieve-banner-content-items.md | 2 +- .../retrieve-navigation-trees.md | 2 +- .../password-management-overview.md | 2 +- ...ue-api-retrieve-business-unit-addresses.md | 2 +- .../glue-api-retrieve-business-units.md | 2 +- .../glue-api-retrieve-companies.md | 2 +- .../glue-api-retrieve-company-roles.md | 2 +- .../glue-api-retrieve-company-users.md | 2 +- .../glue-api-search-by-company-users.md | 2 +- .../glue-api-manage-customer-addresses.md | 2 +- .../customers/glue-api-manage-customers.md | 2 +- .../glue-api-retrieve-customer-orders.md | 2 +- ...-discounts-to-carts-of-registered-users.md | 2 +- ...add-items-with-discounts-to-guest-carts.md | 2 +- ...t-vouchers-in-carts-of-registered-users.md | 2 +- ...manage-discount-vouchers-in-guest-carts.md | 2 +- ...-discounts-in-carts-of-registered-users.md | 2 +- .../retrieve-discounts-in-customer-carts.md | 2 +- .../retrieve-discounts-in-guest-carts.md | 2 +- ...-discounts-to-carts-of-registered-users.md | 2 +- ...add-items-with-discounts-to-guest-carts.md | 2 +- ...t-vouchers-in-carts-of-registered-users.md | 2 +- ...manage-discount-vouchers-in-guest-carts.md | 2 +- ...-discounts-in-carts-of-registered-users.md | 2 +- .../retrieve-discounts-in-customer-carts.md | 2 +- .../retrieve-discounts-in-guest-carts.md | 2 +- ...e-promotions-discounts-feature-overview.md | 30 +- .../manage-gift-cards-of-guest-users.md | 2 +- .../manage-gift-cards-of-registered-users.md | 2 +- ...gift-cards-in-carts-of-registered-users.md | 2 +- .../retrieve-gift-cards-in-guest-carts.md | 2 +- .../manage-gift-cards-of-guest-users.md | 2 +- .../manage-gift-cards-of-registered-users.md | 2 +- ...gift-cards-in-carts-of-registered-users.md | 2 +- .../retrieve-gift-cards-in-guest-carts.md | 2 +- .../glue-api-security-and-authentication.md | 4 +- ...glue-api-authenticate-as-a-company-user.md | 2 +- .../glue-api-authenticate-as-a-customer.md | 2 +- ...lue-api-authenticate-as-an-agent-assist.md | 2 +- .../glue-api-confirm-customer-registration.md | 2 +- ...nage-agent-assist-authentication-tokens.md | 2 +- ...nage-company-user-authentication-tokens.md | 2 +- ...mer-authentication-tokens-via-oauth-2.0.md | 2 +- ...i-manage-customer-authentication-tokens.md | 2 +- .../glue-api-manage-customer-passwords.md | 2 +- .../glue-api-retrieve-protected-resources.md | 2 +- .../file-details-merchant-stock.csv.md | 2 +- .../glue-api-retrieve-merchant-addresses.md | 2 +- ...lue-api-retrieve-merchant-opening-hours.md | 2 +- .../glue-api-retrieve-merchants.md | 2 +- .../glue-api-retrieve-store-configuration.md | 2 +- .../glue-api-retrieve-product-offers.md | 2 +- ...ce-product-offer-service-points-feature.md | 8 + ...ce-product-offer-service-points-feature.md | 10 - ...tall-the-product-offer-shipment-feature.md | 10 - .../base-shop/glue-api-retrieve-orders.md | 2 +- .../hydrate-payment-methods-for-an-order.md | 12 +- .../file-details-payment-method-store.csv.md} | 7 +- .../file-details-payment-method.csv.md} | 5 +- ...d-export-payment-service-provider-data.md} | 2 +- .../install-the-payments-feature.md | 9 +- .../install-the-payments-glue-api.md | 9 +- .../upgrade-the-payment-module.md | 17 +- ...-party-payment-providers-using-glue-api.md | 14 +- .../edit-payment-methods.md | 9 +- .../log-into-the-back-office.md | 4 +- .../view-payment-methods.md | 5 +- .../202212.0/payment-service-provider.md | 21 +- ...-feature-domain-model-and-relationships.md | 2 - .../payments-feature-overview.md | 52 +- .../integrate-payment-methods-for-ratepay.md | 12 - .../adyen/adyen.md | 23 +- ...-filtering-of-payment-methods-for-adyen.md | 12 +- .../adyen/install-and-configure-adyen.md | 30 +- .../adyen/integrate-adyen-payment-methods.md | 12 +- .../adyen/integrate-adyen.md | 17 +- .../afterpay/afterpay.md | 11 +- .../install-and-configure-afterpay.md | 3 +- .../afterpay/integrate-afterpay.md | 3 +- .../amazon-pay-sandbox-simulations.md | 15 +- .../amazon-pay/amazon-pay-state-machine.md | 15 +- .../amazon-pay/amazon-pay.md | 23 +- .../amazon-pay/configure-amazon-pay.md | 9 +- .../handling-orders-with-amazon-pay-api.md | 9 +- ...nd-information-about-shipping-addresses.md | 9 +- .../arvato/arvato-risk-check.md | 9 +- .../arvato/arvato-store-order.md | 8 +- .../arvato/arvato.md | 13 +- .../arvato/install-and-configure-arvato.md | 14 +- .../{ => third-party-integrations}/billie.md | 1 - ...invoice-payments-to-a-preauthorize-mode.md | 7 +- .../billpay/billpay.md | 9 +- .../billpay/integrate-billpay.md | 7 +- .../braintree-performing-requests.md | 11 +- .../braintree/braintree-request-workflow.md | 11 +- .../braintree/braintree.md | 21 +- .../install-and-configure-braintree.md | 11 +- .../braintree/integrate-braintree.md | 13 +- .../computop/computop-api-calls.md | 24 +- .../computop/computop-oms-plugins.md | 25 +- .../computop/computop.md | 33 +- .../install-and-configure-computop.md | 21 +- .../computop/integrate-computop.md | 11 +- ...credit-card-payment-method-for-computop.md | 27 +- ...te-the-crif-payment-method-for-computop.md | 25 +- ...irect-debit-payment-method-for-computop.md | 25 +- ...easy-credit-payment-method-for-computop.md | 21 +- ...e-the-ideal-payment-method-for-computop.md | 17 +- ...e-paydirekt-payment-method-for-computop.md | 25 +- ...-the-paynow-payment-method-for-computop.md | 25 +- ...-the-paypal-payment-method-for-computop.md | 25 +- ...-the-sofort-payment-method-for-computop.md | 25 +- .../crefopay/crefopay-callbacks.md | 17 +- .../crefopay-capture-and-refund-processes.md | 15 +- .../crefopay/crefopay-enable-b2b-payments.md | 15 +- .../crefopay/crefopay-notifications.md | 1 - .../crefopay/crefopay-payment-methods.md | 15 +- .../crefopay/crefopay.md | 21 +- .../install-and-configure-crefopay.md | 19 +- .../crefopay/integrate-crefopay.md | 17 +- .../heidelpay/configure-heidelpay.md | 19 +- .../heidelpay/heidelpay-oms-workflow.md | 1 - .../heidelpay-workflow-for-errors.md | 19 +- .../heidelpay/heidelpay.md | 34 +- .../heidelpay/install-heidelpay.md | 19 +- .../heidelpay/integrate-heidelpay.md | 19 +- ...ard-secure-payment-method-for-heidelpay.md | 23 +- ...rect-debit-payment-method-for-heidelpay.md | 21 +- ...asy-credit-payment-method-for-heidelpay.md | 21 +- ...-the-ideal-payment-method-for-heidelpay.md | 23 +- ...ecured-b2c-payment-method-for-heidelpay.md | 21 +- ...-authorize-payment-method-for-heidelpay.md | 23 +- ...ypal-debit-payment-method-for-heidelpay.md | 23 +- ...the-sofort-payment-method-for-heidelpay.md | 23 +- ...arketplace-payment-method-for-heidelpay.md | 21 +- .../klarna/klarna-invoice-pay-in-14-days.md | 15 +- .../klarna/klarna-part-payment-flexible.md | 15 +- .../klarna/klarna-payment-workflow.md | 13 +- ...a-state-machine-commands-and-conditions.md | 13 +- .../klarna/klarna.md | 21 +- .../payment-service-provider-integrations.md | 23 + .../install-and-configure-payolution.md | 11 +- .../payolution/integrate-payolution.md | 17 +- ...stallment-payment-method-for-payolution.md | 15 +- ...e-invoice-payment-method-for-payolution.md | 17 +- .../payolution-performing-requests.md | 15 +- .../payolution/payolution-request-flow.md | 19 +- .../payolution/payolution.md | 17 +- .../disconnect-payone.md | 1 - .../integrate-payone.md | 1 - .../payone-integration-in-the-back-office.md | 6 +- .../manual-integration/integrate-payone.md | 23 +- .../payone-cash-on-delivery.md | 17 +- .../payone-manual-integration.md | 21 +- .../payone-paypal-express-checkout-payment.md | 5 +- .../payone-risk-check-and-address-check.md | 19 +- .../powerpay.md | 1 - ...l-and-configure-ratenkauf-by-easycredit.md | 10 +- .../integrate-ratenkauf-by-easycredit.md | 9 +- .../ratenkauf-by-easycredit.md | 9 +- ...rom-the-backend-application-for-ratepay.md | 5 +- .../integrate-payment-methods-for-ratepay.md | 12 + ...direct-debit-payment-method-for-ratepay.md | 9 +- ...-installment-payment-method-for-ratepay.md | 9 +- ...-the-invoice-payment-method-for-ratepay.md | 8 +- ...e-prepayment-payment-method-for-ratepay.md | 7 +- .../ratepay-core-module-structure-diagram.md | 5 +- .../ratepay/ratepay-facade-methods.md | 7 +- .../ratepay/ratepay-payment-workflow.md | 7 +- ...y-state-machine-commands-and-conditions.md | 9 +- .../ratepay/ratepay-state-machines.md | 2 +- .../ratepay/ratepay.md | 25 +- .../add-unzer-marketplace-credentials.md | 1 - .../add-unzer-standard-credentails.md | 0 ...redit-card-display-in-your-payment-step.md | 3 +- ...ew-payment-methods-on-the-project-level.md | 5 +- .../refund-shipping-costs.md | 1 - ...tand-payment-method-in-checkout-process.md | 1 - .../install-and-configure-unzer.md | 5 +- .../install-unzer/integrate-unzer-glue-api.md | 5 +- .../unzer/install-unzer/integrate-unzer.md | 7 +- .../unzer-domain-model-and-relationships.md | 1 - .../unzer/unzer.md | 2 - .../unzer/whats-changed-in-unzer.md | 41 ++ docs/pbc/all/pbc.md | 2 +- .../retrieve-abstract-product-prices.md | 2 +- .../retrieve-concrete-product-prices.md | 2 +- ...rices-when-retrieving-concrete-products.md | 2 +- .../retrieve-abstract-product-prices.md | 2 +- .../retrieve-concrete-product-prices.md | 2 +- ...rices-when-retrieving-concrete-products.md | 2 +- .../glue-api-retrieve-product-offer-prices.md | 2 +- .../import-product-data-with-a-single-file.md | 2 +- .../import-product-data-with-a-single-file.md | 2 +- ...etrieve-image-sets-of-abstract-products.md | 2 +- .../glue-api-retrieve-category-nodes.md | 2 +- .../glue-api-retrieve-category-trees.md | 2 +- .../glue-api-retrieve-concrete-products.md | 2 +- ...etrieve-image-sets-of-concrete-products.md | 2 +- .../glue-api-retrieve-sales-units.md | 2 +- .../glue-api-retrieve-alternative-products.md | 2 +- .../glue-api-retrieve-bundled-products.md | 2 +- ...-retrieve-configurable-bundle-templates.md | 2 +- .../glue-api-retrieve-measurement-units.md | 2 +- .../glue-api-retrieve-product-attributes.md | 2 +- .../glue-api-retrieve-product-labels.md | 2 +- .../retrieve-abstract-products.md | 2 +- .../retrieve-concrete-products.md | 2 +- ...tal-product-management-feature-overview.md | 16 - ...tplace-product-options-feature-overview.md | 2 +- .../glue-api-retrieve-related-products.md | 2 +- .../install-the-push-notification-feature.md | 10 - .../ratings-and-reviews-data-import.md | 9 - .../manage-product-reviews-using-glue-api.md | 2 +- ...views-when-retrieving-concrete-products.md | 2 +- .../ratings-and-reviews-data-import.md | 9 - .../manage-product-reviews-using-glue-api.md | 2 +- ...views-when-retrieving-concrete-products.md | 2 +- ...the-product-rating-and-reviews-glue-api.md | 29 - .../glue-api-retrieve-return-reasons.md | 2 +- .../search-data-import.md | 12 - ...etails-product-search-attribute-map.csv.md | 2 +- ...le-details-product-search-attribute.csv.md | 2 +- ...eve-autocomplete-and-search-suggestions.md | 4 +- .../glue-api-search-the-product-catalog.md | 2 +- .../search-feature-overview.md | 4 +- .../third-party-integrations/algolia.md | 37 +- .../integrate-algolia.md | 2 +- .../precise-search-by-super-attributes.md | 117 ++++ .../install-the-service-points-feature.md | 10 - .../glue-api-manage-shopping-list-items.md | 2 +- .../glue-api-manage-shopping-lists.md | 2 +- .../glue-api-manage-wishlist-items.md | 2 +- .../glue-api-manage-wishlists.md | 2 +- ...-manage-marketplace-shopping-list-items.md | 2 +- ...e-api-manage-marketplace-shopping-lists.md | 2 +- ...e-api-manage-marketplace-wishlist-items.md | 2 +- .../glue-api-manage-marketplace-wishlists.md | 2 +- ... import-tax-sets-for-abstract-products.md} | 2 +- ...=> import-tax-sets-for-product-options.md} | 2 +- ...> import-tax-sets-for-shipment-methods.md} | 2 +- ...ils-tax-sets.csv.md => import-tax-sets.md} | 0 .../tax-management-data-import.md | 14 - .../retrieve-tax-sets.md | 2 +- .../base-shop/tax-feature-overview.md | 10 +- ... import-tax-sets-for-abstract-products.md} | 7 +- ...=> import-tax-sets-for-product-options.md} | 6 +- ...> import-tax-sets-for-shipment-methods.md} | 6 +- ...ils-tax-sets.csv.md => import-tax-sets.md} | 5 +- .../tax-management-data-import.md | 14 - .../retrieve-tax-sets.md | 2 +- .../base-shop/tax-feature-overview.md | 10 +- ...mpersonate-customers-as-an-agent-assist.md | 2 +- ...-search-by-customers-as-an-agent-assist.md | 2 +- ...warehouse-management-system-data-import.md | 14 - .../file-details-product-stock.csv.md | 3 +- .../file-details-warehouse-address.csv.md | 5 +- .../file-details-warehouse-store.csv.md | 5 +- .../file-details-warehouse.csv.md | 7 +- .../inventory-management-feature-overview.md | 14 +- ...warehouse-management-system-data-import.md | 14 - .../file-details-product-stock.csv.md | 2 +- .../file-details-warehouse-address.csv.md | 4 +- .../file-details-warehouse-store.csv.md | 4 +- .../file-details-warehouse.csv.md | 6 +- .../inventory-management-feature-overview.md | 14 +- .../manage-availability-notifications.md | 2 +- .../retrieve-abstract-product-availability.md | 2 +- ...ility-when-retrieving-concrete-products.md | 2 +- .../retrieve-concrete-product-availability.md | 2 +- ...criptions-to-availability-notifications.md | 2 +- ...api-retrieve-product-offer-availability.md | 2 +- .../file-details-merchant-stock.csv.md | 2 +- .../file-details-product-offer-stock.csv.md | 2 +- ...e-inventory-management-feature-overview.md | 2 +- ...nstall-the-inventory-management-feature.md | 4 +- ...management-inventory-management-feature.md | 8 + ...l-the-warehouse-user-management-feature.md | 8 + ...management-inventory-management-feature.md | 11 - .../install-the-picker-user-login-feature.md | 10 - .../install-the-warehouse-picking-feature.md | 10 - ...se-picking-inventory-management-feature.md | 9 - ...ehouse-picking-order-management-feature.md | 10 - ...l-the-warehouse-picking-product-feature.md | 10 - ...-the-warehouse-picking-shipment-feature.md | 10 - ...icking-spryker-core-back-office-feature.md | 10 - .../dev/architecture/conceptual-overview.md | 2 +- ...e-data-with-publish-and-synchronization.md | 357 ++-------- .../extend-spryker/development-strategies.md | 4 +- .../commerce-setup/commerce-setup.md | 8 +- .../commerce-setup/commerce-setup.md | 12 +- ...on-order-of-data-importers-in-demo-shop.md | 8 +- ...porting-product-data-with-a-single-file.md | 2 +- docs/scos/dev/drafts-dev/roadmap.md | 2 + .../dynamic-data-api-integration.md | 362 ---------- .../install-the-picker-user-login-feature.md | 8 + ...he-product-offer-service-points-feature.md | 2 +- ...tall-the-product-offer-shipment-feature.md | 8 + .../install-the-push-notification-feature.md | 8 + .../install-the-service-points-feature.md | 8 + ...all-the-shipment-service-points-feature.md | 8 + .../install-the-warehouse-picking-feature.md | 8 + ...se-picking-inventory-management-feature.md | 8 + ...ehouse-picking-order-management-feature.md | 8 + ...l-the-warehouse-picking-product-feature.md | 8 + ...-the-warehouse-picking-shipment-feature.md | 8 + ...icking-spryker-core-back-office-feature.md | 8 + ...l-the-warehouse-user-management-feature.md | 8 +- .../spryker-core-feature-integration.md | 2 +- .../202204.0/payments-feature-walkthrough.md | 2 +- ...ide-upgrade-nodejs-to-v18-and-npm-to-v9.md | 4 +- ...-party-payment-providers-using-glue-api.md | 2 +- .../202212.0/decoupled-glue-api.md | 234 ------- .../authentication-and-authorization.md | 1 - ...d-and-storefront-api-module-differences.md | 1 - .../create-glue-api-applications.md | 1 - .../security-and-authentication.md | 0 .../202212.0/glue-api-guides.md | 23 +- .../b2c-api-react-example.md | 2 +- .../document-glue-api-resources.md | 10 +- .../extend-a-rest-api-resource.md | 4 +- ...ement-versioning-for-rest-api-resources.md | 4 +- .../validate-rest-request-format.md | 2 +- .../glue-infrastructure.md | 18 +- .../glue-rest-api.md | 27 +- .../glue-api-guides/202212.0/glue-spryks.md | 4 +- ...t-requests-and-caching-with-entity-tags.md | 11 +- ...ence-information-glueapplication-errors.md | 11 +- .../resolving-search-engine-friendly-urls.md | 9 +- .../rest-api-b2b-reference.md | 10 +- .../rest-api-b2c-reference.md | 9 +- .../how-to-configure-dynamic-data-api.md | 118 ---- ...how-to-send-request-in-dynamic-data-api.md | 473 ------------- ...additional-logic-in-dependency-provider.md | 11 +- .../dead-code-checker.md | 11 +- .../minimum-allowed-shop-version.md | 13 +- .../multidimensional-array.md | 14 +- .../upgradability-guidelines/php-version.md | 33 +- .../plugin-registration-with-restrintions.md | 11 +- .../upgradability-guidelines/security.md | 11 +- .../single-plugin-argument.md | 29 +- .../upgradability-guidelines.md | 9 +- .../project-development-guidelines.md | 2 +- .../dev/guidelines/security-guidelines.md | 88 --- .../install-docker-prerequisites-on-linux.md | 24 +- ...install-in-demo-mode-on-macos-and-linux.md | 21 +- .../install-in-demo-mode-on-windows.md | 42 +- ...-in-development-mode-on-macos-and-linux.md | 21 +- .../install-in-development-mode-on-windows.md | 45 +- .../set-up-spryker-locally.md | 2 - .../202212.0/system-requirements.md | 20 - .../202304.0/system-requirements.md | 19 - .../integrate-multi-database-logic.md | 4 +- .../202212.0/configure-services.md | 2 +- .../the-docker-sdk/202212.0/the-docker-sdk.md | 2 +- .../howtos/about-howtos.md | 2 +- .../howtos/glue-api-howtos/glue-api-howtos.md | 4 +- .../push-notification-feature-overview.md | 5 +- docs/scos/user/intro-to-spryker/b2b-suite.md | 2 +- docs/scos/user/intro-to-spryker/b2c-suite.md | 2 +- .../intro-to-spryker/docs-release-notes.md | 40 +- .../user/intro-to-spryker/intro-to-spryker.md | 2 +- .../release-notes/release-notes-2018.12.0.md | 4 +- .../release-notes-201903.0.md | 2 +- .../release-notes-201907.0.md | 8 +- .../security-release-notes-202306.0.md | 18 +- .../support/getting-support.md | 3 +- .../support}/handling-new-feature-requests.md | 0 .../support/handling-security-issues.md | 2 +- .../intro-to-spryker/supported-browsers.md | 11 +- .../whats-new/security-updates.md | 8 +- ...are-a-project-for-spryker-code-upgrader.md | 8 + 476 files changed, 2652 insertions(+), 5531 deletions(-) rename docs/pbc/all/payment-service-provider/202212.0/spryker-pay/marketplace/install-marketplace-dummy-payment.md => _includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-dummy-payment-feature.md (96%) delete mode 100644 _includes/pbc/all/install-features/202304.0/install-glue-api/install-the-product-rating-and-reviews-glue-api.md rename _includes/pbc/all/install-features/{202400.0 => 202304.0}/install-the-inventory-management-feature.md (97%) rename _includes/pbc/all/install-features/{202400.0 => 202304.0}/install-the-order-management-inventory-management-feature.md (85%) rename _includes/pbc/all/install-features/{202400.0 => 202304.0}/install-the-picker-user-login-feature.md (95%) rename _includes/pbc/all/install-features/{202400.0 => 202304.0}/install-the-product-offer-service-points-feature.md (99%) rename _includes/pbc/all/install-features/{202400.0 => 202304.0}/install-the-product-offer-shipment-feature.md (98%) rename _includes/pbc/all/install-features/{202400.0 => 202304.0}/install-the-push-notification-feature.md (99%) rename _includes/pbc/all/install-features/{202400.0 => 202304.0}/install-the-service-points-feature.md (100%) rename _includes/pbc/all/install-features/{202400.0 => 202304.0}/install-the-shipment-feature.md (77%) rename _includes/pbc/all/install-features/{202400.0 => 202304.0}/install-the-shipment-service-points-feature.md (92%) rename _includes/pbc/all/install-features/{202400.0 => 202304.0}/install-the-spryker-core-back-office-warehouse-user-management-feature.md (94%) rename _includes/pbc/all/install-features/{202400.0 => 202304.0}/install-the-warehouse-picking-feature.md (96%) rename _includes/pbc/all/install-features/{202400.0 => 202304.0}/install-the-warehouse-picking-inventory-management-feature.md (94%) rename _includes/pbc/all/install-features/{202400.0 => 202304.0}/install-the-warehouse-picking-order-management-feature.md (96%) rename _includes/pbc/all/install-features/{202400.0 => 202304.0}/install-the-warehouse-picking-product-feature.md (97%) rename _includes/pbc/all/install-features/{202400.0 => 202304.0}/install-the-warehouse-picking-shipment-feature.md (99%) rename _includes/pbc/all/install-features/{202400.0 => 202304.0}/install-the-warehouse-picking-spryker-core-back-office-feature.md (94%) rename _includes/pbc/all/install-features/{202400.0 => 202304.0}/install-the-warehouse-user-management-feature.md (96%) rename _includes/pbc/all/install-features/{202400.0 => 202304.0}/marketplace/install-the-marketplace-product-offer-service-points-feature.md (98%) delete mode 100644 _internal/faq-migration-to-opensearch.md delete mode 100644 docs/cloud/dev/spryker-cloud-commerce-os/best-practices/best-practises-jenkins-stability.md create mode 100644 docs/marketplace/dev/data-import/202212.0/data-import.md create mode 100644 docs/marketplace/dev/data-import/202212.0/file-details-merchant-store.csv.md rename docs/{scos/dev/data-import/202212.0/marketplace-data-import.md => marketplace/dev/data-import/202212.0/marketplace-setup.md} (97%) create mode 100644 docs/marketplace/dev/feature-integration-guides/202212.0/marketplace-dummy-payment-feature-integration.md rename docs/{pbc/all/product-information-management/202212.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-cart-feature.md => marketplace/dev/feature-integration-guides/202212.0/marketplace-product-cart-feature-integration.md} (81%) rename docs/{pbc/all/merchant-management/202212.0/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-customer-account-management-feature.md => marketplace/dev/feature-integration-guides/202212.0/merchant-switcher-customer-account-management-feature-integration.md} (87%) rename docs/{pbc/all/merchant-management/202212.0/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-feature.md => marketplace/dev/feature-integration-guides/202212.0/merchant-switcher-feature-integration.md} (90%) rename docs/{pbc/all/merchant-management/202212.0/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-wishlist-feature.md => marketplace/dev/feature-integration-guides/202212.0/merchant-switcher-wishlist-feature-integration.md} (88%) rename docs/{pbc/all/product-information-management/202212.0/marketplace/domain-model-and-relationships/marketplace-merchant-portal-product-management-feature-domain-model-and-relationships.md => marketplace/dev/feature-walkthroughs/202212.0/marketplace-merchant-portal-product-management-feature-walkthrough.md} (50%) rename docs/{pbc/all/merchant-management/202212.0/marketplace/tutorials-and-howtos/create-gui-table-column-types.md => marketplace/dev/howtos/how-to-add-new-guitable-column-type.md} (93%) rename docs/{scos/dev/tutorials-and-howtos/howtos/howto-create-an-angular-module-with-application.md => marketplace/dev/howtos/how-to-create-a-new-angular-module-with-application.md} (96%) rename docs/{scos/dev/tutorials-and-howtos/howtos/howto-split-products-by-stores.md => marketplace/dev/howtos/how-to-split-products-by-stores.md} (99%) rename docs/{scos/dev/migration-concepts/upgrade-to-marketplace.md => marketplace/dev/howtos/how-to-upgrade-spryker-instance-to-marketplace.md} (94%) create mode 100644 docs/marketplace/dev/howtos/howtos.md create mode 100644 docs/marketplace/dev/setup/202212.0/marketplace-supported-browsers.md create mode 100644 docs/marketplace/dev/setup/202212.0/setup.md create mode 100644 docs/marketplace/dev/setup/202212.0/system-requirements.md create mode 100644 docs/marketplace/dev/setup/202304.0/system-requirements.md rename docs/{scos/dev/migration-concepts/upgrade-to-angular-12.md => marketplace/dev/technical-enhancement/202212.0/migration-guide-upgrade-to-angular-v12.md} (97%) create mode 100644 docs/marketplace/dev/technical-enhancement/202212.0/technical-enhancement.md rename docs/{scos/dev/migration-concepts/upgrade-to-angular-15.md => marketplace/dev/technical-enhancement/202304.0/migration-guide-upgrade-to-angular-v15.md} (96%) rename docs/pbc/all/back-office/{202400.0/unified-commerce/install-and-upgrade/install-the-spryker-core-back-office-warehouse-user-management-feature.md => 202304.0/install-spryker-core-back-office-warehouse-user-management-feature.md} (82%) rename docs/pbc/all/carrier-management/{202400.0/unified-commerce => 202304.0/base-shop}/import-and-export-data/file-details-shipment-method-shipment-type.csv.md (92%) rename docs/pbc/all/carrier-management/{202400.0/unified-commerce => 202304.0/base-shop}/import-and-export-data/file-details-shipment-type-store.csv.md (92%) rename docs/pbc/all/carrier-management/{202400.0/unified-commerce => 202304.0/base-shop}/import-and-export-data/file-details-shipment-type.csv.md (91%) rename docs/pbc/all/carrier-management/{202400.0/unified-commerce => 202304.0/base-shop}/install-and-upgrade/install-the-shipment-feature.md (97%) delete mode 100644 docs/pbc/all/carrier-management/202400.0/unified-commerce/install-and-upgrade/install-the-shipment-service-points-feature.md delete mode 100644 docs/pbc/all/cart-and-checkout/202212.0/marketplace/install/install-features/install-the-cart-marketplace-product-feature.md create mode 100644 docs/pbc/all/offer-management/202304.0/marketplace/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.md delete mode 100644 docs/pbc/all/offer-management/202400.0/marketplace/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.md delete mode 100644 docs/pbc/all/offer-management/202400.0/unified-commerce/install-and-upgrade/install-the-product-offer-shipment-feature.md rename docs/pbc/all/payment-service-provider/202212.0/{spryker-pay/base-shop => }/hydrate-payment-methods-for-an-order.md (87%) rename docs/pbc/all/payment-service-provider/202212.0/{spryker-pay/base-shop/import-and-export-data/import-file-details-payment-method-store.csv.md => import-and-export-data/file-details-payment-method-store.csv.md} (85%) rename docs/pbc/all/payment-service-provider/202212.0/{spryker-pay/base-shop/import-and-export-data/import-file-details-payment-method.csv.md => import-and-export-data/file-details-payment-method.csv.md} (89%) rename docs/pbc/all/payment-service-provider/202212.0/{spryker-pay/base-shop/import-and-export-data/payment-service-provider-data-import-and-export.md => import-and-export-data/import-and-export-payment-service-provider-data.md} (93%) rename docs/pbc/all/payment-service-provider/202212.0/{spryker-pay/base-shop => }/install-and-upgrade/install-the-payments-feature.md (76%) rename docs/pbc/all/payment-service-provider/202212.0/{spryker-pay/base-shop => }/install-and-upgrade/install-the-payments-glue-api.md (72%) rename docs/pbc/all/payment-service-provider/202212.0/{spryker-pay/base-shop => }/install-and-upgrade/upgrade-the-payment-module.md (73%) rename docs/pbc/all/payment-service-provider/202212.0/{spryker-pay/base-shop => }/interact-with-third-party-payment-providers-using-glue-api.md (91%) rename docs/pbc/all/payment-service-provider/202212.0/{spryker-pay/base-shop => }/manage-in-the-back-office/edit-payment-methods.md (89%) rename docs/pbc/all/payment-service-provider/202212.0/{spryker-pay/base-shop => }/manage-in-the-back-office/log-into-the-back-office.md (72%) rename docs/pbc/all/payment-service-provider/202212.0/{spryker-pay/base-shop => }/manage-in-the-back-office/view-payment-methods.md (80%) rename docs/pbc/all/payment-service-provider/202212.0/{spryker-pay/base-shop => }/payments-feature-domain-model-and-relationships.md (80%) rename docs/pbc/all/payment-service-provider/202212.0/{spryker-pay/base-shop => }/payments-feature-overview.md (69%) delete mode 100644 docs/pbc/all/payment-service-provider/202212.0/ratepay/integrate-payment-methods-for-ratepay/integrate-payment-methods-for-ratepay.md rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/adyen/adyen.md (65%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/adyen/enable-filtering-of-payment-methods-for-adyen.md (70%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/adyen/install-and-configure-adyen.md (85%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/adyen/integrate-adyen-payment-methods.md (96%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/adyen/integrate-adyen.md (94%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/afterpay/afterpay.md (89%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/afterpay/install-and-configure-afterpay.md (95%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/afterpay/integrate-afterpay.md (96%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/amazon-pay/amazon-pay-sandbox-simulations.md (88%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/amazon-pay/amazon-pay-state-machine.md (80%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/amazon-pay/amazon-pay.md (66%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/amazon-pay/configure-amazon-pay.md (94%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/amazon-pay/handling-orders-with-amazon-pay-api.md (95%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/amazon-pay/obtain-an-amazon-order-reference-and-information-about-shipping-addresses.md (90%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/arvato/arvato-risk-check.md (90%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/arvato/arvato-store-order.md (91%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/arvato/arvato.md (79%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/arvato/install-and-configure-arvato.md (85%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/billie.md (96%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/billpay/billpay-switch-invoice-payments-to-a-preauthorize-mode.md (98%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/billpay/billpay.md (89%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/billpay/integrate-billpay.md (93%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/braintree/braintree-performing-requests.md (88%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/braintree/braintree-request-workflow.md (71%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/braintree/braintree.md (76%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/braintree/install-and-configure-braintree.md (93%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/braintree/integrate-braintree.md (90%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/computop/computop-api-calls.md (61%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/computop/computop-oms-plugins.md (51%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/computop/computop.md (72%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/computop/install-and-configure-computop.md (90%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/computop/integrate-computop.md (99%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.md (69%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.md (82%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.md (64%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.md (66%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.md (66%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.md (63%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.md (86%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.md (60%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.md (66%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/crefopay/crefopay-callbacks.md (61%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/crefopay/crefopay-capture-and-refund-processes.md (73%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/crefopay/crefopay-enable-b2b-payments.md (66%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/crefopay/crefopay-notifications.md (92%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/crefopay/crefopay-payment-methods.md (85%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/crefopay/crefopay.md (70%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/crefopay/install-and-configure-crefopay.md (81%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/crefopay/integrate-crefopay.md (97%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/heidelpay/configure-heidelpay.md (78%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/heidelpay/heidelpay-oms-workflow.md (92%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/heidelpay/heidelpay-workflow-for-errors.md (62%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/heidelpay/heidelpay.md (50%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/heidelpay/install-heidelpay.md (51%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/heidelpay/integrate-heidelpay.md (88%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.md (83%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.md (90%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.md (92%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-ideal-payment-method-for-heidelpay.md (69%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-invoice-secured-b2c-payment-method-for-heidelpay.md (86%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.md (72%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-debit-payment-method-for-heidelpay.md (70%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-sofort-payment-method-for-heidelpay.md (70%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.md (57%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/klarna/klarna-invoice-pay-in-14-days.md (74%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/klarna/klarna-part-payment-flexible.md (75%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/klarna/klarna-payment-workflow.md (66%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/klarna/klarna-state-machine-commands-and-conditions.md (84%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/klarna/klarna.md (81%) create mode 100644 docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payment-service-provider-integrations.md rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/payolution/install-and-configure-payolution.md (89%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/payolution/integrate-payolution.md (85%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/payolution/integrate-the-installment-payment-method-for-payolution.md (81%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/payolution/integrate-the-invoice-payment-method-for-payolution.md (78%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/payolution/payolution-performing-requests.md (85%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/payolution/payolution-request-flow.md (55%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/payolution/payolution.md (75%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/payone/integration-in-the-back-office/disconnect-payone.md (88%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/payone/integration-in-the-back-office/integrate-payone.md (96%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/payone/integration-in-the-back-office/payone-integration-in-the-back-office.md (95%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/payone/manual-integration/integrate-payone.md (89%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/payone/manual-integration/payone-cash-on-delivery.md (68%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/payone/manual-integration/payone-manual-integration.md (92%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/payone/manual-integration/payone-paypal-express-checkout-payment.md (96%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/payone/manual-integration/payone-risk-check-and-address-check.md (86%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/powerpay.md (96%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/ratenkauf-by-easycredit/install-and-configure-ratenkauf-by-easycredit.md (79%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/ratenkauf-by-easycredit/integrate-ratenkauf-by-easycredit.md (98%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/ratenkauf-by-easycredit/ratenkauf-by-easycredit.md (81%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/ratepay/disable-address-updates-from-the-backend-application-for-ratepay.md (93%) create mode 100644 docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-payment-methods-for-ratepay.md rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/ratepay/integrate-payment-methods-for-ratepay/integrate-the-direct-debit-payment-method-for-ratepay.md (84%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/ratepay/integrate-payment-methods-for-ratepay/integrate-the-installment-payment-method-for-ratepay.md (87%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/ratepay/integrate-payment-methods-for-ratepay/integrate-the-invoice-payment-method-for-ratepay.md (89%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/ratepay/integrate-payment-methods-for-ratepay/integrate-the-prepayment-payment-method-for-ratepay.md (89%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/ratepay/ratepay-core-module-structure-diagram.md (94%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/ratepay/ratepay-facade-methods.md (93%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/ratepay/ratepay-payment-workflow.md (91%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/ratepay/ratepay-state-machine-commands-and-conditions.md (85%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/ratepay/ratepay-state-machines.md (87%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/ratepay/ratepay.md (77%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/unzer/configure-in-the-back-office/add-unzer-marketplace-credentials.md (97%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/unzer/configure-in-the-back-office/add-unzer-standard-credentails.md (100%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/unzer/extend-and-customize/customize-the-credit-card-display-in-your-payment-step.md (67%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/unzer/extend-and-customize/implement-new-payment-methods-on-the-project-level.md (98%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/unzer/howto-tips-use-cases/refund-shipping-costs.md (89%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/unzer/howto-tips-use-cases/understand-payment-method-in-checkout-process.md (95%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/unzer/install-unzer/install-and-configure-unzer.md (96%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/unzer/install-unzer/integrate-unzer-glue-api.md (97%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/unzer/install-unzer/integrate-unzer.md (99%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/unzer/unzer-domain-model-and-relationships.md (95%) rename docs/pbc/all/payment-service-provider/202212.0/{ => third-party-integrations}/unzer/unzer.md (82%) create mode 100644 docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/unzer/whats-changed-in-unzer.md delete mode 100644 docs/pbc/all/product-information-management/202212.0/marketplace/marketplace-merchant-portal-product-management-feature-overview.md delete mode 100644 docs/pbc/all/push-notification/202400.0/unified-commerce/install-and-upgrade/install-the-push-notification-feature.md delete mode 100644 docs/pbc/all/ratings-reviews/202204.0/import-and-export-data/ratings-and-reviews-data-import.md delete mode 100644 docs/pbc/all/ratings-reviews/202212.0/import-and-export-data/ratings-and-reviews-data-import.md delete mode 100644 docs/pbc/all/ratings-reviews/202304.0/install-and-upgrade/install-the-product-rating-and-reviews-glue-api.md delete mode 100644 docs/pbc/all/search/202212.0/base-shop/import-and-export-data/search-data-import.md rename docs/pbc/all/search/202212.0/base-shop/{import-and-export-data => import-data}/file-details-product-search-attribute-map.csv.md (95%) rename docs/pbc/all/search/202212.0/base-shop/{import-and-export-data => import-data}/file-details-product-search-attribute.csv.md (96%) create mode 100644 docs/pbc/all/search/202212.0/best-practices/precise-search-by-super-attributes.md delete mode 100644 docs/pbc/all/service-points/202400.0/unified-commerce/install-the-service-points-feature.md rename docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/{import-file-details-product-abstract.csv.md => import-tax-sets-for-abstract-products.md} (95%) rename docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/{import-file-details-product-option.csv.md => import-tax-sets-for-product-options.md} (96%) rename docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/{import-file-details-shipment.csv.md => import-tax-sets-for-shipment-methods.md} (95%) rename docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/{import-file-details-tax-sets.csv.md => import-tax-sets.md} (100%) delete mode 100644 docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/tax-management-data-import.md rename docs/pbc/all/tax-management/202212.0/base-shop/import-and-export-data/{import-file-details-product-abstract.csv.md => import-tax-sets-for-abstract-products.md} (84%) rename docs/pbc/all/tax-management/202212.0/base-shop/import-and-export-data/{import-file-details-product-option.csv.md => import-tax-sets-for-product-options.md} (87%) rename docs/pbc/all/tax-management/202212.0/base-shop/import-and-export-data/{import-file-details-shipment.csv.md => import-tax-sets-for-shipment-methods.md} (84%) rename docs/pbc/all/tax-management/202212.0/base-shop/import-and-export-data/{import-file-details-tax-sets.csv.md => import-tax-sets.md} (90%) delete mode 100644 docs/pbc/all/tax-management/202212.0/base-shop/import-and-export-data/tax-management-data-import.md delete mode 100644 docs/pbc/all/warehouse-management-system/202204.0/base-shop/import-and-export-data/warehouse-management-system-data-import.md rename docs/pbc/all/warehouse-management-system/202204.0/base-shop/{import-and-export-data => import-data}/file-details-product-stock.csv.md (95%) rename docs/pbc/all/warehouse-management-system/202204.0/base-shop/{import-and-export-data => import-data}/file-details-warehouse-address.csv.md (91%) rename docs/pbc/all/warehouse-management-system/202204.0/base-shop/{import-and-export-data => import-data}/file-details-warehouse-store.csv.md (90%) rename docs/pbc/all/warehouse-management-system/202204.0/base-shop/{import-and-export-data => import-data}/file-details-warehouse.csv.md (87%) delete mode 100644 docs/pbc/all/warehouse-management-system/202212.0/base-shop/import-and-export-data/warehouse-management-system-data-import.md rename docs/pbc/all/warehouse-management-system/202212.0/base-shop/{import-and-export-data => import-data}/file-details-product-stock.csv.md (97%) rename docs/pbc/all/warehouse-management-system/202212.0/base-shop/{import-and-export-data => import-data}/file-details-warehouse-address.csv.md (94%) rename docs/pbc/all/warehouse-management-system/202212.0/base-shop/{import-and-export-data => import-data}/file-details-warehouse-store.csv.md (93%) rename docs/pbc/all/warehouse-management-system/202212.0/base-shop/{import-and-export-data => import-data}/file-details-warehouse.csv.md (90%) rename docs/pbc/all/warehouse-management-system/{202400.0/unified-commerce/install-and-upgrade => 202304.0/base-shop/install-and-upgrade/install-features}/install-the-inventory-management-feature.md (60%) create mode 100644 docs/pbc/all/warehouse-management-system/202304.0/base-shop/install-and-upgrade/install-features/install-the-order-management-inventory-management-feature.md create mode 100644 docs/pbc/all/warehouse-management-system/202304.0/base-shop/install-and-upgrade/install-the-warehouse-user-management-feature.md delete mode 100644 docs/pbc/all/warehouse-management-system/202400.0/unified-commerce/install-and-upgrade/install-the-order-management-inventory-management-feature.md delete mode 100644 docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-picker-user-login-feature.md delete mode 100644 docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-feature.md delete mode 100644 docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-inventory-management-feature.md delete mode 100644 docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-order-management-feature.md delete mode 100644 docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-product-feature.md delete mode 100644 docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-shipment-feature.md delete mode 100644 docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-spryker-core-back-office-feature.md delete mode 100644 docs/scos/dev/feature-integration-guides/202304.0/glue-api/dynamic-data-api/dynamic-data-api-integration.md create mode 100644 docs/scos/dev/feature-integration-guides/202304.0/install-the-picker-user-login-feature.md rename docs/{pbc/all/offer-management/202400.0/unified-commerce/install-and-upgrade => scos/dev/feature-integration-guides/202304.0}/install-the-product-offer-service-points-feature.md (51%) create mode 100644 docs/scos/dev/feature-integration-guides/202304.0/install-the-product-offer-shipment-feature.md create mode 100644 docs/scos/dev/feature-integration-guides/202304.0/install-the-push-notification-feature.md create mode 100644 docs/scos/dev/feature-integration-guides/202304.0/install-the-service-points-feature.md create mode 100644 docs/scos/dev/feature-integration-guides/202304.0/install-the-shipment-service-points-feature.md create mode 100644 docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-feature.md create mode 100644 docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-inventory-management-feature.md create mode 100644 docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-order-management-feature.md create mode 100644 docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-product-feature.md create mode 100644 docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-shipment-feature.md create mode 100644 docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-spryker-core-back-office-feature.md rename docs/{pbc/all/warehouse-management-system/202400.0/unified-commerce/install-and-upgrade => scos/dev/feature-integration-guides/202304.0}/install-the-warehouse-user-management-feature.md (54%) delete mode 100644 docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-api.md rename docs/scos/dev/glue-api-guides/202212.0/{ => decoupled-glue-infrastructure}/authentication-and-authorization.md (96%) rename docs/scos/dev/glue-api-guides/202212.0/{ => decoupled-glue-infrastructure}/backend-and-storefront-api-module-differences.md (97%) rename docs/scos/dev/glue-api-guides/202212.0/{ => decoupled-glue-infrastructure}/create-glue-api-applications.md (99%) rename docs/scos/dev/glue-api-guides/202212.0/{ => decoupled-glue-infrastructure}/security-and-authentication.md (100%) rename docs/scos/dev/glue-api-guides/202212.0/{old-glue-infrastructure => }/glue-infrastructure.md (98%) rename docs/scos/dev/glue-api-guides/202212.0/{old-glue-infrastructure => }/glue-rest-api.md (72%) rename docs/scos/dev/glue-api-guides/202212.0/{old-glue-infrastructure => }/handling-concurrent-rest-requests-and-caching-with-entity-tags.md (89%) rename docs/scos/dev/glue-api-guides/202212.0/{old-glue-infrastructure => }/reference-information-glueapplication-errors.md (70%) rename docs/scos/dev/glue-api-guides/202212.0/{old-glue-infrastructure => }/resolving-search-engine-friendly-urls.md (94%) rename docs/scos/dev/glue-api-guides/202212.0/{old-glue-infrastructure => }/rest-api-b2b-reference.md (78%) rename docs/scos/dev/glue-api-guides/202212.0/{old-glue-infrastructure => }/rest-api-b2c-reference.md (82%) delete mode 100644 docs/scos/dev/glue-api-guides/202304.0/dynamic-data-api/how-to-guides/how-to-configure-dynamic-data-api.md delete mode 100644 docs/scos/dev/glue-api-guides/202304.0/dynamic-data-api/how-to-guides/how-to-send-request-in-dynamic-data-api.md rename docs/{pbc/all/push-notification/202400.0/unified-commerce => scos/user/features/202304.0}/push-notification-feature-overview.md (98%) rename {_drafts/deprecated => docs/scos/user/intro-to-spryker/support}/handling-new-feature-requests.md (100%) diff --git a/Rakefile b/Rakefile index dcea302de1d..5f2df935727 100644 --- a/Rakefile +++ b/Rakefile @@ -118,8 +118,7 @@ task :check_mp_dev do /docs\/marketplace\/\w+\/[\w-]+\/202108\.0\/.+/, /docs\/sdk\/.+/, /docs\/marketplace\/\w+\/[\w-]+\/202204\.0\/.+/, - /docs\/marketplace\/\w+\/[\w-]+\/202304\.0\/.+/, - /docs\/marketplace\/\w+\/[\w-]+\/202400\.0\/.+/ + /docs\/marketplace\/\w+\/[\w-]+\/202304\.0\/.+/ ] HTMLProofer.check_directory("./_site", options).run end @@ -136,8 +135,7 @@ task :check_mp_user do /docs\/marketplace\/\w+\/[\w-]+\/202108\.0\/.+/, /docs\/pbc\/.+/, /docs\/sdk\/.+/, - /docs\/marketplace\/\w+\/[\w-]+\/202304\.0\/.+/, - /docs\/marketplace\/\w+\/[\w-]+\/202400\.0\/.+/ + /docs\/marketplace\/\w+\/[\w-]+\/202304\.0\/.+/ ] HTMLProofer.check_directory("./_site", options).run end @@ -161,8 +159,7 @@ task :check_scos_dev do /docs\/scos\/\w+\/[\w-]+\/202009\.0\/.+/, /docs\/scos\/\w+\/[\w-]+\/202108\.0\/.+/, /docs\/scos\/\w+\/[\w-]+\/202204\.0\/.+/, - /docs\/scos\/\w+\/[\w-]+\/202304\.0\/.+/, - /docs\/scos\/\w+\/[\w-]+\/202400\.0\/.+/ + /docs\/scos\/\w+\/[\w-]+\/202304\.0\/.+/ ] HTMLProofer.check_directory("./_site", options).run end @@ -186,8 +183,7 @@ task :check_scos_user do /docs\/scos\/\w+\/[\w-]+\/202009\.0\/.+/, /docs\/scos\/\w+\/[\w-]+\/202108\.0\/.+/, /docs\/scos\/\w+\/[\w-]+\/202204\.0\/.+/, - /docs\/scos\/\w+\/[\w-]+\/202304\.0\/.+/, - /docs\/scos\/\w+\/[\w-]+\/202400\.0\/.+/ + /docs\/scos\/\w+\/[\w-]+\/202304\.0\/.+/ ] HTMLProofer.check_directory("./_site", options).run end @@ -217,8 +213,7 @@ task :check_pbc do /docs\/acp\/.+/, /docs\/scu\/.+/, /docs\/pbc\/\w+\/[\w-]+\/202212\.0\/.+/, - /docs\/pbc\/\w+\/[\w-]+\/202304\.0\/.+/, - /docs\/pbc\/\w+\/[\w-]+\/202400\.0\/.+/ + /docs\/pbc\/\w+\/[\w-]+\/202304\.0\/.+/ ] HTMLProofer.check_directory("./_site", options).run end diff --git a/_config.yml b/_config.yml index a5f5c894d71..155eb424da8 100644 --- a/_config.yml +++ b/_config.yml @@ -171,6 +171,7 @@ defaults: sidebar: "pbc_all_sidebar" role: "all" + versions: '201811.0': '201811.0' '201903.0': '201903.0' @@ -182,7 +183,6 @@ versions: '202204.0': '202204.0' '202212.0': '202212.0' '202304.0': 'Upcoming release' - '202400.0': 'Winter release' # versioned categories - these must match corresponding directories versioned_categories: @@ -250,10 +250,6 @@ versioned_categories: - tax-management - user-management - warehouse-management-system - - push notification - - warehouse-picking - - service-points - # these are defaults used for the front matter for these file types diff --git a/_data/sidebars/cloud_dev_sidebar.yml b/_data/sidebars/cloud_dev_sidebar.yml index 89bf2d351d4..598cd84bbe2 100644 --- a/_data/sidebars/cloud_dev_sidebar.yml +++ b/_data/sidebars/cloud_dev_sidebar.yml @@ -42,11 +42,6 @@ entries: url: /docs/cloud/dev/spryker-cloud-commerce-os/deploying-in-a-production-environment.html - title: Starting asynchronous commands url: /docs/cloud/dev/spryker-cloud-commerce-os/starting-asynchronous-commands.html - - title: Best practices - url: /docs/cloud/dev/spryker-cloud-commerce-os/best-practices/best-practices.html - nested: - - title: "Best practises: Jenkins stability" - url: /docs/cloud/dev/spryker-cloud-commerce-os/best-practices/best-practises-jenkins-stability.html - title: Manage maintenance mode nested: - title: Enable and disable maintenance mode diff --git a/_data/sidebars/marketplace_dev_sidebar.yml b/_data/sidebars/marketplace_dev_sidebar.yml index 9c498f8d0c4..9eae5e915df 100644 --- a/_data/sidebars/marketplace_dev_sidebar.yml +++ b/_data/sidebars/marketplace_dev_sidebar.yml @@ -5,14 +5,25 @@ entries: - product: Marketplace nested: - title: Setup - url: /docs/marketplace/dev/setup/spryker-marketplace-setup.html + url: /docs/marketplace/dev/setup/setup.html include_versions: - - "202204.0" nested: - title: System requirements url: /docs/marketplace/dev/setup/system-requirements.html + include_versions: + - "202204.0" + - title: Marketplace supported browsers url: /docs/marketplace/dev/setup/marketplace-supported-browsers.html + include_versions: + - "202204.0" + - "202212.0" + + - title: Setup + url: /docs/marketplace/dev/setup/spryker-marketplace-setup.html + include_versions: + - "202204.0" + - "202212.0" - title: Marketplace architecture overview url: /docs/marketplace/dev/architecture-overview/architecture-overview.html @@ -255,6 +266,7 @@ entries: include_versions: - "202108.0" - "202204.0" + - "202212.0" - title: Marketplace Inventory Management feature integration url: /docs/marketplace/dev/feature-integration-guides/marketplace-inventory-management-feature-integration.html @@ -309,11 +321,13 @@ entries: include_versions: - "202108.0" - "202204.0" + - "202212.0" - title: Merchant Switcher + Customer Account Management feature integration url: /docs/marketplace/dev/feature-integration-guides/merchant-switcher-customer-account-management-feature-integration.html include_versions: - "202204.0" + - "202212.0" - title: Merchant Switcher + Customer Account Management feature integration url: /docs/marketplace/dev/feature-integration-guides/merchant-switcher-customer-account-management-feature-integration.html @@ -325,6 +339,7 @@ entries: include_versions: - "202108.0" - "202204.0" + - "202212.0" - title: Marketplace Merchant Custom Prices url: /docs/marketplace/dev/feature-integration-guides/marketplace-merchant-custom-prices-feature-integration.html @@ -842,41 +857,73 @@ entries: - "202204.0" - title: Data import url: /docs/marketplace/dev/data-import/data-import.html - include_versions: - - "202204.0" nested: - title: Marketplace setup url: /docs/marketplace/dev/data-import/marketplace-setup.html + include_versions: + - "202108.0" + - "202204.0" + - "202212.0" - title: "File details: merchant.csv" url: /docs/marketplace/dev/data-import/file-details-merchant.csv.html + include_versions: + - "202108.0" + - "202204.0" - title: "File details: merchant-profile.csv" url: /docs/marketplace/dev/data-import/file-details-merchant-profile.csv.html + include_versions: + - "202108.0" + - "202204.0" - title: "File details: merchant-profile-address.csv" url: /docs/marketplace/dev/data-import/file-details-merchant-profile-address.csv.html + include_versions: + - "202108.0" + - "202204.0" - title: "File details: merchant-open-hours-week-day-schedule.csv" url: /docs/marketplace/dev/data-import/file-details-merchant-open-hours-week-day-schedule.csv.html + include_versions: + - "202108.0" + - "202204.0" - title: "File details: merchant_open_hours_date_schedule.csv" url: /docs/marketplace/dev/data-import/file-details-merchant-open-hours-date-schedule.csv.html + include_versions: + - "202108.0" + - "202204.0" - title: "File details: merchant-category.csv" url: /docs/marketplace/dev/data-import/file-details-merchant-category.csv.html + include_versions: + - "202108.0" + - "202204.0" - title: "File details: merchant-stock.csv" url: /docs/marketplace/dev/data-import/file-details-merchant-stock.csv.html + include_versions: + - "202108.0" + - "202204.0" - title: "File details: merchant-store.csv" url: /docs/marketplace/dev/data-import/file-details-merchant-store.csv.html + include_versions: + - "202108.0" + - "202204.0" - title: "File details: merchant-oms-process.csv" url: /docs/marketplace/dev/data-import/file-details-merchant-oms-process.csv.html + include_versions: + - "202108.0" + - "202204.0" - title: "File details: merchant-order-status.csv" url: /docs/marketplace/dev/data-import/file-details-merchant-order-status.csv.html + include_versions: + - "202108.0" + - "202204.0" - title: "File details: merchant_product_approval_status_default.csv" url: /docs/marketplace/dev/data-import/file-details-merchant-product-approval-status-default.csv.html @@ -885,12 +932,21 @@ entries: - title: "File details: merchant-product-offer.csv" url: /docs/marketplace/dev/data-import/file-details-merchant-product-offer.csv.html + include_versions: + - "202108.0" + - "202204.0" - title: "File details: merchant_user.csv" url: /docs/marketplace/dev/data-import/file-details-merchant-user.csv.html + include_versions: + - "202108.0" + - "202204.0" - title: "File details: price-product-offer.csv" url: /docs/marketplace/dev/data-import/file-details-price-product-offer.csv.html + include_versions: + - "202108.0" + - "202204.0" - title: "File details: product-offer-shopping-list.csv" url: /docs/marketplace/dev/data-import/file-details-product-offer-shopping-list.csv.html @@ -899,24 +955,45 @@ entries: - title: "File details: product-offer-stock.csv" url: /docs/marketplace/dev/data-import/file-details-product-offer-stock.csv.html + include_versions: + - "202108.0" + - "202204.0" - title: "File details: merchant-product-offer-store.csv" url: /docs/marketplace/dev/data-import/file-details-merchant-product-offer-store.csv.html + include_versions: + - "202108.0" + - "202204.0" - title: "File details: product-offer-validity.csv" url: /docs/marketplace/dev/data-import/file-details-product-offer-validity.csv.html + include_versions: + - "202108.0" + - "202204.0" - title: "File details: combined-merchant-product-offer.csv" url: /docs/marketplace/dev/data-import/file-details-combined-merchant-product-offer.csv.html + include_versions: + - "202108.0" + - "202204.0" - title: "File details: merchant-product.csv" url: /docs/marketplace/dev/data-import/file-details-merchant-product.csv.html + include_versions: + - "202108.0" + - "202204.0" - title: "File details: product-price.csv" url: /docs/marketplace/dev/data-import/file-details-product-price.csv.html + include_versions: + - "202108.0" + - "202204.0" - title: "File details: product-option-group.csv" url: /docs/marketplace/dev/data-import/file-details-merchant-product-option-group.csv.html + include_versions: + - "202108.0" + - "202204.0" - title: Front-end url: /docs/marketplace/dev/front-end/front-end.html @@ -1353,3 +1430,37 @@ entries: include_versions: - "202204.0" - "202212.0" + + - title: HowTos + url: /docs/marketplace/dev/howtos/howtos.html + nested: + + - title: "How-To: Upgrade Spryker instance to the Marketplace" + url: /docs/marketplace/dev/howtos/how-to-upgrade-spryker-instance-to-marketplace.html + + - title: "How-To: Create a new Angular module with application" + url: /docs/marketplace/dev/howtos/how-to-create-a-new-angular-module-with-application.html + + - title: "How-To: Split products by stores" + url: /docs/marketplace/dev/howtos/how-to-split-products-by-stores.html + + - title: "How-To: Create a new Gui table column type" + url: /docs/marketplace/dev/howtos/how-to-add-new-guitable-column-type.html + + - title: "How-To: Create a new Gui table filter type" + url: /docs/marketplace/dev/howtos/how-to-add-new-guitable-filter-type.html + + - title: Technical enhancement guides + url: /docs/marketplace/dev/technical-enhancement/technical-enhancement.html + nested: + + - title: "Migration guide - Upgrade to Angular v12" + url: /docs/marketplace/dev/technical-enhancement/migration-guide-upgrade-to-angular-v12.html + include_versions: + - "202204.0" + - "202212.0" + + - title: "Migration guide - Upgrade to Angular v15" + url: /docs/marketplace/dev/technical-enhancement/migration-guide-upgrade-to-angular-v15.html + include_versions: + - "202304.0" diff --git a/_data/sidebars/pbc_all_sidebar.yml b/_data/sidebars/pbc_all_sidebar.yml index fb47e2bca44..35f77216b17 100644 --- a/_data/sidebars/pbc_all_sidebar.yml +++ b/_data/sidebars/pbc_all_sidebar.yml @@ -12,6 +12,14 @@ entries: url: /docs/pbc/all/back-office/back-office-translations-overview.html - title: Install the Spryker Core Back Office feature url: /docs/pbc/all/back-office/install-the-spryker-core-back-office-feature.html + - title: Install the Warehouse User Management feature + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-the-warehouse-user-management-feature.html + include_versions: + - "202304.0" + - title: Install the Spryker Core Back Office + Warehouse User Management feature + url: /docs/pbc/all/back-office/install-spryker-core-back-office-warehouse-user-management-feature.html + include_versions: + - "202304.0" - title: "HowTo: Add support of number formatting in the Back Office" url: /docs/pbc/all/back-office/howto-add-support-of-number-formatting-in-the-back-office.html - title: Manage in the Back Office @@ -184,6 +192,14 @@ entries: url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-feature.html - title: Cart + Non-splittable Products url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-non-splittable-products-feature.html + - title: Cart Notes + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-notes-feature.html + include_versions: + - "202304.0" + - title: Cart + Prices + url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-prices-feature.html + include_versions: + - "202304.0" - title: Cart + Product url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-product-feature.html - title: Cart + Product Bundles @@ -379,8 +395,6 @@ entries: nested: - title: Marketplace Cart url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-marketplace-cart-feature.html - - title: Cart + Marketplace Product - url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-cart-marketplace-product-feature.html - title: Cart + Marketplace Product Offer url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-cart-marketplace-product-offer-feature.html - title: Cart + Marketplace Product Options @@ -458,6 +472,10 @@ entries: url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-cms-product-lists-catalog-feature.html - title: Content Items url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-content-items-feature.html + - title: File Manager + url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-file-manager-feature.html + include_versions: + - "202304.0" - title: Navigation url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-navigation-feature.html - title: Product Sets @@ -1168,12 +1186,6 @@ entries: url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-tax-feature.html - title: Merchant Portal - Marketplace Merchant Portal Product Offer Management url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.html - - title: Merchant Switcher - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-feature.html - - title: Merchant Switcher + Customer Account Management - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-customer-account-management-feature.html - - title: Merchant Switcher + Wishlist - url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-wishlist-feature.html - title: Install Glue API nested: - title: Marketplace Merchant @@ -1229,8 +1241,6 @@ entries: url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-modules.html - title: Create Gui table filter types url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-table-filter-types.html - - title: Create Gui table column types - url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-table-column-types.html - title: Create Gui tables url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-tables.html - title: Extend Gui tables @@ -1685,310 +1695,304 @@ entries: include_versions: - "202212.0" nested: - - title: Spryker Pay + - title: Payments feature overview + url: /docs/pbc/all/payment-service-provider/payments-feature-overview.html + - title: Install and upgrade nested: - - title: Base shop + - title: Install features nested: - - title: Payments feature overview - url: /docs/pbc/all/payment-service-provider/spryker-pay/base-shop/payments-feature-overview.html - - title: Install and upgrade - nested: - - title: Install features - nested: - - title: Payments - url: /docs/pbc/all/payment-service-provider/spryker-pay/base-shop/install-and-upgrade/install-the-payments-feature.html - - title: Install Glue APIs - nested: - - title: Payments - url: /docs/pbc/all/payment-service-provider/spryker-pay/base-shop/install-and-upgrade/install-the-payments-glue-api.html - - title: Upgrade modules - nested: - - title: Payment - url: /docs/pbc/all/payment-service-provider/spryker-pay/base-shop/install-and-upgrade/upgrade-the-payment-module.html - - title: Import and export data - url: /docs/pbc/all/payment-service-provider/spryker-pay/base-shop/import-and-export-data/payment-service-provider-data-import-and-export.html - nested: - - title: File details - payment_method.csv - url: /docs/pbc/all/payment-service-provider/spryker-pay/base-shop/import-and-export-data/import-file-details-payment-method.csv.html - - title: File details - payment_method_store.csv - url: /docs/pbc/all/payment-service-provider/spryker-pay/base-shop/import-and-export-data/import-file-details-payment-method-store.csv.html - - title: Manage in the Back Office - url: /docs/pbc/all/payment-service-provider/spryker-pay/base-shop/manage-in-the-back-office/log-into-the-back-office.html - nested: - - title: Edit payment methods - url: /docs/pbc/all/payment-service-provider/spryker-pay/base-shop/manage-in-the-back-office/edit-payment-methods.html - - title: View payment methods - url: /docs/pbc/all/payment-service-provider/spryker-pay/base-shop/manage-in-the-back-office/view-payment-methods.html - - title: Hydrate payment methods for an order - url: /docs/pbc/all/payment-service-provider/spryker-pay/base-shop/hydrate-payment-methods-for-an-order.html - - title: Interact with third party payment providers using Glue API - url: /docs/pbc/all/payment-service-provider/spryker-pay/base-shop/interact-with-third-party-payment-providers-using-glue-api.html - - title: "Payments feature: Domain model and relationships" - url: /docs/pbc/all/payment-service-provider/spryker-pay/base-shop/payments-feature-domain-model-and-relationships.html - - title: Domain model and relationships - url: /docs/pbc/all/payment-service-provider/unzer/unzer-domain-model-and-relationships.html - - title: Marketplace + - title: Payments + url: /docs/pbc/all/payment-service-provider/install-and-upgrade/install-the-payments-feature.html + - title: Install Glue APIs nested: - - title: Install Marketplace Dummy Payment - url: /docs/pbc/all/payment-service-provider/spryker-pay/marketplace/install-marketplace-dummy-payment.html - - - title: Adyen - url: /docs/pbc/all/payment-service-provider/adyen/adyen.html - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/adyen/install-and-configure-adyen.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/adyen/integrate-adyen.html - - title: Integrate payment methods - url: /docs/pbc/all/payment-service-provider/adyen/integrate-adyen-payment-methods.html - - title: Enable filtering of payment methods - url: /docs/pbc/all/payment-service-provider/adyen/enable-filtering-of-payment-methods-for-adyen.html - - - title: Afterpay - url: /docs/pbc/all/payment-service-provider/afterpay/afterpay.html - nested: - - title: Install and configure Afterpay - url: /docs/pbc/all/payment-service-provider/afterpay/install-and-configure-afterpay.html - - title: Integrate Afterpay - url: /docs/pbc/all/payment-service-provider/afterpay/integrate-afterpay.html - - title: Amazon Pay - url: /docs/pbc/all/payment-service-provider/amazon-pay/amazon-pay.html - nested: - - title: Configure Amazon Pay - url: /docs/pbc/all/payment-service-provider/amazon-pay/configure-amazon-pay.html - - title: Obtain an Amazon Order Reference and information about shipping addresses - url: /docs/pbc/all/payment-service-provider/amazon-pay/obtain-an-amazon-order-reference-and-information-about-shipping-addresses.html - - title: Sandbox Simulations - url: /docs/pbc/all/payment-service-provider/amazon-pay/amazon-pay-sandbox-simulations.html - - title: State machine - url: /docs/pbc/all/payment-service-provider/amazon-pay/amazon-pay-state-machine.html - - title: Handling orders with Amazon Pay API - url: /docs/pbc/all/payment-service-provider/amazon-pay/handling-orders-with-amazon-pay-api.html - - - title: Arvato - url: /docs/pbc/all/payment-service-provider/arvato/arvato.html - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/arvato/install-and-configure-arvato.html - - title: Risk Check - url: /docs/pbc/all/payment-service-provider/arvato/arvato-risk-check.html - - title: Store Order - url: /docs/pbc/all/payment-service-provider/arvato/arvato-store-order.html - - - title: Billie - url: /docs/pbc/all/payment-service-provider/billie.html - - title: Billpay - url: /docs/pbc/all/payment-service-provider/billpay/billpay.html + - title: Payments + url: /docs/pbc/all/payment-service-provider/install-and-upgrade/install-the-payments-glue-api.html + - title: Upgrade modules + nested: + - title: Payment + url: /docs/pbc/all/payment-service-provider/install-and-upgrade/upgrade-the-payment-module.html + - title: Import and export data + url: /docs/pbc/all/payment-service-provider/import-and-export-data/import-and-export-payment-service-provider-data.html nested: - - title: Integrate - url: /docs/pbc/all/payment-service-provider/billpay/integrate-billpay.html - - title: Switch invoice payments to a preauthorize mode - url: /docs/pbc/all/payment-service-provider/billpay/billpay-switch-invoice-payments-to-a-preauthorize-mode.html - - title: Braintree - url: /docs/pbc/all/payment-service-provider/braintree/braintree.html + - title: File details - payment_method.csv + url: /docs/pbc/all/payment-service-provider/import-and-export-data/file-details-payment-method.csv.html + - title: File details - payment_method_store.csv + url: /docs/pbc/all/payment-service-provider/import-and-export-data/file-details-payment-method-store.csv.html + - title: Manage in the Back Office + url: /docs/pbc/all/payment-service-provider/manage-in-the-back-office/log-into-the-back-office.html + include_versions: + - "202204.0" + - "202212.0" nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/braintree/install-and-configure-braintree.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/braintree/integrate-braintree.html - - title: Performing requests - url: /docs/pbc/all/payment-service-provider/braintree/braintree-performing-requests.html - - title: Request workflow - url: /docs/pbc/all/payment-service-provider/braintree/braintree-request-workflow.html - - title: Payone + - title: Edit payment methods + url: /docs/pbc/all/payment-service-provider/manage-in-the-back-office/edit-payment-methods.html + - title: View payment methods + url: /docs/pbc/all/payment-service-provider/manage-in-the-back-office/view-payment-methods.html + - title: Hydrate payment methods for an order + url: /docs/pbc/all/payment-service-provider/hydrate-payment-methods-for-an-order.html + - title: Interact with third party payment providers using Glue API + url: /docs/pbc/all/payment-service-provider/interact-with-third-party-payment-providers-using-glue-api.html + - title: "Payments feature: Domain model and relationships" + url: /docs/pbc/all/payment-service-provider/payments-feature-domain-model-and-relationships.html + - title: Third-party integrations + url: /docs/pbc/all/payment-service-provider/third-party-integrations/payment-service-provider-integrations.html + include_versions: + - "202212.0" nested: - - title: Integration in the Back Office - url: /docs/pbc/all/payment-service-provider/payone/integration-in-the-back-office/payone-integration-in-the-back-office.html + - title: Adyen + url: /docs/pbc/all/payment-service-provider/third-party-integrations/adyen/adyen.html nested: + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/third-party-integrations/adyen/install-and-configure-adyen.html - title: Integrate - url: /docs/pbc/all/payment-service-provider/payone/integration-in-the-back-office/integrate-payone.html - - title: Disconnect - url: /docs/pbc/all/payment-service-provider/payone/integration-in-the-back-office/disconnect-payone.html - - title: Manual integration - url: /docs/pbc/all/payment-service-provider/payone/manual-integration/payone-manual-integration.html + url: /docs/pbc/all/payment-service-provider/third-party-integrations/adyen/integrate-adyen.html + - title: Integrate payment methods + url: /docs/pbc/all/payment-service-provider/third-party-integrations/adyen/integrate-adyen-payment-methods.html + - title: Enable filtering of payment methods + url: /docs/pbc/all/payment-service-provider/third-party-integrations/adyen/enable-filtering-of-payment-methods-for-adyen.html + - title: Afterpay + url: /docs/pbc/all/payment-service-provider/third-party-integrations/afterpay/afterpay.html + nested: + - title: Install and configure Afterpay + url: /docs/pbc/all/payment-service-provider/third-party-integrations/afterpay/install-and-configure-afterpay.html + - title: Integrate Afterpay + url: /docs/pbc/all/payment-service-provider/third-party-integrations/afterpay/integrate-afterpay.html + - title: Amazon Pay + url: /docs/pbc/all/payment-service-provider/third-party-integrations/amazon-pay/amazon-pay.html + nested: + - title: Configure Amazon Pay + url: /docs/pbc/all/payment-service-provider/third-party-integrations/amazon-pay/configure-amazon-pay.html + - title: Obtain an Amazon Order Reference and information about shipping addresses + url: /docs/pbc/all/payment-service-provider/third-party-integrations/amazon-pay/obtain-an-amazon-order-reference-and-information-about-shipping-addresses.html + - title: Sandbox Simulations + url: /docs/pbc/all/payment-service-provider/third-party-integrations/amazon-pay/amazon-pay-sandbox-simulations.html + - title: State machine + url: /docs/pbc/all/payment-service-provider/third-party-integrations/amazon-pay/amazon-pay-state-machine.html + - title: Handling orders with Amazon Pay API + url: /docs/pbc/all/payment-service-provider/third-party-integrations/amazon-pay/handling-orders-with-amazon-pay-api.html + - title: Arvato + url: /docs/pbc/all/payment-service-provider/third-party-integrations/arvato/arvato.html nested: - - title: Integrate - url: /docs/pbc/all/payment-service-provider/payone/manual-integration/integrate-payone.html - - title: Cash on Delivery - url: /docs/pbc/all/payment-service-provider/payone/manual-integration/payone-cash-on-delivery.html - - title: PayPal Express Checkout payment - url: /docs/pbc/all/payment-service-provider/payone/manual-integration/payone-paypal-express-checkout-payment.html - - title: Risk Check and Address Check - url: /docs/pbc/all/payment-service-provider/payone/manual-integration/payone-risk-check-and-address-check.html - - title: Computop - url: /docs/pbc/all/payment-service-provider/computop/computop.html - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/computop/install-and-configure-computop.html - - title: OMS plugins - url: /docs/pbc/all/payment-service-provider/computop/computop-oms-plugins.html - - title: API calls - url: /docs/pbc/all/payment-service-provider/computop/computop-api-calls.html - - title: Integrate payment methods - nested: - - title: Sofort - url: /docs/pbc/all/payment-service-provider/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html - - title: PayPal - url: /docs/pbc/all/payment-service-provider/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html - - title: Easy - url: /docs/pbc/all/payment-service-provider/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html - - title: CRIF - url: /docs/pbc/all/payment-service-provider/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.html - - title: iDeal - url: /docs/pbc/all/payment-service-provider/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html - - title: PayNow - url: /docs/pbc/all/payment-service-provider/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html - - title: Сredit Сard - url: /docs/pbc/all/payment-service-provider/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html - - title: Direct Debit - url: /docs/pbc/all/payment-service-provider/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html - - title: Paydirekt - url: /docs/pbc/all/payment-service-provider/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/computop/integrate-computop.html - - title: CrefoPay - url: /docs/pbc/all/payment-service-provider/crefopay/crefopay.html - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/crefopay/install-and-configure-crefopay.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/crefopay/integrate-crefopay.html - - title: Enable B2B payments - url: /docs/pbc/all/payment-service-provider/crefopay/crefopay-enable-b2b-payments.html - - title: Callbacks - url: /docs/pbc/all/payment-service-provider/crefopay/crefopay-callbacks.html - - title: Notifications - url: /docs/pbc/all/payment-service-provider/crefopay/crefopay-notifications.html - - title: Capture and refund processes - url: /docs/pbc/all/payment-service-provider/crefopay/crefopay-capture-and-refund-processes.html - - title: Payment methods - url: /docs/pbc/all/payment-service-provider/crefopay/crefopay-payment-methods.html - - title: Heidelpay - url: /docs/pbc/all/payment-service-provider/heidelpay/heidelpay.html - nested: - - title: Install - url: /docs/pbc/all/payment-service-provider/heidelpay/install-heidelpay.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/heidelpay/integrate-heidelpay.html - - title: Configure - url: /docs/pbc/all/payment-service-provider/heidelpay/configure-heidelpay.html - - title: Integrate payment methods - nested: - - title: Sofort - url: /docs/pbc/all/payment-service-provider/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-sofort-payment-method-for-heidelpay.html - - title: Invoice Secured B2C - url: /docs/pbc/all/payment-service-provider/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-invoice-secured-b2c-payment-method-for-heidelpay.html - - title: iDeal - url: /docs/pbc/all/payment-service-provider/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-ideal-payment-method-for-heidelpay.html - - title: Easy Credit - url: /docs/pbc/all/payment-service-provider/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html - - title: Direct Debit - url: /docs/pbc/all/payment-service-provider/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html - - title: Split-payment Marketplace - url: /docs/pbc/all/payment-service-provider/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.html - - title: Paypal Debit - url: /docs/pbc/all/payment-service-provider/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-debit-payment-method-for-heidelpay.html - - title: Paypal Authorize - url: /docs/pbc/all/payment-service-provider/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html - - title: Credit Card Secure - url: /docs/pbc/all/payment-service-provider/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html - - title: Workflow for errors - url: /docs/pbc/all/payment-service-provider/heidelpay/heidelpay-workflow-for-errors.html - - title: OMS workflow - url: /docs/pbc/all/payment-service-provider/heidelpay/heidelpay-oms-workflow.html - - title: Klarna - url: /docs/pbc/all/payment-service-provider/klarna/klarna.html - nested: - - title: Invoice Pay in 14 days - url: /docs/pbc/all/payment-service-provider/klarna/klarna-invoice-pay-in-14-days.html - - title: Part Payment Flexible - url: /docs/pbc/all/payment-service-provider/klarna/klarna-part-payment-flexible.html - - title: Payment workflow - url: /docs/pbc/all/payment-service-provider/klarna/klarna-payment-workflow.html - - title: State machine commands and conditions - url: /docs/pbc/all/payment-service-provider/klarna/klarna-state-machine-commands-and-conditions.html - - title: Payolution - url: /docs/pbc/all/payment-service-provider/payolution/payolution.html - nested: - - title: Install and configure Payolution - url: /docs/pbc/all/payment-service-provider/payolution/install-and-configure-payolution.html - - title: Integrate Payolution - url: /docs/pbc/all/payment-service-provider/payolution/integrate-payolution.html - - title: Integrate the invoice paymnet method - url: /docs/pbc/all/payment-service-provider/payolution/integrate-the-invoice-payment-method-for-payolution.html - - title: Integrate the installment payment method for - url: /docs/pbc/all/payment-service-provider/payolution/integrate-the-installment-payment-method-for-payolution.html - - title: Performing requests - url: /docs/pbc/all/payment-service-provider/payolution/payolution-performing-requests.html - - title: Payolution request flow - url: /docs/pbc/all/payment-service-provider/payolution/payolution-request-flow.html - - title: ratenkauf by easyCredit - url: /docs/pbc/all/payment-service-provider/ratenkauf-by-easycredit/ratenkauf-by-easycredit.html - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/ratenkauf-by-easycredit/install-and-configure-ratenkauf-by-easycredit.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/ratenkauf-by-easycredit/integrate-ratenkauf-by-easycredit.html - - title: Powerpay - url: /docs/pbc/all/payment-service-provider/powerpay.html - - title: RatePay - url: /docs/pbc/all/payment-service-provider/ratepay/ratepay.html - nested: - - title: Facade methods - url: /docs/pbc/all/payment-service-provider/ratepay/ratepay-facade-methods.html - - title: Payment workflow - url: /docs/pbc/all/payment-service-provider/ratepay/ratepay-payment-workflow.html - - title: Disable address updates from the backend application - url: /docs/pbc/all/payment-service-provider/ratepay/disable-address-updates-from-the-backend-application-for-ratepay.html - - title: State machine commands and conditions - url: /docs/pbc/all/payment-service-provider/ratepay/ratepay-state-machine-commands-and-conditions.html - - title: Core module structure diagram - url: /docs/pbc/all/payment-service-provider/ratepay/ratepay-core-module-structure-diagram.html - - title: State machines - url: /docs/pbc/all/payment-service-provider/ratepay/ratepay-state-machines.html - - title: Integrate payment methods + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/third-party-integrations/arvato/install-and-configure-arvato.html + - title: Risk Check + url: /docs/pbc/all/payment-service-provider/third-party-integrations/arvato/arvato-risk-check.html + - title: Store Order + url: /docs/pbc/all/payment-service-provider/third-party-integrations/arvato/arvato-store-order.html + - title: Billie + url: /docs/pbc/all/payment-service-provider/third-party-integrations/billie.html + - title: Billpay + url: /docs/pbc/all/payment-service-provider/third-party-integrations/billpay/billpay.html nested: - - title: Direct Debit - url: /docs/pbc/all/payment-service-provider/ratepay/integrate-payment-methods-for-ratepay/integrate-the-direct-debit-payment-method-for-ratepay.html - - title: Prepayment - url: /docs/pbc/all/payment-service-provider/ratepay/integrate-payment-methods-for-ratepay/integrate-the-prepayment-payment-method-for-ratepay.html - - title: Installment - url: /docs/pbc/all/payment-service-provider/ratepay/integrate-payment-methods-for-ratepay/integrate-the-installment-payment-method-for-ratepay.html - - title: Invoice - url: /docs/pbc/all/payment-service-provider/ratepay/integrate-payment-methods-for-ratepay/integrate-the-invoice-payment-method-for-ratepay.html - - title: Unzer - url: /docs/pbc/all/payment-service-provider/unzer/unzer.html - nested: - - title: Install + - title: Integrate + url: /docs/pbc/all/payment-service-provider/third-party-integrations/billpay/integrate-billpay.html + - title: Switch invoice payments to a preauthorize mode + url: /docs/pbc/all/payment-service-provider/third-party-integrations/billpay/billpay-switch-invoice-payments-to-a-preauthorize-mode.html + - title: Braintree + url: /docs/pbc/all/payment-service-provider/third-party-integrations/braintree/braintree.html nested: - title: Install and configure - url: /docs/pbc/all/payment-service-provider/unzer/install-unzer/install-and-configure-unzer.html + url: /docs/pbc/all/payment-service-provider/third-party-integrations/braintree/install-and-configure-braintree.html - title: Integrate - url: /docs/pbc/all/payment-service-provider/unzer/install-unzer/integrate-unzer.html - - title: Integrate Glue API - url: /docs/pbc/all/payment-service-provider/unzer/install-unzer/integrate-unzer-glue-api.html - - title: Use cases, HowTos, and tips - nested: - - title: Refund shipping costs - url: /docs/pbc/all/payment-service-provider/unzer/howto-tips-use-cases/refund-shipping-costs.html - - title: Understand how payment methods are displayed in the checkout process - url: /docs/pbc/all/payment-service-provider/unzer/howto-tips-use-cases/understand-payment-method-in-checkout-process.html - - title: Configuration in the Back Office - nested: - - title: Add Unzer standard credentials - url: /docs/pbc/all/payment-service-provider/unzer/configure-in-the-back-office/add-unzer-standard-credentails.html - - title: Add Unzer marketplace credentials - url: /docs/pbc/all/payment-service-provider/unzer/configure-in-the-back-office/add-unzer-marketplace-credentials.html - - title: Extend and Customize - nested: - - title: Implement new payment methods on the project level - url: /docs/pbc/all/payment-service-provider/unzer/extend-and-customize/implement-new-payment-methods-on-the-project-level.html - - title: Customize the credit card display in your payment step - url: /docs/pbc/all/payment-service-provider/unzer/extend-and-customize/customize-the-credit-card-display-in-your-payment-step.html - - - - + url: /docs/pbc/all/payment-service-provider/third-party-integrations/braintree/integrate-braintree.html + - title: Performing requests + url: /docs/pbc/all/payment-service-provider/third-party-integrations/braintree/braintree-performing-requests.html + - title: Request workflow + url: /docs/pbc/all/payment-service-provider/third-party-integrations/braintree/braintree-request-workflow.html + - title: Payone + nested: + - title: Integration in the Back Office + url: /docs/pbc/all/payment-service-provider/third-party-integrations/payone/integration-in-the-back-office/payone-integration-in-the-back-office.html + nested: + - title: Integrate + url: /docs/pbc/all/payment-service-provider/third-party-integrations/payone/integration-in-the-back-office/integrate-payone.html + - title: Disconnect + url: /docs/pbc/all/payment-service-provider/third-party-integrations/payone/integration-in-the-back-office/disconnect-payone.html + - title: Manual integration + url: /docs/pbc/all/payment-service-provider/third-party-integrations/payone/manual-integration/payone-manual-integration.html + nested: + - title: Integrate + url: /docs/pbc/all/payment-service-provider/third-party-integrations/payone/manual-integration/integrate-payone.html + - title: Cash on Delivery + url: /docs/pbc/all/payment-service-provider/third-party-integrations/payone/manual-integration/payone-cash-on-delivery.html + - title: PayPal Express Checkout payment + url: /docs/pbc/all/payment-service-provider/third-party-integrations/payone/manual-integration/payone-paypal-express-checkout-payment.html + - title: Risk Check and Address Check + url: /docs/pbc/all/payment-service-provider/third-party-integrations/payone/manual-integration/payone-risk-check-and-address-check.html + - title: Computop + url: /docs/pbc/all/payment-service-provider/third-party-integrations/computop/computop.html + nested: + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/third-party-integrations/computop/install-and-configure-computop.html + - title: OMS plugins + url: /docs/pbc/all/payment-service-provider/third-party-integrations/computop/computop-oms-plugins.html + - title: API calls + url: /docs/pbc/all/payment-service-provider/third-party-integrations/computop/computop-api-calls.html + - title: Integrate payment methods + nested: + - title: Sofort + url: /docs/pbc/all/payment-service-provider/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html + - title: PayPal + url: /docs/pbc/all/payment-service-provider/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html + - title: Easy + url: /docs/pbc/all/payment-service-provider/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html + - title: CRIF + url: /docs/pbc/all/payment-service-provider/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.html + - title: iDeal + url: /docs/pbc/all/payment-service-provider/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html + - title: PayNow + url: /docs/pbc/all/payment-service-provider/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html + - title: Сredit Сard + url: /docs/pbc/all/payment-service-provider/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html + - title: Direct Debit + url: /docs/pbc/all/payment-service-provider/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html + - title: Paydirekt + url: /docs/pbc/all/payment-service-provider/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/third-party-integrations/computop/integrate-computop.html + - title: CrefoPay + url: /docs/pbc/all/payment-service-provider/third-party-integrations/crefopay/crefopay.html + nested: + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/third-party-integrations/crefopay/install-and-configure-crefopay.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/third-party-integrations/crefopay/integrate-crefopay.html + - title: Enable B2B payments + url: /docs/pbc/all/payment-service-provider/third-party-integrations/crefopay/crefopay-enable-b2b-payments.html + - title: Callbacks + url: /docs/pbc/all/payment-service-provider/third-party-integrations/crefopay/crefopay-callbacks.html + - title: Notifications + url: /docs/pbc/all/payment-service-provider/third-party-integrations/crefopay/crefopay-notifications.html + - title: Capture and refund processes + url: /docs/pbc/all/payment-service-provider/third-party-integrations/crefopay/crefopay-capture-and-refund-processes.html + - title: Payment methods + url: /docs/pbc/all/payment-service-provider/third-party-integrations/crefopay/crefopay-payment-methods.html + - title: Heidelpay + url: /docs/pbc/all/payment-service-provider/third-party-integrations/heidelpay/heidelpay.html + nested: + - title: Install + url: /docs/pbc/all/payment-service-provider/third-party-integrations/heidelpay/install-heidelpay.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/third-party-integrations/heidelpay/integrate-heidelpay.html + - title: Configure + url: /docs/pbc/all/payment-service-provider/third-party-integrations/heidelpay/configure-heidelpay.html + - title: Integrate payment methods + nested: + - title: Sofort + url: /docs/pbc/all/payment-service-provider/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-sofort-payment-method-for-heidelpay.html + - title: Invoice Secured B2C + url: /docs/pbc/all/payment-service-provider/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-invoice-secured-b2c-payment-method-for-heidelpay.html + - title: iDeal + url: /docs/pbc/all/payment-service-provider/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-ideal-payment-method-for-heidelpay.html + - title: Easy Credit + url: /docs/pbc/all/payment-service-provider/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html + - title: Direct Debit + url: /docs/pbc/all/payment-service-provider/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html + - title: Split-payment Marketplace + url: /docs/pbc/all/payment-service-provider/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.html + - title: Paypal Debit + url: /docs/pbc/all/payment-service-provider/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-debit-payment-method-for-heidelpay.html + - title: Paypal Authorize + url: /docs/pbc/all/payment-service-provider/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html + - title: Credit Card Secure + url: /docs/pbc/all/payment-service-provider/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html + - title: Workflow for errors + url: /docs/pbc/all/payment-service-provider/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.html + - title: OMS workflow + url: /docs/pbc/all/payment-service-provider/third-party-integrations/heidelpay/heidelpay-oms-workflow.html + - title: Klarna + url: /docs/pbc/all/payment-service-provider/third-party-integrations/klarna/klarna.html + nested: + - title: Invoice Pay in 14 days + url: /docs/pbc/all/payment-service-provider/third-party-integrations/klarna/klarna-invoice-pay-in-14-days.html + - title: Part Payment Flexible + url: /docs/pbc/all/payment-service-provider/third-party-integrations/klarna/klarna-part-payment-flexible.html + - title: Payment workflow + url: /docs/pbc/all/payment-service-provider/third-party-integrations/klarna/klarna-payment-workflow.html + - title: State machine commands and conditions + url: /docs/pbc/all/payment-service-provider/third-party-integrations/klarna/klarna-state-machine-commands-and-conditions.html + - title: Payolution + url: /docs/pbc/all/payment-service-provider/third-party-integrations/payolution/payolution.html + nested: + - title: Install and configure Payolution + url: /docs/pbc/all/payment-service-provider/third-party-integrations/payolution/install-and-configure-payolution.html + - title: Integrate Payolution + url: /docs/pbc/all/payment-service-provider/third-party-integrations/payolution/integrate-payolution.html + - title: Integrate the invoice paymnet method + url: /docs/pbc/all/payment-service-provider/third-party-integrations/payolution/integrate-the-invoice-payment-method-for-payolution.html + - title: Integrate the installment payment method for + url: /docs/pbc/all/payment-service-provider/third-party-integrations/payolution/integrate-the-installment-payment-method-for-payolution.html + - title: Performing requests + url: /docs/pbc/all/payment-service-provider/third-party-integrations/payolution/payolution-performing-requests.html + - title: Payolution request flow + url: /docs/pbc/all/payment-service-provider/third-party-integrations/payolution/payolution-request-flow.html + - title: ratenkauf by easyCredit + url: /docs/pbc/all/payment-service-provider/third-party-integrations/ratenkauf-by-easycredit/ratenkauf-by-easycredit.html + nested: + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/third-party-integrations/ratenkauf-by-easycredit/install-and-configure-ratenkauf-by-easycredit.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/third-party-integrations/ratenkauf-by-easycredit/integrate-ratenkauf-by-easycredit.html + - title: Powerpay + url: /docs/pbc/all/payment-service-provider/third-party-integrations/powerpay.html + - title: RatePay + url: /docs/pbc/all/payment-service-provider/third-party-integrations/ratepay/ratepay.html + nested: + - title: Facade methods + url: /docs/pbc/all/payment-service-provider/third-party-integrations/ratepay/ratepay-facade-methods.html + - title: Payment workflow + url: /docs/pbc/all/payment-service-provider/third-party-integrations/ratepay/ratepay-payment-workflow.html + - title: Disable address updates from the backend application + url: /docs/pbc/all/payment-service-provider/third-party-integrations/ratepay/disable-address-updates-from-the-backend-application-for-ratepay.html + - title: State machine commands and conditions + url: /docs/pbc/all/payment-service-provider/third-party-integrations/ratepay/ratepay-state-machine-commands-and-conditions.html + - title: Core module structure diagram + url: /docs/pbc/all/payment-service-provider/third-party-integrations/ratepay/ratepay-core-module-structure-diagram.html + - title: State machines + url: /docs/pbc/all/payment-service-provider/third-party-integrations/ratepay/ratepay-state-machines.html + - title: Integrate payment methods + nested: + - title: Direct Debit + url: /docs/pbc/all/payment-service-provider/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-direct-debit-payment-method-for-ratepay.html + - title: Prepayment + url: /docs/pbc/all/payment-service-provider/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-prepayment-payment-method-for-ratepay.html + - title: Installment + url: /docs/pbc/all/payment-service-provider/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-installment-payment-method-for-ratepay.html + - title: Invoice + url: /docs/pbc/all/payment-service-provider/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-invoice-payment-method-for-ratepay.html + - title: Unzer + url: /docs/pbc/all/payment-service-provider/third-party-integrations/unzer/unzer.html + nested: + - title: What's changed + url: /docs/pbc/all/payment-service-provider/third-party-integrations/unzer/whats-changed-in-unzer.html + - title: Install + nested: + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/third-party-integrations/unzer/install-unzer/install-and-configure-unzer.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/third-party-integrations/unzer/install-unzer/integrate-unzer.html + - title: Integrate Glue API + url: /docs/pbc/all/payment-service-provider/third-party-integrations/unzer/install-unzer/integrate-unzer-glue-api.html + - title: Use cases, HowTos, and tips + nested: + - title: Refund shipping costs + url: /docs/pbc/all/payment-service-provider/third-party-integrations/unzer/howto-tips-use-cases/refund-shipping-costs.html + - title: Understand how payment methods are displayed in the checkout process + url: /docs/pbc/all/payment-service-provider/third-party-integrations/unzer/howto-tips-use-cases/understand-payment-method-in-checkout-process.html + - title: Configuration in the Back Office + nested: + - title: Add Unzer standard credentials + url: /docs/pbc/all/payment-service-provider/third-party-integrations/unzer/configure-in-the-back-office/add-unzer-standard-credentails.html + - title: Add Unzer marketplace credentials + url: /docs/pbc/all/payment-service-provider/third-party-integrations/unzer/configure-in-the-back-office/add-unzer-marketplace-credentials.html + - title: Extend and Customize + nested: + - title: Implement new payment methods on the project level + url: /docs/pbc/all/payment-service-provider/third-party-integrations/unzer/extend-and-customize/implement-new-payment-methods-on-the-project-level.html + - title: Customize the credit card display in your payment step + url: /docs/pbc/all/payment-service-provider/third-party-integrations/unzer/extend-and-customize/customize-the-credit-card-display-in-your-payment-step.html + - title: Domain model and relationships + url: /docs/pbc/all/payment-service-provider/third-party-integrations/unzer/unzer-domain-model-and-relationships.html - title: Price Management url: /docs/pbc/all/price-management/price-management.html nested: @@ -2620,8 +2624,6 @@ entries: url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-approval-process-feature.html - title: Marketplace Product url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-feature.html - - title: Marketplace Product + Cart - url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-cart-feature.html - title: Marketplace Product + Inventory Management url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-inventory-management-feature.html - title: Marketplace Product + Marketplace Product Offer @@ -2819,7 +2821,6 @@ entries: - title: Install the Product Rating and Reviews Glue API url: /docs/pbc/all/ratings-reviews/install-and-upgrade/install-the-product-rating-and-reviews-glue-api.html - title: Import and export data - url: /docs/pbc/all/ratings-reviews/import-and-export-data/ratings-and-reviews-data-import.html nested: - title: File details- product_review.csv url: /docs/pbc/all/ratings-reviews/import-and-export-data/file-details-product-review.csv.html @@ -3023,12 +3024,11 @@ entries: - title: Search the product catalog url: /docs/pbc/all/search/base-shop/manage-using-glue-api/glue-api-search-the-product-catalog.html - title: Import and export data - url: /docs/pbc/all/search/base-shop/import-and-export-data/search-data-import.html nested: - title: "File details: product_search_attribute_map.csv" - url: /docs/pbc/all/search/base-shop/import-and-export-data/file-details-product-search-attribute-map.csv.html + url: /docs/pbc/all/search/base-shop/import-data/file-details-product-search-attribute-map.csv.html - title: "File details: product_search_attribute.csv" - url: /docs/pbc/all/search/base-shop/import-and-export-data/file-details-product-search-attribute.csv.html + url: /docs/pbc/all/search/base-shop/import-data/file-details-product-search-attribute.csv.html - title: Tutorials and Howtos nested: - title: "Tutorial: Content and search - attribute-cart-based catalog personalization" @@ -3231,16 +3231,15 @@ entries: - title: Retrieve tax sets when retrieving abstract products url: /docs/pbc/all/tax-management/base-shop/manage-using-glue-api/retrieve-tax-sets-when-retrieving-abstract-products.html - title: Import and export data - url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/tax-management-data-import.html - nested: - - title: "Import file details: tax_sets.csv" - url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-tax-sets.csv.html - - title: "Import file details: product_abstract.csv" - url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-product-abstract.csv.html - - title: "Import file details: product_option.csv" - url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-product-option.csv.html - - title: "Import file details: shipment.csv" - url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-shipment.csv.html + nested: + - title: Import tax sets + url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-tax-sets.html + - title: Import tax sets for abstract products + url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-tax-sets-for-abstract-products.html + - title: Import tax sets for product options + url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-tax-sets-for-product-options.html + - title: Import tax sets for shipment methoods + url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-tax-sets-for-shipment-methods.html - title: Extend and customize url: /docs/pbc/all/tax-management/base-shop/extend-and-customize/tax-module-reference-information.html - title: Domain model and relationships @@ -3331,6 +3330,10 @@ entries: url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-inventory-management-feature.html - title: Inventory Management + Alternative Products url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-inventory-management-alternative-products-feature.html + - title: Order Management + Inventory Management + url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-order-management-inventory-management-feature.html + include_versions: + - "202304.0" - title: Availability Notification Glue API url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-availability-notification-glue-api.html - title: Inventory Management Glue API @@ -3351,17 +3354,16 @@ entries: url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stockgui-module.html include_versions: - "202212.0" - - title: Import and export data - url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/warehouse-management-system-data-import.html + - title: Import data nested: - title: File details - warehouse.csv - url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/file-details-warehouse.csv.html + url: /docs/pbc/all/warehouse-management-system/base-shop/import-data/file-details-warehouse.csv.html - title: File details - warehouse_address.csv - url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/file-details-warehouse-address.csv.html + url: /docs/pbc/all/warehouse-management-system/base-shop/import-data/file-details-warehouse-address.csv.html - title: File details - warehouse_store.csv - url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/file-details-warehouse-store.csv.html + url: /docs/pbc/all/warehouse-management-system/base-shop/import-data/file-details-warehouse-store.csv.html - title: File details - product_stock.csv - url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/file-details-product-stock.csv.html + url: /docs/pbc/all/warehouse-management-system/base-shop/import-data/file-details-product-stock.csv.html - title: Manage in the Back Office url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/log-into-the-back-office.html nested: diff --git a/_data/sidebars/scos_dev_sidebar.yml b/_data/sidebars/scos_dev_sidebar.yml index b24cd8e1ca9..1cce9088a4e 100644 --- a/_data/sidebars/scos_dev_sidebar.yml +++ b/_data/sidebars/scos_dev_sidebar.yml @@ -658,105 +658,35 @@ entries: - "202005.0" - "202009.0" - "202108.0" + + + + + + - title: Glue API guides url: /docs/scos/dev/glue-api-guides/glue-api-guides.html nested: - title: Glue REST API url: /docs/scos/dev/glue-api-guides/glue-rest-api.html - include_versions: - - "201811.0" - - "201903.0" - - "201907.0" - - "202001.0" - - "202005.0" - - "202009.0" - - "202108.0" - - "202204.0" - title: Glue Spryks url: /docs/scos/dev/glue-api-guides/glue-spryks.html - - title: Decoupled Glue API - url: /docs/scos/dev/glue-api-guides/decoupled-glue-api.html - include_versions: - - "202212.0" - title: Glue infrastructure url: /docs/scos/dev/glue-api-guides/glue-infrastructure.html - include_versions: - - "201811.0" - - "201903.0" - - "201907.0" - - "202001.0" - - "202005.0" - - "202009.0" - - "202108.0" - - "202204.0" - title: Decoupled Glue infrastructure include_versions: - "202204.0" + - "202212.0" nested: - title: Backend and Storefront API module differences url: /docs/scos/dev/glue-api-guides/decoupled-glue-infrastructure/backend-and-storefront-api-module-differences.html - include_versions: - - "202204.0" - title: Create Glue API applications url: /docs/scos/dev/glue-api-guides/decoupled-glue-infrastructure/create-glue-api-applications.html - include_versions: - - "202204.0" - title: Authentication and authorization url: /docs/scos/dev/glue-api-guides/decoupled-glue-infrastructure/authentication-and-authorization.html - include_versions: - - "202204.0" - title: Security and authentication url: /docs/scos/dev/glue-api-guides/decoupled-glue-infrastructure/security-and-authentication.html - include_versions: - - "202204.0" - - title: Backend and Storefront API module differences - url: /docs/scos/dev/glue-api-guides/backend-and-storefront-api-module-differences.html - include_versions: - - "202212.0" - - title: Create Glue API applications - url: /docs/scos/dev/glue-api-guides/create-glue-api-applications.html - include_versions: - - "202212.0" - - title: Authentication and authorization - url: /docs/scos/dev/glue-api-guides/authentication-and-authorization.html - include_versions: - - "202212.0" - - title: Security and authentication - url: /docs/scos/dev/glue-api-guides/security-and-authentication.html - include_versions: - - "202212.0" - - title: Old Glue infrastructure - include_versions: - - "202212.0" - nested: - - title: Glue REST API - url: /docs/scos/dev/glue-api-guides/old-glue-infrastructure/glue-rest-api.html - include_versions: - - "202212.0" - - title: Glue infrastructure - url: /docs/scos/dev/glue-api-guides/old-glue-infrastructure/glue-infrastructure.html - include_versions: - - "202212.0" - - title: Handling concurrent REST requests and caching with entity tags - url: /docs/scos/dev/glue-api-guides/old-glue-infrastructure/handling-concurrent-rest-requests-and-caching-with-entity-tags.html - include_versions: - - "202212.0" - - title: Resolving search engine friendly URLs - url: /docs/scos/dev/glue-api-guides/old-glue-infrastructure/resolving-search-engine-friendly-urls.html - include_versions: - - "202212.0" - - title: Reference information - GlueApplication errors - url: /docs/scos/dev/glue-api-guides/old-glue-infrastructure/reference-information-glueapplication-errors.html - include_versions: - - "202212.0" - - title: REST API B2B Demo Shop reference - url: /docs/scos/dev/glue-api-guides/old-glue-infrastructure/rest-api-b2b-reference.html - include_versions: - - "202212.0" - - title: REST API B2C Demo Shop reference - url: /docs/scos/dev/glue-api-guides/old-glue-infrastructure/rest-api-b2c-reference.html - include_versions: - - "202212.0" + - title: Routing include_versions: - "202204.0" @@ -768,6 +698,7 @@ entries: url: /docs/scos/dev/glue-api-guides/routing/create-backend-resources.html - title: Create routes url: /docs/scos/dev/glue-api-guides/routing/create-routes.html + - title: Create and change Glue API conventions url: /docs/scos/dev/glue-api-guides/create-and-change-glue-api-conventions.html include_versions: @@ -775,9 +706,6 @@ entries: - "202212.0" - title: Create Glue API authorization strategies url: /docs/scos/dev/glue-api-guides/create-glue-api-authorization-strategies.html - include_versions: - - "202204.0" - - "202212.0" - title: Create Glue API resources with parent-child relationships url: /docs/scos/dev/glue-api-guides/create-glue-api-resources-with-parent-child-relationships.html include_versions: @@ -805,21 +733,8 @@ entries: - "202212.0" - title: Handling concurrent REST requests and caching with entity tags url: /docs/scos/dev/glue-api-guides/handling-concurrent-rest-requests-and-caching-with-entity-tags.html - include_versions: - - "201907.0" - - "202001.0" - - "202005.0" - - "202009.0" - - "202108.0" - - "202204.0" - title: Resolving search engine friendly URLs url: /docs/scos/dev/glue-api-guides/resolving-search-engine-friendly-urls.html - include_versions: - - "202001.0" - - "202005.0" - - "202009.0" - - "202108.0" - - "202204.0" - title: Use authentication servers with Glue API url: /docs/scos/dev/glue-api-guides/use-authentication-servers-with-glue-api.html include_versions: @@ -869,14 +784,17 @@ entries: - "202009.0" - "202108.0" - "202204.0" + - "202212.0" - title: REST API B2C Demo Shop reference url: /docs/scos/dev/glue-api-guides/rest-api-b2c-reference.html include_versions: - "202204.0" + - "202212.0" - title: REST API B2B Demo Shop reference url: /docs/scos/dev/glue-api-guides/rest-api-b2b-reference.html include_versions: - "202204.0" + - "202212.0" - title: Managing customers url: /docs/scos/dev/glue-api-guides/managing-customers/managing-customers.html include_versions: @@ -888,25 +806,14 @@ entries: - "202009.0" - "202108.0" - "202204.0" - nested: - - title: Managing customer addresses - url: /docs/scos/dev/glue-api-guides/managing-customers/managing-customer-addresses.html - include_versions: - - "202009.0" - - "202108.0" - - "202204.0" - - title: Retrieving customer orders - url: /docs/scos/dev/glue-api-guides/managing-customers/retrieving-customer-orders.html - include_versions: - - "201811.0" - - "201903.0" - - "202005.0" - - "202009.0" - - "202108.0" - - "202204.0" - title: Managing B2B account - url: /docs/scos/dev/glue-api-guides/managing-b2b-account/managing-b2b-account.html + url: /docs/scos/dev/glue-api-guidesmanaging-b2b-account/managing-b2b-account.html include_versions: + - "201907.0" + - "202001.0" + - "202005.0" + - "202009.0" + - "202108.0" - "202204.0" nested: - title: Searching by company users @@ -921,20 +828,14 @@ entries: url: /docs/scos/dev/glue-api-guides/managing-b2b-account/retrieving-company-roles.html - title: Retrieving business unit addresses url: /docs/scos/dev/glue-api-guides/managing-b2b-account/retrieving-business-unit-addresses.html - - title: Retrieving store configuration - url: /docs/scos/dev/glue-api-guides/retrieving-store-configuration.html - include_versions: - - "201811.0" - - "201903.0" - - "201907.0" - - "202001.0" - - "202005.0" - - "202009.0" - - "202108.0" - - "202204.0" + + - title: Retrieve related products url: /docs/scos/dev/glue-api-guides/retrieve-related-products.html include_versions: + - "202009.0" + - "201907.0" + - "202108.0" - "202204.0" - title: Searching the product catalog url: /docs/scos/dev/glue-api-guides/searching-the-product-catalog.html @@ -957,6 +858,13 @@ entries: - "201907.0" - "202108.0" - "202204.0" + + + + + + + - title: Feature integration guides url: /docs/scos/dev/feature-integration-guides/feature-integration-guides.html nested: @@ -2953,10 +2861,6 @@ entries: - "202108.0" - "202204.0" - "202212.0" - - title: Marketplace data import - url: /docs/scos/dev/data-import/marketplace-data-import.html - include_versions: - - "202212.0" - title: "Tutorial: Replace a default data importer with the queue data importer" url: /docs/scos/dev/data-import/tutorial-replace-a-default-data-importer-with-the-queue-data-importer.html include_versions: @@ -3483,18 +3387,11 @@ entries: url: /docs/scos/dev/migration-concepts/silex-replacement/migrate-modules/migrate-the-validator-module.html - title: WebProfiler url: /docs/scos/dev/migration-concepts/silex-replacement/migrate-modules/migrate-the-webprofiler-module.html - - title: Update to Angular 12 - url: /docs/scos/dev/migration-concepts/upgrade-to-angular-12.html - - title: Update to Angular 15 - url: /docs/scos/dev/migration-concepts/upgrade-to-angular-15.html - - title: Upgrade to Marketplace - url: /docs/scos/dev/migration-concepts/upgrade-to-marketplace.html - title: Migrate to Docker url: /docs/scos/dev/migration-concepts/migrate-to-docker/migrate-to-docker.html nested: - title: Adjust Jenkins for a Docker environment url: /docs/scos/dev/migration-concepts/migrate-to-docker/adjust-jenkins-for-a-docker-environment.html - - title: - title: The Docker SDK url: /docs/scos/dev/the-docker-sdk/the-docker-sdk.html include_versions: @@ -3924,11 +3821,6 @@ entries: url: /docs/scos/dev/tutorials-and-howtos/howtos/howto-allow-zed-css-js-on-a-project-for-oryx-for-zed-2.13.0-and-later.html - title: "HowTo: Reduce Jenkins execution by up to 80% without P&S and Data importers refactoring" url: /docs/scos/dev/tutorials-and-howtos/howtos/howto-reduce-jenkins-execution-by-up-to-80-percent-without-ps-and-data-import-refactoring.html - - title: "HowTo: Create an Angular module with application" - url: /docs/scos/dev/tutorials-and-howtos/howtos/howto-create-an-angular-module-with-application.html - - title: "HowTo: Split products by stores" - url: /docs/scos/dev/tutorials-and-howtos/howtos/howto-split-products-by-stores.html - - title: Technology partner guides url: /docs/scos/dev/technology-partner-guides/technology-partner-guides.html include_versions: @@ -4811,4 +4703,4 @@ entries: url: /docs/scos/dev/updating-spryker/troubleshooting-updates.html - title: Code contribution guide url: /docs/scos/dev/code-contribution-guide.html -... \ No newline at end of file +... diff --git a/_data/sidebars/scos_user_sidebar.yml b/_data/sidebars/scos_user_sidebar.yml index 02900a12eda..d488f0d5a5c 100644 --- a/_data/sidebars/scos_user_sidebar.yml +++ b/_data/sidebars/scos_user_sidebar.yml @@ -104,6 +104,8 @@ entries: nested: - title: How Spryker Support works url: /docs/scos/user/intro-to-spryker/support/how-spryker-support-works.html + - title: Handling new feature requests + url: /docs/scos/user/intro-to-spryker/support/handling-new-feature-requests.html - title: Case escalation url: /docs/scos/user/intro-to-spryker/support/case-escalation.html - title: Getting support diff --git a/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-checkout-glue-api.md b/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-checkout-glue-api.md index a15d86b4a0f..9a5a3c0ca60 100644 --- a/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-checkout-glue-api.md +++ b/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-checkout-glue-api.md @@ -16,7 +16,7 @@ To start feature integration, overview and install the necessary features: | Glue API: Spryker Core | {{page.version}} | [Glue API: Spryker Core feature integration](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html) | | Glue API: Cart | {{page.version}} | [Install the Cart Glue API](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-cart-glue-api.html) | | Glue API: Customer Account Management | {{page.version}} | [Install the Customer Account Management Glue API](/docs/pbc/all/identity-access-management/{{page.version}}/install-and-upgrade/install-the-customer-account-management-glue-api.html) | -| Glue API: Payments | {{page.version}} | [Glue API: Payments feature integration](/docs/pbc/all/payment-service-provider/{{page.version}}/spryker-pay/base-shop/install-and-upgrade/install-the-payments-glue-api.html) | +| Glue API: Payments | {{page.version}} | [Glue API: Payments feature integration](/docs/pbc/all/payment-service-provider/{{page.version}}/install-and-upgrade/install-the-payments-glue-api.html) | | Glue API: Shipment | {{page.version}} | [Integrate the Shipment Glue API](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/install-and-upgrade/install-the-shipment-glue-api.html) | ### 1) Install the required modules using Composer @@ -545,7 +545,7 @@ Ensure that `GuestCartByRestCheckoutDataResourceRelationshipPlugin` is set up co {% endinfo_block %} -For more details, see [Implementing Checkout Steps for Glue API](/docs/pbc/all/payment-service-provider/{{page.version}}/spryker-pay/base-shop/interact-with-third-party-payment-providers-using-glue-api.html). +For more details, see [Implementing Checkout Steps for Glue API](/docs/pbc/all/payment-service-provider/{{page.version}}/interact-with-third-party-payment-providers-using-glue-api.html). #### Configure mapping @@ -879,4 +879,4 @@ Integrate the following related features. | FEATURE | REQUIRED FOR THE CURRENT FEATURE | INTEGRATION GUIDE | | -------- | ----------------- | ---------------------- | | Glue API: Shipment | ✓ | [Glue API: Shipment feature integration](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/install-and-upgrade/install-the-shipment-glue-api.html) | -| Glue API: Payments | ✓ | [Glue API: Payments feature integration](/docs/pbc/all/payment-service-provider/{{page.version}}/spryker-pay/base-shop/install-and-upgrade/install-the-payments-glue-api.html) | +| Glue API: Payments | ✓ | [Glue API: Payments feature integration](/docs/pbc/all/payment-service-provider/{{page.version}}/install-and-upgrade/install-the-payments-glue-api.html) | diff --git a/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-order-management-glue-api.md b/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-order-management-glue-api.md index b7efee899eb..7e490fffffe 100644 --- a/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-order-management-glue-api.md +++ b/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-order-management-glue-api.md @@ -69,7 +69,7 @@ Activate the following plugins: {% info_block infoBox %} -`OrdersResourceRoutePlugin` GET verb is a protected resource. For more details, see the `configure` function [Resource routing](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastucture/glue-infrastructure.html#resource-routing). +`OrdersResourceRoutePlugin` GET verb is a protected resource. For more details, see the `configure` function [Resource routing](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-infrastructure.html#resource-routing). {% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-payments-glue-api.md b/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-payments-glue-api.md index a98f85fe2b8..f118fa6db6f 100644 --- a/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-payments-glue-api.md +++ b/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-payments-glue-api.md @@ -18,7 +18,7 @@ To start the feature integration, overview and install the necessary features: | NAME | VERSION | INTEGRATION GUIDE | | --- | --- | --- | | Spryker Core | {{page.version}} | [Glue Application feature integration](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html) | -| Payments | {{page.version}} | [Payments feature integration](/docs/pbc/all/payment-service-provider/{{page.version}}/spryker-pay/base-shop/install-and-upgrade/install-the-payments-feature.html) | +| Payments | {{page.version}} | [Payments feature integration](/docs/pbc/all/payment-service-provider/{{page.version}}/install-and-upgrade/install-the-payments-feature.html) | ## 1) Install the required modules using Composer diff --git a/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-shared-carts-glue-api.md b/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-shared-carts-glue-api.md index ed471760667..cc9f8dc47b2 100644 --- a/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-shared-carts-glue-api.md +++ b/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-shared-carts-glue-api.md @@ -109,7 +109,7 @@ The result should be 0 records. * `CartPermissionGroupsResourceRoutePlugin` is a protected resource for the `GET` request. -For more details, see the `configure` function in [Resource Routing](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastucture/glue-infrastructure.html#resource-routing). +For more details, see the `configure` function in [Resource Routing](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-infrastructure.html#resource-routing). {% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-shopping-lists-glue-api.md b/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-shopping-lists-glue-api.md index 33d4391aa57..dfd1941de5d 100644 --- a/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-shopping-lists-glue-api.md +++ b/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-shopping-lists-glue-api.md @@ -108,7 +108,7 @@ SELECT COUNT(*) FROM spy_shopping_list_item WHERE uuid IS NULL; {% info_block infoBox %} -`ShoppingListsResourcePlugin` GET, POST, PATCH and DELETE, `ShoppingListItemsResourcePlugin` POST, PATCH and DELETE verbs are protected resources. For details, refer to the Configure section of [Glue Infrastructure documentation](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastucture/glue-infrastructure.html#resource-routing). +`ShoppingListsResourcePlugin` GET, POST, PATCH and DELETE, `ShoppingListItemsResourcePlugin` POST, PATCH and DELETE verbs are protected resources. For details, refer to the Configure section of [Glue Infrastructure documentation](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-infrastructure.html#resource-routing). {% endinfo_block %} diff --git a/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/marketplace/install-marketplace-dummy-payment.md b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-dummy-payment-feature.md similarity index 96% rename from docs/pbc/all/payment-service-provider/202212.0/spryker-pay/marketplace/install-marketplace-dummy-payment.md rename to _includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-dummy-payment-feature.md index 3e57b43ceb0..189485dd66a 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/marketplace/install-marketplace-dummy-payment.md +++ b/_includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-dummy-payment-feature.md @@ -1,9 +1,4 @@ ---- -title: Install Marketplace Dummy Payment -last_updated: Oct 05, 2021 -description: This document describes the process how to integrate the Marketplace Dummy Payment into a Spryker project. -template: feature-integration-guide-template ---- + This document describes how to integrate the Marketplace Dummy Payment into a Spryker project. @@ -18,7 +13,7 @@ To start feature integration, integrate the required features: | NAME | VERSION | INTEGRATION GUIDE | | - | - | - | | Spryker Core | {{page.version}} | [Spryker Core feature integration](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | -| Payments | {{page.version}} | [Payments feature integration](/docs/pbc/all/payment-service-provider/{{page.version}}/spryker-pay/base-shop/install-and-upgrade/install-the-payments-feature.html) | +| Payments | {{page.version}} | [Payments feature integration](/docs/pbc/all/payment-service-provider/{{page.version}}/install-and-upgrade/install-the-payments-feature.html) | | Checkout | {{page.version}} | [Install the Checkout feature](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-checkout-feature.html) | Marketplace Merchant | {{page.version}} | [Marketplace Merchant feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.html) | Marketplace Order Management | {{page.version}} | [Marketplace Order Management feature integration](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/install-features/install-the-marketplace-order-management-feature.html) diff --git a/_includes/pbc/all/install-features/202304.0/install-glue-api/install-the-product-rating-and-reviews-glue-api.md b/_includes/pbc/all/install-features/202304.0/install-glue-api/install-the-product-rating-and-reviews-glue-api.md deleted file mode 100644 index a46bd7b851d..00000000000 --- a/_includes/pbc/all/install-features/202304.0/install-glue-api/install-the-product-rating-and-reviews-glue-api.md +++ /dev/null @@ -1,614 +0,0 @@ - - -This document describes how to integrate the [Product Raiting and Reviews](/docs/pbc/all/ratings-reviews/{{page.version}}/ratings-and-reviews.html) Glue API feature into a Spryker project. - -## Install feature core - -Follow the steps below to install the Product Raiting and Review Glue API feature core. - - -### Prerequisites - -To start feature integration, integrate the required features and Glue APIs: - -| NAME | VERSION | INTEGRATION GUIDE | -| --- | --- | --- | -| Spryker Core Glue API | {{page.version}} | [Install the Spryker Core Glue API](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-spryker-core-feature-integration.html) | -| Product Rating & Reviews | {{page.version}} | [Install the Product Rating and Reviews feature](/docs/pbc/all/ratings-reviews/{{page.version}}/install-and-upgrade/install-the-product-rating-and-reviews-feature.html) | - -### 1) Install the required modules using Composer - -```bash -composer require spryker/product-reviews-rest-api:"^1.1.0" --update-with-dependencies -``` -{% info_block warningBox "Verification" %} - -Make sure that the following module has been installed: - -| MODULE | EXPECTED DIRECTORY | -| --- | --- | -| ProductReviewsRestApi | vendor/spryker/product-reviews-rest-api | - -{% endinfo_block %} - -### 2) Set up database schema and transfer objects - -Generate transfer changes: - -```bash -console transfer:generate -console propel:install -console transfer:generate -``` -{% info_block warningBox "Verification" %} - -Make sure that the following changes have been applied in the transfer objects: - -| TRANSFER | TYPE | EVENT | PATH | -|----------------------------------------| --- | --- |----------------------------------------------------------------------| -| RestProductReviewsAttributesTransfer | class | created | src/Generated/Shared/Transfer/RestProductReviewsAttributesTransfer | -| BulkProductReviewSearchRequestTransfer | class | created | src/Generated/Shared/Transfer/BulkProductReviewSearchRequestTransfer | -| StoreTransfer | class | created | src/Generated/Shared/Transfer/StoreTransfer | - - -Make sure that `SpyProductAbstractStorage` and `SpyProductConcreteStorage` are extended by synchronization behavior with these methods: - -| ENTITY | TYPE | EVENT | PATH | METHODS | -| --- | --- | --- | --- | --- | -| SpyProductAbstractStorage | class | extended |src/Orm/Zed/ProductStorage/Persistence/Base/SpyProductAbstractStorage | syncPublishedMessageForMappings(), syncUnpublishedMessageForMappings() | -| SpyProductConcreteStorage | class | extended | src/Orm/Zed/ProductStorage/Persistence/Base/SpyProductConcreteStorage | syncPublishedMessageForMappings(), yncUnpublishedMessageForMappings() | - -{% endinfo_block %} - -### 3) Reload data to storage - -Reload abstract and product data to storage. - -```bash -console event:trigger -r product_abstract -console event:trigger -r product_concrete -``` -{% info_block warningBox "Verification" %} - -Make sure that there is data in Redis with keys: - -- `kv:product_abstract:{% raw %}{{{% endraw %}store_name{% raw %}}}{% endraw %}:{% raw %}{{{% endraw %}locale_name{% raw %}}}{% endraw %}:sku:{% raw %}{{{% endraw %}sku_product_abstract{% raw %}}}{% endraw %}` -- `kv:product_concrete:{% raw %}{{{% endraw %}locale_name{% raw %}}}{% endraw %}:sku:{% raw %}{{{% endraw %}sku_product_concrete{% raw %}}}{% endraw %}` - -{% endinfo_block %} - -### 4) Enable resources - -Activate the following plugins: - -| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | -| --- | --- | --- | --- | -| AbstractProductsProductReviewsResourceRoutePlugin | Registers the product-reviews resource. | None | Spryker\Glue\ProductReviewsRestApi\Plugin\GlueApplication | - -**src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php** - -```php - -Example - -```json -{ - "data": [ - { - "type": "product-reviews", - "id": "21", - "attributes": { - "rating": 4, - "nickname": "Spencor", - "summary": "Donec vestibulum lectus ligula", - "description": "Donec vestibulum lectus ligula, non aliquet neque vulputate vel. Integer neque massa, ornare sit amet felis vitae, pretium feugiat magna. Suspendisse mollis rutrum ante, vitae gravida ipsum commodo quis. Donec eleifend orci sit amet nisi suscipit pulvinar. Nullam ullamcorper dui lorem, nec vehicula justo accumsan id. Sed venenatis magna at posuere maximus. Sed in mauris mauris. Curabitur quam ex, vulputate ac dignissim ac, auctor eget lorem. Cras vestibulum ex quis interdum tristique." - }, - "links": { - "self": "http://glue.de.suite-nonsplit.local/abstract-products/139/product-reviews/21" - } - }, - { - "type": "product-reviews", - "id": "22", - "attributes": { - "rating": 4, - "nickname": "Maria", - "summary": "Curabitur varius, dui ac vulputate ullamcorper", - "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc vel mauris consequat, dictum metus id, facilisis quam. Vestibulum imperdiet aliquam interdum. Pellentesque tempus at neque sed laoreet. Nam elementum vitae nunc fermentum suscipit. Suspendisse finibus risus at sem pretium ullamcorper. Donec rutrum nulla nec massa tristique, porttitor gravida risus feugiat. Ut aliquam turpis nisi." - }, - "links": { - "self": "http://glue.de.suite-nonsplit.local/abstract-products/139/product-reviews/22" - } - }, - { - "type": "product-reviews", - "id": "23", - "attributes": { - "rating": 4, - "nickname": "Maggie", - "summary": "Aliquam erat volutpat", - "description": "Morbi vitae ultricies libero. Aenean id lectus a elit sollicitudin commodo. Donec mattis libero sem, eu convallis nulla rhoncus ac. Nam tincidunt volutpat sem, eu congue augue cursus at. Mauris augue lorem, lobortis eget varius at, iaculis ac velit. Sed vulputate rutrum lorem, ut rhoncus dolor commodo ac. Aenean sed varius massa. Quisque tristique orci nec blandit fermentum. Sed non vestibulum ante, vitae tincidunt odio. Integer quis elit eros. Phasellus tempor dolor lectus, et egestas magna convallis quis. Ut sed odio nulla. Suspendisse quis laoreet nulla. Integer quis justo at velit euismod imperdiet. Ut orci dui, placerat ut ex ac, lobortis ullamcorper dui. Etiam euismod risus hendrerit laoreet auctor." - }, - "links": { - "self": "http://glue.de.suite-nonsplit.local/abstract-products/139/product-reviews/23" - } - }, - { - "type": "product-reviews", - "id": "25", - "attributes": { - "rating": 3, - "nickname": "Spencor", - "summary": "Curabitur ultricies, sapien quis placerat lacinia", - "description": "Etiam venenatis sit amet lorem eget tristique. Donec rutrum massa nec commodo cursus. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Suspendisse scelerisque scelerisque augue eget condimentum. Quisque quis arcu consequat, lacinia nulla tempor, venenatis ante. In ullamcorper, orci sit amet tempus tincidunt, massa augue molestie enim, in finibus metus odio at purus. Mauris ut semper sem, a ornare sapien. Fusce eget facilisis felis. Integer imperdiet massa a tortor varius, tincidunt laoreet ipsum viverra." - }, - "links": { - "self": "http://glue.de.suite-nonsplit.local/abstract-products/139/product-reviews/25" - } - }, - { - "type": "product-reviews", - "id": "26", - "attributes": { - "rating": 5, - "nickname": "Spencor", - "summary": "Cras porttitor", - "description": "Cras porttitor, odio vel ultricies commodo, erat turpis pulvinar turpis, id faucibus dolor odio a tellus. Mauris et nibh tempus, convallis ipsum luctus, mollis risus. Donec molestie orci ante, id tristique diam interdum eget. Praesent erat neque, sollicitudin sit amet pellentesque eget, gravida in lectus. Donec ultrices, nisl in laoreet ultrices, nunc enim lacinia felis, ac convallis tortor ligula non eros. Morbi semper ipsum non elit mollis, non commodo arcu porta. Mauris tincidunt purus rutrum erat ornare, varius egestas eros eleifend." - }, - "links": { - "self": "http://glue.de.suite-nonsplit.local/abstract-products/139/product-reviews/26" - } - } - ], - "links": { - "self": "http://glue.de.suite-nonsplit.local/abstract-products/139/product-reviews?page[offset]=0&page[limit]=5", - "last": "http://glue.de.suite-nonsplit.local/abstract-products/139/product-reviews?page[offset]=0&page[limit]=5", - "first": "http://glue.de.suite-nonsplit.local/abstract-products/139/product-reviews?page[offset]=0&page[limit]=5" - } -} -``` -
- -* `https://glue.mysprykershop.com/abstract-products/{% raw %}{{{% endraw %}abstract_sku{% raw %}}}{% endraw %}/product-reviews/{% raw %}{{{% endraw %}review_id{% raw %}}}{% endraw %}` - -
-Example - -```json -{ - "data": { - "type": "product-reviews", - "id": "21", - "attributes": { - "rating": 4, - "nickname": "Spencor", - "summary": "Donec vestibulum lectus ligula", - "description": "Donec vestibulum lectus ligula, non aliquet neque vulputate vel. Integer neque massa, ornare sit amet felis vitae, pretium feugiat magna. Suspendisse mollis rutrum ante, vitae gravida ipsum commodo quis. Donec eleifend orci sit amet nisi suscipit pulvinar. Nullam ullamcorper dui lorem, nec vehicula justo accumsan id. Sed venenatis magna at posuere maximus. Sed in mauris mauris. Curabitur quam ex, vulputate ac dignissim ac, auctor eget lorem. Cras vestibulum ex quis interdum tristique." - }, - "links": { - "self": "http://glue.de.suite-nonsplit.local/abstract-products/139/product-reviews/21" - } - } -} -``` -
- -{% endinfo_block %} - -### 5) Enable relationships - -Activate the following plugins: - -| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | -| --- | --- | --- | --- | -| ProductReviewsRelationshipByProductAbstractSkuPlugin | Adds product-reviews relationship by abstract product sku. | None |\Spryker\Glue\ProductReviewsRestApi\Plugin\GlueApplication | -| ProductReviewsRelationshipByProductConcreteSkuPlugin | Adds product-reviews relationship by concrete product sku. | None | \Spryker\Glue\ProductReviewsRestApi\Plugin\GlueApplication | -| ProductReviewsAbstractProductsResourceExpanderPlugin | Expands abstract-products resource with reviews data. | None | Spryker\Glue\ProductReviewsRestApi\Plugin\ProductsRestApi | -| ProductReviewsConcreteProductsResourceExpanderPlugin | Expands concrete-products resource with reviews data. | None | Spryker\Glue\ProductReviewsRestApi\Plugin\ProductsRestApi | - -**src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php** - -```php -addRelationship( - ProductsRestApiConfig::RESOURCE_ABSTRACT_PRODUCTS, - new ProductReviewsRelationshipByProductAbstractSkuPlugin() - ); - $resourceRelationshipCollection->addRelationship( - ProductsRestApiConfig::RESOURCE_CONCRETE_PRODUCTS, - new ProductReviewsRelationshipByProductConcreteSkuPlugin() - ); - - return $resourceRelationshipCollection; - } -} -``` - -**src/Pyz/Glue/ProductsRestApi/ProductsRestApiDependencyProvider.php** - -```php - -Example - -```json -{ - "data": { - "type": "abstract-products", - "id": "139", - "attributes": { - "sku": "139", - "averageRating": 4, - "reviewCount": 5, - "name": "Asus Transformer Book T200TA", - "description": "As light as you like Transformer Book T200 is sleek, slim and oh so light—just 26mm tall and 1.5kg docked. And when need to travel even lighter, detach the 11.6-inch tablet for 11.95mm slenderness and a mere 750g weight! With up to 10.4 hours of battery life that lasts all day long, you’re free to work or play from dawn to dusk. And ASUS Instant On technology ensures that Transformer Book T200 is always responsive and ready for action! Experience outstanding performance from the latest Intel® quad-core processor. You’ll multitask seamlessly and get more done in less time. Transformer Book T200 also delivers exceptional graphics performance—with Intel HD graphics that are up to 30% faster than ever before! Transformer Book T200 is equipped with USB 3.0 connectivity for data transfers that never leave you waiting. Just attach your USB 3.0 devices to enjoy speeds that are up to 10X faster than USB 2.0!", - "attributes": { - "product_type": "Hybrid (2-in-1)", - "form_factor": "clamshell", - "processor_cache_type": "2", - "processor_frequency": "1.59 GHz", - "brand": "Asus", - "color": "Black" - }, - "superAttributesDefinition": [ - "form_factor", - "processor_frequency", - "color" - ], - "superAttributes": [], - "attributeMap": { - "product_concrete_ids": [ - "139_24699831" - ], - "super_attributes": [], - "attribute_variants": [] - }, - "metaTitle": "Asus Transformer Book T200TA", - "metaKeywords": "Asus,Entertainment Electronics", - "metaDescription": "As light as you like Transformer Book T200 is sleek, slim and oh so light—just 26mm tall and 1.5kg docked. And when need to travel even lighter, detach t", - "attributeNames": { - "product_type": "Product type", - "form_factor": "Form factor", - "processor_cache_type": "Processor cache", - "processor_frequency": "Processor frequency", - "brand": "Brand", - "color": "Color" - }, - "url": "/en/asus-transformer-book-t200ta-139" - }, - "links": { - "self": "http://glue.de.suite-nonsplit.local/abstract-products/139?include=product-reviews" - }, - "relationships": { - "product-reviews": { - "data": [ - { - "type": "product-reviews", - "id": "21" - }, - { - "type": "product-reviews", - "id": "22" - }, - { - "type": "product-reviews", - "id": "23" - }, - { - "type": "product-reviews", - "id": "25" - }, - { - "type": "product-reviews", - "id": "26" - } - ] - } - } - }, - "included": [ - { - "type": "product-reviews", - "id": "21", - "attributes": { - "rating": 4, - "nickname": "Spencor", - "summary": "Donec vestibulum lectus ligula", - "description": "Donec vestibulum lectus ligula, non aliquet neque vulputate vel. Integer neque massa, ornare sit amet felis vitae, pretium feugiat magna. Suspendisse mollis rutrum ante, vitae gravida ipsum commodo quis. Donec eleifend orci sit amet nisi suscipit pulvinar. Nullam ullamcorper dui lorem, nec vehicula justo accumsan id. Sed venenatis magna at posuere maximus. Sed in mauris mauris. Curabitur quam ex, vulputate ac dignissim ac, auctor eget lorem. Cras vestibulum ex quis interdum tristique." - }, - "links": { - "self": "http://glue.de.suite-nonsplit.local/product-reviews/21" - } - }, - { - "type": "product-reviews", - "id": "22", - "attributes": { - "rating": 4, - "nickname": "Maria", - "summary": "Curabitur varius, dui ac vulputate ullamcorper", - "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc vel mauris consequat, dictum metus id, facilisis quam. Vestibulum imperdiet aliquam interdum. Pellentesque tempus at neque sed laoreet. Nam elementum vitae nunc fermentum suscipit. Suspendisse finibus risus at sem pretium ullamcorper. Donec rutrum nulla nec massa tristique, porttitor gravida risus feugiat. Ut aliquam turpis nisi." - }, - "links": { - "self": "http://glue.de.suite-nonsplit.local/product-reviews/22" - } - }, - { - "type": "product-reviews", - "id": "23", - "attributes": { - "rating": 4, - "nickname": "Maggie", - "summary": "Aliquam erat volutpat", - "description": "Morbi vitae ultricies libero. Aenean id lectus a elit sollicitudin commodo. Donec mattis libero sem, eu convallis nulla rhoncus ac. Nam tincidunt volutpat sem, eu congue augue cursus at. Mauris augue lorem, lobortis eget varius at, iaculis ac velit. Sed vulputate rutrum lorem, ut rhoncus dolor commodo ac. Aenean sed varius massa. Quisque tristique orci nec blandit fermentum. Sed non vestibulum ante, vitae tincidunt odio. Integer quis elit eros. Phasellus tempor dolor lectus, et egestas magna convallis quis. Ut sed odio nulla. Suspendisse quis laoreet nulla. Integer quis justo at velit euismod imperdiet. Ut orci dui, placerat ut ex ac, lobortis ullamcorper dui. Etiam euismod risus hendrerit laoreet auctor." - }, - "links": { - "self": "http://glue.de.suite-nonsplit.local/product-reviews/23" - } - }, - { - "type": "product-reviews", - "id": "25", - "attributes": { - "rating": 3, - "nickname": "Spencor", - "summary": "Curabitur ultricies, sapien quis placerat lacinia", - "description": "Etiam venenatis sit amet lorem eget tristique. Donec rutrum massa nec commodo cursus. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Suspendisse scelerisque scelerisque augue eget condimentum. Quisque quis arcu consequat, lacinia nulla tempor, venenatis ante. In ullamcorper, orci sit amet tempus tincidunt, massa augue molestie enim, in finibus metus odio at purus. Mauris ut semper sem, a ornare sapien. Fusce eget facilisis felis. Integer imperdiet massa a tortor varius, tincidunt laoreet ipsum viverra." - }, - "links": { - "self": "http://glue.de.suite-nonsplit.local/product-reviews/25" - } - }, - { - "type": "product-reviews", - "id": "26", - "attributes": { - "rating": 5, - "nickname": "Spencor", - "summary": "Cras porttitor", - "description": "Cras porttitor, odio vel ultricies commodo, erat turpis pulvinar turpis, id faucibus dolor odio a tellus. Mauris et nibh tempus, convallis ipsum luctus, mollis risus. Donec molestie orci ante, id tristique diam interdum eget. Praesent erat neque, sollicitudin sit amet pellentesque eget, gravida in lectus. Donec ultrices, nisl in laoreet ultrices, nunc enim lacinia felis, ac convallis tortor ligula non eros. Morbi semper ipsum non elit mollis, non commodo arcu porta. Mauris tincidunt purus rutrum erat ornare, varius egestas eros eleifend." - }, - "links": { - "self": "http://glue.de.suite-nonsplit.local/product-reviews/26" - } - } - ] -} -``` -
- - -4. Make a request to `https://glue.mysprykershop.com/concrete-products/{% raw %}{{{% endraw %}concrete_sku{% raw %}}}{% endraw %}?include=product-reviews`. - -5. Make sure that the response contains `product-reviews` as a relationship and `product-reviews` data included. - -
-Example - -```json -{ - "data": { - "type": "concrete-products", - "id": "139_24699831", - "attributes": { - "sku": "139_24699831", - "isDiscontinued": false, - "discontinuedNote": null, - "averageRating": 4, - "reviewCount": 5, - "name": "Asus Transformer Book T200TA", - "description": "As light as you like Transformer Book T200 is sleek, slim and oh so light—just 26mm tall and 1.5kg docked. And when need to travel even lighter, detach the 11.6-inch tablet for 11.95mm slenderness and a mere 750g weight! With up to 10.4 hours of battery life that lasts all day long, you’re free to work or play from dawn to dusk. And ASUS Instant On technology ensures that Transformer Book T200 is always responsive and ready for action! Experience outstanding performance from the latest Intel® quad-core processor. You’ll multitask seamlessly and get more done in less time. Transformer Book T200 also delivers exceptional graphics performance—with Intel HD graphics that are up to 30% faster than ever before! Transformer Book T200 is equipped with USB 3.0 connectivity for data transfers that never leave you waiting. Just attach your USB 3.0 devices to enjoy speeds that are up to 10X faster than USB 2.0!", - "attributes": { - "product_type": "Hybrid (2-in-1)", - "form_factor": "clamshell", - "processor_cache_type": "2", - "processor_frequency": "1.59 GHz", - "brand": "Asus", - "color": "Black" - }, - "superAttributesDefinition": [ - "form_factor", - "processor_frequency", - "color" - ], - "metaTitle": "Asus Transformer Book T200TA", - "metaKeywords": "Asus,Entertainment Electronics", - "metaDescription": "As light as you like Transformer Book T200 is sleek, slim and oh so light—just 26mm tall and 1.5kg docked. And when need to travel even lighter, detach t", - "attributeNames": { - "product_type": "Product type", - "form_factor": "Form factor", - "processor_cache_type": "Processor cache", - "processor_frequency": "Processor frequency", - "brand": "Brand", - "color": "Color" - } - }, - "links": { - "self": "http://glue.de.suite-nonsplit.local/concrete-products/139_24699831?include=product-reviews" - }, - "relationships": { - "product-reviews": { - "data": [ - { - "type": "product-reviews", - "id": "21" - }, - { - "type": "product-reviews", - "id": "22" - }, - { - "type": "product-reviews", - "id": "23" - }, - { - "type": "product-reviews", - "id": "25" - }, - { - "type": "product-reviews", - "id": "26" - } - ] - } - } - }, - "included": [ - { - "type": "product-reviews", - "id": "21", - "attributes": { - "rating": 4, - "nickname": "Spencor", - "summary": "Donec vestibulum lectus ligula", - "description": "Donec vestibulum lectus ligula, non aliquet neque vulputate vel. Integer neque massa, ornare sit amet felis vitae, pretium feugiat magna. Suspendisse mollis rutrum ante, vitae gravida ipsum commodo quis. Donec eleifend orci sit amet nisi suscipit pulvinar. Nullam ullamcorper dui lorem, nec vehicula justo accumsan id. Sed venenatis magna at posuere maximus. Sed in mauris mauris. Curabitur quam ex, vulputate ac dignissim ac, auctor eget lorem. Cras vestibulum ex quis interdum tristique." - }, - "links": { - "self": "http://glue.de.suite-nonsplit.local/product-reviews/21" - } - }, - { - "type": "product-reviews", - "id": "22", - "attributes": { - "rating": 4, - "nickname": "Maria", - "summary": "Curabitur varius, dui ac vulputate ullamcorper", - "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc vel mauris consequat, dictum metus id, facilisis quam. Vestibulum imperdiet aliquam interdum. Pellentesque tempus at neque sed laoreet. Nam elementum vitae nunc fermentum suscipit. Suspendisse finibus risus at sem pretium ullamcorper. Donec rutrum nulla nec massa tristique, porttitor gravida risus feugiat. Ut aliquam turpis nisi." - }, - "links": { - "self": "http://glue.de.suite-nonsplit.local/product-reviews/22" - } - }, - { - "type": "product-reviews", - "id": "23", - "attributes": { - "rating": 4, - "nickname": "Maggie", - "summary": "Aliquam erat volutpat", - "description": "Morbi vitae ultricies libero. Aenean id lectus a elit sollicitudin commodo. Donec mattis libero sem, eu convallis nulla rhoncus ac. Nam tincidunt volutpat sem, eu congue augue cursus at. Mauris augue lorem, lobortis eget varius at, iaculis ac velit. Sed vulputate rutrum lorem, ut rhoncus dolor commodo ac. Aenean sed varius massa. Quisque tristique orci nec blandit fermentum. Sed non vestibulum ante, vitae tincidunt odio. Integer quis elit eros. Phasellus tempor dolor lectus, et egestas magna convallis quis. Ut sed odio nulla. Suspendisse quis laoreet nulla. Integer quis justo at velit euismod imperdiet. Ut orci dui, placerat ut ex ac, lobortis ullamcorper dui. Etiam euismod risus hendrerit laoreet auctor." - }, - "links": { - "self": "http://glue.de.suite-nonsplit.local/product-reviews/23" - } - }, - { - "type": "product-reviews", - "id": "25", - "attributes": { - "rating": 3, - "nickname": "Spencor", - "summary": "Curabitur ultricies, sapien quis placerat lacinia", - "description": "Etiam venenatis sit amet lorem eget tristique. Donec rutrum massa nec commodo cursus. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Suspendisse scelerisque scelerisque augue eget condimentum. Quisque quis arcu consequat, lacinia nulla tempor, venenatis ante. In ullamcorper, orci sit amet tempus tincidunt, massa augue molestie enim, in finibus metus odio at purus. Mauris ut semper sem, a ornare sapien. Fusce eget facilisis felis. Integer imperdiet massa a tortor varius, tincidunt laoreet ipsum viverra." - }, - "links": { - "self": "http://glue.de.suite-nonsplit.local/product-reviews/25" - } - }, - { - "type": "product-reviews", - "id": "26", - "attributes": { - "rating": 5, - "nickname": "Spencor", - "summary": "Cras porttitor", - "description": "Cras porttitor, odio vel ultricies commodo, erat turpis pulvinar turpis, id faucibus dolor odio a tellus. Mauris et nibh tempus, convallis ipsum luctus, mollis risus. Donec molestie orci ante, id tristique diam interdum eget. Praesent erat neque, sollicitudin sit amet pellentesque eget, gravida in lectus. Donec ultrices, nisl in laoreet ultrices, nunc enim lacinia felis, ac convallis tortor ligula non eros. Morbi semper ipsum non elit mollis, non commodo arcu porta. Mauris tincidunt purus rutrum erat ornare, varius egestas eros eleifend." - }, - "links": { - "self": "http://glue.de.suite-nonsplit.local/product-reviews/26" - } - } - ] -} -``` -
- -{% endinfo_block %} - - - diff --git a/_includes/pbc/all/install-features/202304.0/install-the-gift-cards-feature.md b/_includes/pbc/all/install-features/202304.0/install-the-gift-cards-feature.md index f147dd1ca18..fb4c042d79e 100644 --- a/_includes/pbc/all/install-features/202304.0/install-the-gift-cards-feature.md +++ b/_includes/pbc/all/install-features/202304.0/install-the-gift-cards-feature.md @@ -15,7 +15,7 @@ To start feature integration, integrate the required features: | Spryker Core | {{site.version}}| [Spryker Core feature integration](/docs/pbc/all/miscellaneous/{{site.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | | Cart | {{site.version}} |[Install the Cart feature](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-cart-feature.html)| |Product | {{site.version}} |[Product feature integration](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-product-feature.html)| -|Payments | {{site.version}} |[Payments feature integration](/docs/pbc/all/payment-service-provider/{{page.version}}/spryker-pay/base-shop/install-and-upgrade/install-the-payments-feature.html)| +|Payments | {{site.version}} |[Payments feature integration](/docs/pbc/all/payment-service-provider/{{page.version}}/install-and-upgrade/install-the-payments-feature.html)| | Shipment | {{site.version}} |[Integrate the Shipment feature](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/install-the-shipment-feature.html)| | Order Management | {{site.version}} |[Order Management feature integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/order-management-feature-integration.html)| | Mailing & Notifications | {{site.version}} |[Mailing & Notifications feature integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/mailing-and-notifications-feature-integration.html)| diff --git a/_includes/pbc/all/install-features/202400.0/install-the-inventory-management-feature.md b/_includes/pbc/all/install-features/202304.0/install-the-inventory-management-feature.md similarity index 97% rename from _includes/pbc/all/install-features/202400.0/install-the-inventory-management-feature.md rename to _includes/pbc/all/install-features/202304.0/install-the-inventory-management-feature.md index 025400882d5..89cf2db9a75 100644 --- a/_includes/pbc/all/install-features/202400.0/install-the-inventory-management-feature.md +++ b/_includes/pbc/all/install-features/202304.0/install-the-inventory-management-feature.md @@ -1,15 +1,15 @@ -This document describes how to ingrate the [Inventory Management](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/inventory-management-feature-overview.html) feature into a Spryker project. +This document describes how to ingrate the [Inventory Management](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/inventory-management-feature-overview.html) feature into a Spryker project. {% info_block errorBox %} The following feature integration guide expects the basic feature to be in place. The current feature integration guide adds the following functionality: -* [Warehouse Management](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/inventory-management-feature-overview.html#warehouse-management) -* [Add to cart from catalog page](/docs/scos/user/features/{{page.version}}/cart-feature-overview/quick-order-from-the-catalog-page-overview.html) -* [Warehouse address](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/inventory-management-feature-overview.html#defining-a-warehouse-address) +* [Warehouse Management](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/inventory-management-feature-overview.html#warehouse-management) +* [Add to cart from catalog page](/docs/scos/user/features/{{site.version}}/cart-feature-overview/quick-order-from-the-catalog-page-overview.html) +* [Warehouse address](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/inventory-management-feature-overview.html#defining-a-warehouse-address) {% endinfo_block %} @@ -23,12 +23,12 @@ To start feature integration, integrate the required features: | NAME | VERSION | INTEGRATION GUIDE | |--------------|------------------|------------------| -| Spryker Core | {{page.version}} | [Spryker core feature integration](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) +| Spryker Core | {{site.version}} | [Spryker core feature integration](/docs/pbc/all/miscellaneous/{{site.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) ### 1) Install the required modules using Composer ```bash -composer require spryker-feature/inventory-management:"{{page.version}}" --update-with-dependencies +composer require spryker-feature/inventory-management:"{{site.version}}" --update-with-dependencies ``` {% info_block warningBox "Verification" %} @@ -632,7 +632,7 @@ To start integration, integrate the required features: | NAME | VERSION | INTEGRATION GUIDE | |--------------|------------------|------------------| -| Inventory Management | {{page.version}} |[Inventory Mamagement feature integration](#install-feature-core) | +| Inventory Management | {{site.version}} |[Inventory Mamagement feature integration](#install-feature-core) | ### 1) Install the required modules using Composer @@ -721,6 +721,6 @@ Make sure that after the order is created, the new row in the `warehouse_allocat | FEATURE | REQUIRED FOR THE CURRENT FEATURE | INTEGRATION GUIDE | |--------------------------|----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Inventory Management API | | [Install the Inventory Management Glue API](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-inventory-management-glue-api.html) | -| Alternative Products | | [Alternative Products + Inventory Management feature integration - ongoing](/docs/scos/dev/feature-integration-guides/{{page.version}}/alternative-products-inventory-management-feature-integration.html) | -| Order Management | | [Order Management + Inventory Management feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/order-management-inventory-management-feature-integration.html) | +| Inventory Management API | | [Install the Inventory Management Glue API](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-inventory-management-glue-api.html) | +| Alternative Products | | [Alternative Products + Inventory Management feature integration - ongoing](/docs/scos/dev/feature-integration-guides/{{site.version}}/alternative-products-inventory-management-feature-integration.html) | +| Order Management | | [Order Management + Inventory Management feature integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/order-management-inventory-management-feature-integration.html) | diff --git a/_includes/pbc/all/install-features/202400.0/install-the-order-management-inventory-management-feature.md b/_includes/pbc/all/install-features/202304.0/install-the-order-management-inventory-management-feature.md similarity index 85% rename from _includes/pbc/all/install-features/202400.0/install-the-order-management-inventory-management-feature.md rename to _includes/pbc/all/install-features/202304.0/install-the-order-management-inventory-management-feature.md index 764b35a0451..8d45eea2c26 100644 --- a/_includes/pbc/all/install-features/202400.0/install-the-order-management-inventory-management-feature.md +++ b/_includes/pbc/all/install-features/202304.0/install-the-order-management-inventory-management-feature.md @@ -1,7 +1,7 @@ -This document describes how to ingrate the [Order Management](/docs/scos/user/features/{{page.version}}/order-management-feature-overview/order-management-feature-overview.html) + [Inventory Management](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/inventory-management-feature-overview.html) feature into a Spryker project. +This document describes how to ingrate the [Order Management](/docs/scos/user/features/{{page.version}}/order-management-feature-overview/order-management-feature-overview.html) + [Inventory Management](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/inventory-management-feature-overview.html) feature into a Spryker project. {% info_block errorBox %} @@ -10,7 +10,7 @@ The following features integration guide expects the basic feature to be in plac The current feature integration guide adds the following functionality: * [Order Management](/docs/scos/user/features/{{page.version}}/order-management-feature-overview/order-management-feature-overview.html) -* [Inventory Management](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/inventory-management-feature-overview.html) +* [Inventory Management](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/inventory-management-feature-overview.html) {% endinfo_block %} @@ -24,8 +24,8 @@ To start feature integration, integrate the required features: | NAME | VERSION | INTEGRATION GUIDE | |--------------|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------| -| Order Management | {{page.version}} | [Order Management feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/order-management-feature-integration.html) -| Inventory Management | {{page.version}} | [Inventory Management feature integration](docs/scos/dev/feature-integration-guides/{{page.version}}/install-the-inventory-management-feature.md) | +| Order Management | {{site.version}} | [Order Management feature integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/order-management-feature-integration.html) +| Inventory Management | {{site.version}} | [Inventory Management feature integration](docs/scos/dev/feature-integration-guides/{{site.version}}/install-the-inventory-management-feature.md) | ### 1) Set up behavior diff --git a/_includes/pbc/all/install-features/202400.0/install-the-picker-user-login-feature.md b/_includes/pbc/all/install-features/202304.0/install-the-picker-user-login-feature.md similarity index 95% rename from _includes/pbc/all/install-features/202400.0/install-the-picker-user-login-feature.md rename to _includes/pbc/all/install-features/202304.0/install-the-picker-user-login-feature.md index a396e136ac9..f9d487ba40c 100644 --- a/_includes/pbc/all/install-features/202400.0/install-the-picker-user-login-feature.md +++ b/_includes/pbc/all/install-features/202304.0/install-the-picker-user-login-feature.md @@ -13,8 +13,8 @@ To start feature integration, integrate the required features: | NAME | VERSION | INTEGRATION GUIDE | |-----------------------------------------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Warehouse User Management | {{page.version}} | [Install the Warehouse User Management feature](/docs/pbc/all/warehouse-management-system/{{page.version}}/unified-commerce/fulfillment-app/install-and-upgrade/install-features/install-the-warehouse-user-management-feature.html) | -| Order Management + Inventory Management | {{page.version}} | [Order Management + Inventory Management feature](/docs/pbc/all/warehouse-management-system/{{page.version}}/unified-commerce/fulfillment-app/install-and-upgrade/install-features/install-the-order-management-inventory-management-feature.html) | +| Warehouse User Management | {{site.version}} | [Install the Warehouse User Management feature](/docs/scos/dev/feature-integration-guides/{{site.version}}/install-the-warehouse-user-management-feature.html) | +| Order Management + Inventory Management | {{site.version}} | [Order Management and Inventory Management feature](/docs/scos/dev/feature-integration-guides/{{site.version}}/install-the-order-management-and-inventory-management-feature.html) | ### 1) Set up configuration diff --git a/_includes/pbc/all/install-features/202400.0/install-the-product-offer-service-points-feature.md b/_includes/pbc/all/install-features/202304.0/install-the-product-offer-service-points-feature.md similarity index 99% rename from _includes/pbc/all/install-features/202400.0/install-the-product-offer-service-points-feature.md rename to _includes/pbc/all/install-features/202304.0/install-the-product-offer-service-points-feature.md index 4a52053bd7c..7c359aa3947 100644 --- a/_includes/pbc/all/install-features/202400.0/install-the-product-offer-service-points-feature.md +++ b/_includes/pbc/all/install-features/202304.0/install-the-product-offer-service-points-feature.md @@ -13,7 +13,7 @@ To start feature integration, integrate the required features: | NAME | VERSION | INTEGRATION GUIDE | |----------------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Product Offer | {{page.version}} | [Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | -| Service Points | {{page.version}} | [Service Points feature integration](/docs/pbc/all/servcie-points/{{page.version}}/install-and-upgrade/install-the-service-points-feature.html) | +| Service Points | {{page.version}} | [Service Points feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/install-the-service-points-feature.html) | ### 1) Install the required modules using Composer diff --git a/_includes/pbc/all/install-features/202400.0/install-the-product-offer-shipment-feature.md b/_includes/pbc/all/install-features/202304.0/install-the-product-offer-shipment-feature.md similarity index 98% rename from _includes/pbc/all/install-features/202400.0/install-the-product-offer-shipment-feature.md rename to _includes/pbc/all/install-features/202304.0/install-the-product-offer-shipment-feature.md index 59aca134523..6ead3117e5e 100644 --- a/_includes/pbc/all/install-features/202400.0/install-the-product-offer-shipment-feature.md +++ b/_includes/pbc/all/install-features/202304.0/install-the-product-offer-shipment-feature.md @@ -12,13 +12,13 @@ To start feature integration, integrate the following required features: | NAME | VERSION | INTEGRATION GUIDE | |---------------|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| - | Product Offer | {{page.version}} | [Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | - | Shipment | {{page.version}} | [Shipment feature integration](/docs/pbc/all/carrier-management/{{page.version}}/unified-commerce/enhanced-click-and-collect/install-and-upgrade/install-the-shipment-feature.html) | + | Product Offer | {{site.version}} | [Product Offer feature integration](/docs/pbc/all/offer-management/{{site.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | + | Shipment | {{site.version}} | [Shipment feature integration](/docs/pbc/all/carrier-management/{{page.version}}/install-and-upgrade/install-the-shipment-feature.html) | ## 1) Install the required modules using Composer ```bash -composer require spryker-feature/product-offer-shipment:"{{page.version}}" --update-with-dependencies +composer require spryker-feature/product-offer-shipment:"{{site.version}}" --update-with-dependencies ``` {% info_block warningBox "Verification" %} diff --git a/_includes/pbc/all/install-features/202400.0/install-the-push-notification-feature.md b/_includes/pbc/all/install-features/202304.0/install-the-push-notification-feature.md similarity index 99% rename from _includes/pbc/all/install-features/202400.0/install-the-push-notification-feature.md rename to _includes/pbc/all/install-features/202304.0/install-the-push-notification-feature.md index 4912044693b..eaf17d8a837 100644 --- a/_includes/pbc/all/install-features/202400.0/install-the-push-notification-feature.md +++ b/_includes/pbc/all/install-features/202304.0/install-the-push-notification-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the [Push Notification feature](/docs/pbc/all/push-notification/{{page.version}}/unified-commerce/push-notification-feature-overview.html) into a Spryker project. +This document describes how to integrate the [Push Notification feature](/docs/scos/user/features/202304.0/push-notification-feature-overview.html) into a Spryker project. ## Install feature core diff --git a/_includes/pbc/all/install-features/202400.0/install-the-service-points-feature.md b/_includes/pbc/all/install-features/202304.0/install-the-service-points-feature.md similarity index 100% rename from _includes/pbc/all/install-features/202400.0/install-the-service-points-feature.md rename to _includes/pbc/all/install-features/202304.0/install-the-service-points-feature.md diff --git a/_includes/pbc/all/install-features/202400.0/install-the-shipment-feature.md b/_includes/pbc/all/install-features/202304.0/install-the-shipment-feature.md similarity index 77% rename from _includes/pbc/all/install-features/202400.0/install-the-shipment-feature.md rename to _includes/pbc/all/install-features/202304.0/install-the-shipment-feature.md index 58bd000313f..9fdedc256a7 100644 --- a/_includes/pbc/all/install-features/202400.0/install-the-shipment-feature.md +++ b/_includes/pbc/all/install-features/202304.0/install-the-shipment-feature.md @@ -3,9 +3,9 @@ {% info_block errorBox %} -The following feature integration guide expects the basic feature to be in place. +The following feature integration guide expects the basic feature to be in place.
The current feature integration +guide only adds the following functionalities: -The current feature integration guide only adds the following functionalities: * Shipment Back Office UI * Delivery method per store * Shipment data import @@ -24,12 +24,12 @@ To start the feature integration, integrate the required features: | NAME | VERSION | INTEGRATION GUIDE | |--------------|------------------|--------------------------------------------------------------------------------------------------------------------------------------| -| Spryker Core | {{page.version}} | [Spryker Core feature integration](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | | +| Spryker Core | {{site.version}} | [Spryker Core feature integration](/docs/pbc/all/miscellaneous/{{site.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | | ### 1) Install the required modules using Composer ```bash -composer require spryker-feature/shipment:"{{page.version}}" --update-with-dependencies +composer require spryker-feature/shipment:"{{site.version}}" --update-with-dependencies ``` {% info_block warningBox "Verification" %} @@ -42,7 +42,6 @@ Make sure that the following modules have been installed: | ShipmentGui | vendor/spryker/shipment-gui | | Shipment | vendor/spryker/shipment | | ShipmentType | vendor/spryker/shipment-type | -| ShipmentTypeCart | vendor/spryker/shipment-type-cart | | ShipmentTypeDataImport | vendor/spryker/shipment-type-data-import | | ShipmentTypeStorage | vendor/spryker/shipment-type-storage | | ShipmentTypesBackendApi | vendor/spryker/shipment-types-backend-api | @@ -51,35 +50,7 @@ Make sure that the following modules have been installed: ### 2) Set up configuration -1. Add the following configuration to your project: - -| CONFIGURATION | SPECIFICATION | NAMESPACE | -|-----------------------------------------|-----------------------------------------------------------|----------------------| -| ShipmentConfig::getShipmentHashFields() | Used to group items by shipment using shipment type uuid. | Pyz\Service\Shipment | - -**src/Pyz/Service/Shipment/ShipmentConfig.php** - -```php - - */ - public function getShipmentHashFields(): array - { - return array_merge(parent::getShipmentHashFields(), [ShipmentTransfer::SHIPMENT_TYPE_UUID]); - } -} -``` - -2. To make the `shipment-types` resource protected, adjust the protected paths' configuration: +To make the `shipment-types` resource protected, adjust the protected paths' configuration: **src/Pyz/Shared/GlueBackendApiApplicationAuthorizationConnector/GlueBackendApiApplicationAuthorizationConnectorConfig.php** @@ -174,10 +145,7 @@ Make sure that the following changes have been applied in transfer objects: | ShipmentTypeStorageTransfer | class | created | src/Generated/Shared/Transfer/ShipmentTypeStorageTransfer | | ShipmentTypeStorageCriteriaTransfer | class | created | src/Generated/Shared/Transfer/ShipmentTypeStorageCriteriaTransfer | | ShipmentTypeStorageConditionsTransfer | class | created | src/Generated/Shared/Transfer/ShipmentTypeStorageConditionsTransfer | -| ShipmentMethodCollectionTransfer | class | created | src/Generated/Shared/Transfer/ShipmentMethodCollectionTransfer | | ShipmentMethodTransfer.shipmentType | property | created | src/Generated/Shared/Transfer/ShipmentMethodTransfer | -| ShipmentTransfer.shipmentTypeUuid | property | created | src/Generated/Shared/Transfer/ShipmentTransfer | -| ItemTransfer.shipmentType | property | created | src/Generated/Shared/Transfer/ItemTransfer | {% endinfo_block %} @@ -220,7 +188,7 @@ Make sure that the configured data has been added to the `spy_glossary_key` and Configure tables to be published to `spy_shipment_type_storage` and synchronized to the Storage on create, edit, and delete changes: -1. In `src/Pyz/Client/RabbitMq/RabbitMqConfig.php`, adjust the `RabbitMq` module configuration: +1. In `src/Pyz/Client/RabbitMq/RabbitMqConfig.php`, adjust the `RabbitMq` module configuration: **src/Pyz/Client/RabbitMq/RabbitMqConfig.php** @@ -309,7 +277,7 @@ class ShipmentTypeStorageConfig extends SprykerShipmentTypeStorageConfig | ShipmentTypeStoreWriterPublisherPlugin | Publishes shipment type data by `SpyShipmentTypeStore` events. | | Spryker\Zed\ShipmentTypeStorage\Communication\Plugin\Publisher\ShipmentTypeStore | | ShipmentTypePublisherTriggerPlugin | Allows populating shipment type storage table with data and triggering further export to Redis. | | Spryker\Zed\ShipmentTypeStorage\Communication\Plugin\Publisher | -
src/Pyz/Zed/Publisher/PublisherDependencyProvider.php +**src/Pyz/Zed/Publisher/PublisherDependencyProvider.php** ```php 5. Set up synchronization plugins: @@ -414,7 +381,6 @@ In Redis, make sure data is represented in the following format: "_timestamp": 1684933897.870368 } ``` - {% endinfo_block %} ### 6) Import shipment methods @@ -851,135 +817,7 @@ class SalesDependencyProvider extends SprykerSalesDependencyProvider } ``` -4. Configure the shipment type expander plugins: - -| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | -|----------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------|---------------|---------------------------------------------------------| -| ShipmentTypeItemExpanderPlugin | Expands `CartChange.items.shipment` transfer with `shipmentTypeUuid` taken from `CartChange.items.shipmentType.uuid`. | | Spryker\Zed\ShipmentTypeCart\Communication\Plugin\Cart | -| ShipmentTypeQuoteExpanderPlugin | Expands `QuoteTransfer.items.shipment` transfer with `shipmentTypeUuid` taken from `QuoteTransfer.items.shipmentType.uuid`. | | Spryker\Zed\ShipmentTypeCart\Communication\Plugin\Quote | -| ShipmentTypeShipmentMethodCollectionExpanderPlugin | Expands `ShipmentMethodCollectionTransfer.shipmentMethod` with shipment type. | | Spryker\Zed\ShipmentType\Communication\Plugin\Shipment | - -**src/Pyz/Zed/Cart/CartDependencyProvider.php** - -```php - - */ - protected function getExpanderPlugins(Container $container): array - { - return [ - new ShipmentTypeItemExpanderPlugin(), - ]; - } -} - -``` - -**src/Pyz/Zed/Quote/QuoteDependencyProvider.php** - -```php - - */ - protected function getQuoteExpanderPlugins(): array - { - return [ - new ShipmentTypeQuoteExpanderPlugin(), - ]; - } -} -``` - -**src/Pyz/Zed/Shipment/ShipmentDependencyProvider.php** - -```php - - */ - protected function getShipmentMethodCollectionExpanderPlugins(): array - { - return [ - new ShipmentTypeShipmentMethodCollectionExpanderPlugin(), - ]; - } -} -``` - -5. Configure shipment type filter plugins: - -| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | -|----------------------------------------------------|---------------|---------------|-----------| -| ShipmentTypeShipmentMethodFilterPlugin | | | | - -**src/Pyz/Zed/Shipment/ShipmentDependencyProvider.php** - -```php - - */ - protected function getMethodFilterPlugins(Container $container): array - { - return [ - new ShipmentTypeShipmentMethodFilterPlugin(), - ]; - } -} -``` - -{% info_block warningBox "Verification" %} - -Make sure that during checkout on the Shipment step, you can only see shipment methods that have relation to active shipment types related to the current store or shipment methods without shipment type relation: - -1. In the `spy_shipment_type` DB table, set `isActive = 0` to deactivate one of the shipment types. -2. Set its ID as `fk_shipment_type` in `spy_shipment_method_table`. -3. In the Storefront, add an item to the cart, do a checkout, and proceed to the Shipment step. -4. Check that there's no shipment method related to inactive shipment type in the shipment form. - -{% endinfo_block %} - -6. To enable the Backend API, register these plugins: +4. To enable the Backend API, register these plugins: | PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | |------------------------------------|------------------------------------------|---------------|-----------------------------------------------------------------------| @@ -1046,88 +884,3 @@ Make sure that you can send the following requests: ``` {% endinfo_block %} - -## Install feature frontend - -Follow the steps below to install the feature frontend. - -### Prerequisites - -To start feature integration, integrate the required features: - -| NAME | VERSION | INTEGRATION GUIDE | -|--------------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Spryker Core | {{page.version}} | [Install the Spryker Сore feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | -| Product | {{page.version}} | [Isntall the Product feature](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-product-feature.html) | - -### 1) Install the required modules using Composer - -```bash -composer require spryker-feature/shipment:"{{page.version}}" --update-with-dependencies -``` - -{% info_block warningBox "Verification" %} - -Ensure that the following modules have been installed: - -| MODULE | EXPECTED DIRECTORY | -|--------------------|------------------------------------------| -| ShipmentTypeWidget | vendor/spryker-shop/shipment-type-widget | - -{% endinfo_block %} - -### 2) Set up Behavior - -Enable the following behaviors by registering the plugins: - -| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | -|--------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------|---------------|---------------------------------------------------------| -| ShipmentTypeCheckoutPageStepEnginePreRenderPlugin | Expands `Quote.items.shipment` transfer with `shipmentTypeUuid` taken from `Quote.items.shipmentType.uuid`. | | SprykerShop\Yves\ShipmentTypeWidget\Plugin\CheckoutPage | -| ShipmentTypeCheckoutAddressStepPreGroupItemsByShipmentPlugin | Cleans `Shipment.shipmentTypeUuid` from each item in `Quote.items`. | | SprykerShop\Yves\ShipmentTypeWidget\Plugin\CustomerPage | - -**src/Pyz/Yves/CheckoutPage/CheckoutPageDependencyProvider.php** - -```php - - */ - protected function getCheckoutPageStepEnginePreRenderPlugins(): array - { - return [ - new ShipmentTypeCheckoutPageStepEnginePreRenderPlugin(), - ]; - } -``` - -**src/Pyz/Yves/CustomerPage/CustomerPageDependencyProvider.php** - -```php - - */ - protected function getCheckoutAddressStepPreGroupItemsByShipmentPlugins(): array - { - return [ - new ShipmentTypeCheckoutAddressStepPreGroupItemsByShipmentPlugin(), - ]; - } -} -``` diff --git a/_includes/pbc/all/install-features/202400.0/install-the-shipment-service-points-feature.md b/_includes/pbc/all/install-features/202304.0/install-the-shipment-service-points-feature.md similarity index 92% rename from _includes/pbc/all/install-features/202400.0/install-the-shipment-service-points-feature.md rename to _includes/pbc/all/install-features/202304.0/install-the-shipment-service-points-feature.md index cb6962536fc..ea10c403487 100644 --- a/_includes/pbc/all/install-features/202400.0/install-the-shipment-service-points-feature.md +++ b/_includes/pbc/all/install-features/202304.0/install-the-shipment-service-points-feature.md @@ -14,8 +14,8 @@ To start feature integration, integrate the required features: | NAME | VERSION | INTEGRATION GUIDE | |----------------|------------------|------------------------------------------------------------------------------------------------------------------------------------------| -| Shipment | {{page.version}} | [Shipment feature integration](/docs/pbc/all/carrier-management/{{page.version}}/unified-commerce/enhanced-click-and-collect/install-and-upgrade/install-the-shipment-feature.html) | -| Service Points | {{page.version}} | [Service Points feature integration](/docs/pbc/all/service-points/{{page.version}}/install-and-upgrade/install-the-service-points-feature.html) | +| Shipment | {{site.version}} | [Shipment feature integration](/docs/pbc/all/carrier-management/{{page.version}}/install-and-upgrade/install-the-shipment-feature.html) | +| Service Points | {{site.version}} | [Service Points feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/install-the-service-points-feature.html) | ## 1) Install the required modules using Composer diff --git a/_includes/pbc/all/install-features/202400.0/install-the-spryker-core-back-office-warehouse-user-management-feature.md b/_includes/pbc/all/install-features/202304.0/install-the-spryker-core-back-office-warehouse-user-management-feature.md similarity index 94% rename from _includes/pbc/all/install-features/202400.0/install-the-spryker-core-back-office-warehouse-user-management-feature.md rename to _includes/pbc/all/install-features/202304.0/install-the-spryker-core-back-office-warehouse-user-management-feature.md index 7ec66247822..b25b2d8c07f 100644 --- a/_includes/pbc/all/install-features/202400.0/install-the-spryker-core-back-office-warehouse-user-management-feature.md +++ b/_includes/pbc/all/install-features/202304.0/install-the-spryker-core-back-office-warehouse-user-management-feature.md @@ -11,7 +11,7 @@ To start feature integration, integrate the required features and Glue APIs: | NAME | VERSION | INTEGRATION GUIDE | |---------------------------|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------| | Spryker Core Back Office | {{page.version}} | [Install the Spryker Core Back Office feature](/docs/scos/dev/feature-integration-guides/{{page.version}}/spryker-core-back-office-feature-integration.html) | -| Warehouse User Management | {{page.version}} | [Install the Warehouse User Management feature](/docs/pbc/all/warehouse-management-system/{{page.version}}/unified-commerce/fulfillment-app/install-and-upgrade/install-features/install-the-warehouse-user-management-feature.html) | +| Warehouse User Management | {{page.version}} | [Install the Warehouse User Management feature](/docs/scos/dev/feature-integration-guides/{{page.version}}/install-the-warehouse-user-management-feature.html) | ## 1) Set up behavior diff --git a/_includes/pbc/all/install-features/202304.0/install-the-spryker-core-feature.md b/_includes/pbc/all/install-features/202304.0/install-the-spryker-core-feature.md index 1c773f9d6b7..4191227c41c 100644 --- a/_includes/pbc/all/install-features/202304.0/install-the-spryker-core-feature.md +++ b/_includes/pbc/all/install-features/202304.0/install-the-spryker-core-feature.md @@ -811,11 +811,6 @@ use SprykerShop\Yves\SecurityBlockerPage\SecurityBlockerPageConfig as SprykerSec class SecurityBlockerPageConfig extends SprykerSecurityBlockerPageConfig { - /** - * @var bool - */ - protected const USE_EMAIL_CONTEXT_FOR_LOGIN_SECURITY_BLOCKER = false; - /** * @return bool */ diff --git a/_includes/pbc/all/install-features/202400.0/install-the-warehouse-picking-feature.md b/_includes/pbc/all/install-features/202304.0/install-the-warehouse-picking-feature.md similarity index 96% rename from _includes/pbc/all/install-features/202400.0/install-the-warehouse-picking-feature.md rename to _includes/pbc/all/install-features/202304.0/install-the-warehouse-picking-feature.md index 3f16eeb535f..0c8cf983bd1 100644 --- a/_includes/pbc/all/install-features/202400.0/install-the-warehouse-picking-feature.md +++ b/_includes/pbc/all/install-features/202304.0/install-the-warehouse-picking-feature.md @@ -13,16 +13,16 @@ To start feature integration, integrate the required features: | NAME | VERSION | INTEGRATION GUIDE | |-----------------------------------------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Warehouse User Management | {{page.version}} | [Install the Warehouse User Management feature](/docs/pbc/all/warehouse-management-system/{{page.version}}/unified-commerce/fulfillment-app/install-and-upgrade/install-features/install-the-warehouse-user-management-feature.html) | -| Order Management + Inventory Management | {{page.version}} | [Order Management and Inventory Management feature](/docs/scos/dev/feature-integration-guides/{{page.version}}/install-the-order-management-and-inventory-management-feature.html) | -| Shipment | {{page.version}} | [Install the Shipment feature](/docs/scos/dev/feature-integration-guides/{{page.version}}/shipment-feature-integration.html) | -| Push Notification | {{page.version}} | [Install the Push Notification feature](/docs/scos/dev/feature-integration-guides/{{page.version}}/install-the-push-notification-feature.html) | -| Spryker Core Back Office | {{page.version}} | [Install the Spryker Core Backoffice feature](/docs/scos/dev/feature-integration-guides/{{page.version}}/install-the-spryker-core-back-office-feature.html) | +| Warehouse User Management | {{site.version}} | [Install the Warehouse User Management feature](/docs/scos/dev/feature-integration-guides/{{site.version}}/install-the-warehouse-user-management-feature.html) | +| Order Management + Inventory Management | {{site.version}} | [Order Management and Inventory Management feature](/docs/scos/dev/feature-integration-guides/{{site.version}}/install-the-order-management-and-inventory-management-feature.html) | +| Shipment | {{site.version}} | [Install the Shipment feature](/docs/scos/dev/feature-integration-guides/{{site.version}}/shipment-feature-integration.html) | +| Push Notification | {{site.version}} | [Install the Push Notification feature](/docs/scos/dev/feature-integration-guides/{{site.version}}/install-the-push-notification-feature.html) | +| Spryker Core Back Office | {{site.version}} | [Install the Spryker Core Backoffice feature](/docs/scos/dev/feature-integration-guides/{{site.version}}/install-the-spryker-core-back-office-feature.html) | ### 1) Install the required modules using Composer ```bash -composer require spryker-feature/warehouse-picking: "{{page.version}}" --update-with-dependencies +composer require spryker-feature/warehouse-picking: "{{site.version}}" --update-with-dependencies ``` {% info_block warningBox "Verification" %} @@ -632,7 +632,7 @@ class GlueBackendApiApplicationGlueJsonApiConventionConnectorDependencyProvider As a prerequisite, you must take the following steps: -1. Attach a Back Office user to any warehouse you have in the system—use the [Install the Warehouse User Management feature](/docs/pbc/all/warehouse-management-system/{{page.version}}/unified-commerce/fulfillment-app/install-and-upgrade/install-features/install-the-warehouse-user-management-feature.html) guide. +1. Attach a Back Office user to any warehouse you have in the system—use the [Install the Warehouse User Management feature](/docs/scos/dev/feature-integration-guides/{{site.version}}/install-the-warehouse-user-management-feature.html) guide. 2. Place an order in the system so that the product is in the warehouse where you added the user in the previous step. 3. Obtain the access token of the warehouse user. 4. Use the warehouse user access token as the request header `Authorization: Bearer {{YOUR_ACCESS_TOKEN}}`. diff --git a/_includes/pbc/all/install-features/202400.0/install-the-warehouse-picking-inventory-management-feature.md b/_includes/pbc/all/install-features/202304.0/install-the-warehouse-picking-inventory-management-feature.md similarity index 94% rename from _includes/pbc/all/install-features/202400.0/install-the-warehouse-picking-inventory-management-feature.md rename to _includes/pbc/all/install-features/202304.0/install-the-warehouse-picking-inventory-management-feature.md index fa8f62544b0..e32f0c3ca53 100644 --- a/_includes/pbc/all/install-features/202400.0/install-the-warehouse-picking-inventory-management-feature.md +++ b/_includes/pbc/all/install-features/202304.0/install-the-warehouse-picking-inventory-management-feature.md @@ -1,4 +1,4 @@ -This document describes how to integrate the Warehouse picking + [Inventory Management](/docs/pbc/all/warehouse-management-system/{{page.version}}/inventory-management-feature-overview.html) feature into a Spryker project. +This document describes how to integrate the Warehouse picking + [Inventory Management](/docs/pbc/all/warehouse-management-system/{{site.version}}/inventory-management-feature-overview.html) feature into a Spryker project. ## Install feature core @@ -10,8 +10,8 @@ To start feature integration, integrate the required features: | NAME | VERSION | INTEGRATION GUIDE | |----------------------|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------| -| Warehouse Picking | {{page.version}} | [Warehouse Picking feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/install-the-warehouse-picking-feature.html) | -| Inventory Management | {{page.version}} | [Inventory Management feature integration](docs/scos/dev/feature-integration-guides/{{page.version}}/install-the-inventory-management-feature.md) | +| Warehouse Picking | {{site.version}} | [Warehouse Picking feature integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/install-the-warehouse-picking-feature.html) | +| Inventory Management | {{site.version}} | [Inventory Management feature integration](docs/scos/dev/feature-integration-guides/{{site.version}}/install-the-inventory-management-feature.md) | ## 1) Install the required modules using Composer diff --git a/_includes/pbc/all/install-features/202400.0/install-the-warehouse-picking-order-management-feature.md b/_includes/pbc/all/install-features/202304.0/install-the-warehouse-picking-order-management-feature.md similarity index 96% rename from _includes/pbc/all/install-features/202400.0/install-the-warehouse-picking-order-management-feature.md rename to _includes/pbc/all/install-features/202304.0/install-the-warehouse-picking-order-management-feature.md index ecf8f6541ef..88db7ec3760 100644 --- a/_includes/pbc/all/install-features/202400.0/install-the-warehouse-picking-order-management-feature.md +++ b/_includes/pbc/all/install-features/202304.0/install-the-warehouse-picking-order-management-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Warehouse picking + [Order Management](/docs/scos/user/features/{{page.version}}/order-management-feature-overview/order-management-feature-overview.html) feature into a Spryker project. +This document describes how to integrate the Warehouse picking + [Order Management](/docs/scos/user/features/{{site.version}}/order-management-feature-overview/order-management-feature-overview.html) feature into a Spryker project. ## Install feature core @@ -12,8 +12,8 @@ To start feature integration, integrate the required features: | NAME | VERSION | INTEGRATION GUIDE | |-------------------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------| -| Warehouse Picking | {{page.version}} | [Warehouse Picking feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/install-the-warehouse-picking-feature.html) | -| Order Management | {{page.version}} | [Order Management feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/order-management-feature-integration.html) | +| Warehouse Picking | {{site.version}} | [Warehouse Picking feature integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/install-the-warehouse-picking-feature.html) | +| Order Management | {{site.version}} | [Order Management feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/order-management-feature-integration.html) | ## 1) Install the required modules using Composer diff --git a/_includes/pbc/all/install-features/202400.0/install-the-warehouse-picking-product-feature.md b/_includes/pbc/all/install-features/202304.0/install-the-warehouse-picking-product-feature.md similarity index 97% rename from _includes/pbc/all/install-features/202400.0/install-the-warehouse-picking-product-feature.md rename to _includes/pbc/all/install-features/202304.0/install-the-warehouse-picking-product-feature.md index ffec811ce84..b7f060a3687 100644 --- a/_includes/pbc/all/install-features/202400.0/install-the-warehouse-picking-product-feature.md +++ b/_includes/pbc/all/install-features/202304.0/install-the-warehouse-picking-product-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the Warehouse picking + [Product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/product-feature-overview.html) feature into a Spryker project. +This document describes how to integrate the Warehouse picking + [Product](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/feature-overviews/product-feature-overview/product-feature-overview.html) feature into a Spryker project. ## Install feature core @@ -14,7 +14,7 @@ To start feature integration, integrate the required features: | NAME | VERSION | INTEGRATION GUIDE | |-------------------|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Warehouse Picking | {{page.version}} | [Warehouse Picking feature integration](/docs/pbc/all/install-features/{{page.version}}/install-the-warehouse-picking-order-management-feature.html) | -| Product | {{page.version}} | [Product feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-product-feature.html) | +| Product | {{site.version}} | [Product feature integration](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-product-feature.html) | ## 1) Install the required modules using Composer diff --git a/_includes/pbc/all/install-features/202400.0/install-the-warehouse-picking-shipment-feature.md b/_includes/pbc/all/install-features/202304.0/install-the-warehouse-picking-shipment-feature.md similarity index 99% rename from _includes/pbc/all/install-features/202400.0/install-the-warehouse-picking-shipment-feature.md rename to _includes/pbc/all/install-features/202304.0/install-the-warehouse-picking-shipment-feature.md index 1b7536ce820..9f2d489e6d6 100644 --- a/_includes/pbc/all/install-features/202400.0/install-the-warehouse-picking-shipment-feature.md +++ b/_includes/pbc/all/install-features/202304.0/install-the-warehouse-picking-shipment-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the Warehouse picking + [Shipment](/docs/scos/user/features/{{page.version}}/shipment/shipment-feature-overview.html) feature into a Spryker project. +This document describes how to integrate the Warehouse picking + [Shipment](/docs/scos/user/features/{{site.version}}/shipment/shipment-feature-overview.html) feature into a Spryker project. ## Install feature core diff --git a/_includes/pbc/all/install-features/202400.0/install-the-warehouse-picking-spryker-core-back-office-feature.md b/_includes/pbc/all/install-features/202304.0/install-the-warehouse-picking-spryker-core-back-office-feature.md similarity index 94% rename from _includes/pbc/all/install-features/202400.0/install-the-warehouse-picking-spryker-core-back-office-feature.md rename to _includes/pbc/all/install-features/202304.0/install-the-warehouse-picking-spryker-core-back-office-feature.md index e23a713f431..fc3c09b2e89 100644 --- a/_includes/pbc/all/install-features/202400.0/install-the-warehouse-picking-spryker-core-back-office-feature.md +++ b/_includes/pbc/all/install-features/202304.0/install-the-warehouse-picking-spryker-core-back-office-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the Warehouse picking + [Spryker Core Back Office](/docs/scos/user/features/{{page.version}}/spryker-core-back-office-feature-overview/spryker-core-back-office-feature-overview.html) feature into a Spryker project. +This document describes how to integrate the Warehouse picking + [Spryker Core Back Office](/docs/scos/user/features/{{site.version}}/spryker-core-back-office-feature-overview/spryker-core-back-office-feature-overview.html) feature into a Spryker project. ## Install feature core @@ -14,8 +14,8 @@ To start feature integration, integrate the required features: | NAME | VERSION | INTEGRATION GUIDE | |--------------------------|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Warehouse Picking | {{page.version}} | [Warehouse Picking feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/install-the-warehouse-picking-feature.html) | -| Spryker Core Back Office | {{page.version}} | [Spryker Core Back Office feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/spryker-core-back-office-feature-integration.html) | +| Warehouse Picking | {{site.version}} | [Warehouse Picking feature integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/install-the-warehouse-picking-feature.html) | +| Spryker Core Back Office | {{site.version}} | [Spryker Core Back Office feature integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/spryker-core-back-office-feature-integration.html) | ## 1) Install the required modules using Composer diff --git a/_includes/pbc/all/install-features/202400.0/install-the-warehouse-user-management-feature.md b/_includes/pbc/all/install-features/202304.0/install-the-warehouse-user-management-feature.md similarity index 96% rename from _includes/pbc/all/install-features/202400.0/install-the-warehouse-user-management-feature.md rename to _includes/pbc/all/install-features/202304.0/install-the-warehouse-user-management-feature.md index f56986cf2ad..a1746a129cf 100644 --- a/_includes/pbc/all/install-features/202400.0/install-the-warehouse-user-management-feature.md +++ b/_includes/pbc/all/install-features/202304.0/install-the-warehouse-user-management-feature.md @@ -13,14 +13,14 @@ To start feature integration, integrate the required features: | NAME | VERSION | INTEGRATION GUIDE | |--------------------------|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Spryker Core | {{page.version}} | [Spryker Core feature integration](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | | -| Spryker Core Back Office | {{page.version}} | [Install the Spryker Core Back Office feature](/docs/scos/dev/feature-integration-guides/{{page.version}}/spryker-core-back-office-feature-integration.html) | -| Inventory Management | {{page.version}} | [Install the Inventory Management feature](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-inventory-management-feature.html) | +| Spryker Core | {{site.version}} | [Spryker Core feature integration](/docs/pbc/all/miscellaneous/{{site.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | | +| Spryker Core Back Office | {{site.version}} | [Install the Spryker Core Back Office feature](/docs/scos/dev/feature-integration-guides/{{site.version}}/spryker-core-back-office-feature-integration.html) | +| Inventory Management | {{site.version}} | [Install the Inventory Management feature](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-inventory-management-feature.html) | ### 1) Install the required modules using Composer ```bash -composer require spryker-feature/warehouse-user-management: "{{page.version}}" --update-with-dependencies +composer require spryker-feature/warehouse-user-management: "{{site.version}}" --update-with-dependencies ``` {% info_block warningBox "Verification" %} diff --git a/_includes/pbc/all/install-features/202400.0/marketplace/install-the-marketplace-product-offer-service-points-feature.md b/_includes/pbc/all/install-features/202304.0/marketplace/install-the-marketplace-product-offer-service-points-feature.md similarity index 98% rename from _includes/pbc/all/install-features/202400.0/marketplace/install-the-marketplace-product-offer-service-points-feature.md rename to _includes/pbc/all/install-features/202304.0/marketplace/install-the-marketplace-product-offer-service-points-feature.md index 41567065362..b97350b5001 100644 --- a/_includes/pbc/all/install-features/202400.0/marketplace/install-the-marketplace-product-offer-service-points-feature.md +++ b/_includes/pbc/all/install-features/202304.0/marketplace/install-the-marketplace-product-offer-service-points-feature.md @@ -4,7 +4,7 @@ This document describes how to integrate the Marketplace Product Offer + Service ## Install feature core -Follow the steps below to install the Marketplace Product Offer + Service Points feature core. +Follow the steps below to install the Marketplace Product Offer + Product Offer Service Points feature core. ### Prerequisites diff --git a/_internal/faq-migration-to-opensearch.md b/_internal/faq-migration-to-opensearch.md deleted file mode 100644 index 5f4f5922760..00000000000 --- a/_internal/faq-migration-to-opensearch.md +++ /dev/null @@ -1,128 +0,0 @@ -# FAQ: Migration to OpenSearch - -This document provides answers to the frequently asked questions about the migration to OpenSearch. - -## What is OpenSearch, and how is it different from Elasticsearch? - -[OpenSearch](https://opensearch.org/) is an open-source search and analytics suite derived from Elasticsearch 7.10.2. It had been the same before it was forked. After the fork, the projects started to diverge slightly. OpenSearch consists of the OpenSearch search engine and OpenSearch Dashboards, which are based on Kibana. OpenSearch maintains compatibility with Elasticsearch 7.10.2 while introducing additional enhancements and features. It is fully open source and developed in a community-driven manner. - -## What is Amazon OpenSearch Service? - -Amazon OpenSearch Service is a managed search solution that is based on OpenSearch. As part of the service, AWS provides the OpenSearch suite and continues to support legacy Elasticsearch versions until 7.10. - -## How is OpenSearch different from the Amazon OpenSearch Service? - -OpenSearch refers to the community-driven open-source search and analytics technology. On the other hand, Amazon OpenSearch Service is a managed service provided by AWS that lets users deploy, secure, and run OpenSearch and Elasticsearch at scale without the need to manage the underlying infrastructure. It offers the benefits of a fully managed service, including simplified deployment and management, while leveraging the power and capabilities of OpenSearch and Elasticsearch. - -## How does Spryker Cloud Commerce OS leverage Amazon OpenSearch service? - -As a recognized AWS Partner, Spryker Cloud Commerce OS(SCCOS) relies on AWS-managed services. SCCOS leverages Amazon OpenSearch Service to securely unlock real-time search, monitoring, and analysis of business and operational data for use cases like application monitoring, log analytics, observability, and website search. - -## Does it mean that all SCCOS projects are already using Amazon OpenSearch Service? - -Yes, all SCCOS projects are already running Amazon OpenSearch Service, regardless of the engine version of Elasticsearch or OpenSearch you are currently using. - -## Can my project migrate to OpenSearch if it's running Spryker Commerce OS on-premises? - -Yes, you can enable OpenSearch until version 1.2 on-premises because OpenSearch is an open-source project that can be deployed and run on your own infrastructure. - -## If my SCCOS project is running Elasticsearch, do I need to prepare for the migration from Elasticsearch to OpenSearch? - -If you are running Elasticsearch version 6.8 or above, no action is required on your part. We will handle the migration from Elasticsearch to OpenSearch. For the projects running lower versions of Elasticsearch, before migrating, we recommend updating Elasticsearch to version 6.8. If you need technical guidance for updating Elasticsearch, [contact our Support team](https://spryker.my.site.com/support/s/). - -## How long does it take to migrate from Elasticsearch to OpenSearch? - -The migration takes a short time, usually within the maintenance window. We can migrate your project during the maintenance window or on demand. - -## Will there be any data loss during the migration? - -No, the migration to OpenSearch follows AWS's blue-green deployment strategy, which ensures data continuity and prevents any loss. Your data will remain intact and available in the upgraded environment. - -## Will any functionality be lost during the migration? - -No, there won't be any loss of functionality during the migration. Because OpenSearch 1 is backward compatible with Elasticsearch 7, all features and functions remain accessible after the migration. - -## Will there be any downtime during the migration or scaling process? - -No, AWS's blue-green deployment strategy ensures uninterrupted service during the migration. - -## I am currently using Elasticsearch 7 or older versions. What are the benefits of migrating to OpenSearch? - -Migration to OpenSearch provides several benefits: - -* Enhanced security: OpenSearch includes built-in security features to protect your data better. - -* Continued support: OpenSearch receives long-term support and updates, ensuring ongoing improvements and maintenance. - -* Advanced features: OpenSearch introduces new features such as better observability, anomaly detection, and data lifecycle management. - -* Active community: OpenSearch benefits from a thriving open-source community, driving continuous enhancement and innovation. - -## Why didn’t we get access to OpenSearch earlier? - -We prioritize our services' stability, security, and compatibility above all else. That's why we approach upgrades with the utmost caution, ensuring that we have extensively tested and verified their functionality and compatibility before they are introduced into our ecosystem. Elasticsearch has been a reliable and robust search engine, and many of our customers still use versions under 7.10. Despite Elastic's decision to deprecate some older versions of Elasticsearch, we've been able to maintain their service continuity through our partnership with AWS, which has committed to supporting these versions without deprecation notice. As a result, there was no immediate need to rush the migration to OpenSearch. - -However, we recognize the potential benefits and features that OpenSearch brings. After thorough testing and validation, we are confident that OpenSearch is a solid platform, and the transition will be smooth, backward compatible, and minimally disruptive. - -## Does the migration to OpenSearch entail any additional costs? - -No, we take care of the migration on our side as part of your existing agreement. The cost of running OpenSearch is similar to Elasticsearch. However, any changes in usage or scale can affect overall costs. - -## Can I continue using Elasticsearch APIs with OpenSearch? - -Yes, OpenSearch maintains backward compatibility with Elasticsearch 7.10. All your existing APIs, clients, and applications should continue to work as expected with OpenSearch. - -## How is backward compatibility maintained in OpenSearch? - -OpenSearch maintains backward compatibility by ensuring its APIs and core search functionality are compatible with Elasticsearch 7.10.2. When OpenSearch was forked from Elasticsearch 7.10.2, the goal was to keep the base functionality and APIs the same. This lets applications and tools built work with Elasticsearch 7.10.2 to continue functioning with OpenSearch. - -Also, OpenSearch includes a compatibility mode, which lets OpenSearch respond with a version number of 7.10.2. This can be useful for tools or clients that check the version of the search engine and expect to communicate with Elasticsearch 7.10.2. - -However, while backward compatibility is a priority, certain features or functionalities from older versions of Elasticsearch are not supported in OpenSearch. We recommend thoroughly testing your application in a non-production environment when upgrading or migrating to different software. - -Also, as OpenSearch continues to evolve and new versions are released, for the updates on backward compatibility, make sure to check the [OpenSearch documentation](https://opensearch.org/docs/latest/) or their [GitHub repository](https://github.com/opensearch-project/OpenSearch). - -## Does OpenSearch support all the plugins that I used with Elasticsearch? - -OpenSearch supports most plugins compatible with Elasticsearch 7.10.2. However, make sure to check the compatibility of specific plugins in the OpenSearch documentation or with a particular plugin's provider. Some cases require plugins to be updated or replaced with OpenSearch-compatible versions. To get the list of the plugins you are currently using, [contact our Support team](https://spryker.my.site.com/support/s/). Before the production environment is migrated, we will migrate your development and staging environments, so you can test backward compatibility. - -## How will the migration affect my configuration and settings? - -The migration from Elasticsearch to OpenSearch should not affect your current configuration and settings. OpenSearch is backward compatible with Elasticsearch 7.10.2, so it should respect your existing configuration and settings. However, when updating to a major version, we recommend always reviewing and updating documentation or notes provided by OpenSearch. - -## Can I roll back to Elasticsearch if I face issues after migrating to OpenSearch? - -While rolling back is generally not recommended, if you experience any significant issues after the migration, a rollback to Elasticsearch 7 is still possible. The rollback may require downtime and data migration, but we will facilitate this process. - -Because long-term support, security patches, and updates will be provided for OpenSearch, a rollback should be a temporary solution. After the compatibility issues are fixed, to ensure the project's security and long-term support, it should be migrated to OpenSearch. - -## Is there any change in the way I interact with the platform after the upgrade? - -No, OpenSearch maintains compatibility with the Elasticsearch APIs, so the operations, requests, and procedures you are accustomed to using with Elasticsearch will continue functioning as before. - -## How will the migration impact my data ingestion and query processes? - -The migration should not impact your data ingestion and query processes. OpenSearch is designed to be fully backward compatible with Elasticsearch. The APIs used for data ingestion, such as the Index and Bulk APIs, and the query DSL for searching your data, will work as they did in Elasticsearch. - -## Are there any security implications with the migration to OpenSearch? - -No, there are no security implications. OpenSearch includes improved security features, such as granular access control, audit logging, and integration with identity providers, which further enhance the security of your deployments. However, we recommend reviewing the security settings and ensuring they align with your organization's security policies. - -## Does OpenSearch support the languages and frameworks that Elasticsearch does? - -Yes, OpenSearch supports all the official clients supported by Elasticsearch, such as those for Java, JavaScript, Python, Ruby, Go, .NET, and PHP. You should be able to continue using the same languages and frameworks with OpenSearch. - -## Will SCCOS support Elasticsearch 8+? - - As SCCOS heavily relies on Amazon OpenSearch Service, which does not support Elasticsearch 8+, SCCOS does not support it by default. This decision is based on our commitment to ensuring the best possible stability, security, and compatibility for our users within the supported AWS ecosystem. We continue to closely monitor the developments in this area and adjust our strategies as needed to best serve the needs of our community. - -## My on-premises project is running Elasticsearch 8+. What steps should I take to ensure compatibility when migrating to SCCOS? - -To ensure compatibility with SCCOS, you need to migrate from Elasticsearch 8+ to OpenSearch 1. - -However, we understand that sophisticated business models have unique needs, and we are always open to exploring new patterns that enable our customers to leverage and extend SCCOS with their own solutions. Therefore, if you have ideas or requirements related to Elasticsearch 8+ or any other technology, we encourage you to contact us. Our primary goal is to ensure that SCCOS is a robust and reliable platform and a customizable solution that can adapt to your needs. - - -## When can we expect the upgrade to OpenSearch 2 within the Spryker ecosystem? - -OpenSearch 2 is already available. We are analyzing the changes to understand their implications and develop an upgrade strategy that ensures you experience no disruption in services during the upgrade. Once we have a robust and tested upgrade plan, we will provide detailed guidance on how to do it. diff --git a/_scripts/sidebar_checker/sidebar_checker.sh b/_scripts/sidebar_checker/sidebar_checker.sh index 7de2b0b77cf..56012a91568 100644 --- a/_scripts/sidebar_checker/sidebar_checker.sh +++ b/_scripts/sidebar_checker/sidebar_checker.sh @@ -10,7 +10,7 @@ SIDEBARS=("_data/sidebars/acp_user_sidebar.yml" "_data/sidebars/cloud_dev_sideba TITLES=("ACP User" "Cloud Dev" "Marketplace Dev" "Marketplace User" "PBC All" "SCOS Dev" "SCOS User" "SCU Dev" "SDK Dev") # Define the folders to ignore -IGNORED_FOLDERS=("201811.0" "201903.0" "201907.0" "202001.0" "202005.0" "202009.0" "202108.0", "202304.0", "202400.0") +IGNORED_FOLDERS=("201811.0" "201903.0" "201907.0" "202001.0" "202005.0" "202009.0" "202108.0" "202304.0") # Define output file path OUTPUT_FILE="_scripts/sidebar_checker/missing-documents.yml" diff --git a/algolia_config/_cloud_dev.yml b/algolia_config/_cloud_dev.yml index 9e3a4a949c9..c88cbda94a5 100644 --- a/algolia_config/_cloud_dev.yml +++ b/algolia_config/_cloud_dev.yml @@ -13,4 +13,4 @@ algolia: - docs/fes/dev/**/*.md - docs/pbc/all/**/*.md - docs/acp/user/**/*.md - - docs/sdk/dev/**/*.md + - docs/sdk/dev/**/*.md diff --git a/algolia_config/_sdk_dev.yml b/algolia_config/_sdk_dev.yml index 4bcf9c8c96b..6535ae7744c 100644 --- a/algolia_config/_sdk_dev.yml +++ b/algolia_config/_sdk_dev.yml @@ -11,6 +11,6 @@ algolia: - docs/scos/dev/**/*.md - docs/scu/dev/**/*.md - docs/cloud/dev/spryker-cloud-commerce-os/**/*.md - - docs/acp/user/**/*.md + - docs/acp/user/**/*.md - docs/fes/dev/**/*.md - docs/pbc/all/**/*.md \ No newline at end of file diff --git a/docs/acp/user/app-composition-platform-installation.md b/docs/acp/user/app-composition-platform-installation.md index a463f8a44e6..5ee18e675db 100644 --- a/docs/acp/user/app-composition-platform-installation.md +++ b/docs/acp/user/app-composition-platform-installation.md @@ -2,7 +2,6 @@ title: App Composition Platform installation description: Learn how to install the App Orchestration Platform. template: concept-topic-template -last_updated: Jul 11, 2023 redirect_from: - /docs/aop/user/intro-to-acp/acp-installation.html --- @@ -41,30 +40,30 @@ To make your project ACP-ready, different update steps are necessary depending o - SCCOS product release [202211.0](/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202211.0/release-notes-202211.0.html): All the changes required for ACP readiness are already included, but you should still verify them at the project level. - Older versions: To get the project ACP-ready, you should complete all steps described in this document. -{% info_block infoBox "Product version earlier than 202211.0" %} +{% info_block infoBox "Product version ealier than 202211.0" %} If you were onboarded with a version older than product release [202211.0](/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202211.0/release-notes-202211.0.html), please [contact us](https://support.spryker.com/). {% endinfo_block %} -### Module updates for ACP +### 1. Module updates for ACP To get your project ACP-ready, it is important to ensure that your project modules are updated to the necessary versions. -#### ACP modules +#### 1. ACP modules Starting with the Spryker product release [202211.0](/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202211.0/release-notes-202211.0.html), the ACP catalog is included by default in the Spryker Cloud product. However, you should still make sure that your Spryker project uses the latest versions of the following modules: -* `spryker/app-catalog-gui: ^1.2.0` or later -* `spryker/message-broker:^1.4.0` or later -* `spryker/message-broker-aws:^1.3.2` or later -* `spryker/session:^4.15.1` or later +* `spryker/app-catalog-gui: ^1.2.0` or higher +* `spryker/message-broker:^1.4.0` or higher +* `spryker/message-broker-aws:^1.3.2` or higher +* `spryker/session:^4.15.1` or higher -#### App modules +#### 2. App modules {% info_block warningBox "Apps- and PBC-specific modules" %} -Depending on the specific ACP apps or [PBCs](/docs/pbc/all/pbc.html#acp-app-composition-platform-apps) you intend to use through ACP, you will need to add or update the modules for each respective app or PBC as explained in the corresponding app guide. +Depending on the specific ACP apps or [PBCs](/docs/pbc/all/pbc.html) you intend to use via ACP, you will need to add or update the modules for each respective app or PBC as explained in the corresponding app guide. {% endinfo_block %} @@ -72,19 +71,13 @@ The Spryker ACP Apps are continuously enhanced and improved with new versions. T For [each app](https://docs.spryker.com/docs/acp/user/intro-to-acp/acp-overview.html#supported-apps) you wish to use, ensure that you have the latest app-related SCCOS modules installed. -### Configure SCCOS - -{% info_block infoBox "This step can be omitted for Product version later than 202211.0" %} - -If your version is based on product release [202211.0](/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202211.0/release-notes-202211.0.html) or newer, you can skip this section! - -{% endinfo_block %} +### 2. Configure SCCOS Once you have ensured that your project modules are up-to-date, proceed to configure your SCCOS project to activate the ACP catalog in the Back Office using the following steps: 1. Define the configuration and add plugins to the following files: -
+
config/Shared/config_default.php ```php @@ -146,7 +139,10 @@ $config[OauthClientConstants::OAUTH_OPTION_AUDIENCE_FOR_PAYMENT_AUTHORIZE] = 'ao ```
-1. In the `navigation.xml` file, add one more navigation item: +2. In the `navigation.xml` file, add one more navigation item: + +
+config/Zed/navigation.xml ```xml ... @@ -158,12 +154,13 @@ $config[OauthClientConstants::OAUTH_OPTION_AUDIENCE_FOR_PAYMENT_AUTHORIZE] = 'ao index index -... +... ``` +
3. In the `MessageBrokerDependencyProvider.php` file, enable the following module plugins: -
+
src/Pyz/Zed/MessageBroker/MessageBrokerDependencyProvider.php ```php @@ -248,9 +245,10 @@ class MessageBrokerDependencyProvider extends SprykerMessageBrokerDependencyProv ```
-1. In the `MessageBrokerConfig.php` file, adjust the following module config: +4. In the `MessageBrokerConfig.php` file, adjust the following module config: -**src/Pyz/Zed/MessageBroker/MessageBrokerConfig.php**: +
+src/Pyz/Zed/MessageBroker/MessageBrokerConfig.php ```php 5. In the `OauthClientDependencyProvider.php` file, enable the following module plugins: In the MessageBrokerConfig.php, adjust the following module config: - -
+
src/Pyz/Zed/OauthClient/OauthClientDependencyProvider.php ```php @@ -337,11 +335,12 @@ You need to define the environment variables in the `deploy.yml` file of *each* {% info_block warningBox "Warning" %} -It is crucial to specify the keys for the environment variables. The infrastructure values, such as `SPRYKER_AOP_INFRASTRUCTURE` and `STORE_NAME_REFERENCE_MAP`, are provided by Spryker OPS upon request. +It is crucial to specify the keys for the environment variables. The infrastructure values, such as `SPRYKER_AOP_INFRASTRUCTURE` and `STORE_NAME_REFERENCE_MAP` are provided by Spryker OPS upon request. {% endinfo_block %} -General structure: +
+General structure ```json ENVIRONMENT_VARIABLE_NAME_A: '{ @@ -349,8 +348,10 @@ ENVIRONMENT_VARIABLE_NAME_A: '{ "CONFIGURATION_KEY_B":"SOME_VALUE_B" }' ``` +
-Data structure example for a demo environment connected to the Spryker ACP production: +
+Data structure example for a demo environment connected to the Spryker ACP production ```json #AOP @@ -383,10 +384,11 @@ SPRYKER_AOP_INFRASTRUCTURE: '{ } }' ``` +
#### General configurations: SPRYKER_AOP_APPLICATION variable -The configuration key `APP_CATALOG_SCRIPT_URL` is a URL for the App-Tenant-Registry-Service (ATRS) and the path to the JS script to load the ACP catalog. +The configuration key `APP_CATALOG_SCRIPT_URL`is the URL for the App-Tenant-Registry-Service (ATRS) and path to the JS script to load the ACP catalog. Example of the production ATRS_HOST and path: @@ -402,6 +404,7 @@ The StoreReference mapping is created by Spryker OPS, and they provide you with {% endinfo_block %} + Example of demo stores for DE and AT: ```json @@ -416,6 +419,7 @@ The app domains are provided by Spryker OPS. {% endinfo_block %} + Example of the app domain values: ```json @@ -463,7 +467,7 @@ Example of the `SPRYKER_MESSAGE_BROKER_HTTP_SENDER_CONFIG` configuration key val After configuring the files, updating all modules, and adding the requested keys with their corresponding values provided by Spryker OPS to the `deploy.yml` file, the SCCOS codebase is now up-to-date. Once redeployed, your environment is ACP-ready. -The next step is to get your newly updated and deployed ACP-ready SCCOS environment ACP-enabled. The ACP enablement step is fully handled by Spryker and implies the registration of your ACP-ready SCCOS environment with ACP by connecting it with the ACP App-Tenant-Registry-Service (ATRS) as well as the Event Platform (EP) so that the ACP catalog is able to work with SCCOS. +The next step is to get your newly updated and deployed ACP-ready SCCOS environment ACP-enabled. The ACP enablement step is fully handled by Spryker and implies registration of your ACP-ready SCCOS environment with ACP by connecting it with the ACP App-Tenant-Registry-Service (ATRS) as well as the Event Platform (EP), so that the ACP catalog is able to work with SCCOS. To get your project ACP-enabled, contact the [Spryker support](https://spryker.com/support/). @@ -474,6 +478,6 @@ Once all the steps of the ACP-enablement process are completed, the ACP catalog Once your projecrt is ACP-enabled, you can start integrating the apps: - [Integrate Algolia](/docs/pbc/all/search/{{site.version}}/base-shop/third-party-integrations/integrate-algolia.html) -- [Integrate Payone](/docs/pbc/all/payment-service-provider/{{site.version}}/payone/integration-in-the-back-office/integrate-payone.html) +- [Integrate Payone](/docs/pbc/all/payment-service-provider/{{site.version}}/third-party-integrations/payone/integration-in-the-back-office/integrate-payone.html) - [Integrate Usercentrics](/docs/pbc/all/usercentrics/integrate-usercentrics.html) - [Integrate Bazaarvoice](/docs/pbc/all/ratings-reviews/{{site.version}}/third-party-integrations/integrate-bazaarvoice.html) diff --git a/docs/acp/user/app-manifest.md b/docs/acp/user/app-manifest.md index a73118b5aec..5f7be3c5a2d 100644 --- a/docs/acp/user/app-manifest.md +++ b/docs/acp/user/app-manifest.md @@ -117,7 +117,7 @@ For the manifest, make sure to follow these conditions: |url | URL to a homepage of the application provider (not visible in the AppCatalog). | "url": "https://www.payone.com/DE-en" | |isAvailable | Shows if the application is currently available. Possible values:
  • false—the application is not available, it isn't possible to connect and configure it.
  • true—the application is available, it’s possible to connect, configure, and use it.
| "isAvailable": true | |businessModels | An array of suite types that are compatible with the application. Possible values:
  • B2C
  • B2B
  • B2C_MARKETPLACE
  • B2B_MARKETPLACE
| See *businessModels example* under this table. | -|categories | An array of categories that the application belongs to. Possible values:
  • BUSINESS_INTELLIGENCE
  • CONSENT_MANAGEMENT
  • LOYALTY_MANAGEMENT
  • PAYMENT
  • PRODUCT_INFORMATION_MANAGEMENT
  • SEARCH
  • USER_GENERATED_CONTENT
| See *categories example* under this table. | +|categories | An array of categories that the application belongs to. Possible values:
  • BI_ANALYTICS
  • CUSTOMER
  • LOYALTY
  • PAYMENT
  • PRODUCT_INFORMATION_SYSTEM
  • SEARCH
  • USER_GENERATED_CONTENT
| See *categories example* under this table. | |pages | Adds additional content to the application detail page. This part contains an object with a page type and its blocks.
Possible page types (object keys):
  • Overview
  • Legal
Each page can contain no or multiple blocks. Each block should be specified by an object with the following keys:
  • title—header of the block;
  • type—the way the data is displayed. Possible values:
    • list
    • text
  • data—information that is displayed inside the block. Can be a string, if *type=text*, or an array of strings if *type=list*.
| See *pages example* under this table. | |assets | An array of objects represented as application assets. Each object has the following keys:
  • type—type of the asset. Possible values:
    • icon—displayed on the application tile and on top of the application detail page.
    • image—displayed in a carousel on the application detail page.
    • video—displayed in a carousel on the application detail page. Allows only videos hosted on https://wistia.com.
  • url—a relative path to the asset. Possible extensions:
    • jpeg
    • png
    • svg
    • url to a video hosted on https://wistia.com
| See *assets example* under this table. | |labels | An array of strings. Displays label icons on the application detail page according to the label. Possible values:
  • Silver Partner
  • Gold Partner
  • New
  • Popular
  • Free Trial
| See *labels example* under this table. | diff --git a/docs/acp/user/developing-an-app.md b/docs/acp/user/developing-an-app.md index a5c6e6eb517..7c8a8ba0a22 100644 --- a/docs/acp/user/developing-an-app.md +++ b/docs/acp/user/developing-an-app.md @@ -122,7 +122,7 @@ For more details, see [App Configuration Translation](/docs/acp/user/app-configu The command defines Sync API and Async API. ##### Sync API -The Sync API defines the app's synchronous endpoints, or [Glue](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/glue-rest-api.html) endpoints. The workflow creates a boilerplate that you need to update with the required endpoints your app should have. See the [current OpenAPI specification](https://spec.openapis.org/oas/v3.1.0). +The Sync API defines the app's synchronous endpoints, or [Glue](/docs/scos/dev/glue-api-guides/{{site.version}}/glue-rest-api.html) endpoints. The workflow creates a boilerplate that you need to update with the required endpoints your app should have. See the [current OpenAPI specification](https://spec.openapis.org/oas/v3.1.0). For more details about the Sync API with information specific to Spryker, see [Sync API](/docs/acp/user/sync-api.html). diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/best-practices/best-practices.md b/docs/cloud/dev/spryker-cloud-commerce-os/best-practices/best-practices.md index b0c91f3ad83..3b3d0f493ff 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/best-practices/best-practices.md +++ b/docs/cloud/dev/spryker-cloud-commerce-os/best-practices/best-practices.md @@ -2,7 +2,6 @@ title: Best practices description: Best practices for developers working on Spryker Cloud Commerce OS template: concept-topic-template -last_updated: Jun, 10, 2023 --- This section contains best practices for developing and working with the Spryker Cloud Commerce OS. diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/best-practices/best-practises-jenkins-stability.md b/docs/cloud/dev/spryker-cloud-commerce-os/best-practices/best-practises-jenkins-stability.md deleted file mode 100644 index 1f1fd11d89f..00000000000 --- a/docs/cloud/dev/spryker-cloud-commerce-os/best-practices/best-practises-jenkins-stability.md +++ /dev/null @@ -1,26 +0,0 @@ ---- - title: "Best practises: Jenkins stability" - description: Improve the stability of the scheduler component. - template: best-practices-guide-template - last_updated: Jun 10, 2023 ---- - -Jenkins fulfills the role of a scheduler in the Spryker applications. It is used to run repetitive console commands and jobs. In Spryker Cloud Commerce OS, the Jenkins instance runs the commands configured directly in its container. This means that, when you run a command like the following one, it's executed within the Jenkins container, utilizing its resources: - -```bash -/vendor/bin/console queue:worker:start -``` - -Unlike in cloud, in a local environment, these commands are executed by a CLI container. This difference leads to some side effects where the same code and actions work fine in the local development environment but fail when deployed to cloud. - -## Memory management - -One of the most common issues encountered with Jenkins is excessive memory usage. In a local development environment, Docker containers are usually set up to use as much RAM as they need as long as they stay within the RAM limit configured in Docker. This limit often corresponds to the total RAM available on the machine. However, when deployed to cloud, the Jenkins container is deployed to its own dedicated server, which limits the available RAM based on the server's configuration. Non-production environments have different RAM configuration tiers, which can be found in our Service Description. Standard environments typically assign 2%nbspGB of RAM to Jenkins. This means that the server running Jenkins has a total of 2%nbspGB of RAM. Considering some overhead for the operating system, Docker, and Jenkins itself, around 1-1.5%nbspGB of memory is usually available for PHP code execution. This shared memory needs to accommodate all console commands run on Jenkins. Therefore, if you set `php memory_limit` to 1%nbspGB and have a job that requires 1%nbspGB at any given time, no other job can run in parallel without risking a memory constraint and potential job failures. The `php memory_limit` does not control the total memory consumption by any PHP process but limits the amount each individual process can take. - -We recommend profiling your application to understand how much RAM your Jenkins jobs require. A good way to do this is by utilizing XDebug Profiling in your local development environment. Jobs that may have unexpected memory demands are the `queue:worker:start` commands. These commands are responsible for spawning the `queue:task:start` commands, which consume messages from RabbitMQ. Depending on the complexity and configured chunk size of these messages, these jobs can easily consume multiple GBs of RAM. - -## Jenkins executors configuration - -Jenkins executors let you orchestrate Jenkins jobs and introduce parallel processing. By default, Jenkins instances have two executors configured, similar to local environment setups. You can adjust the executor count freely and run many console commands in parallel. While this may speed up processing in your application, it increases the importance of understanding the memory utilization profile of your application. For stable job execution, you need to ensure that no parallelized jobs collectively consume more memory than what is available to the Jenkins container. Also, it is common practice to set the number of executors to the count of CPUs available to Jenkins. Standard environments are equipped with two vCPUs, which means that configuring more than the standard two executors risks jobs "fighting" for CPU cycles. This severely limits the performance of all jobs run in parallel and potentially introduces instability to the container itself. - -We recommend sticking to the default executor count or the concurrent job limit recommended in the Spryker Service Description for your package. This will help ensure the stability of Jenkins, as configuring more Jenkins Executors is the most common cause of Jenkins instability and crashes. diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/performance-testing-in-staging-enivronments.md b/docs/cloud/dev/spryker-cloud-commerce-os/performance-testing-in-staging-enivronments.md index 6a00d0bee2a..315292be16a 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/performance-testing-in-staging-enivronments.md +++ b/docs/cloud/dev/spryker-cloud-commerce-os/performance-testing-in-staging-enivronments.md @@ -1,7 +1,6 @@ --- title: Performance testing in staging environments description: Learn about performance testing for the Spryker Cloud Commerce OS -last_updated: Sep 15, 2022 template: concept-topic-template redirect_from: - /docs/cloud/dev/spryker-cloud-commerce-os/performance-testing.html @@ -15,592 +14,4 @@ If you want to execute a full load test on a production-like dataset and traffic If you are unable to use real data for your load tests, you can use the [test data](https://drive.google.com/drive/folders/1QvwDp2wGz6C4aqGI1O9nK7G9Q_U8UUS-?usp=sharing) for an expanding amount of use cases. Please note that we do not provide support for this data. However, if your specific use case is not covered, you can [contact support](https://spryker.force.com/support/s/knowledge-center), and we will try to accommodate your needs. -Based on our experience, the [Load testing tool](https://github.com/spryker-sdk/load-testing) can greatly assist you in conducting more effective load tests. - -# Load testing tool for Spryker - -To assist in performance testing, we have a [load testing tool](https://github.com/spryker-sdk/load-testing). The tool contains predefined test scenarios that are specific to Spryker. Test runs based on Gatling.io, an open-source tool. Web UI helps to manage runs and multiple target projects are supported simultaneously. - -The tool can be used as a package integrated into the Spryker project or as a standalone package. - -## What is Gatling? - -Gatling is a powerful performance testing tool that supports HTTP, WebSocket, Server-Sent-Events, and JMS. Gatling is built on top of Akka that enables thousands of virtual users on a single machine. Akka has a message-driven architecture, and this overrides the JVM limitation of handling many threads. Virtual users are not threads but messages. - -Gatling is capable of creating an immense amount of traffic from a single node, which helps obtain the most precise information during the load testing. - -## Prerequisites - -- Java 8+ -- Node 10.10+ - -## Including the load testing tool into an environment - -The purpose of this guide is to show you how to integrate Spryker's load testing tool into your environment. While the instructions here will focus on setting this up with using one of Spryker’s many available demo shops, it can also be implemented into an on-going project. - -For instructions on setting up a developer environment using one of the available Spryker shops, you can visit our [getting started guide](/docs/scos/dev/developer-getting-started-guide.html) which shows you how to set up the Spryker Commerce OS. - -Some of the following options are available to choose from: -- [B2B Demo Shop](/docs/scos/user/intro-to-spryker//b2b-suite.html): A boilerplate for B2B commerce projects. -- [B2C Demo Shop](/docs/scos/user/intro-to-spryker/b2c-suite.html): A starting point for B2C implementations. - -If you wish to start with a demo shop that has been pre-configured with the Spryker load testing module, you can use the [Spryker Suite Demo Shop](https://github.com/spryker-shop/suite). - -For this example, we will be using the B2C Demo Shop. While a demo shop is used in this example, this can be integrated into a pre-existing project. You will just need to integrate Gatling into your project and generate the necessary data from fixtures into your database. - -To begin, we will need to create a project folder and clone the B2C Demo Shop and the Docker SDK: - -```bash -mkdir spryker-b2c && cd spryker-b2c -git clone https://github.com/spryker-shop/b2c-demo-shop.git ./ -git clone git@github.com:spryker/docker-sdk.git docker -``` - -### Integrating Gatling - -With the B2C Demo Shop and Docker SDK cloned, you will need to make a few changes to integrate Gatling into your project. These changes include requiring the load testing tool with composer as well as updating the [Router module](/docs/scos/dev/migration-concepts/silex-replacement/router/router-yves.html) inside of Yves. - -{% info_block infoBox %} - -The required composer package as well as the changes to the Router module are needed on the project level. They are what help to run the appropriate tests and generate the data needed for the load test tool. - -It should be noted that the Spryker Suite already has these changes implemented in them and comes pre-configured for load testing. For either of the B2C or B2B Demo Shops, you will need to implement the below changes. - -{% endinfo_block %} - -1. Requires the *composer* package. This step is necessary if you are looking to implement the Gatling load testing tool into your project. This line will add the new package to your `composer.json` file. The `--dev` flag will install the requirements needed for development which have a version constraint (e.g. "spryker-sdk/load-testing": "^0.1.0"). - -```bash -composer require spryker-sdk/load-testing --dev -``` - -2. Add the Router provider plugin to `src/Pyz/Yves/Router/RouterDependencyProvider.php`. Please note that you must import the appropriate class, `LoadTestingRouterProviderPlugin` to initialize the load testing. We also need to build onto the available array, so the `return` clause should be updated to reflect the additions to the array with `$routeProviders`. - -```php - Depending on your requirements, you can select any combination of the following `up` command attributes. To fetch all the changes from the branch you switch to, we recommend running the command with all of them: -> - `--build` - update composer, generate transfer objects, etc. -> - `--assets` - build assets -> - `--data` - get new demo data - -You've set up your Spryker B2C Demo Shop and can now access your applications. - -### Data preparation - -With the integrations done and the environment set up, you will need to create and load the data fixtures. This is done by first generating the necessary fixtures before triggering a *publish* of all events and then running the *queue worker*. As this will be running tests for this data preparation step, this will need to be done in the [testing mode for the Docker SDK](/docs/scos/dev/the-docker-sdk/202204.0/running-tests-with-the-docker-sdk.html). - -These steps assume you are working from a local environment. If you are attempting to implement these changes to a production or staging environment, you will need to take separate steps to generate parity data between the load-testing tool and your cloud-based environment. - -#### Steps for using a cloud-hosted environment. - -The Gatling test tool uses pre-seeded data which is used locally for both testing and generating the fixtures in the project's database. If you wish to test a production or a staging environment, there are several factors which need to be addressed. - -- You may have data you wish to test with directly which the sample dummy data may not cover. -- Cloud-hosted applications are not able to be run in test mode. -- Cloud-hosted applications are not set up to run `codeception`. -- Jenkins jobs in a cloud-hosted application are set up to run differently than those found on a locally-hosted environment. -- Some cloud-hosted applications may require `BASIC AUTH` authentication or require being connected to a VPN to access. - -Data used for Gatling's load testing can be found in **/load-test-tool-dir/tests/_data**. Any data that you generate from your cloud-hosted environment will need to be stored here. - -##### Setting up for basic authentication. - -If your environment is set for `BASIC AUTH` authentication and requires a user name and password before the site can be loaded, Gatling needs additional configuration. Found within **/load-test-tool-dir/resources/scenarios/spryker/**, two files control the HTTP protocol which is used by each test within the same directory. `GlueProtocol.scala` and `YvesProtocol.scala` each have a value (`httpProtocol`) which needs an additional argument to account for this authentication mode. - -```scala -val httpProtocol = http - .baseUrl(baseUrl) - -... - .basicAuth("usernamehere","passwordhere") -... - - .userAgentHeader("Mozilla/5.0 (Macintosh; Intel Mac OS X 10.8; rv:16.0) Gecko/20100101 Firefox/16.0") -``` - -**usernamehere** and **passwordhere** should match the username and password used for your environment's basic authentication, and not an account created within Spryker. This username and password are typically set up within your deploy file. - -##### Generating product data - -{% info_block errorBox %} - -You will need to be connected to the appropriate VPN for whichever resource you are trying to access. - -{% endinfo_block %} - -Product data can be generated from existing product data for use with the load-testing tool. Within **/load-test-tool-dir/tests/_data**, you will find `product_concrete.csv` which stores the necessary **sku** and **pdp_url** for each product. This information can be parsed directly from the existing data of your cloud-hosted environment. To do so, connect to your store's database. Product data is stored in the `data` column found within the `spy_product_concrete_storage` table as a JSON entry. We can extract this information and format it with the appropriate column names with the following command: - -```sql --- `us-docker` refers to your database name. Please make the appropriate adjustments in the SQL query below - -SELECT - JSON_UNQUOTE(JSON_EXTRACT(data, "$.sku")) as `sku`, - JSON_UNQUOTE(JSON_EXTRACT(data, "$.url")) as `url` -FROM `us-docker`.`spy_product_concrete_storage`; -``` - -This command parses through the JSON entry and extracts what we need. Once this information has been generated, it should be saved as `product_concrete.csv` and saved in the **/load-test-tool-dir/tests/_data** directory. - -##### Generating customer data - -{% info_block errorBox %} - -You will need to be connected to the appropriate VPN for whichever resource you are trying to access. - -{% endinfo_block %} - -Customer data can be generated from existing product data for use with the load-testing tool. Within **/load-test-tool-dir/tests/_data**, you will find `customer.csv` which stores the necessary fields for each user (email, password, auth_token, first_name, and last_name). Most of this information can be parsed directly from the existing data of your cloud-hosted environment. There are a number of caveats which come with generating this customer data: - -- To generate information for `auth_token`, a separate Glue call is required. -- Passwords are encrypted in the database, while the load-testing tool requires a password to use in plain-text. - -Because of these aforementioned issues, it is recommended that you create the test users you need first through the Zed or Backoffice interface. For help with creating users, please refer to [Managing customers](/docs/scos/user/back-office-user-guides/202009.0/customer/customer-customer-access-customer-groups/managing-customers.html). - -Once the users have been created, you will need to generate access tokens for each. This can be done using Glue with the `access-token` end point. You can review the [access-token](/docs/scos/dev/glue-api-guides/202108.0/managing-b2b-account/managing-company-user-authentication-tokens.html) documentation for further guidance, but below is a sample of the call to be made. - -Expected request body -```json -{ - "data": { - "type": "string", - "attributes": { - "username": "string", - "password": "string" - } - } -} -``` - -Sample call with CURL -```bash -curl -X POST "http://glue.de.spryker.local/access-tokens" -H "accept: application/json" -H "Content-Type: application/json" -d "{\"data\":{\"type\":\"access-tokens\",\"attributes\":{\"username\":\"emailgoeshere\",\"password\":\"passwordgoeshere\"}}}" -``` - -{% info_block infoBox %} - -For each of these, the username is typically the email of the user that was created. Within the response from Glue, you will also want the **accessToken** to be saved for the **auth_token** column. - -{% endinfo_block %} - -Once users have been created and access tokens generated, this information should be stored and formatted in `customer.csv` and saved in the **/load-test-tool-dir/tests/_data** directory. Make sure to put the correct information under the appropriate column name. - -#### Steps for using a local environment - -To start, entering testing mode with the following command: - -```bash -docker/sdk testing -``` - -Once inside the Docker SDK CLI, to create and load the fixtures, do the following: - -1. Generate fixtures and data for the load testing tool to utilize. As we are specifying a different location for the configuration files, we will need to use the `-c` or `--config` flag with our command. These tests will run to generate the data that is needed for load testing purposes. This can be done with the following: - -```bash -vendor/bin/codecept fixtures -c vendor/spryker-sdk/load-testing -``` - -2. As we generated fixtures to be used with the Spryker load testing tool, the data needs to be republished. To do this, we need to trigger all *publish* events to publish Zed resources, such as products and prices, to storage and search functionality. - -```bash -console publish:trigger-events -``` - -3. Run the *queue worker*. The [Queue System](/docs/scos/dev/back-end-development/data-manipulation/queue/queue.html) provides a protocol for managing asynchronous processing, meaning that the sender and the receiver do not have access to the same message at the same time. Queue Workers are commands which send the queued task to a background process and provides it with parallel processing. The `-s` or `--stop-when-empty` flag stops worker execution only when the queues are empty. - -```bash -console queue:worker:start -s -``` - -You should have the fixtures loaded into the databases and can now exit the CLI to install Gatling into the project. - -#### Alternative method to generate local fixtures. - -Jenkins is the default scheduler which ships with Spryker. It is an automation service which helps to automate tasks within Spryker. If you would like an alternative way to generate fixtures for your local environment, Jenkins can be used to schedule the necessary tasks you need for the data preparation step. - -1. From the Dashboard, select `New Item`. -![screenshot](https://lh3.googleusercontent.com/drive-viewer/AJc5JmTzW2A-gkFX6PC1YiG4r0EUQX5S2xWDRQWq4hkgzKn889xva_FwrEaDo-lYl2i3CWgXiMqebPA=w1920-h919) - -2. Enter an item name for the new job and select `Freestyle project`. Once you have done that, you can move to the next step with `OK`. -![screenshot](https://lh3.googleusercontent.com/drive-viewer/AJc5JmR2mN1q7_Du2JZPTw_CFqi9hjYnEqi8XvjXpgidcmcEeIEvUYwiEFX2GAAeLU105pz53guDHqI=w1920-h919) - -3. The next step will allow up to input the commands we need to run. While a description is optional, you can choose to set one here. There are also additional settings, such as a display name, which may also be toggled. As you only need the commands to run once, you can move down to the `Build` section to add the three build steps needed. - -Click on `Add build step` and select `Execute shell`. A Command field will appear, allowing you to input the following: - -```bash -APPLICATION_STORE="DE" COMMAND="$PHP_BIN vendor/bin/codecept fixtures -c vendor/spryker-sdk/load-testing" bash /usr/bin/spryker.sh -``` - -{% info_block errorBox %} - -Once these fixtures have been generated, attempting to rerun them in the future with the default data files found in **/vendor/spryker-sdk/load-testing/tests/_data/** will cause an error. New data should be considered if you wish to regenerate fixtures for whatever reason. - -{% endinfo_block %} - -You can change the store for which you wish to generate fixtures for (i.e., `AT` or `US`). This command allows Codeception to locate the proper configuration file with the `-c` flag for the load testing tool. Once the fixtures have been generated, the data needs to be republished. We can have Jenkins do that with the same job by adding an additional build step with `Add build step`. - -```bash -APPLICATION_STORE="DE" COMMAND="$PHP_BIN vendor/bin/console publish:trigger-events" bash /usr/bin/spryker.sh -``` - -From here, you can either add another build step to toggle the queue worker to run, or you can run the queue worker job already available within Jenkins, i.e. `DE__queue-worker-start`. - -```bash -APPLICATION_STORE="DE" COMMAND="$PHP_BIN vendor/bin/console queue:worker:start -s " bash /usr/bin/spryker.sh -``` -![screenshot](https://lh3.googleusercontent.com/drive-viewer/AJc5JmTeb8OPIZwA65e57LNg8fq_t7DnQ2T_okTLFBxcljKIXgqXcjWyt9yiCFiPKX50_Nb2LyE__Ao=w1920-h919) - -4. Once the build steps have been added, you can `Save` to be taken to the project status page for the newly-created job. As this is a job that you only need to run once and no schedule was set, you can select the `Build Now` option. -![screenshot](https://lh3.googleusercontent.com/drive-viewer/AJc5JmRTLzDFMolgcaZ_xE-nKMNBEiIDXkSjwEiInkEIJL3ZbMbIY5ygKXqc-7eE_H5N2X-m7ap1l8s=w1920-h919) - -5. With the job set to build and run, it will build a new workspace for the tasks and run each build step that you specified. Once the build has successfully completed, you can review the `Console Output` and then remove the project with `Delete Project` once you are finished, if you no longer need it. -![screenshot](https://lh3.googleusercontent.com/drive-viewer/AJc5JmSJmYXg2MyBlTWGbCU6BtzL4ye4y2YOiKNFSobALdDrnescyH8wgIIOzF84QfWQAeSVEmz5HnI=w1920-h919) - -{% info_block infoBox %} - -While it is possible to change the Jenkins cronjobs found at **/config/Zed/cronjobs/jenkins.php**, please note that these entries require a scheduled time and setting this will cause those jobs to run until they have been disabled in the Jenkins web UI. - -{% endinfo_block %} - -You are now done and can move on to [Installing Gatling](#installing-gatling)! - -### Installing Gatling - -{% info_block infoBox %} - -If you are running this tool, you will need to have access to the appropriate Yves and Glue addresses of your environment. This may require your device be white-listed or may need to be accessed through VPN. - -Both Java 8+ and Node 10.10+ are requirements to run Gatling from any system. This may also require further configuration on the standalone device. - -{% endinfo_block %} - -The last steps to getting the Spryker load testing tool set up with your project is to finally install Gatling. The load testing tool is set up with a PHP interface which makes calls to Gatling to run the tests that have been built into the tool. - -If you are attempting to load test your production or staging environment and are not testing your site locally, you can skip to the [steps for standalone installation](/docs/cloud/dev/spryker-cloud-commerce-os/performance-testing-in-staging-enivronments.html#installing-gatling-as-a-standalone-package). - -An installation script is included with the load testing tool and can be run with the following: - -1. Enter the tests directory: - -```bash -cd vendor/spryker-sdk/load-testing -``` - -2. Run the installation script: - -```bash -./install.sh -``` - -After this step has been finished, you will be able to run the Web UI and tool to perform load testing for your project on the local level. - -#### Installing Gatling as a standalone package - -It is possible for you to run Gatling as a standalone package. Fixtures and data are still needed to be generated on the project level to determine what loads to send with each test. However, as the Spryker load testing tool utilizes NPM to run a localized server for the Web UI, you can do the following to install it: - - -1. You will first need to clone to the package directory from the Spryker SDK repository and navigate to it: - -```bash -git clone git@github.com:spryker-sdk/load-testing.git -cd load-testing -``` -2. Once you have navigated to the appropriate folder, you can run the installation script as follows: - -```bash -./install.sh -``` - -This should install Gatling with Spryker's available Web UI, making it ready for load testing. - -### Running Gatling - -To get the Web UI of the Gatling tool, run: - -```bash -npm run run -``` - -{% info_block infoBox %} - -The tool runs on port 3000 by default. If you want to use a different port, specify it in the PORT environment variable. - -{% endinfo_block %} - -The tool should now be available at `http://localhost:3000`. The Web UI comes with a variety of pre-built tests. These tests can be run against either the front-end of Yves or through the Glue API. It allows you to set up an instance of a host using the Yves and Glue addresses which can have these tests applied against. Each of the available tests allows you to run with either a growing load or a constant load for a designated amount of time and number of requests per second. Gatling will run the tests specified through the Web UI and then out-put their results in a separate report with charts that can be further broken down. - -Below is a list of available tests which can be run through the Web UI: - -For *Yves*: -- `Home` - request to the Home page -- `Nope` - empty request -- `AddToCustomerCart` - scenario to add a random product from fixtures to a user cart -- `AddToGuestCart` - scenario to add a random product from fixtures to a guest cart -- `CatalogSearch` - search request for a random product from fixtures -- `Pdp` - request a random product detail page from fixtures -- `PlaceOrder` - request to place an order -- `PlaceOrderCustomer` - scenario to place an order - -For *Glue API*: -- `CatalogSearchApi` - search request for a random product from fixtures -- `CheckoutApi` - scenario to checkout for logged user -- `GuestCheckoutApi` - scenario to checkout for guest user -- `CartApi` - scenario to add a product to the cart for logged user -- `GuestCartApi` - scenario to add a product to cart for guest user -- `PdpApi` - request a random product detail page from fixtures - -{% info_block errorBox %} - -Tests like **CartApi** and **GuestCartApi** use an older method of the `cart` end-point and will need to have their scenarios updated. These and other tests may need to be updated to take this into account. Please visit the [Glue Cart](/docs/scos/dev/glue-api-guides/202108.0/managing-carts/carts-of-registered-users/managing-carts-of-registered-users.html#create-a-cart) reference for more details. - -{% endinfo_block %} - - -## Using Gatling - -In the testing tool Web UI, you can do the following: -- Create, edit, and delete instances. -- Run one of the available tests on a specific instance. -- View detailed reports on all the available instances and tests. - -You can perform all these actions from the main page: - -![screenshot](https://github.com/spryker-sdk/load-testing/raw/master/docs/images/main-page.png) - - -### Managing instances - -You can create new instances and edit or delete the existing ones. - -#### Creating an instance - -To create an instance: - -1. In the navigation bar, click **New instance**. The *Instance* page opens. -![screenshot](https://github.com/spryker-sdk/load-testing/raw/master/docs/images/instance.png) -2. Enter the instance name. -3. Optional: in the Yves URL field, enter the Yves server URL. -4. Optional: in the Glue URL field, enter the GLUE API server URL. -5. Click **Go**. - -Now, the new instance should appear in the navigation bar in *INSTANCES* section. - - -#### Editing an instance -For the already available instances, you can edit Yves URL and Glue URL. Instance names cannot be edited. - -To edit an instance: -1. In the navigation bar, click **New instance**. The *Instance* page opens. -2. Click the *edit* sign next to the instance you want to edit: -![screenshot](https://github.com/spryker-sdk/load-testing/raw/master/docs/images/edit-instance.png) -3. Edit the Yves URL or the Glue URL. -4. Click **Go**. - -Now, the instance data is updated. - -#### Deleting an instance -To delete an instance: -1. In the navigation bar, click **New instance**. The *Instance* page opens. -2. Click the X sign next to the instance you want to delete: -![screenshot](https://github.com/spryker-sdk/load-testing/raw/master/docs/images/delete-instance.png) -3. Click **Go**. - -Your instance is now deleted. - -### Running tests - -To run a new load test: - -1. In the navigation bar, click **New test**. The *Run a test* page opens: -![screenshot](https://github.com/spryker-sdk/load-testing/raw/master/docs/images/test.png) -2. Select the instance you want to run the test for. See [Managing instances](#managing-instances) for information on how you can create and manage instances. -3. In the *Test* field, select the test you want to run. -4. In the *Type* field, select one of the test types: - - *Ramp*: Test type with the growing load (request per second), identifies a Peak Load capacity. - - *Steady*: Test type with the constant load, confirms reliance of a system under the Peak Load. -5. In the *Target RPS* field, set the test RPS (request per second) value. -6. In the *Duration* field, set the test duration. -7. Optional: In the *Description*, provide the test description. -8. Click **Go**. - -That's it - your test should run now. While it runs, you see a page where logs are generated. Once the time you specified in the Duration field from step 6 elapses, the test stops, and you can view the detailed test report. - - -### Viewing the test reports - -On the main page, you can check what tests are currently being run as well as view the detailed log for the completed tests. - ---- -**Info** - -By default, information on all instances and tests is displayed on the main page. To check details for specific tests or instances, specify them in the *Test* or *Instance* columns, respectively: -![screenshot](https://github.com/spryker-sdk/load-testing/raw/master/docs/images/filter.png) - ---- - -To check what tests are being run, on the main page, expand the *Running* section. - -To view the reports of the completed tests, on the main page, in the *Done* section, click **Report log** for the test you need: -![screenshot](https://github.com/spryker-sdk/load-testing/raw/master/docs/images/reports.png) A new tab with the detailed Gatling reports is opened. - - - -## Example test: Measuring the capacity - -Let's consider the example of measuring the capacity with the `AddToCustomerCart` or `AddToGuestCart` test. - -During the test, Gatling calls Yves, Yves calls Zed, Zed operates with the database. Data flows through the entire infrastructure. - -For the *Ramp probe* test type, the following is done: - -- Ramping *Requests per second* (RPS) from 0 to 100 over 10 minutes. -- Measuring the RPS right before the outage. -- Measuring the average response time before the outage under maximum load. - [56 RPS, 250ms] -![screenshot](https://github.com/spryker-sdk/load-testing/raw/master/docs/images/ramp-probe.png) - -For the *Steady probe* test type, the following is done: - -- Keeping the RPS on the expected level for 30 minutes. [56 RPS] -- Checking that the response time is in acceptable boundaries. [< 400ms for 90% of requests] -![screenshot](https://github.com/spryker-sdk/load-testing/raw/master/docs/images/steady-probe.png) - -## Gatling Reports - -Gatling reports are a valuable source of information to read the performance data by providing some details about requests and response timing. - -There are the following report types in Gatling: -- Indicators -- Statistics -- Active users among time -- Response time distribution -- Response time percentiles over time (OK) -- Number of requests per second -- Number of responses per second -- Response time against Global RPS - - -### Indicators - -This chart shows how response times are distributed among the standard ranges. -The right panel shows the number of OK/KO requests. -![screenshot](https://github.com/spryker-sdk/load-testing/raw/master/docs/images/indicators.png) - -### Statistics - -This table shows some standard statistics such as min, max, average, standard deviation, and percentiles globally and per request. -![screenshot](https://github.com/spryker-sdk/load-testing/raw/master/docs/images/statistics.png) - -### Active users among time - -This chart displays the active users during the simulation: total and per scenario. - -“Active users” is neither “concurrent users” or “users arrival rate”. It’s a kind of mixed metric that serves for both open and closed workload models, and that represents “users who were active on the system under load at a given second”. - -It’s computed as: -``` -(number of alive users at previous second) -+ (number of users that were started during this second) -- (number of users that were terminated during the previous second) -``` -![screenshot](https://github.com/spryker-sdk/load-testing/raw/master/docs/images/active-users-among-time.png) - -### Response time distribution - -This chart displays the distribution of response times. -![screenshot](https://github.com/spryker-sdk/load-testing/raw/master/docs/images/response-time-distribution.png) - -### Response time percentiles over time (OK) - -This chart displays a variety of response time percentiles over time, but only for successful requests. As failed requests can end prematurely or be caused by timeouts, they would have a drastic effect on the computation for percentiles. -![screenshot](https://github.com/spryker-sdk/load-testing/raw/master/docs/images/response-time-percentiles-over-time-ok.png) - -### Number of requests per second - -This chart displays the number of requests sent per second overtime. -![screenshot](https://github.com/spryker-sdk/load-testing/raw/master/docs/images/number-of-requests-per-second.png) - -### Number of responses per second - -This chart displays the number of responses received per second overtime: total, successes, and failures. -![screenshot](https://github.com/spryker-sdk/load-testing/raw/master/docs/images/number-of-responses-per-second.png) - -### Response time against Global RPS - -This chart shows how the response time for the given request is distributed, depending on the overall number of requests at the same time. -![screenshot](https://github.com/spryker-sdk/load-testing/raw/master/docs/images/response-time-against-global-rps.png) \ No newline at end of file +Based on our experience, the [Load testing tool](https://github.com/spryker-sdk/load-testing) can greatly assist you in conducting more effective load tests. \ No newline at end of file diff --git a/docs/marketplace/dev/data-import/202108.0/marketplace-setup.md b/docs/marketplace/dev/data-import/202108.0/marketplace-setup.md index 0a63fe90465..efd3ebec626 100644 --- a/docs/marketplace/dev/data-import/202108.0/marketplace-setup.md +++ b/docs/marketplace/dev/data-import/202108.0/marketplace-setup.md @@ -19,7 +19,7 @@ The following table provides details about Marketplace setup data importers, the | Merchant category | Imports merchant categories. | `data:import merchant-category` | [merchant_category.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant-category.csv.html) | [merchant.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant.csv.html) | | Merchant users | Imports merchant users of the merchant. | `data:import merchant-user` | [merchant_user.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant-user.csv.html) | [merchant.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant.csv.html) | | Merchant stores | Imports merchant stores. | `data:import merchant-store` | [merchant_store.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant-store.csv.html) |
  • [merchant.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant.csv.html)
  • `stores.php` configuration file of Demo Shop
| -| Merchant stock | Imports merchant stock details. | `data:import merchant-stock` | [merchant_stock.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant-stock.csv.html) |
  • [merchant.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant.csv.html)
  • [File details: warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/file-details-warehouse.csv.html)
| +| Merchant stock | Imports merchant stock details. | `data:import merchant-stock` | [merchant_stock.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant-stock.csv.html) |
  • [merchant.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant.csv.html)
  • [File details: warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-data/file-details-warehouse.csv.html)
| | Merchant OMS processes | Imports Merchant OMS processes. | `data:import merchant-oms-process` | [merchant_oms_process.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant-oms-process.csv.html) |
  • [merchant.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant.csv.html)
  • OMS configuration that can be found at:
    • `project/config/Zed/oms project/config/Zed/StateMachine`
    • `project/config/Zed/StateMachine`
| | Merchant product offer | Imports basic merchant product offer information. | `data:import merchant-product-offer` | [merchant_product_offer.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant-product-offer.csv.html) |
  • [merchant.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant.csv.html)
  • [File details: product_concrete.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/catalog-setup/products/file-details-product-concrete.csv.html)
| | Merchant product offer price | Imports product offer prices. | `data:import price-product-offer` | [price-product-offer.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-price-product-offer.csv.html) |
  • [merchant_product_offer.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant-product-offer.csv.html)
  • [product_price.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/catalog-setup/pricing/file-details-product-price.csv.html)
| diff --git a/docs/marketplace/dev/data-import/202204.0/file-details-merchant-stock.csv.md b/docs/marketplace/dev/data-import/202204.0/file-details-merchant-stock.csv.md index 92218c3e716..27d40f70692 100644 --- a/docs/marketplace/dev/data-import/202204.0/file-details-merchant-stock.csv.md +++ b/docs/marketplace/dev/data-import/202204.0/file-details-merchant-stock.csv.md @@ -34,7 +34,7 @@ The file should have the following parameters: The file has the following dependencies: - [merchant.csv](/docs/marketplace/dev/data-import/{{site.version}}/file-details-merchant.csv.html) -- [warehouse.csv](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/import-and-export-data/file-details-warehouse.csv.html) +- [warehouse.csv](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/import-data/file-details-warehouse.csv.html) ## Import template file and content example diff --git a/docs/marketplace/dev/data-import/202204.0/file-details-product-offer-stock.csv.md b/docs/marketplace/dev/data-import/202204.0/file-details-product-offer-stock.csv.md index 86fef577e8c..1ad8c00357a 100644 --- a/docs/marketplace/dev/data-import/202204.0/file-details-product-offer-stock.csv.md +++ b/docs/marketplace/dev/data-import/202204.0/file-details-product-offer-stock.csv.md @@ -36,7 +36,7 @@ The file should have the following parameters: The file has the following dependencies: - [merchant_product_offer.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant-product-offer.csv.html) -- [warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/file-details-warehouse.csv.html) +- [warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-data/file-details-warehouse.csv.html) ## Import template file and content example diff --git a/docs/marketplace/dev/data-import/202204.0/marketplace-setup.md b/docs/marketplace/dev/data-import/202204.0/marketplace-setup.md index 5a446702ce9..420118b2494 100644 --- a/docs/marketplace/dev/data-import/202204.0/marketplace-setup.md +++ b/docs/marketplace/dev/data-import/202204.0/marketplace-setup.md @@ -23,7 +23,7 @@ The following table provides details about Marketplace setup data importers, the | Merchant OMS processes | Imports Merchant OMS processes. | `data:import merchant-oms-process` | [merchant_oms_process.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant-oms-process.csv.html) |
  • [merchant.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-data/file-details-merchant.csv.html)
  • OMS configuration that can be found at:
    • `project/config/Zed/oms project/config/Zed/StateMachine`
    • `project/config/Zed/StateMachine`
| | Merchant product offer | Imports basic merchant product offer information. | `data:import merchant-product-offer` | [merchant_product_offer.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant-product-offer.csv.html) |
  • [merchant.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-data/file-details-merchant.csv.html)
  • [File details: product_concrete.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/file-details-product-concrete.csv.html)
| | Merchant product offer price | Imports product offer prices. | `data:import price-product-offer` | [price-product-offer.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-price-product-offer.csv.html) |
  • [merchant_product_offer.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant-product-offer.csv.html)
  • [product_price.csv](/docs/pbc/all/price-management/{{site.version}}/base-shop/import-and-export-data/file-details-product-price.csv.html)
| -| Merchant product offer stock | Imports merchant product stock. | `data:import product-offer-stock` | [product_offer_stock.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-product-offer-stock.csv.html) |
  • [merchant_product_offer.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant-product-offer.csv.html)
  • [warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/file-details-warehouse.csv.html)
| +| Merchant product offer stock | Imports merchant product stock. | `data:import product-offer-stock` | [product_offer_stock.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-product-offer-stock.csv.html) |
  • [merchant_product_offer.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant-product-offer.csv.html)
  • [warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-data/file-details-warehouse.csv.html)
| | Merchant product offer stores | Imports merchant product offer stores. | `data:import merchant-product-offer-store` | [merchant_product_offer_store.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant-product-offer-store.csv.html) |
  • [merchant_product_offer.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant-product-offer.csv.html)
  • `stores.php` configuration file of Demo Shop
| | Validity of the merchant product offers | Imports the validity of the merchant product offers. | `data:import product-offer-validity` | [product_offer_validity.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-product-offer-validity.csv.html) | [merchant_product_offer.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant-product-offer.csv.html) | | Merchant product offers | Imports full product offer information via a single file. | `data:import --config data/import/common/combined_merchant_product_offer_import_config_{store}.yml` | [combined_merchant_product_offer.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-combined-merchant-product-offer.csv.html) |
  • [merchant.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-data/file-details-merchant.csv.html)
  • `stores.php` configuration file of Demo Shop
| diff --git a/docs/marketplace/dev/data-import/202212.0/data-import.md b/docs/marketplace/dev/data-import/202212.0/data-import.md new file mode 100644 index 00000000000..2e829f14eb4 --- /dev/null +++ b/docs/marketplace/dev/data-import/202212.0/data-import.md @@ -0,0 +1,10 @@ +--- +title: Data import +description: Import data from other systems into your marketplace project +last_updated: Sep 7, 2022 +template: concept-topic-template +--- + +Spryker’s customers need to import data from other systems into their Spryker Marketplace project. The _Data import_ section holds all the needed information for that. For more details, see the following documents: + +* [Marketplace setup](/docs/marketplace/dev/data-import/{{page.version}}/marketplace-setup.html) diff --git a/docs/marketplace/dev/data-import/202212.0/file-details-merchant-store.csv.md b/docs/marketplace/dev/data-import/202212.0/file-details-merchant-store.csv.md new file mode 100644 index 00000000000..0ceec9de088 --- /dev/null +++ b/docs/marketplace/dev/data-import/202212.0/file-details-merchant-store.csv.md @@ -0,0 +1,44 @@ +--- +title: "File details: merchant_store.csv" +last_updated: Feb 26, 2021 +description: This document describes the merchant_store.csv file to configure merchant store information in your Spryker shop. +template: import-file-template +related: + - title: Marketplace Merchant feature overview + link: docs/pbc/all/merchant-management/page.version/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.html + - title: Execution order of data importers in Demo Shop + link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html +--- + +This document describes the `merchant_store.csv` file to configure merchant's stores in your Spryker shop. + +To import the file, run: + +```bash +data:import merchant-store +``` + +## Import file parameters + +The file should have the following parameters: + +| PARAMETER | REQUIRED | TYPE | DEFAULT VALUE | REQUIREMENTS OR COMMENTS | DESCRIPTION | +| -------------- | ----------- | ----- | -------------- | ------------------------ | ----------------------- | +| merchant_reference | ✓ | String | | Unique | Identifier of the merchant in the system. | +| store_name | ✓ | String | | Value previously defined in the *stores.php* project configuration. | Store where the merchant product offer belongs. | + +## Import file dependencies + +The file has the following dependencies: + +- [merchant.csv](/docs/pbc/all/merchant-management/{{site.version}}/marketplace/import-data/file-details-merchant.csv.html) +- `stores.php` configuration file of the demo shop PHP project, where stores are defined initially + +## Import template file and content example + +Find the template and an example of the file below: + +| FILE | DESCRIPTION | +| --------------------------- | ---------------------- | +| [template_merchant_store.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Marketplace+setup/template_merchant_store.csv) | Import file template with headers only. | +| [merchant_store.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Marketplace+setup/merchant_store.csv) | Example of the import file with Demo Shop data. | diff --git a/docs/scos/dev/data-import/202212.0/marketplace-data-import.md b/docs/marketplace/dev/data-import/202212.0/marketplace-setup.md similarity index 97% rename from docs/scos/dev/data-import/202212.0/marketplace-data-import.md rename to docs/marketplace/dev/data-import/202212.0/marketplace-setup.md index 3377449de57..6ce37b40d42 100644 --- a/docs/scos/dev/data-import/202212.0/marketplace-data-import.md +++ b/docs/marketplace/dev/data-import/202212.0/marketplace-setup.md @@ -1,10 +1,8 @@ --- -title: "Marketplace data import" +title: "Marketplace setup" last_updated: May 28, 2021 description: The Marketplace setup category holds data required to set up the Marketplace environment. template: import-file-template -redirect_from: - - /docs/marketplace/dev/data-import/202212.0/marketplace-setup.html --- The Marketplace setup category contains data required to set up the Marketplace environment. @@ -21,11 +19,11 @@ The following table provides details about Marketplace setup data importers, the | Merchant category | Imports merchant categories. | `data:import merchant-category` | [merchant_category.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-data/file-details-merchant-category.csv.html) | [merchant.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-data/file-details-merchant.csv.html) | | Merchant users | Imports merchant users of the merchant. | `data:import merchant-user` | [merchant_user.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-data/file-details-merchant-user.csv.html) | [merchant.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-data/file-details-merchant.csv.html) | | Merchant stores | Imports merchant stores. | `data:import merchant-store` | [merchant_store.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-data/file-details-merchant-store.csv.html) |
  • [merchant.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-data/file-details-merchant.csv.html)
  • `stores.php` configuration file of Demo Shop
| -| Merchant stock | Imports merchant stock details. | `data:import merchant-stock` | [merchant_stock.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/import-data/file-details-merchant-stock.csv.html) |
  • [merchant.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant.csv.html)
  • [File details: warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/file-details-warehouse.csv.html)
| +| Merchant stock | Imports merchant stock details. | `data:import merchant-stock` | [merchant_stock.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/import-data/file-details-merchant-stock.csv.html) |
  • [merchant.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant.csv.html)
  • [File details: warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-data/file-details-warehouse.csv.html)
| | Merchant OMS processes | Imports Merchant OMS processes. | `data:import merchant-oms-process` | [merchant_oms_process.csv](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-oms-process.csv.html) |
  • [merchant.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-data/file-details-merchant.csv.html)
  • OMS configuration that can be found at:
    • `project/config/Zed/oms project/config/Zed/StateMachine`
    • `project/config/Zed/StateMachine`
| | Merchant product offer | Imports basic merchant product offer information. | `data:import merchant-product-offer` | [merchant_product_offer.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html) |
  • [merchant.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-data/file-details-merchant.csv.html)
  • [File details: product_concrete.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/file-details-product-concrete.csv.html)
| | Merchant product offer price | Imports product offer prices. | `data:import price-product-offer` | [price-product-offer.csv](/docs/pbc/all/price-management/{{page.version}}/marketplace/import-and-export-data/file-details-price-product-offer.csv.html) |
  • [merchant_product_offer.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html)
  • [product_price.csv](/docs/pbc/all/price-management/{{page.version}}/base-shop/import-and-export-data/file-details-product-price.csv.html)
| -| Merchant product offer stock | Imports merchant product stock. | `data:import product-offer-stock` | [product_offer_stock.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/import-data/file-details-product-offer-stock.csv.html) |
  • [merchant_product_offer.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html)
  • [warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/file-details-warehouse.csv.html)
| +| Merchant product offer stock | Imports merchant product stock. | `data:import product-offer-stock` | [product_offer_stock.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/import-data/file-details-product-offer-stock.csv.html) |
  • [merchant_product_offer.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html)
  • [warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-data/file-details-warehouse.csv.html)
| | Merchant product offer stores | Imports merchant product offer stores. | `data:import merchant-product-offer-store` | [merchant_product_offer_store.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-offer-store.csv.html) |
  • [merchant_product_offer.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html)
  • `stores.php` configuration file of Demo Shop
| | Validity of the merchant product offers | Imports the validity of the merchant product offers. | `data:import product-offer-validity` | [product_offer_validity.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-product-offer-validity.csv.html) | [merchant_product_offer.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html) | | Merchant product offers | Imports full product offer information via a single file. | `data:import --config data/import/common/combined_merchant_product_offer_import_config_{store}.yml` | [combined_merchant_product_offer.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-combined-merchant-product-offer.csv.html) |
  • [merchant.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-data/file-details-merchant.csv.html)
  • `stores.php` configuration file of Demo Shop
| diff --git a/docs/marketplace/dev/feature-integration-guides/202212.0/feature-integration-guides.md b/docs/marketplace/dev/feature-integration-guides/202212.0/feature-integration-guides.md index 2e66536fa06..b99527cc373 100644 --- a/docs/marketplace/dev/feature-integration-guides/202212.0/feature-integration-guides.md +++ b/docs/marketplace/dev/feature-integration-guides/202212.0/feature-integration-guides.md @@ -6,5 +6,13 @@ template: concept-topic-template --- This section contains the following Marketplace feature integration guides: +* [Marketplace Dummy Payment feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/marketplace-dummy-payment-feature-integration.html) * [Merchant Category feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/merchant-category-feature-integration.html) * [Merchant Opening Hours feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/merchant-opening-hours-feature-integration.html) +* [Merchant Switcher feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/merchant-switcher-feature-integration.html) +* [Merchant Switcher + Customer Account Management feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/merchant-switcher-customer-account-management-feature-integration.html) +* [Merchant Switcher + Wishlist feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/merchant-switcher-wishlist-feature-integration.html) +* [Merchant Portal feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/merchant-portal-feature-integration.html) +* [Merchant Portal - Marketplace Product feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/merchant-portal-marketplace-product-feature-integration.html) +* [Merchant Portal - Marketplace Product Options Management feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/merchant-portal-marketplace-product-options-management-feature-integration.html) +* [Merchant Portal - Marketplace Merchant Portal Product Offer Management feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/marketplace-merchant-portal-product-offer-management-feature-integration.html) diff --git a/docs/marketplace/dev/feature-integration-guides/202212.0/marketplace-dummy-payment-feature-integration.md b/docs/marketplace/dev/feature-integration-guides/202212.0/marketplace-dummy-payment-feature-integration.md new file mode 100644 index 00000000000..cbf5c66309c --- /dev/null +++ b/docs/marketplace/dev/feature-integration-guides/202212.0/marketplace-dummy-payment-feature-integration.md @@ -0,0 +1,8 @@ +--- +title: Marketplace Dummy Payment +last_updated: Oct 05, 2021 +description: This document describes the process how to integrate the Marketplace Dummy Payment into a Spryker project. +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202212.0/marketplace/install-the-marketplace-dummy-payment-feature.md %} diff --git a/docs/pbc/all/product-information-management/202212.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-cart-feature.md b/docs/marketplace/dev/feature-integration-guides/202212.0/marketplace-product-cart-feature-integration.md similarity index 81% rename from docs/pbc/all/product-information-management/202212.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-cart-feature.md rename to docs/marketplace/dev/feature-integration-guides/202212.0/marketplace-product-cart-feature-integration.md index 054c7f5a7be..b080d4f929b 100644 --- a/docs/pbc/all/product-information-management/202212.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-cart-feature.md +++ b/docs/marketplace/dev/feature-integration-guides/202212.0/marketplace-product-cart-feature-integration.md @@ -1,10 +1,10 @@ --- -title: Install the Marketplace Product + Cart feature +title: Marketplace Product + Cart feature integration last_updated: Dec 16, 2020 description: This document describes the process how to integrate the Marketplace Product + Cart feature into a Spryker project. template: feature-integration-guide-template redirect_from: - - /docs/marketplace/dev/feature-integration-guides/202212.0/marketplace-product-cart-feature-integration.html + - /docs/marketplace/dev/feature-integration-guides/202200.0/marketplace-product-cart-feature-integration.html --- {% include pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-cart-feature.md %} diff --git a/docs/pbc/all/merchant-management/202212.0/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-customer-account-management-feature.md b/docs/marketplace/dev/feature-integration-guides/202212.0/merchant-switcher-customer-account-management-feature-integration.md similarity index 87% rename from docs/pbc/all/merchant-management/202212.0/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-customer-account-management-feature.md rename to docs/marketplace/dev/feature-integration-guides/202212.0/merchant-switcher-customer-account-management-feature-integration.md index b0987741434..323adfc0fea 100644 --- a/docs/pbc/all/merchant-management/202212.0/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-customer-account-management-feature.md +++ b/docs/marketplace/dev/feature-integration-guides/202212.0/merchant-switcher-customer-account-management-feature-integration.md @@ -1,5 +1,5 @@ --- -title: Install the Merchant Switcher + Customer Account Management feature +title: Merchant Switcher + Customer Account Management feature integration last_updated: Jan 06, 2021 description: This document describes the process how to integrate the Merchant Switcher + Customer Account Management feature into a Spryker project. template: feature-integration-guide-template diff --git a/docs/pbc/all/merchant-management/202212.0/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-feature.md b/docs/marketplace/dev/feature-integration-guides/202212.0/merchant-switcher-feature-integration.md similarity index 90% rename from docs/pbc/all/merchant-management/202212.0/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-feature.md rename to docs/marketplace/dev/feature-integration-guides/202212.0/merchant-switcher-feature-integration.md index 33e76a1c27f..4bd9cb04c47 100644 --- a/docs/pbc/all/merchant-management/202212.0/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-feature.md +++ b/docs/marketplace/dev/feature-integration-guides/202212.0/merchant-switcher-feature-integration.md @@ -1,5 +1,5 @@ --- -title: Install the Merchant Switcher feature +title: Merchant Switcher feature integration last_updated: Jan 06, 2021 description: This integration guide provides steps on how to integrate the Merchant Switcher feature into a Spryker project. template: feature-integration-guide-template diff --git a/docs/pbc/all/merchant-management/202212.0/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-wishlist-feature.md b/docs/marketplace/dev/feature-integration-guides/202212.0/merchant-switcher-wishlist-feature-integration.md similarity index 88% rename from docs/pbc/all/merchant-management/202212.0/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-wishlist-feature.md rename to docs/marketplace/dev/feature-integration-guides/202212.0/merchant-switcher-wishlist-feature-integration.md index 2b9462f07ca..e1d75006a5f 100644 --- a/docs/pbc/all/merchant-management/202212.0/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-wishlist-feature.md +++ b/docs/marketplace/dev/feature-integration-guides/202212.0/merchant-switcher-wishlist-feature-integration.md @@ -1,5 +1,5 @@ --- -title: Install the Merchant Switcher + Wishlist feature +title: Merchant Switcher + Wishlist feature integration last_updated: Oct 08, 2021 description: This document describes the process how to integrate the Merchant Switcher + Wishlist feature into a Spryker project. template: feature-integration-guide-template diff --git a/docs/pbc/all/product-information-management/202212.0/marketplace/domain-model-and-relationships/marketplace-merchant-portal-product-management-feature-domain-model-and-relationships.md b/docs/marketplace/dev/feature-walkthroughs/202212.0/marketplace-merchant-portal-product-management-feature-walkthrough.md similarity index 50% rename from docs/pbc/all/product-information-management/202212.0/marketplace/domain-model-and-relationships/marketplace-merchant-portal-product-management-feature-domain-model-and-relationships.md rename to docs/marketplace/dev/feature-walkthroughs/202212.0/marketplace-merchant-portal-product-management-feature-walkthrough.md index 394aa57495e..5c25f4d7900 100644 --- a/docs/pbc/all/product-information-management/202212.0/marketplace/domain-model-and-relationships/marketplace-merchant-portal-product-management-feature-domain-model-and-relationships.md +++ b/docs/marketplace/dev/feature-walkthroughs/202212.0/marketplace-merchant-portal-product-management-feature-walkthrough.md @@ -1,9 +1,13 @@ --- -title: "Marketplace Merchant Portal Product Management feature: Domain model and relationships" +title: Marketplace Merchant Portal Product Management feature walkthrough description: This document provides reference information about product in the Merchant Portal. +last_updated: Nov 05, 2021 template: feature-walkthrough-template --- +The *Marketplace Merchant Portal Product Management* feature lets merchants manage products and their category, attributes, prices, tax sets, SEO settings, variants, stock and validity dates in the Merchant Portal. + +## Module dependency graph The following diagram illustrates the dependencies between the modules for the *Marketplace Merchant Portal Product Management* feature. @@ -12,3 +16,10 @@ The following diagram illustrates the dependencies between the modules for the * | NAME | DESCRIPTION | | --- | --- | | [ProductMerchantPortalGui](https://github.com/spryker/product-merchant-portal-gui) | Provides the UI for managing marketplace products in the Merchant Portal. | + + +## Related Developer documents + +|INSTALLATION GUIDES | +|---------| +|[Marketplace Merchant Portal Product Management feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/merchant-portal-marketplace-product-feature-integration.html) | diff --git a/docs/marketplace/dev/front-end/202212.0/web-components.md b/docs/marketplace/dev/front-end/202212.0/web-components.md index dcab6f47cb9..ac4fbc5874b 100644 --- a/docs/marketplace/dev/front-end/202212.0/web-components.md +++ b/docs/marketplace/dev/front-end/202212.0/web-components.md @@ -63,4 +63,4 @@ import { SomeComponentModule } from './some-component/some-component.module'; export class ComponentsModule {} ``` -The complete process of creating a new module and registering it as a web component can be found in the [How-To: Create a new Angular module with application](/docs/scos/dev/tutorials-and-howtos/howtos/howto-create-an-angular-module-with-application.html). +The complete process of creating a new module and registering it as a web component can be found in the [How-To: Create a new Angular module with application](/docs/marketplace/dev/howtos/how-to-create-a-new-angular-module-with-application.html). diff --git a/docs/marketplace/dev/glue-api-guides/202212.0/resolving-search-engine-friendly-urls.md b/docs/marketplace/dev/glue-api-guides/202212.0/resolving-search-engine-friendly-urls.md index c0e61dfbdcf..77dde79ca8d 100644 --- a/docs/marketplace/dev/glue-api-guides/202212.0/resolving-search-engine-friendly-urls.md +++ b/docs/marketplace/dev/glue-api-guides/202212.0/resolving-search-engine-friendly-urls.md @@ -171,4 +171,4 @@ Using the information from the response and the Glue server name, you can constr | 404 | The provided URL does not exist. | | 422 | The `url` parameter is missing. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/marketplace/dev/glue-api-guides/202212.0/retrieving-autocomplete-and-search-suggestions.md b/docs/marketplace/dev/glue-api-guides/202212.0/retrieving-autocomplete-and-search-suggestions.md index 391e3af7afd..e8b37d6ea61 100644 --- a/docs/marketplace/dev/glue-api-guides/202212.0/retrieving-autocomplete-and-search-suggestions.md +++ b/docs/marketplace/dev/glue-api-guides/202212.0/retrieving-autocomplete-and-search-suggestions.md @@ -1800,7 +1800,7 @@ To retrieve a search suggestion, send the request: {% info_block infoBox "SEO-friendly URLs" %} -The `url` attribute of categories and abstract products exposes a SEO-friendly URL of the resource that represents the respective category or product. For information about how to resolve such a URL and retrieve the corresponding resource, see [Resolving search engine friendly URLs](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/resolving-search-engine-friendly-urls.html). +The `url` attribute of categories and abstract products exposes a SEO-friendly URL of the resource that represents the respective category or product. For information about how to resolve such a URL and retrieve the corresponding resource, see [Resolving search engine friendly URLs](/docs/scos/dev/glue-api-guides/{{page.version}}/resolving-search-engine-friendly-urls.html). {% endinfo_block %} @@ -1810,4 +1810,4 @@ Although CMS pages also expose the `url` parameter, resolving of CMS page SEF UR {% endinfo_block %} -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/merchant-management/202212.0/marketplace/tutorials-and-howtos/create-gui-table-column-types.md b/docs/marketplace/dev/howtos/how-to-add-new-guitable-column-type.md similarity index 93% rename from docs/pbc/all/merchant-management/202212.0/marketplace/tutorials-and-howtos/create-gui-table-column-types.md rename to docs/marketplace/dev/howtos/how-to-add-new-guitable-column-type.md index 44b71ce2c4b..71f469c027b 100644 --- a/docs/pbc/all/merchant-management/202212.0/marketplace/tutorials-and-howtos/create-gui-table-column-types.md +++ b/docs/marketplace/dev/howtos/how-to-add-new-guitable-column-type.md @@ -1,9 +1,7 @@ --- -title: Create Gui table column types +title: "How-To: Create a new Gui table column type" description: This articles provides details how to create a new Gui table column type template: howto-guide-template -redirect_from: - - /docs/marketplace/dev/howtos/how-to-add-new-guitable-column-type.html --- This document describes how to add new column types to a Gui table. diff --git a/docs/scos/dev/tutorials-and-howtos/howtos/howto-create-an-angular-module-with-application.md b/docs/marketplace/dev/howtos/how-to-create-a-new-angular-module-with-application.md similarity index 96% rename from docs/scos/dev/tutorials-and-howtos/howtos/howto-create-an-angular-module-with-application.md rename to docs/marketplace/dev/howtos/how-to-create-a-new-angular-module-with-application.md index 1758e9f0a34..560c1339d2a 100644 --- a/docs/scos/dev/tutorials-and-howtos/howtos/howto-create-an-angular-module-with-application.md +++ b/docs/marketplace/dev/howtos/how-to-create-a-new-angular-module-with-application.md @@ -1,5 +1,5 @@ --- -title: "HowTo: Create an Angular module with application" +title: "HowTo: Create a new Angular module with application" last_updated: Jan 17, 2023 description: This document shows how to create a new Angular module with the application template: howto-guide-template @@ -21,7 +21,7 @@ A new Angular module needs a proper scaffolding structure. The necessary list of files is provided in the [Project structure document, Module structure section](/docs/marketplace/dev/front-end/{{site.version}}/project-structure.html#module-structure). Each new Angular module can contain its own set of Twig Web Components. -## 2) Register aт Angular module +## 2) Register a new Angular module To register components, a special Angular module is created. The `components.module.ts` file contains a list of all Angular components exposed as Web Components. diff --git a/docs/scos/dev/tutorials-and-howtos/howtos/howto-split-products-by-stores.md b/docs/marketplace/dev/howtos/how-to-split-products-by-stores.md similarity index 99% rename from docs/scos/dev/tutorials-and-howtos/howtos/howto-split-products-by-stores.md rename to docs/marketplace/dev/howtos/how-to-split-products-by-stores.md index 51f9af84f94..e5f59cd39c0 100644 --- a/docs/scos/dev/tutorials-and-howtos/howtos/howto-split-products-by-stores.md +++ b/docs/marketplace/dev/howtos/how-to-split-products-by-stores.md @@ -1,9 +1,7 @@ --- -title: "HowTo: Split products by stores" +title: "How-To: Split products by stores" description: This document provides details about how to split products by stores. template: howto-guide-template -redirect_from: - - /docs/marketplace/dev/howtos/how-to-split-products-by-stores.html related: - title: Persistence ACL feature walkthrough link: docs/marketplace/dev/feature-walkthroughs/page.version/persistence-acl-feature-walkthrough/persistence-acl-feature-walkthrough.html diff --git a/docs/scos/dev/migration-concepts/upgrade-to-marketplace.md b/docs/marketplace/dev/howtos/how-to-upgrade-spryker-instance-to-marketplace.md similarity index 94% rename from docs/scos/dev/migration-concepts/upgrade-to-marketplace.md rename to docs/marketplace/dev/howtos/how-to-upgrade-spryker-instance-to-marketplace.md index eafb929ee95..3088c2e9cdd 100644 --- a/docs/scos/dev/migration-concepts/upgrade-to-marketplace.md +++ b/docs/marketplace/dev/howtos/how-to-upgrade-spryker-instance-to-marketplace.md @@ -1,14 +1,12 @@ --- -title: Upgrade to Marketplace +title: "How-To: Upgrade Spryker instance to the Marketplace" description: This document provides details how to upgrade Spryker instance to the Marketplace. template: howto-guide-template -redirect_from: - - /docs/marketplace/dev/howtos/how-to-upgrade-spryker-instance-to-marketplace.html --- This document describes how to upgrade the existing instance of Spryker Shop to the Marketplace. -## 1. Add core features +## 1) Add core features Implement the features and functionality of the Marketplace by following the integration guides from the following table. @@ -29,7 +27,7 @@ Implement the features and functionality of the Marketplace by following the int | [Marketplace Shipment](/docs/marketplace/dev/feature-integration-guides/{{site.version}}/marketplace-shipment-feature-integration.html) | The Marketplace orders are split into several shipments based on the merchants from which the items were bought. Merchants can see their shipments only. | | [Marketplace Return Management](/docs/pbc/all/return-management/{{site.version}}/marketplace/install-and-upgrade/install-the-marketplace-return-management-glue-api.html) | Order returns management enhancement for OMS. | -## 2. Add MerchantPortal features +## 2) Add MerchantPortal features Follow feature integration guides from the table that provides functionality for MerchantPortal Application. @@ -42,10 +40,7 @@ Follow feature integration guides from the table that provides functionality for | [Marketplace Merchant Portal Order Management](/docs/marketplace/dev/feature-integration-guides/{{site.version}}/merchant-portal-marketplace-order-management-feature-integration.html) | Allows merchants to manage their orders in the Merchant Portal. | | [ACL](/docs/pbc/all/user-management/{{site.version}}/install-and-upgrade/install-the-acl-feature.html) | Allows managing access to HTTP endpoints and Persistence entities. | -## 3. Build and start the instance +## 3) Build app -Rebuild your app in order to apply all the changes regarding database entities, data imports, search engine indexes, UI assets: - -```shell -docker/sdk up -``` +Please rebuild your app in order to apply all the changes regarding database entities, data imports, search engine indexes, UI assets. +Depending on the virtualization solution you use, use the recommendations in [Docker based instance build](/docs/scos/dev/set-up-spryker-locally/set-up-spryker-locally.html). diff --git a/docs/marketplace/dev/howtos/howtos.md b/docs/marketplace/dev/howtos/howtos.md new file mode 100644 index 00000000000..d07b038a3b7 --- /dev/null +++ b/docs/marketplace/dev/howtos/howtos.md @@ -0,0 +1,10 @@ +--- +title: HowTos +description: how-to guides for developers working with Marketplace +last_updated: Jan 12, 2023 +template: concept-topic-template +--- +This section contains the following Marketplace how-to guides: +* [How-To: Upgrade Spryker instance to the Marketplace](/docs/marketplace/dev/howtos/how-to-upgrade-spryker-instance-to-marketplace.html) +* [How-To: Create a new module with application](/docs/marketplace/dev/howtos/how-to-create-a-new-module-with-application.html) +* [How-To: Split products by stores](/docs/marketplace/dev/howtos/how-to-split-products-by-stores.html) diff --git a/docs/marketplace/dev/setup/202212.0/marketplace-supported-browsers.md b/docs/marketplace/dev/setup/202212.0/marketplace-supported-browsers.md new file mode 100644 index 00000000000..61f1affb970 --- /dev/null +++ b/docs/marketplace/dev/setup/202212.0/marketplace-supported-browsers.md @@ -0,0 +1,14 @@ +--- +title: Marketplace supported browsers +description: This document lists browsers supported by the Spryker Marketplace. +last_updated: Jun 8, 2022 +template: howto-guide-template +redirect_from: + - /docs/marketplace/dev/setup/marketplace-supported-browsers.html +--- + +The Spryker Marketplace supports the following browsers: + +| DESKTOP (MARKETPLACE AND MERCHANT PORTAL) | MOBILE (MARKETPLACE ONLY) | TABLET (MARKETPLACE AND MERCHANT PORTAL) | +| --- | --- | --- | +| *Browsers*:
  • Windows, macOS: Chrome (latest version)
  • Windows: Firefox (latest version)
  • Windows: Edge (latest version)
  • macOS: Safari (latest version)
*Windows versions*:
  • Windows 10
  • Windows 7
*macOS versions*:
  • Catalina 10 or later
*Screen resolutions*:
  • 1024-1920 width
| *Browsers*:
  • iOS: Safari
  • Android: Chrome
*Screen resolutions*:
  • 360x640—for example, Samsung Galaxy S8 or S9)
  • 375x667—for example, iPhone 7 or 8
  • iPhone X, Xs, Xr
*Android versions*:
  • 8.0
*iOS versions*:
  • iOS 13 or later
| *Browsers*:
  • iOS: Safari
  • Android: Chrome
*iOS versions*:
  • iOS 13
*Screen resolutions*:
  • 1024x703—for example, iPad Air
| diff --git a/docs/marketplace/dev/setup/202212.0/setup.md b/docs/marketplace/dev/setup/202212.0/setup.md new file mode 100644 index 00000000000..d33b8ef24ce --- /dev/null +++ b/docs/marketplace/dev/setup/202212.0/setup.md @@ -0,0 +1,10 @@ +--- +title: Setup +description: How to get started with the B2C Demo Marketplace +last_updated: Jan 12, 2023 +template: concept-topic-template +--- + +This section describes how to get started with the B2C Demo Marketplace, including requirements and supported browsers. It contains the following topics: +* [System requirements](/docs/marketplace/dev/setup/{{page.version}}/system-requirements.html) +* [Marketplace supported browsers](/docs/marketplace/dev/setup/{{page.version}}/marketplace-supported-browsers.html) diff --git a/docs/marketplace/dev/setup/202212.0/system-requirements.md b/docs/marketplace/dev/setup/202212.0/system-requirements.md new file mode 100644 index 00000000000..ada7a178bf8 --- /dev/null +++ b/docs/marketplace/dev/setup/202212.0/system-requirements.md @@ -0,0 +1,26 @@ +--- +title: System requirements +last_updated: May 15, 2023 +Descriptions: System infrastructure requirements for the Spryker Marketplace with Merchant Portal +template: howto-guide-template +redirect_from: + - /docs/marketplace/dev/setup/system-requirements.html + - /docs/marketplace/dev/setup/202212.0/infrastructure-requirements.html +--- + + +| OPERATING SYSTEM | NATIVE: LINUXONLY tHROUGH VM: MACOS AND MS WINDOWS | +|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Web Server | NginX—preferred. But any webserver which supports PHP will work such as lighttpd, Apache, Cherokee. | +| Databases | Depending on the project, one of the databases: MariaDB >= 10.4—preferred, PostgreSQL >=9.6, or MySQL >=5.7. | +| PHP | Spryker supports PHP `>=8.0` with the following extensions: `curl`, `json`, `mysql`, `pdo-sqlite`, `sqlite3`, `gd`, `intl`, `mysqli`, `pgsql`, `ssh2`, `gmp`, `mcrypt`, `pdo-mysql`, `readline`, `twig`, `imagick`, `memcache`, `pdo-pgsql`, `redis`, `xml`, `bz2`, `mbstring`. For details about the supported PHP versions, see [Supported Versions of PHP](/docs/scos/user/intro-to-spryker/whats-new/supported-versions-of-php.html). | +| SSL | For production systems, a valid security certificate is required for HTTPS. | +| Redis | Version >=3.2, >=5.0 | +| Elasticsearch | Version 6.*x* or 7.*x* | +| RabbitMQ | Version 3.6+ | +| Jenkins (for cronjob management) | Version 1.6.*x* or 2.*x* | +| Graphviz (for statemachine visualization) | 2.*x* | +| Symfony | Version >= 4.0 | +| Node.js | Version >= 16.0.0 | +| Intranet | Back Office application (Zed) must be secured in an Intranet (using VPN, Basic Auth, IP Allowlist, and DMZ) | +| Spryker Commerce OS | Version >= {{page.version}} | diff --git a/docs/marketplace/dev/setup/202304.0/system-requirements.md b/docs/marketplace/dev/setup/202304.0/system-requirements.md new file mode 100644 index 00000000000..3ec35dbc958 --- /dev/null +++ b/docs/marketplace/dev/setup/202304.0/system-requirements.md @@ -0,0 +1,28 @@ +--- +title: System requirements +last_updated: May 15, 2023 +Descriptions: System infrastructure requirements for the Spryker Marketplace with Merchant Portal +template: howto-guide-template +redirect_from: + - /docs/marketplace/dev/setup/system-requirements.html +related: + - title: Infrastructure requirements + link: docs/marketplace/dev/setup/page.version/infrastructure-requirements.html +--- + + +| OPERATING SYSTEM | NATIVE: LINUXONLY tHROUGH VM: MACOS AND MS WINDOWS | +|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Web Server | NginX—preferred. But any webserver which supports PHP will work such as lighttpd, Apache, Cherokee. | +| Databases | Depending on the project, one of the databases: MariaDB >= 10.4—preferred, PostgreSQL >=9.6, or MySQL >=5.7. | +| PHP | Spryker supports PHP `>=8.0` with the following extensions: `curl`, `json`, `mysql`, `pdo-sqlite`, `sqlite3`, `gd`, `intl`, `mysqli`, `pgsql`, `ssh2`, `gmp`, `mcrypt`, `pdo-mysql`, `readline`, `twig`, `imagick`, `memcache`, `pdo-pgsql`, `redis`, `xml`, `bz2`, `mbstring`. For details about the supported PHP versions, see [Supported Versions of PHP](/docs/scos/user/intro-to-spryker/whats-new/supported-versions-of-php.html). | +| SSL | For production systems, a valid security certificate is required for HTTPS. | +| Redis | Version >=3.2, >=5.0 | +| Elasticsearch | Version 6.*x* or 7.*x* | +| RabbitMQ | Version 3.6+ | +| Jenkins (for cronjob management) | Version 1.6.*x* or 2.*x* | +| Graphviz (for statemachine visualization) | 2.*x* | +| Symfony | Version >= 4.0 | +| Node.js | Version >= 18.0.0 | +| Intranet | Back Office application (Zed) must be secured in an Intranet (using VPN, Basic Auth, IP Allowlist, and DMZ) | +| Spryker Commerce OS | Version >= {{page.version}} | diff --git a/docs/scos/dev/migration-concepts/upgrade-to-angular-12.md b/docs/marketplace/dev/technical-enhancement/202212.0/migration-guide-upgrade-to-angular-v12.md similarity index 97% rename from docs/scos/dev/migration-concepts/upgrade-to-angular-12.md rename to docs/marketplace/dev/technical-enhancement/202212.0/migration-guide-upgrade-to-angular-v12.md index 4144b91804f..067d6ab551a 100644 --- a/docs/scos/dev/migration-concepts/upgrade-to-angular-12.md +++ b/docs/marketplace/dev/technical-enhancement/202212.0/migration-guide-upgrade-to-angular-v12.md @@ -1,21 +1,20 @@ --- -title: Upgrade to Angular 12 +title: Migration guide - Upgrade to Angular v12 description: Use the guide to update versions of the Angular and related modules. template: module-migration-guide-template redirect_from: - /docs/marketplace/dev/front-end/extending-the-project/migration-guide-upgrade-to-angular-v12.html - - /docs/marketplace/dev/technical-enhancement/202212.0/migration-guide-upgrade-to-angular-v12.html --- ## Upgrading from version 9.* to version 12.* This document shows how to upgrade Angular to version 12 in your Spryker project. -### Overview +### Overview Every six months, the Angular community releases a major update, and on 12th May 2021 version 12 of Angular was released. -A version upgrade is necessary for improved performance, stability, and security. Stability allows reusable components and tools and makes medium and large applications thrive and shine. +A version upgrade is necessary for improved performance, stability, and security. Stability allows reusable components and tools and makes medium and large applications thrive and shine. Angular provides regular updates to ensure stability and security. These are major, minor, and small patches. An upgrade from an existing version to a newer version always requires time and changes to the code. @@ -283,7 +282,7 @@ module.exports = { ...nxPreset }; "defaultProject": "merchant-portal" } ``` -
+
`jest.config.js` in the `frontend/merchant-portal/` folder: @@ -324,7 +323,7 @@ import 'jest-preset-angular/setup-jest'; 1. Rename `tsconfig.json` to `tsconfig.base.json` and fix usage in `tsconfig.mp.json`: -**tsconfig.mp.json** +**tsconfig.mp.json** ```json "extends": "./tsconfig.base.json", diff --git a/docs/marketplace/dev/technical-enhancement/202212.0/technical-enhancement.md b/docs/marketplace/dev/technical-enhancement/202212.0/technical-enhancement.md new file mode 100644 index 00000000000..e79926bf763 --- /dev/null +++ b/docs/marketplace/dev/technical-enhancement/202212.0/technical-enhancement.md @@ -0,0 +1,9 @@ +--- +title: Technical enhancement guides +description: Describes how to upgrade to Angluar v12 +last_updated: Jan 12, 2023 +template: concept-topic-template +--- + +This section contains the following article: +* [Migration guide – Upgrade to Angular v12](/docs/marketplace/dev/technical-enhancement/{{page.version}}/migration-guide-upgrade-to-angular-v12.html) diff --git a/docs/scos/dev/migration-concepts/upgrade-to-angular-15.md b/docs/marketplace/dev/technical-enhancement/202304.0/migration-guide-upgrade-to-angular-v15.md similarity index 96% rename from docs/scos/dev/migration-concepts/upgrade-to-angular-15.md rename to docs/marketplace/dev/technical-enhancement/202304.0/migration-guide-upgrade-to-angular-v15.md index 5952a905285..c6ad826dfaf 100644 --- a/docs/scos/dev/migration-concepts/upgrade-to-angular-15.md +++ b/docs/marketplace/dev/technical-enhancement/202304.0/migration-guide-upgrade-to-angular-v15.md @@ -1,5 +1,5 @@ --- -title: Upgrade to Angular 15 +title: Migration guide - Upgrade to Angular v15 description: Use the guide to update versions of the Angular and related modules. last_updated: Mar 24, 2023 template: module-migration-guide-template @@ -32,9 +32,9 @@ So the update requires a major release for these modules: ### 1) Update modules -1. Upgrade modules to the new version: +1. Upgrade modules to the new version: -The marketplace modules must correspond to the following versions: +The marketplace modules must correspond to the following versions: | NAME | VERSION | | ------------------------------------------- | --------- | @@ -72,9 +72,9 @@ Make sure you are using [Node.js 18 or later](https://nodejs.org/en/download). {% endinfo_block %} -1. In `package.json`, do the following: +1. In `package.json`, do the following: - 1. Update or add the following dependencies: + 1. Update or add the following dependencies: ```json { @@ -151,7 +151,7 @@ Ensure that the `package-lock.json` file and the `node_modules` folder have been 1. In `frontend/merchant-portal` folder, do the following: - 1. Rename the `jest.config.js` file to `jest.config.ts` and replace its content with the following: + 1. Rename the `jest.config.js` file to `jest.config.ts` and replace its content with the following: ```ts export default { @@ -174,7 +174,7 @@ Ensure that the `package-lock.json` file and the `node_modules` folder have been passWithNoTests: true, }; ``` - + 2. In `jest.preset.js`, replace its content with the following: ```js @@ -210,7 +210,7 @@ Ensure that the `package-lock.json` file and the `node_modules` folder have been ] } ``` - + 4. In `webpack.config.ts`, add aliases to resolve imports paths in `.less` files: ```js @@ -220,7 +220,7 @@ Ensure that the `package-lock.json` file and the `node_modules` folder have been }; ``` -2. In `angular.json`, add the following changes: +2. In `angular.json`, add the following changes: 1. Update the `test` section: @@ -235,16 +235,16 @@ Ensure that the `package-lock.json` file and the `node_modules` folder have been // must be "outputs": ["{projectRoot}/coverage"] ``` - + 2. Remove the `defaultProject` section. - + 3. Add the `.angular` folder to `.gitignore` and `.prettierignore` files: ```text /.angular/ ``` -4. In `nx.json`, replace its content with the following: +4. In `nx.json`, replace its content with the following: ```json { @@ -278,7 +278,7 @@ Ensure that the `package-lock.json` file and the `node_modules` folder have been } ``` -5. In `tsconfig.base.json`, add the following changes: +5. In `tsconfig.base.json`, add the following changes: 1. In `compilerOptions` section, change the `target` property and add the new `useDefineForClassFields` property. 2. In `exclude` section, add the `"**/*.test.ts"` file extension. @@ -296,7 +296,7 @@ Ensure that the `package-lock.json` file and the `node_modules` folder have been } ``` -6. In `tsconfig.mp.json`, add the `"src/Pyz/Zed/ZedUi/Presentation/Components/environments/environment.prod.ts"` path to the `include` section: +6. In `tsconfig.mp.json`, add the `"src/Pyz/Zed/ZedUi/Presentation/Components/environments/environment.prod.ts"` path to the `include` section: ```json { @@ -317,7 +317,7 @@ Ensure that the `package-lock.json` file and the `node_modules` folder have been - `tslint.mp-githook.json` - `tslint.mp.json` -2. Add a new `.eslintrc.mp.json` file to the root folder with the following content: +2. Add a new `.eslintrc.mp.json` file to the root folder with the following content: ```json { @@ -422,7 +422,7 @@ Ensure that the `package-lock.json` file and the `node_modules` folder have been }, ``` -4. In `tslint.json`, add the `"src/Pyz/Zed/*/Presentation/Components/**"` path to the `linterOptions.exlude` section: +4. In `tslint.json`, add the `"src/Pyz/Zed/*/Presentation/Components/**"` path to the `linterOptions.exlude` section: ```json { @@ -436,7 +436,7 @@ Ensure that the `package-lock.json` file and the `node_modules` folder have been } ``` -5. Make sure to replace `tslint` disable comments with `eslint`—for example: +5. Make sure to replace `tslint` disable comments with `eslint`—for example: ```ts /* tslint:disable:no-unnecessary-class */ diff --git a/docs/marketplace/user/features/202108.0/marketplace-promotions-and-discounts-feature-overview.md b/docs/marketplace/user/features/202108.0/marketplace-promotions-and-discounts-feature-overview.md index 6bb13f6416f..e20eb16ecc0 100644 --- a/docs/marketplace/user/features/202108.0/marketplace-promotions-and-discounts-feature-overview.md +++ b/docs/marketplace/user/features/202108.0/marketplace-promotions-and-discounts-feature-overview.md @@ -2,7 +2,6 @@ title: Marketplace Promotions and Discounts feature overview description: This document contains concept information for the Marketplace Promotions and Discounts feature. template: concept-topic-template -lust_udpated: Jul 17, 2023 related: - title: Discount link: docs/marketplace/dev/feature-walkthroughs/page.version/marketplace-promotions-and-discounts-feature-walkthrough.html @@ -64,7 +63,7 @@ A decision rule is a condition assigned to a discount that should be fulfilled f A discount can have one or more decision rules. Find an exemplary combination below: -| Parameter | RELATION OPERATOR | VALUE | +| Parameter | RELATION OPERATOR | Value | | --- | --- | --- | | total-quantity | equal | 3 | | day-of-week| equal | 5 | @@ -140,9 +139,7 @@ The Marketplace discounts are applied based on the query string. The *query string* is a discount application type that uses [decision rules](#decision-rule) to dynamically define what products a discount applies to. The discount in the following example applies to white products. - ![Query collection](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+&+Discounts/Discount/Discount+Feature+Overview/collection-query.png) - The product selection based on the query string is dynamic: * If at some point, the color attribute of a product changes from white to anything else, the product is no longer eligible to be discounted. * If at some point, a product receives the white color attribute, it becomes eligible for the discount. @@ -161,9 +158,9 @@ With the calculator fixed type, the currency of the respective shop is used for {% endinfo_block %} -See examples in the following table. -| PRODUCT PRICE | CALCULATION TYPE | AMOUNT | DISCOUNT APPLIED | PRICE TO PAY | +See examples in the following table. +| Product price | Calculation type | Amount | Discount applied | Price to pay | | --- | --- | --- | --- | --- | | €50 | Calculator percentage | 10 | €5 | €45 | | €50 | Calculator fixed | 10 | €10 | €40 | @@ -184,7 +181,7 @@ An exclusive discount is a discount that, when applied to a cart, discards all t In the following example, a cart with the order total amount of €100 contains the following discounts. -| DISCOUNT NAME | DISCOUNT AMOUNT | DISCOUNT TYPE | EXCLUSIVENESS | DISCOUNTED AMOUNT | +| Discount name | Discount amount | Discount type | Exclusiveness | Discounted amount | | --- | --- | --- | --- | --- | | D1 | 15 | Calculator percentage | Exclusive | €15 | |D2|5| Calculator fixed | Exclusive | €5 | @@ -202,7 +199,7 @@ A non-exclusive discount is a discount that can be combined with other non-exclu In the following example, a cart with the order total amount of €30 contains the following discounts. -| DISCOUNT NAME | DISCOUNT AMOUNT | DISCOUNT TYPE | EXCLUSIVENESS | DISCOUNTED AMOUNT | +| Discount name | Discount amount | Discount type | Exclusiveness | Discounted amount | | --- | --- | --- | --- | --- | | D1 | 15 | Calculator percentage | Non-exclusive | €15 | | D2 | 5 | Calculator fixed | Non-exclusive | €5 | diff --git a/docs/marketplace/user/features/202204.0/marketplace-inventory-management-feature-overview.md b/docs/marketplace/user/features/202204.0/marketplace-inventory-management-feature-overview.md index 21caa723992..8daf5081ea3 100644 --- a/docs/marketplace/user/features/202204.0/marketplace-inventory-management-feature-overview.md +++ b/docs/marketplace/user/features/202204.0/marketplace-inventory-management-feature-overview.md @@ -32,7 +32,7 @@ Also, you can do the following using the data import: * Manage stock of product offers for a merchant by importing the product offer and stock data separately: [File details: product_offer_stock.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-product-offer-stock.csv.html). * Define stock when importing the product offer data: [File details: combined_merchant_product_offer.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-combined-merchant-product-offer.csv.html). * Import merchant stock data: [File details: merchant_stock.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant-stock.csv.html). -* Import stock of merchant products: [File details: product_stock.csv](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/import-and-export-data/file-details-product-stock.csv.html). +* Import stock of merchant products: [File details: product_stock.csv](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/import-data/file-details-product-stock.csv.html). ## Marketplace availability management diff --git a/docs/marketplace/user/features/202204.0/marketplace-promotions-and-discounts-feature-overview.md b/docs/marketplace/user/features/202204.0/marketplace-promotions-and-discounts-feature-overview.md index c6084b8b840..fd05db183b8 100644 --- a/docs/marketplace/user/features/202204.0/marketplace-promotions-and-discounts-feature-overview.md +++ b/docs/marketplace/user/features/202204.0/marketplace-promotions-and-discounts-feature-overview.md @@ -2,7 +2,6 @@ title: Marketplace Promotions and Discounts feature overview description: This document contains concept information for the Marketplace Promotions and Discounts feature. template: concept-topic-template -last_udpated: Jul 17, 2023 related: - title: Discount link: docs/marketplace/dev/feature-walkthroughs/page.version/marketplace-promotions-and-discounts-feature-walkthrough.html @@ -15,11 +14,11 @@ There are two discount types: * Voucher * Cart rule -A product catalog manager selects a discount type when [creating a discount](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html). +A product catalog manager selects a discount type when [creating a discount](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-in-the-back-office/create-discounts.html). {% info_block warningBox "Warning" %} -In current implementation, it is impossible to create cart rules or vouchers based on any merchant parameters, such as merchant or product offer. However, it is still possible to create cart rules and vouchers for the marketplace products. See [Create discounts](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html) for more details. +In current implementation, it is impossible to create cart rules or vouchers based on any merchant parameters, such as merchant or product offer. However, it is still possible to create cart rules and vouchers for the marketplace products. See [Create discounts](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-in-the-back-office/create-discounts.html) for more details. {% endinfo_block %} @@ -37,38 +36,34 @@ Based on the business logic, discounts can be applied in the following ways: ## Voucher A *Voucher* is a discount that applies when a customer enters an active voucher code on the *Cart* page. - ![Cart voucher](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Features/Marketplace+Promotions+and+Discounts+feature+overview/voucher-storefront.png) Once the customer clicks **Redeem code**, the page refreshes to show the discount name, discount value, and available actions: **Remove** and **Clear all**. The **Clear all** action disables all the applied discounts. The **Remove** action disables a single discount. - ![Cart voucher applied](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Features/Marketplace+Promotions+and+Discounts+feature+overview/voucher-cart.png) Multiple voucher codes can be generated for a single voucher. The code has a **Max number of uses** value which defines how many times the code can be redeemed. You can enter codes manually or use the code generator in the Back Office. - ![Generate codes](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+&+Discounts/Discount/Discount+Feature+Overview/generate_codes.png) To learn how a product catalog manager can create a voucher in the Back Office, see [Creating a voucher](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html). ## Cart Rule -A *cart rule* is a discount that applies to the cart once all the [decision rules](#decision-rule) linked to the cart rule are fulfilled. +A *cart rule* is a discount that applies to cart once all the [decision rules](#decision-rule) linked to the cart rule are fulfilled. The cart rule is applied automatically. If the decision rules of a discount are fulfilled, the customer can see the discount upon entering the cart. Unlike with [vouchers](#voucher), the **Clear all** and **Remove** actions are not displayed. - ![Cart rule](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Features/Marketplace+Promotions+and+Discounts+feature+overview/cart-rule-storefront.png) -To learn how a product catalog manager can create a cart rule in the Back Office, see [Create discounts](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html). +To learn how a product catalog manager can create a cart rule in the Back Office, see [Create discounts](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-in-the-back-office/create-discounts.html). ### Decision rule A decision rule is a condition assigned to a discount that should be fulfilled for the discount to be applied. A discount can have one or more decision rules. Find an exemplary combination below: -| PARAMETER | RELATION OPERATOR | VALUE | +| Parameter | RELATION OPERATOR | Value | | --- | --- | --- | | total-quantity | equal | 3 | | day-of-week| equal | 5 | @@ -103,11 +98,9 @@ Decision rules are combined with *AND* and *OR* combination operators. With the In the following example, for the discount to be applied, a cart should contain three items, and the purchase should be made on Wednesday. - ![AND operator](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+&+Discounts/Discount/Discount+Feature+Overview/and-operator.png) In the following example, for the discount to be applied, a cart should contain three items, or the purchase should be made on Wednesday. - ![OR operator](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+&+Discounts/Discount/Discount+Feature+Overview/or-operator.png) {% info_block infoBox "Info" %} @@ -123,15 +116,15 @@ A rule group is a separate set of rules with its own combination operator. ![Decision rule group](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+%26+Discounts/Discount/Discount+Feature+Overview/decision-rule-group.png) -With the rule groups, you can build multiple levels of rule hierarchy. When a cart is evaluated against the rules, it is evaluated on all levels of the hierarchy. On each level, there can be both rules and rule groups. +With the rule groups, you can build multiple levels of rule hierarchy. When a cart is evaluated against the rules, it is evaluated on all the levels of the hierarchy. On each level, there can be both rules and rule groups. ![Decision rule hierarchy](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+%26+Discounts/Discount/Discount+Feature+Overview/decision-rule-hierarchy.png) -When a cart is evaluated on a level that has a rule and a rule group, the rule group is treated as a single rule. The following diagram shows how a cart is evaluated against the rules in the previous screenshot. +When a cart is evaluated on a level that has a rule and a rule group, the rule group is treated as a single rule. The following diagram shows how a cart is evaluated against the rules on the previous screenshot. ### Discount threshold A *threshold* is a minimum number of items in the cart that should fulfill all the specified decision rules for the discount to be applied. -The default value is *1*. It means that a discount is applied if at least one item fulfills the discount's decision rules. +The default value is *1* . It means that a discount is applied if at least one item fulfills the discount's decision rules. In the following example, the discount is applied if there are four items with the Intel Core processor in the cart. ![Threshold](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+&+Discounts/Discount/Discount+Feature+Overview/threshold.png) @@ -146,9 +139,7 @@ The Marketplace discounts are applied based on the query string. The *query string* is a discount application type that uses [decision rules](#decision-rule) to dynamically define what products a discount applies to. The discount in the following example applies to white products. - ![Query collection](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+&+Discounts/Discount/Discount+Feature+Overview/collection-query.png) - The product selection based on the query string is dynamic: * If at some point, the color attribute of a product changes from white to anything else, the product is no longer eligible to be discounted. * If at some point, a product receives the white color attribute, it becomes eligible for the discount. @@ -169,20 +160,19 @@ With the calculator fixed type, the currency of the respective shop is used for See examples in the following table. - -| PRODUCT PRICE | CALCULATION TYPE | AMOUNT | DISCOUNT APPLIED | PRICE TO PAY | +| Product price | Calculation type | Amount | Discount applied | Price to pay | | --- | --- | --- | --- | --- | | €50 | Calculator percentage | 10 | €5 | €45 | | €50 | Calculator fixed | 10 | €10 | €40 | -A product catalog manager defines calculation when [creating a voucher](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html) or [Create discounts](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html). +A product catalog manager defines calculation when [creating a voucher](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html) or [Create discounts](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-in-the-back-office/create-discounts.html). ![Discount calculation](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+&+Discounts/Discount/Discount+Feature+Overview/discount_calculation.png) ## Discount exclusiveness Discount exclusiveness defines if a discount value of a discount can be combined with the discount value of other discounts in a single order. -A product catalog manager defines calculation when [creating a voucher](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html) or [Create discounts](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html). +A product catalog manager defines calculation when [creating a voucher](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html) or [Create discounts](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-in-the-back-office/create-discounts.html). ![Exclusive discount](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+&+Discounts/Discount/Discount+Feature+Overview/exclusivity.png) ### Exclusive discount @@ -191,7 +181,7 @@ An exclusive discount is a discount that, when applied to a cart, discards all t In the following example, a cart with the order total amount of €100 contains the following discounts. -| DISCOUNT NAME | DISCOUNT AMOUNT | DISCOUNT TYPE | EXCLUSIVENESS | DISCOUNTED AMOUNT | +| Discount name | Discount amount | Discount type | Exclusiveness | Discounted amount | | --- | --- | --- | --- | --- | | D1 | 15 | Calculator percentage | Exclusive | €15 | |D2|5| Calculator fixed | Exclusive | €5 | @@ -209,7 +199,7 @@ A non-exclusive discount is a discount that can be combined with other non-exclu In the following example, a cart with the order total amount of €30 contains the following discounts. -| DISCOUNT NAME | DISCOUNT AMOUNT | DISCOUNT TYPE | EXCLUSIVENESS | DISCOUNTED AMOUNT | +| Discount name | Discount amount | Discount type | Exclusiveness | Discounted amount | | --- | --- | --- | --- | --- | | D1 | 15 | Calculator percentage | Non-exclusive | €15 | | D2 | 5 | Calculator fixed | Non-exclusive | €5 | @@ -225,7 +215,7 @@ A *validity interval* is a time period during which a discount is active and can If a cart is eligible for a discount outside of its validity interval, the cart rule is not applied. If a customer enters a voucher code outside of its validity interval, they get a "Your voucher code is invalid." message. -A product catalog manager defines the calculation when [creating a discount](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html). +A product catalog manager defines calculation when [creating a discount](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-in-the-back-office/create-discounts.html). ![Validity interval](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+&+Discounts/Discount/Discount+Feature+Overview/validity-interval.png) {% info_block warningBox "Developer guides" %} diff --git a/docs/marketplace/user/merchant-portal-user-guides/202212.0/logging-in-to-the-merchant-portal.md b/docs/marketplace/user/merchant-portal-user-guides/202212.0/logging-in-to-the-merchant-portal.md index 2413e0bd195..91fe254c49c 100644 --- a/docs/marketplace/user/merchant-portal-user-guides/202212.0/logging-in-to-the-merchant-portal.md +++ b/docs/marketplace/user/merchant-portal-user-guides/202212.0/logging-in-to-the-merchant-portal.md @@ -69,7 +69,16 @@ The **Reset Password** page opens. Your password is now updated. To log in, enter the new password in the login form. -## Next steps + + + +**What’s Next?** To have a quick overview of Merchant performance, see [Managing merchant's performance data](/docs/marketplace/user/merchant-portal-user-guides/{{page.version}}/dashboard/managing-merchants-performance-data.html). diff --git a/docs/pbc/all/back-office/202400.0/unified-commerce/install-and-upgrade/install-the-spryker-core-back-office-warehouse-user-management-feature.md b/docs/pbc/all/back-office/202304.0/install-spryker-core-back-office-warehouse-user-management-feature.md similarity index 82% rename from docs/pbc/all/back-office/202400.0/unified-commerce/install-and-upgrade/install-the-spryker-core-back-office-warehouse-user-management-feature.md rename to docs/pbc/all/back-office/202304.0/install-spryker-core-back-office-warehouse-user-management-feature.md index e638802e5fc..02645f32cd1 100644 --- a/docs/pbc/all/back-office/202400.0/unified-commerce/install-and-upgrade/install-the-spryker-core-back-office-warehouse-user-management-feature.md +++ b/docs/pbc/all/back-office/202304.0/install-spryker-core-back-office-warehouse-user-management-feature.md @@ -4,7 +4,6 @@ description: Learn how to integrate the Spryker Core Back Office + Warehouse Use last_updated: Jan 25, 2023 template: feature-integration-guide-template redirect_from: - - /docs/pbc/all/back-office/202400.0/unified-commerce/fulfillment-app/install-the-spryker-core-back-office-warehouse-user-management-feature.html - /docs/scos/dev/feature-integration-guides/202304.0/spryker-core-back-office-warehouse-user-management-feature-integration.html --- diff --git a/docs/pbc/all/carrier-management/202212.0/base-shop/manage-via-glue-api/retrieve-shipments-in-orders.md b/docs/pbc/all/carrier-management/202212.0/base-shop/manage-via-glue-api/retrieve-shipments-in-orders.md index 2496a882255..a9f5633d173 100644 --- a/docs/pbc/all/carrier-management/202212.0/base-shop/manage-via-glue-api/retrieve-shipments-in-orders.md +++ b/docs/pbc/all/carrier-management/202212.0/base-shop/manage-via-glue-api/retrieve-shipments-in-orders.md @@ -352,4 +352,4 @@ To retrieve detailed information about an order, send the following request: |002| Access token is missing. | |801| Order with the given order reference is not found. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/carrier-management/202400.0/unified-commerce/import-and-export-data/file-details-shipment-method-shipment-type.csv.md b/docs/pbc/all/carrier-management/202304.0/base-shop/import-and-export-data/file-details-shipment-method-shipment-type.csv.md similarity index 92% rename from docs/pbc/all/carrier-management/202400.0/unified-commerce/import-and-export-data/file-details-shipment-method-shipment-type.csv.md rename to docs/pbc/all/carrier-management/202304.0/base-shop/import-and-export-data/file-details-shipment-method-shipment-type.csv.md index 681cc7145c1..0f518704682 100644 --- a/docs/pbc/all/carrier-management/202400.0/unified-commerce/import-and-export-data/file-details-shipment-method-shipment-type.csv.md +++ b/docs/pbc/all/carrier-management/202304.0/base-shop/import-and-export-data/file-details-shipment-method-shipment-type.csv.md @@ -3,8 +3,6 @@ title: File details - shipment_method_shipment_type.csv description: This document describes the shipment_method_shipment_type.csv file to configure the shipment information in your Spryker Demo Shop. template: data-import-template last_updated: May 23, 2023 -redirect_from: - - /docs/pbc/all/carrier-management/202304.0/base-shop/import-and-export-data/file-details-shipment-method-shipment-type.csv.html --- This document describes the `shipment_method_shipment_type.csv` file to configure the [shipment method](/docs/pbc/all/carrier-management/base-shop/shipment-feature-overview.html) and store information in your Spryker Demo Shop. diff --git a/docs/pbc/all/carrier-management/202400.0/unified-commerce/import-and-export-data/file-details-shipment-type-store.csv.md b/docs/pbc/all/carrier-management/202304.0/base-shop/import-and-export-data/file-details-shipment-type-store.csv.md similarity index 92% rename from docs/pbc/all/carrier-management/202400.0/unified-commerce/import-and-export-data/file-details-shipment-type-store.csv.md rename to docs/pbc/all/carrier-management/202304.0/base-shop/import-and-export-data/file-details-shipment-type-store.csv.md index 7b9d619b6e9..6871eea732d 100644 --- a/docs/pbc/all/carrier-management/202400.0/unified-commerce/import-and-export-data/file-details-shipment-type-store.csv.md +++ b/docs/pbc/all/carrier-management/202304.0/base-shop/import-and-export-data/file-details-shipment-type-store.csv.md @@ -3,8 +3,6 @@ title: File details - shipment_type_store.csv description: This document describes the shipment_type_store.csv file to configure the shipment information in your Spryker Demo Shop. template: data-import-template last_updated: May 23, 2023 -redirect_From: - - /docs/pbc/all/carrier-management/202304.0/base-shop/import-and-export-data/file-details-shipment-type-store.csv.html --- This document describes the `shipment_type_store.csv` file to configure the [shipment method](/docs/pbc/all/carrier-management/base-shop/shipment-feature-overview.html) and store information in your Spryker Demo Shop. diff --git a/docs/pbc/all/carrier-management/202400.0/unified-commerce/import-and-export-data/file-details-shipment-type.csv.md b/docs/pbc/all/carrier-management/202304.0/base-shop/import-and-export-data/file-details-shipment-type.csv.md similarity index 91% rename from docs/pbc/all/carrier-management/202400.0/unified-commerce/import-and-export-data/file-details-shipment-type.csv.md rename to docs/pbc/all/carrier-management/202304.0/base-shop/import-and-export-data/file-details-shipment-type.csv.md index 7d36eb56f27..995f50dd1ca 100644 --- a/docs/pbc/all/carrier-management/202400.0/unified-commerce/import-and-export-data/file-details-shipment-type.csv.md +++ b/docs/pbc/all/carrier-management/202304.0/base-shop/import-and-export-data/file-details-shipment-type.csv.md @@ -3,8 +3,6 @@ title: File details - shipment_type.csv description: This document describes the shipment_type.csv file to configure the shipment information in your Spryker Demo Shop. template: data-import-template last_updated: May 23, 2023 -redirect_from: - - /docs/pbc/all/carrier-management/202304.0/base-shop/import-and-export-data/file-details-shipment-type.csv.html --- This document describes the `shipment_type.csv` file to configure the [shipment method](/docs/pbc/all/carrier-management/base-shop/shipment-feature-overview.html) and store information in your Spryker Demo Shop. diff --git a/docs/pbc/all/carrier-management/202400.0/unified-commerce/install-and-upgrade/install-the-shipment-feature.md b/docs/pbc/all/carrier-management/202304.0/base-shop/install-and-upgrade/install-the-shipment-feature.md similarity index 97% rename from docs/pbc/all/carrier-management/202400.0/unified-commerce/install-and-upgrade/install-the-shipment-feature.md rename to docs/pbc/all/carrier-management/202304.0/base-shop/install-and-upgrade/install-the-shipment-feature.md index c96a00b5f03..06e838c8cee 100644 --- a/docs/pbc/all/carrier-management/202400.0/unified-commerce/install-and-upgrade/install-the-shipment-feature.md +++ b/docs/pbc/all/carrier-management/202304.0/base-shop/install-and-upgrade/install-the-shipment-feature.md @@ -1,7 +1,7 @@ --- title: Install the Shipment feature description: Use the guide to install the Shipment Back Office UI, Delivery method per store, and Shipment data import functionalities in your project. -last_updated: Jul 24, 2023 +last_updated: Apr 26, 2023 template: feature-integration-guide-template originalLink: https://documentation.spryker.com/2021080/docs/shipment-feature-integration originalArticleId: 593f9273-8a34-4a11-afdf-a21e7e74a57b diff --git a/docs/pbc/all/carrier-management/202400.0/unified-commerce/install-and-upgrade/install-the-shipment-service-points-feature.md b/docs/pbc/all/carrier-management/202400.0/unified-commerce/install-and-upgrade/install-the-shipment-service-points-feature.md deleted file mode 100644 index 8cb45ecc6e2..00000000000 --- a/docs/pbc/all/carrier-management/202400.0/unified-commerce/install-and-upgrade/install-the-shipment-service-points-feature.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: Install the Shipment + Service Points feature -description: Learn how to integrate the Shipment + Service Points feature into your project -last_updated: May 30, 2023 -template: feature-integration-guide-template -redirect_from: - - /docs/scos/dev/feature-integration-guides/202304.0/install-the-shipment-service-points-feature.html ---- - -{% include pbc/all/install-features/202400.0/install-the-shipment-service-points-feature.md %} diff --git a/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/check-out/update-payment-data.md b/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/check-out/update-payment-data.md index 3eafffec7fe..afbc84cb154 100644 --- a/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/check-out/update-payment-data.md +++ b/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/check-out/update-payment-data.md @@ -29,7 +29,7 @@ When [checking out purchases](/docs/pbc/all/cart-and-checkout/{{site.version}}/b It is the responsibility of the API Client to redirect the customer to the page and capture the response. For information on how to process it, see the payment service provider's API reference. -The formats of the payloads used in the request and response to the third-party page are defined by the Eco layer module that implements the interaction with the payment provider. See [3. Implement Payload Processor Plugin](/docs/pbc/all/payment-service-provider/{{site.version}}/spryker-pay/base-shop/interact-with-third-party-payment-providers-using-glue-api.html#implement-payload-processor-plugin) to learn more. +The formats of the payloads used in the request and response to the third-party page are defined by the Eco layer module that implements the interaction with the payment provider. See [3. Implement Payload Processor Plugin](/docs/pbc/all/payment-service-provider/{{site.version}}/interact-with-third-party-payment-providers-using-glue-api.html#implement-payload-processor-plugin) to learn more. **Interaction Diagram** @@ -87,7 +87,7 @@ To update payment with a payload from a third-party payment provider, send the r | ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | | --- | --- | --- | --- | -| paymentIdentifier | String | | The Unique payment ID. To get it, [place. an order](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/manage-using-glue-api/check-out/check-out-purchases.html#place-an-order). The value depends on the payment services provider plugin used to process the payment. For details, see [3. Implement Payload Processor Plugin](/docs/pbc/all/payment-service-provider/{{site.version}}/spryker-pay/base-shop/interact-with-third-party-payment-providers-using-glue-api.html#implement-payload-processor-plugin). | +| paymentIdentifier | String | | The Unique payment ID. To get it, [place. an order](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/manage-using-glue-api/check-out/check-out-purchases.html#place-an-order). The value depends on the payment services provider plugin used to process the payment. For details, see [3. Implement Payload Processor Plugin](/docs/pbc/all/payment-service-provider/{{site.version}}/interact-with-third-party-payment-providers-using-glue-api.html#implement-payload-processor-plugin). | | dataPayload | Array | v | Payload from the payment service provider. The attributes of the payload depend on the selected payment service provider. | diff --git a/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/manage-carts-of-registered-users.md b/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/manage-carts-of-registered-users.md index a9901744233..47869272768 100644 --- a/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/manage-carts-of-registered-users.md +++ b/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/manage-carts-of-registered-users.md @@ -3076,4 +3076,4 @@ If the cart is deleted successfully, the endpoint returns the `204 No Content` s | 118 | Price mode is missing. | | 119 | Price mode is incorrect. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/manage-items-in-carts-of-registered-users.md b/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/manage-items-in-carts-of-registered-users.md index dd0ac6c3a58..a7bd6b84cc9 100644 --- a/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/manage-items-in-carts-of-registered-users.md +++ b/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/manage-items-in-carts-of-registered-users.md @@ -3245,4 +3245,4 @@ If the item is deleted successfully, the endpoint returns the “204 No Content | 4006 | The configured bundle cannot be updated. | | 4007 | The configured bundle cannot be removed. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/manage-guest-carts/manage-guest-cart-items.md b/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/manage-guest-carts/manage-guest-cart-items.md index 2d93da16c23..f53ecb244e3 100644 --- a/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/manage-guest-carts/manage-guest-cart-items.md +++ b/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/manage-guest-carts/manage-guest-cart-items.md @@ -3314,4 +3314,4 @@ If the item is deleted successfully, the endpoint returns the “204 No Content | 4006 | The configured bundle cannot be updated. | | 4007 | The configured bundle cannot be removed. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/manage-guest-carts/manage-guest-carts.md b/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/manage-guest-carts/manage-guest-carts.md index bda6f8a4091..7102092ac97 100644 --- a/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/manage-guest-carts/manage-guest-carts.md +++ b/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/manage-guest-carts/manage-guest-carts.md @@ -1193,4 +1193,4 @@ In a **single cart** environment, items from the guest cart have been added to | 118 | Price mode is missing. | | 119 | Price mode is incorrect. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/retrieve-customer-carts.md b/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/retrieve-customer-carts.md index d27b92360e5..237aa0777de 100644 --- a/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/retrieve-customer-carts.md +++ b/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/retrieve-customer-carts.md @@ -1625,4 +1625,4 @@ For the attributes of the included resources, see: | 402 | Customer with the specified ID was not found. | | 802 | Request is unauthorized. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/cart-and-checkout/202212.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkoutrestapi-module.md b/docs/pbc/all/cart-and-checkout/202212.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkoutrestapi-module.md index fa6dcc91660..93de8bb84a4 100644 --- a/docs/pbc/all/cart-and-checkout/202212.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkoutrestapi-module.md +++ b/docs/pbc/all/cart-and-checkout/202212.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkoutrestapi-module.md @@ -23,7 +23,7 @@ redirect_from: - /docs/pbc/all/cart-and-checkout/202212.0/install-and-upgrade/upgrade-modules/upgrade-the-checkoutrestapi-module.html related: - title: Migration guide - Payment - link: docs/pbc/all/payment-service-provider/page.version/spryker-pay/base-shop/install-and-upgrade/upgrade-the-payment-module.html + link: docs/pbc/all/payment-service-provider/page.version/install-and-upgrade/upgrade-the-payment-module.html --- {% include pbc/all/upgrade-modules/upgrade-glue-api-modules/upgrade-the-checkoutrestapi-module.md %} diff --git a/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/check-out/update-payment-data.md b/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/check-out/update-payment-data.md index 7e21ed6ca0f..d502ed6e79c 100644 --- a/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/check-out/update-payment-data.md +++ b/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/check-out/update-payment-data.md @@ -29,7 +29,7 @@ When [checking out purchases](/docs/pbc/all/cart-and-checkout/{{site.version}}/b It is the responsibility of the API Client to redirect the customer to the page and capture the response. For information on how to process it, see the payment service provider's API reference. -The formats of the payloads used in the request and response to the third-party page are defined by the Eco layer module that implements the interaction with the payment provider. See [3. Implement Payload Processor Plugin](/docs/pbc/all/payment-service-provider/{{page.version}}/spryker-pay/base-shop/interact-with-third-party-payment-providers-using-glue-api.html#implement-payload-processor-plugin) to learn more. +The formats of the payloads used in the request and response to the third-party page are defined by the Eco layer module that implements the interaction with the payment provider. See [3. Implement Payload Processor Plugin](/docs/pbc/all/payment-service-provider/{{page.version}}/interact-with-third-party-payment-providers-using-glue-api.html#implement-payload-processor-plugin) to learn more. **Interaction Diagram** @@ -87,7 +87,7 @@ To update payment with a payload from a third-party payment provider, send the r | ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | | --- | --- | --- | --- | -| paymentIdentifier | String | | The Unique payment ID. To get it, [place. an order](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/manage-using-glue-api/check-out/check-out-purchases.html#place-an-order). The value depends on the payment services provider plugin used to process the payment. For details, see [3. Implement Payload Processor Plugin](/docs/pbc/all/payment-service-provider/{{page.version}}/spryker-pay/base-shop/interact-with-third-party-payment-providers-using-glue-api.html#implement-payload-processor-plugin). | +| paymentIdentifier | String | | The Unique payment ID. To get it, [place. an order](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/manage-using-glue-api/check-out/check-out-purchases.html#place-an-order). The value depends on the payment services provider plugin used to process the payment. For details, see [3. Implement Payload Processor Plugin](/docs/pbc/all/payment-service-provider/{{page.version}}/interact-with-third-party-payment-providers-using-glue-api.html#implement-payload-processor-plugin). | | dataPayload | Array | v | Payload from the payment service provider. The attributes of the payload depend on the selected payment service provider. | diff --git a/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/manage-carts-of-registered-users.md b/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/manage-carts-of-registered-users.md index 4c756330ffb..a3a4a7d08df 100644 --- a/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/manage-carts-of-registered-users.md +++ b/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/manage-carts-of-registered-users.md @@ -3077,4 +3077,4 @@ If the cart is deleted successfully, the endpoint returns the `204 No Content` s | 118 | Price mode is missing. | | 119 | Price mode is incorrect. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/manage-items-in-carts-of-registered-users.md b/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/manage-items-in-carts-of-registered-users.md index 7542649b43d..0b2936366b3 100644 --- a/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/manage-items-in-carts-of-registered-users.md +++ b/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/manage-items-in-carts-of-registered-users.md @@ -3245,4 +3245,4 @@ If the item is deleted successfully, the endpoint returns the “204 No Content | 4006 | The configured bundle cannot be updated. | | 4007 | The configured bundle cannot be removed. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-guest-carts/manage-guest-cart-items.md b/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-guest-carts/manage-guest-cart-items.md index 2192d353f6c..1d87eeb6a16 100644 --- a/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-guest-carts/manage-guest-cart-items.md +++ b/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-guest-carts/manage-guest-cart-items.md @@ -3314,4 +3314,4 @@ If the item is deleted successfully, the endpoint returns the “204 No Content | 4006 | The configured bundle cannot be updated. | | 4007 | The configured bundle cannot be removed. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-guest-carts/manage-guest-carts.md b/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-guest-carts/manage-guest-carts.md index cf7949ba9ba..550cf8baeff 100644 --- a/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-guest-carts/manage-guest-carts.md +++ b/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-guest-carts/manage-guest-carts.md @@ -1210,4 +1210,4 @@ In a *single cart* environment, items from the guest cart have been added to t | 118 | Price mode is missing. | | 119 | Price mode is incorrect. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/retrieve-customer-carts.md b/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/retrieve-customer-carts.md index 68a25badad1..44e2d12cd11 100644 --- a/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/retrieve-customer-carts.md +++ b/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/retrieve-customer-carts.md @@ -1625,4 +1625,4 @@ For the attributes of the included resources, see: | 402 | Customer with the specified ID was not found. | | 802 | Request is unauthorized. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/cart-and-checkout/202212.0/marketplace/install/install-features/install-the-cart-marketplace-product-feature.md b/docs/pbc/all/cart-and-checkout/202212.0/marketplace/install/install-features/install-the-cart-marketplace-product-feature.md deleted file mode 100644 index 78b3cb29233..00000000000 --- a/docs/pbc/all/cart-and-checkout/202212.0/marketplace/install/install-features/install-the-cart-marketplace-product-feature.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: Install the Cart + Marketplace Product feature -last_updated: Dec 16, 2020 -description: This document describes the process how to integrate the Cart + Marketplace Product feature into a Spryker project. -template: feature-integration-guide-template ---- - -{% include pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-cart-feature.md %} diff --git a/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.md b/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.md index 23a7edf9cb5..ffd0ddf8683 100644 --- a/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.md +++ b/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.md @@ -4494,4 +4494,4 @@ If the cart is deleted successfully, the endpoint returns the `204 No Content` s | 118 | Price mode is missing. | | 119 | Price mode is incorrect. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.md b/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.md index f4b4bdd9814..0b9b132ac34 100644 --- a/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.md +++ b/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.md @@ -1822,4 +1822,4 @@ If the item is deleted successfully, the endpoint returns the `204 No Content` | 118 | Price mode is missing. | | 119 | Price mode is incorrect. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-cart-items.md b/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-cart-items.md index f5c2b7f81ed..a543ce443b6 100644 --- a/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-cart-items.md +++ b/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-cart-items.md @@ -1859,4 +1859,4 @@ If the item is deleted successfully, the endpoint returns the "204 No Content" | 118 | Price mode is missing. | | 119 | Price mode is incorrect. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.md b/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.md index 4f83725bcc8..396fd231f6a 100644 --- a/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.md +++ b/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.md @@ -2135,4 +2135,4 @@ In a *single cart* environment, items from the guest cart have been added to t | 118 | Price mode is missing. | | 119 | Price mode is incorrect. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/content-management-system/202212.0/base-shop/import-and-export-data/import-content-management-system-data.md b/docs/pbc/all/content-management-system/202212.0/base-shop/import-and-export-data/import-content-management-system-data.md index a2d268b8a6d..2e74d7e4c0e 100644 --- a/docs/pbc/all/content-management-system/202212.0/base-shop/import-and-export-data/import-content-management-system-data.md +++ b/docs/pbc/all/content-management-system/202212.0/base-shop/import-and-export-data/import-content-management-system-data.md @@ -15,7 +15,7 @@ redirect_from: - /docs/pbc/all/content-management-system/202212.0/import-and-export-data/import-content-management-system-data.html --- -To learn how data import works and about different ways of importing data, see [Data import](/docs/scos/dev/data-import/{{page.version}}/data-import.html). This section describes the data import files that are used to import data related to the Content Management System PBC. +To learn how data import works and about different ways of importing data, see [Data import](/docs/scos/dev/data-import/{{page.version}}/data-import.html). This section describes the data import files that are used to import data related to the Cart and Checkout PBC. The CMS data import category contains data required to create and manage content elements like CMS pages or blocks. diff --git a/docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-abstract-product-list-content-items.md b/docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-abstract-product-list-content-items.md index b3a21eb9bbf..dd162875496 100644 --- a/docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-abstract-product-list-content-items.md +++ b/docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-abstract-product-list-content-items.md @@ -366,4 +366,4 @@ Request sample: retrieve Abstract Product List with its abstract products | 2202 | Content key is missing. | | 2203 | Content type is invalid. | -For generic Glue Application errors that can also occur, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +For generic Glue Application errors that can also occur, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-banner-content-items.md b/docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-banner-content-items.md index 38e69ff98e0..e9741e6d3f1 100644 --- a/docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-banner-content-items.md +++ b/docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-banner-content-items.md @@ -89,4 +89,4 @@ Response sample: retrieve a banner content item | 2202 | Content key is missing. | | 2203 | Content type is invalid. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-navigation-trees.md b/docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-navigation-trees.md index 5c26b55d5a6..7061e8f446d 100644 --- a/docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-navigation-trees.md +++ b/docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-navigation-trees.md @@ -1134,4 +1134,4 @@ If a navigation tree has a category child node, include the `category-nodes` res | 1601 | Navigation is not found. | | 1602 | Navigation ID is not specified. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/customer-relationship-management/202212.0/customer-account-management-feature-overview/password-management-overview.md b/docs/pbc/all/customer-relationship-management/202212.0/customer-account-management-feature-overview/password-management-overview.md index d2fdf71ef1b..fa272514bee 100644 --- a/docs/pbc/all/customer-relationship-management/202212.0/customer-account-management-feature-overview/password-management-overview.md +++ b/docs/pbc/all/customer-relationship-management/202212.0/customer-account-management-feature-overview/password-management-overview.md @@ -20,7 +20,7 @@ When you create a customer account in the Back Office, you do not enter the pass You can create customer accounts by [importing](/docs/scos/dev/data-import/{{page.version}}/importing-data-with-a-configuration-file.html#console-commands-to-run-import) a [`customerCSV file`](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/commerce-setup/file-details-customer.csv.html). In this case, you can specify the passwords of the customer accounts to import, but it’s not mandatory. If you do not specify the passwords, you can send password reset emails to the customers without passwords by running `console customer:password:set`. Also, you can send password reset emails to all customers by running console `customer:password:reset`. To learn how a developer can import customer data, see [Importing Data with a Configuration File](/docs/scos/dev/data-import/{{page.version}}/importing-data-with-a-configuration-file.html). -With the help of [Glue API](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/glue-rest-api.html), you can change and reset customer account passwords. This can be useful when you want to use a single authentication in all the apps connected to your shop. To learn how a developer can do it, see [Change a customer’s password](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-manage-customer-passwords.html#change-a-customers-password) and [Reset a customer’s password](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-manage-customer-passwords.html#reset-a-customers-password). +With the help of [Glue API](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-rest-api.html), you can change and reset customer account passwords. This can be useful when you want to use a single authentication in all the apps connected to your shop. To learn how a developer can do it, see [Change a customer’s password](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-manage-customer-passwords.html#change-a-customers-password) and [Reset a customer’s password](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-manage-customer-passwords.html#reset-a-customers-password). On the Storefront, it is mandatory to enter a password when creating a customer account. After the account is created, you can update the password in the customer account or request a password reset using email. diff --git a/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/company-account/glue-api-retrieve-business-unit-addresses.md b/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/company-account/glue-api-retrieve-business-unit-addresses.md index f876d7a9bd1..75addfe858a 100644 --- a/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/company-account/glue-api-retrieve-business-unit-addresses.md +++ b/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/company-account/glue-api-retrieve-business-unit-addresses.md @@ -114,7 +114,7 @@ If your current company account is not set, you may get the `404` status code. {% endinfo_block %} -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). ## Next steps diff --git a/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/company-account/glue-api-retrieve-business-units.md b/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/company-account/glue-api-retrieve-business-units.md index 2392073409a..b4b6b551063 100644 --- a/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/company-account/glue-api-retrieve-business-units.md +++ b/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/company-account/glue-api-retrieve-business-units.md @@ -247,7 +247,7 @@ To retrieve a business unit, send the request: | 1903 | Current company account is not set. Select the current company user with `/company-user-access-tokens` to access the resource collection. | | 1901 | Specified business unit is not found or the user does not have access to it. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). ## Next steps diff --git a/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/company-account/glue-api-retrieve-companies.md b/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/company-account/glue-api-retrieve-companies.md index ce8d5dce629..4d15b5d723d 100644 --- a/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/company-account/glue-api-retrieve-companies.md +++ b/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/company-account/glue-api-retrieve-companies.md @@ -110,7 +110,7 @@ To retrieve information about a company, send the request: | 1801 | Specified company is not found, or the current authenticated company user does not have access to it. | | 1803 | Current company account is not set. Select the current company user with `/company-user-access-tokens` to access the resource collection. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). ## Next steps diff --git a/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/company-account/glue-api-retrieve-company-roles.md b/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/company-account/glue-api-retrieve-company-roles.md index 2e48a79d9bc..9258c2a2401 100644 --- a/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/company-account/glue-api-retrieve-company-roles.md +++ b/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/company-account/glue-api-retrieve-company-roles.md @@ -176,7 +176,7 @@ To retrieve a company role, send the request: | 2101 | Company role is not found. | | 2103 | Current company user is not set. Select the current company user with `/company-user-access-tokens` to access the resource collection. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). ## Next steps diff --git a/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/company-account/glue-api-retrieve-company-users.md b/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/company-account/glue-api-retrieve-company-users.md index 9dc479c182a..ce337b9b301 100644 --- a/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/company-account/glue-api-retrieve-company-users.md +++ b/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/company-account/glue-api-retrieve-company-users.md @@ -370,7 +370,7 @@ To retrieve information about a company user, send the request: | 1403 | Current company account is not set. Select the current company user with `/company-user-access-tokens` to access the resource collection. | | 1404 | Specified company user is not found or does not have permissions to view the account. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). ## Next steps diff --git a/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/company-account/glue-api-search-by-company-users.md b/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/company-account/glue-api-search-by-company-users.md index 2d1c1352713..ec48bfc1ee7 100644 --- a/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/company-account/glue-api-search-by-company-users.md +++ b/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/company-account/glue-api-search-by-company-users.md @@ -314,7 +314,7 @@ To retrieve company users of the current authenticated customer, send the reques | 001 | The access token is invalid. | | 002 | The access token is missing. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). ## Next steps diff --git a/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/customers/glue-api-manage-customer-addresses.md b/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/customers/glue-api-manage-customer-addresses.md index 7cb96278798..bb4e4408593 100644 --- a/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/customers/glue-api-manage-customer-addresses.md +++ b/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/customers/glue-api-manage-customer-addresses.md @@ -427,7 +427,7 @@ If the address is deleted successfully, the endpoint returns the `204 No Content | 412 | No address ID provided. | | 901 | One of the following fields is not specified: `salutaion`, `firstName`, `lastName`, `city`, `address1`, `address2`, `zipCode`, `country`, `iso2Code`, `isDefaultShipping`, `isDefaultBilling` | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). ## Next steps diff --git a/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/customers/glue-api-manage-customers.md b/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/customers/glue-api-manage-customers.md index 7a40193835d..ef7eefd2203 100644 --- a/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/customers/glue-api-manage-customers.md +++ b/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/customers/glue-api-manage-customers.md @@ -342,7 +342,7 @@ There is an alternative way to retrieve existing subscriptions, for details see | 4606 | Request is unauthorized.| -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). ## Next steps diff --git a/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.md b/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.md index 27d290f0278..6d2dbe88388 100644 --- a/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.md +++ b/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.md @@ -136,4 +136,4 @@ Alternatively, you can retrieve all orders made by a customer through the **/ord | 402 | Customer with the specified ID was not found. | | 802 | Request is unauthorized. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-carts-of-registered-users.md b/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-carts-of-registered-users.md index bfe2b6b9a36..09168e88235 100644 --- a/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-carts-of-registered-users.md +++ b/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-carts-of-registered-users.md @@ -719,4 +719,4 @@ For the attributes of the other included resources, see the docs: | 118 | Price mode is missing. | | 119 | Price mode is incorrect. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-guest-carts.md b/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-guest-carts.md index 472e8231e60..a084c3f0015 100644 --- a/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-guest-carts.md +++ b/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-guest-carts.md @@ -702,4 +702,4 @@ For the attributes of guest carts, see [Retrieve discounts in guest cart](/docs/ | 119 | Price mode is incorrect. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-carts-of-registered-users.md b/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-carts-of-registered-users.md index 8f5796ba32f..e4a4041235b 100644 --- a/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-carts-of-registered-users.md +++ b/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-carts-of-registered-users.md @@ -236,4 +236,4 @@ If the voucher is deleted successfully, the endpoints returns the `204 No Data` | 3302 | Incorrect voucher code or the voucher cannot be applied. | | 3303 | Cart code can't be removed. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-guest-carts.md b/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-guest-carts.md index 75529395755..e83506662fc 100644 --- a/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-guest-carts.md +++ b/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-guest-carts.md @@ -250,4 +250,4 @@ If the voucher is deleted successfully, the endpoints returns the `204 No Data` | 3302 | Incorrect voucher code or the voucher cannot be applied.| | 3303| Cart code can't be removed. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/retrieve-discounts-in-carts-of-registered-users.md b/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/retrieve-discounts-in-carts-of-registered-users.md index b543288dc41..5fb8176fecd 100644 --- a/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/retrieve-discounts-in-carts-of-registered-users.md +++ b/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/retrieve-discounts-in-carts-of-registered-users.md @@ -604,4 +604,4 @@ For the attributes of carts of registered users and included resources, see [Ret | 115 | Unauthorized cart action. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/retrieve-discounts-in-customer-carts.md b/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/retrieve-discounts-in-customer-carts.md index 72cd939b936..653190cfda5 100644 --- a/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/retrieve-discounts-in-customer-carts.md +++ b/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/retrieve-discounts-in-customer-carts.md @@ -346,4 +346,4 @@ Alternatively, you can retrieve all carts belonging to a customer through the ** | 402 | Customer with the specified ID was not found. | | 802 | Request is unauthorized. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/retrieve-discounts-in-guest-carts.md b/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/retrieve-discounts-in-guest-carts.md index 35669591c46..eda41fba818 100644 --- a/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/retrieve-discounts-in-guest-carts.md +++ b/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/retrieve-discounts-in-guest-carts.md @@ -228,4 +228,4 @@ When retrieving the cart with `guestCartId`, the response includes a single obje | 104 | Cart uuid is missing. | | 109 | Anonymous customer unique ID is empty. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-carts-of-registered-users.md b/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-carts-of-registered-users.md index cb0446d3c40..c812f99be83 100644 --- a/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-carts-of-registered-users.md +++ b/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-carts-of-registered-users.md @@ -721,4 +721,4 @@ For the attributes of the other included resources, see the docs: | 118 | Price mode is missing. | | 119 | Price mode is incorrect. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-guest-carts.md b/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-guest-carts.md index 400a25245ac..a86f966783b 100644 --- a/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-guest-carts.md +++ b/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-guest-carts.md @@ -706,4 +706,4 @@ For the attributes of guest carts, see [Retrieve discounts in guest cart](/docs/ | 119 | Price mode is incorrect. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-carts-of-registered-users.md b/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-carts-of-registered-users.md index 8624a67d631..6597db2df4d 100644 --- a/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-carts-of-registered-users.md +++ b/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-carts-of-registered-users.md @@ -237,4 +237,4 @@ If the voucher is deleted successfully, the endpoints returns the `204 No Data` | 3302 | Incorrect voucher code or the voucher cannot be applied. | | 3303 | Cart code can't be removed. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-guest-carts.md b/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-guest-carts.md index 7fbd7ead8bd..43581abf2b5 100644 --- a/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-guest-carts.md +++ b/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-guest-carts.md @@ -249,4 +249,4 @@ If the voucher is deleted successfully, the endpoints returns the `204 No Data` | 3302 | Incorrect voucher code or the voucher cannot be applied.| | 3303| Cart code can't be removed. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/retrieve-discounts-in-carts-of-registered-users.md b/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/retrieve-discounts-in-carts-of-registered-users.md index 25a9329e622..3c893be420e 100644 --- a/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/retrieve-discounts-in-carts-of-registered-users.md +++ b/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/retrieve-discounts-in-carts-of-registered-users.md @@ -606,4 +606,4 @@ For the attributes of carts of registered users and included resources, see [Ret | 115 | Unauthorized cart action. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/retrieve-discounts-in-customer-carts.md b/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/retrieve-discounts-in-customer-carts.md index 9ab3b74eca6..6ad0ff9a491 100644 --- a/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/retrieve-discounts-in-customer-carts.md +++ b/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/retrieve-discounts-in-customer-carts.md @@ -348,4 +348,4 @@ Alternatively, you can retrieve all carts belonging to a customer through the ** | 402 | Customer with the specified ID was not found. | | 802 | Request is unauthorized. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/retrieve-discounts-in-guest-carts.md b/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/retrieve-discounts-in-guest-carts.md index 659acdb1077..36d4792494c 100644 --- a/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/retrieve-discounts-in-guest-carts.md +++ b/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/retrieve-discounts-in-guest-carts.md @@ -229,4 +229,4 @@ When retrieving the cart with `guestCartId`, the response includes a single obje | 104 | Cart uuid is missing. | | 109 | Anonymous customer unique ID is empty. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/discount-management/202212.0/marketplace/marketplace-promotions-discounts-feature-overview.md b/docs/pbc/all/discount-management/202212.0/marketplace/marketplace-promotions-discounts-feature-overview.md index 10f23ef73c7..97432c712f2 100644 --- a/docs/pbc/all/discount-management/202212.0/marketplace/marketplace-promotions-discounts-feature-overview.md +++ b/docs/pbc/all/discount-management/202212.0/marketplace/marketplace-promotions-discounts-feature-overview.md @@ -2,7 +2,6 @@ title: Marketplace Promotions & Discounts feature overview description: This document contains concept information for the Marketplace Promotions and Discounts feature. template: concept-topic-template -last_updated: Jul 17, 2023 redirect_from: - /docs/marketplace/user/features/202212.0/marketplace-promotions-and-discounts-feature-overview.html - /docs/marketplace/dev/feature-walkthroughs/202212.0/marketplace-promotions-and-discounts-feature-walkthrough.html @@ -40,7 +39,6 @@ Based on the business logic, discounts can be applied in the following ways: ## Voucher A *Voucher* is a discount that applies when a customer enters an active voucher code on the *Cart* page. - ![Cart voucher](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Features/Marketplace+Promotions+and+Discounts+feature+overview/voucher-storefront.png) Once the customer clicks **Redeem code**, the page refreshes to show the discount name, discount value, and available actions: **Remove** and **Clear all**. The **Clear all** action disables all the applied discounts. The **Remove** action disables a single discount. @@ -49,14 +47,14 @@ Once the customer clicks **Redeem code**, the page refreshes to show the discoun Multiple voucher codes can be generated for a single voucher. The code has a **Max number of uses** value which defines how many times the code can be redeemed. You can enter codes manually or use the code generator in the Back Office. - ![Generate codes](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+&+Discounts/Discount/Discount+Feature+Overview/generate_codes.png) To learn how a product catalog manager can create a voucher in the Back Office, see [Creating a voucher](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html). ## Cart Rule -A *cart rule* is a discount that applies to the cart once all the [decision rules](#decision-rule) linked to the cart rule are fulfilled. +A *cart rule* is a discount that applies to cart once all the [decision rules](#decision-rule) linked to the cart rule are fulfilled. + The cart rule is applied automatically. If the decision rules of a discount are fulfilled, the customer can see the discount upon entering the cart. Unlike with [vouchers](#voucher), the **Clear all** and **Remove** actions are not displayed. ![Cart rule](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Features/Marketplace+Promotions+and+Discounts+feature+overview/cart-rule-storefront.png) @@ -68,7 +66,7 @@ A decision rule is a condition assigned to a discount that should be fulfilled f A discount can have one or more decision rules. Find an exemplary combination below: -| PARAMETER | RELATION OPERATOR | VALUE | +| Parameter | RELATION OPERATOR | Value | | --- | --- | --- | | total-quantity | equal | 3 | | day-of-week| equal | 5 | @@ -103,11 +101,9 @@ Decision rules are combined with *AND* and *OR* combination operators. With the In the following example, for the discount to be applied, a cart should contain three items, and the purchase should be made on Wednesday. - ![AND operator](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+&+Discounts/Discount/Discount+Feature+Overview/and-operator.png) In the following example, for the discount to be applied, a cart should contain three items, or the purchase should be made on Wednesday. - ![OR operator](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+&+Discounts/Discount/Discount+Feature+Overview/or-operator.png) {% info_block infoBox "Info" %} @@ -123,15 +119,15 @@ A rule group is a separate set of rules with its own combination operator. ![Decision rule group](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+%26+Discounts/Discount/Discount+Feature+Overview/decision-rule-group.png) -With the rule groups, you can build multiple levels of rule hierarchy. When a cart is evaluated against the rules, it is evaluated on all levels of the hierarchy. On each level, there can be both rules and rule groups. +With the rule groups, you can build multiple levels of rule hierarchy. When a cart is evaluated against the rules, it is evaluated on all the levels of the hierarchy. On each level, there can be both rules and rule groups. ![Decision rule hierarchy](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+%26+Discounts/Discount/Discount+Feature+Overview/decision-rule-hierarchy.png) -When a cart is evaluated on a level that has a rule and a rule group, the rule group is treated as a single rule. The following diagram shows how a cart is evaluated against the rules in the previous screenshot. +When a cart is evaluated on a level that has a rule and a rule group, the rule group is treated as a single rule. The following diagram shows how a cart is evaluated against the rules on the previous screenshot. ### Discount threshold A *threshold* is a minimum number of items in the cart that should fulfill all the specified decision rules for the discount to be applied. -The default value is *1*. It means that a discount is applied if at least one item fulfills the discount's decision rules. +The default value is *1* . It means that a discount is applied if at least one item fulfills the discount's decision rules. In the following example, the discount is applied if there are four items with the Intel Core processor in the cart. ![Threshold](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+&+Discounts/Discount/Discount+Feature+Overview/threshold.png) @@ -146,13 +142,12 @@ The Marketplace discounts are applied based on the query string. The *query string* is a discount application type that uses [decision rules](#decision-rule) to dynamically define what products a discount applies to. The discount in the following example applies to white products. - ![Query collection](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+&+Discounts/Discount/Discount+Feature+Overview/collection-query.png) - The product selection based on the query string is dynamic: * If at some point, the color attribute of a product changes from white to anything else, the product is no longer eligible to be discounted. * If at some point, a product receives the white color attribute, it becomes eligible for the discount. + ## Discount calculation Calculation defines the value to be deducted from a product's original price. There are two types of discount calculation: @@ -168,8 +163,7 @@ With the calculator fixed type, the currency of the respective shop is used for See examples in the following table. - -| PRODUCT PRICE | CALCULATION TYPE | AMOUNT | DISCOUNT APPLIED | PRICE TO PAY | +| Product price | Calculation type | Amount | Discount applied | Price to pay | | --- | --- | --- | --- | --- | | €50 | Calculator percentage | 10 | €5 | €45 | | €50 | Calculator fixed | 10 | €10 | €40 | @@ -190,7 +184,7 @@ An exclusive discount is a discount that, when applied to a cart, discards all t In the following example, a cart with the order total amount of €100 contains the following discounts. -| DISCOUNT NAME | DISCOUNT AMOUNT | DISCOUNT TYPE | EXCLUSIVENESS | DISCOUNTED AMOUNT | +| Discount name | Discount amount | Discount type | Exclusiveness | Discounted amount | | --- | --- | --- | --- | --- | | D1 | 15 | Calculator percentage | Exclusive | €15 | |D2|5| Calculator fixed | Exclusive | €5 | @@ -208,7 +202,7 @@ A non-exclusive discount is a discount that can be combined with other non-exclu In the following example, a cart with the order total amount of €30 contains the following discounts. -| DISCOUNT NAME | DISCOUNT AMOUNT | DISCOUNT TYPE | EXCLUSIVENESS | DISCOUNTED AMOUNT | +| Discount name | Discount amount | Discount type | Exclusiveness | Discounted amount | | --- | --- | --- | --- | --- | | D1 | 15 | Calculator percentage | Non-exclusive | €15 | | D2 | 5 | Calculator fixed | Non-exclusive | €5 | @@ -220,9 +214,11 @@ As all the discounts are non-exclusive, they are applied together. A *validity interval* is a time period during which a discount is active and can be applied. + If a cart is eligible for a discount outside of its validity interval, the cart rule is not applied. If a customer enters a voucher code outside of its validity interval, they get a "Your voucher code is invalid." message. -A product catalog manager defines the calculation when [creating a discount](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html). + +A product catalog manager defines calculation when [creating a discount](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html). ![Validity interval](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+&+Discounts/Discount/Discount+Feature+Overview/validity-interval.png) ## Related Developer articles diff --git a/docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/manage-gift-cards-of-guest-users.md b/docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/manage-gift-cards-of-guest-users.md index 34c31c46283..dbfe4d1f6e5 100644 --- a/docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/manage-gift-cards-of-guest-users.md +++ b/docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/manage-gift-cards-of-guest-users.md @@ -197,4 +197,4 @@ If the item is deleted successfully, the endpoint will respond with a `204 No C | 3302| Cart code can't be added. | | 3303| Cart code can't be removed. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/manage-gift-cards-of-registered-users.md b/docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/manage-gift-cards-of-registered-users.md index 69f183508bc..02b50c998de 100644 --- a/docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/manage-gift-cards-of-registered-users.md +++ b/docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/manage-gift-cards-of-registered-users.md @@ -206,4 +206,4 @@ If the item is deleted successfully, the endpoint will respond with a `204 No Co | 3302 | Incorrect voucher code or the voucher cannot be applied. | | 3303| Cart code can't be removed. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/retrieve-gift-cards-in-carts-of-registered-users.md b/docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/retrieve-gift-cards-in-carts-of-registered-users.md index 0e24fa192db..16792d7cfb4 100644 --- a/docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/retrieve-gift-cards-in-carts-of-registered-users.md +++ b/docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/retrieve-gift-cards-in-carts-of-registered-users.md @@ -235,4 +235,4 @@ For the attributes of the gift cards included resource, see [Manage gift cards o | 115 | Unauthorized cart action. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/retrieve-gift-cards-in-guest-carts.md b/docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/retrieve-gift-cards-in-guest-carts.md index 86d295e0aa5..0de759fe5ee 100644 --- a/docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/retrieve-gift-cards-in-guest-carts.md +++ b/docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/retrieve-gift-cards-in-guest-carts.md @@ -146,4 +146,4 @@ For the attributes of guest cart items, see [Managing gift cards of guest users] | 104 | Cart uuid is missing. | | 109 | Anonymous customer unique id is empty. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/manage-gift-cards-of-guest-users.md b/docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/manage-gift-cards-of-guest-users.md index 50a216ba6a7..419528996f1 100644 --- a/docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/manage-gift-cards-of-guest-users.md +++ b/docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/manage-gift-cards-of-guest-users.md @@ -197,4 +197,4 @@ If the item is deleted successfully, the endpoint will respond with a `204 No C | 3302| Cart code can't be added. | | 3303| Cart code can't be removed. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/manage-gift-cards-of-registered-users.md b/docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/manage-gift-cards-of-registered-users.md index 71a5fd3f6cc..e93e07891c2 100644 --- a/docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/manage-gift-cards-of-registered-users.md +++ b/docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/manage-gift-cards-of-registered-users.md @@ -206,4 +206,4 @@ If the item is deleted successfully, the endpoint will respond with a `204 No Co | 3302 | Incorrect voucher code or the voucher cannot be applied. | | 3303| Cart code can't be removed. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/retrieve-gift-cards-in-carts-of-registered-users.md b/docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/retrieve-gift-cards-in-carts-of-registered-users.md index 6d0722f3f10..e489e6365fd 100644 --- a/docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/retrieve-gift-cards-in-carts-of-registered-users.md +++ b/docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/retrieve-gift-cards-in-carts-of-registered-users.md @@ -235,4 +235,4 @@ For the attributes of the gift cards included resource, see [Manage gift cards o | 115 | Unauthorized cart action. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/retrieve-gift-cards-in-guest-carts.md b/docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/retrieve-gift-cards-in-guest-carts.md index 4d085ff95ac..aeab6ccabdc 100644 --- a/docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/retrieve-gift-cards-in-guest-carts.md +++ b/docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/retrieve-gift-cards-in-guest-carts.md @@ -146,4 +146,4 @@ For the attributes of guest cart items, see [Managing gift cards of guest users] | 104 | Cart uuid is missing. | | 109 | Anonymous customer unique id is empty. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/identity-access-management/202212.0/glue-api-security-and-authentication.md b/docs/pbc/all/identity-access-management/202212.0/glue-api-security-and-authentication.md index a67b94a8fff..5bcfafdd9f9 100644 --- a/docs/pbc/all/identity-access-management/202212.0/glue-api-security-and-authentication.md +++ b/docs/pbc/all/identity-access-management/202212.0/glue-api-security-and-authentication.md @@ -21,7 +21,7 @@ related: - title: Authentication and Authorization link: docs/pbc/all/identity-access-management/page.version/glue-api-authentication-and-authorization.html - title: Glue Infrastructure - link: docs/scos/dev/glue-api-guides/page.version/old-glue-infrastructure/glue-infrastructure.html + link: docs/scos/dev/glue-api-guides/page.version/glue-infrastructure.html --- When exposing information via Spryker Glue API and integrating with third-party applications, it is essential to protect API endpoints from unauthorized access. For this purpose, Spryker provides an authorization mechanism, using which you can request users to authenticate themselves before accessing a resource. For this purpose, Spryker Glue is shipped with an implementation of the OAuth 2.0 protocol. It allows users to authenticate themselves with their username and password and receive an access token. The token can then be used to access protected resources. @@ -113,7 +113,7 @@ In addition to user scopes, each endpoint can be secured individually. For this {% info_block infoBox %} -For details, see [Resource Routing](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/glue-infrastructure.html#resource-routing). +For details, see [Resource Routing](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-infrastructure.html#resource-routing). {% endinfo_block %} diff --git a/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-authenticate-as-a-company-user.md b/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-authenticate-as-a-company-user.md index 7dcffe6ad3f..57073035e76 100644 --- a/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-authenticate-as-a-company-user.md +++ b/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-authenticate-as-a-company-user.md @@ -112,7 +112,7 @@ Request sample: authenticate as a company user | 002 | Authentication token is missing. | | 901 | The `idCompanyUser` attribute is not specified, invalid, or empty. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). ## Next steps diff --git a/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-authenticate-as-a-customer.md b/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-authenticate-as-a-customer.md index 143634f24c9..2d1b2430972 100644 --- a/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-authenticate-as-a-customer.md +++ b/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-authenticate-as-a-customer.md @@ -133,7 +133,7 @@ Note that depending on the Login feature configuration for your project, too man | 003 | Failed to log in the user. | | 901 | Unprocessable login data (incorrect email format; email or password is empty).| -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). ## Next steps diff --git a/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-authenticate-as-an-agent-assist.md b/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-authenticate-as-an-agent-assist.md index c80dfbf6eb0..dcefb87bb53 100644 --- a/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-authenticate-as-an-agent-assist.md +++ b/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-authenticate-as-an-agent-assist.md @@ -106,7 +106,7 @@ Note that depending on the Login feature configuration for your project, too man | --- | --- | |4101 | Failed to authenticate an agent. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). ## Next steps diff --git a/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-confirm-customer-registration.md b/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-confirm-customer-registration.md index fb35a7df324..524e59aeac7 100644 --- a/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-confirm-customer-registration.md +++ b/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-confirm-customer-registration.md @@ -82,7 +82,7 @@ If the customer email is confirmed successfully, the endpoint returns the `204 N | --- | --- | | 423 | Confirmation code is invalid or has been already used. | | 901 | Confirmation code is empty. | -For generic Glue Application errors that can also occur, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +For generic Glue Application errors that can also occur, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). ## Next Steps diff --git a/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-manage-agent-assist-authentication-tokens.md b/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-manage-agent-assist-authentication-tokens.md index 39002dffcc9..d9b9d29d06a 100644 --- a/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-manage-agent-assist-authentication-tokens.md +++ b/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-manage-agent-assist-authentication-tokens.md @@ -132,4 +132,4 @@ The tokens are marked as expired on the date and time of the request. You can co | 901 | The `refreshToken` attribute is not specified or empty. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-manage-company-user-authentication-tokens.md b/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-manage-company-user-authentication-tokens.md index 2f42832b720..b625eb4d1a9 100644 --- a/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-manage-company-user-authentication-tokens.md +++ b/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-manage-company-user-authentication-tokens.md @@ -144,4 +144,4 @@ The tokens are marked as expired on the date and time of the request. You can co | 004 | Failed to refresh the token. | | 901 | Refresh token is not specified or empty. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-manage-customer-authentication-tokens-via-oauth-2.0.md b/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-manage-customer-authentication-tokens-via-oauth-2.0.md index b6f1f72106e..ad0deb975b7 100644 --- a/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-manage-customer-authentication-tokens-via-oauth-2.0.md +++ b/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-manage-customer-authentication-tokens-via-oauth-2.0.md @@ -152,4 +152,4 @@ To refresh an authentication token, send the request: | invalid_request | The refresh token is invalid. | | invalid_grant | The provided authorization grant or refresh token is invalid, expired, or revoked. The provided authorization grant or refresh token does not match the redirection URI used in the authorization request, or was issued to another client. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-manage-customer-authentication-tokens.md b/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-manage-customer-authentication-tokens.md index d381f234cf4..a880b9c4ecd 100644 --- a/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-manage-customer-authentication-tokens.md +++ b/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-manage-customer-authentication-tokens.md @@ -148,7 +148,7 @@ The tokens are marked as expired on the date and time of the request. You can co | --- | --- | | 004 | Failed to refresh the token. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). ## Next steps diff --git a/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-manage-customer-passwords.md b/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-manage-customer-passwords.md index 4bc405f5625..d4a46d5fba6 100644 --- a/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-manage-customer-passwords.md +++ b/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-manage-customer-passwords.md @@ -190,7 +190,7 @@ If the password reset is successful, the endpoint returns the `204 No Content` s | 422 | `newPassword` and `confirmPassword` values are not identical. | | 901 | `newPassword` and `confirmPassword` are not specified; or the password length is invalid (it should be from 8 to 64 characters). | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). ## Next steps diff --git a/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-retrieve-protected-resources.md b/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-retrieve-protected-resources.md index 937afcc24e7..897f9de5eb6 100644 --- a/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-retrieve-protected-resources.md +++ b/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-retrieve-protected-resources.md @@ -77,4 +77,4 @@ Response sample: retrieve protected resources | --- | --- | --- | | resourceTypes | String | Contains a `string` array, where each element is a resource type that is protected from unauthorized access. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/merchant-management/202212.0/marketplace/import-data/file-details-merchant-stock.csv.md b/docs/pbc/all/merchant-management/202212.0/marketplace/import-data/file-details-merchant-stock.csv.md index 240b0ce24e5..b5634f57d3a 100644 --- a/docs/pbc/all/merchant-management/202212.0/marketplace/import-data/file-details-merchant-stock.csv.md +++ b/docs/pbc/all/merchant-management/202212.0/marketplace/import-data/file-details-merchant-stock.csv.md @@ -18,7 +18,7 @@ This document describes the `merchant_stock.csv` file to configure [merchant sto ## Import file dependencies - [merchant.csv](/docs/pbc/all/merchant-management/{{site.version}}/marketplace/import-data/file-details-merchant.csv.html) -- [warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/file-details-warehouse.csv.html) +- [warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-data/file-details-warehouse.csv.html) ## Import file parameters diff --git a/docs/pbc/all/merchant-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-addresses.md b/docs/pbc/all/merchant-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-addresses.md index ea10e600fc5..03513147d99 100644 --- a/docs/pbc/all/merchant-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-addresses.md +++ b/docs/pbc/all/merchant-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-addresses.md @@ -106,4 +106,4 @@ Request sample: retrieve merchant addresses ## Possible errors -For statuses, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +For statuses, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/merchant-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-opening-hours.md b/docs/pbc/all/merchant-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-opening-hours.md index a8a0d146909..d34aa9ad25e 100644 --- a/docs/pbc/all/merchant-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-opening-hours.md +++ b/docs/pbc/all/merchant-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-opening-hours.md @@ -206,4 +206,4 @@ Request sample: retrieve merchant opening hours ## Possible errors -For statuses, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +For statuses, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/merchant-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.md b/docs/pbc/all/merchant-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.md index 84e4c6ba14b..c728680db20 100644 --- a/docs/pbc/all/merchant-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.md +++ b/docs/pbc/all/merchant-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.md @@ -656,4 +656,4 @@ Resolve a search engine friendly URL of a merchant page. For details, see [Resol ## Possible errors -For statuses, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +For statuses, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/miscellaneous/202212.0/glue-api-retrieve-store-configuration.md b/docs/pbc/all/miscellaneous/202212.0/glue-api-retrieve-store-configuration.md index bfbb3feb6ea..4ace50e898f 100644 --- a/docs/pbc/all/miscellaneous/202212.0/glue-api-retrieve-store-configuration.md +++ b/docs/pbc/all/miscellaneous/202212.0/glue-api-retrieve-store-configuration.md @@ -118,4 +118,4 @@ Request sample: retrieve stores | iso2Code | String | Iso 2 code for the region. | | name | String | Region name. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/offer-management/202212.0/marketplace/glue-api-retrieve-product-offers.md b/docs/pbc/all/offer-management/202212.0/marketplace/glue-api-retrieve-product-offers.md index 880f594bad5..5d54c186ab9 100644 --- a/docs/pbc/all/offer-management/202212.0/marketplace/glue-api-retrieve-product-offers.md +++ b/docs/pbc/all/offer-management/202212.0/marketplace/glue-api-retrieve-product-offers.md @@ -278,4 +278,4 @@ You can use the product offers resource as follows: | 3701 | Product offer was not found. | | 3702 | Product offer ID is not specified. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/offer-management/202304.0/marketplace/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.md b/docs/pbc/all/offer-management/202304.0/marketplace/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.md new file mode 100644 index 00000000000..010a91b479b --- /dev/null +++ b/docs/pbc/all/offer-management/202304.0/marketplace/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.md @@ -0,0 +1,8 @@ +--- +title: Install the Marketplace Product Offer + Product Offer Service Points feature +description: Follow the steps below to install the Marketplace Product Offer + Service Points feature core. +last_updated: July 05, 2023 +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/{{page.version}}/marketplace/install-the-marketplace-product-offer-service-points-feature.md %} diff --git a/docs/pbc/all/offer-management/202400.0/marketplace/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.md b/docs/pbc/all/offer-management/202400.0/marketplace/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.md deleted file mode 100644 index c51bfd67d0b..00000000000 --- a/docs/pbc/all/offer-management/202400.0/marketplace/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: Install the Marketplace Product Offer + Service Points feature -description: Install the Marketplace Product Offer + Service Points feature -last_updated: July 05, 2023 -template: feature-integration-guide-template -redirect_from: - - /docs/pbc/all/offer-management/202304.0/marketplace/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.html ---- - -{% include pbc/all/install-features/202400.0/marketplace/install-the-marketplace-product-offer-service-points-feature.md %} diff --git a/docs/pbc/all/offer-management/202400.0/unified-commerce/install-and-upgrade/install-the-product-offer-shipment-feature.md b/docs/pbc/all/offer-management/202400.0/unified-commerce/install-and-upgrade/install-the-product-offer-shipment-feature.md deleted file mode 100644 index 4295c43c51e..00000000000 --- a/docs/pbc/all/offer-management/202400.0/unified-commerce/install-and-upgrade/install-the-product-offer-shipment-feature.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: Install the Product offer shipment feature -description: Learn how to integrate the Product offer shipment feature into your project -last_updated: June 20, 2023 -template: feature-integration-guide-template -redirect_from: - - /docs/scos/dev/feature-integration-guides/202304.0/install-the-product-offer-shipment-feature.html ---- - -{% include pbc/all/install-features/202400.0/install-the-product-offer-shipment-feature.md %} diff --git a/docs/pbc/all/order-management-system/202212.0/base-shop/glue-api-retrieve-orders.md b/docs/pbc/all/order-management-system/202212.0/base-shop/glue-api-retrieve-orders.md index 85ddd04eacc..33d4f7bb830 100644 --- a/docs/pbc/all/order-management-system/202212.0/base-shop/glue-api-retrieve-orders.md +++ b/docs/pbc/all/order-management-system/202212.0/base-shop/glue-api-retrieve-orders.md @@ -1226,4 +1226,4 @@ To retrieve detailed information on an order, send the request: |002| Access token is missing. | |801| Order with the given order reference is not found. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/hydrate-payment-methods-for-an-order.md b/docs/pbc/all/payment-service-provider/202212.0/hydrate-payment-methods-for-an-order.md similarity index 87% rename from docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/hydrate-payment-methods-for-an-order.md rename to docs/pbc/all/payment-service-provider/202212.0/hydrate-payment-methods-for-an-order.md index f46f3d019e3..7bdce6c5d74 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/hydrate-payment-methods-for-an-order.md +++ b/docs/pbc/all/payment-service-provider/202212.0/hydrate-payment-methods-for-an-order.md @@ -6,9 +6,17 @@ template: howto-guide-template originalLink: https://documentation.spryker.com/2021080/docs/ht-hydrate-payment-methods-for-order originalArticleId: 4e35e87f-d4a5-4a06-8cf5-d830eec89b5d redirect_from: + - /2021080/docs/ht-hydrate-payment-methods-for-order + - /2021080/docs/en/ht-hydrate-payment-methods-for-order + - /docs/ht-hydrate-payment-methods-for-order + - /docs/en/ht-hydrate-payment-methods-for-order + - /v6/docs/ht-hydrate-payment-methods-for-order + - /v6/docs/en/ht-hydrate-payment-methods-for-order + - /v5/docs/ht-hydrate-payment-methods-for-order + - /v5/docs/en/ht-hydrate-payment-methods-for-order + - /v4/docs/ht-hydrate-payment-methods-for-order + - /v4/docs/en/ht-hydrate-payment-methods-for-order - /docs/scos/dev/tutorials-and-howtos/howtos/howto-hydrate-payment-methods-for-an-order.html - - /docs/pbc/all/payment-service-provider/202212.0/hydrate-payment-methods-for-an-order.html - - /docs/pbc/all/payment-service-provider/202212.0/hydrate-payment-methods-for-an-order.html --- {% info_block warningBox "Warning" %} diff --git a/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/import-and-export-data/import-file-details-payment-method-store.csv.md b/docs/pbc/all/payment-service-provider/202212.0/import-and-export-data/file-details-payment-method-store.csv.md similarity index 85% rename from docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/import-and-export-data/import-file-details-payment-method-store.csv.md rename to docs/pbc/all/payment-service-provider/202212.0/import-and-export-data/file-details-payment-method-store.csv.md index d76b003c937..05456719c65 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/import-and-export-data/import-file-details-payment-method-store.csv.md +++ b/docs/pbc/all/payment-service-provider/202212.0/import-and-export-data/file-details-payment-method-store.csv.md @@ -1,5 +1,5 @@ --- -title: "Import file details: payment_method_store.csv" +title: File details - payment_method_store.csv last_updated: Jun 16, 2021 template: data-import-template originalLink: https://documentation.spryker.com/2021080/docs/file-details-payment-method-storecsv @@ -14,7 +14,6 @@ redirect_from: - /docs/scos/dev/data-import/201907.0/data-import-categories/commerce-setup/file-details-payment-method-store.csv.html - /docs/scos/dev/data-import/202212.0/data-import-categories/commerce-setup/file-details-payment-method-store.csv.html - /docs/pbc/all/payment-service-provider/202212.0/import-data/file-details-payment-method-store.csv.html - - /docs/pbc/all/payment-service-provider/202212.0/import-and-export-data/import-file-details-payment-method-store.csv.html related: - title: Execution order of data importers in Demo Shop link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html @@ -25,14 +24,14 @@ This document describes the `payment_method_store.csv` file to configure Payment ## Import file dependencies -* [payment_method.csv](/docs/pbc/all/payment-service-provider/{{page.version}}/spryker-pay/base-shop/import-and-export-data/import-file-details-payment-method.csv.html) +* [payment_method.csv](/docs/pbc/all/payment-service-provider/{{page.version}}/import-and-export-data/file-details-payment-method.csv.html) * *stores.php* configuration file of the demo shop PHP project ## Import file parameters | PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | |-|-|-|-|-| -| payment_method_key | ✓ | String | Value should be imported from the [payment_method.csv](/docs/pbc/all/payment-service-provider/{{page.version}}/spryker-pay/base-shop/import-and-export-data/import-file-details-payment-method.csv.html) file. | Identifier of the payment method. | +| payment_method_key | ✓ | String | Value should be imported from the [payment_method.csv](/docs/pbc/all/payment-service-provider/{{page.version}}/import-and-export-data/file-details-payment-method.csv.html) file. | Identifier of the payment method. | | store | ✓ | String | Value must be within an existing store name, set in the *store.php* configuration file of the demo shop PHP project. | Name of the store. | diff --git a/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/import-and-export-data/import-file-details-payment-method.csv.md b/docs/pbc/all/payment-service-provider/202212.0/import-and-export-data/file-details-payment-method.csv.md similarity index 89% rename from docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/import-and-export-data/import-file-details-payment-method.csv.md rename to docs/pbc/all/payment-service-provider/202212.0/import-and-export-data/file-details-payment-method.csv.md index d74be8a7cd6..11f4118aa57 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/import-and-export-data/import-file-details-payment-method.csv.md +++ b/docs/pbc/all/payment-service-provider/202212.0/import-and-export-data/file-details-payment-method.csv.md @@ -1,5 +1,5 @@ --- -title: "Import file details: payment_method.csv" +title: File details - payment_method.csv last_updated: Jun 16, 2021 template: data-import-template originalLink: https://documentation.spryker.com/2021080/docs/file-details-payment-methodcsv @@ -11,13 +11,12 @@ redirect_from: - /docs/en/file-details-payment-methodcsv - /docs/scos/dev/data-import/202212.0/data-import-categories/commerce-setup/file-details-payment-method.csv.html - /docs/pbc/all/payment-service-provider/202212.0/import-data/file-details-payment-method.csv.html - - /docs/pbc/all/payment-service-provider/202212.0/import-and-export-data/import-file-details-payment-method.csv.html related: - title: Execution order of data importers in Demo Shop link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html --- -This document describes the `payment_method.csv` file to configure the [Payment Method](/docs/pbc/all/payment-service-provider/{{page.version}}/spryker-pay/base-shop/payments-feature-overview.html) information in your Spryker Demo Shop. +This document describes the `payment_method.csv` file to configure the [Payment Method](/docs/pbc/all/payment-service-provider/{{page.version}}/payments-feature-overview.html) information in your Spryker Demo Shop. ## Import file parameters diff --git a/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/import-and-export-data/payment-service-provider-data-import-and-export.md b/docs/pbc/all/payment-service-provider/202212.0/import-and-export-data/import-and-export-payment-service-provider-data.md similarity index 93% rename from docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/import-and-export-data/payment-service-provider-data-import-and-export.md rename to docs/pbc/all/payment-service-provider/202212.0/import-and-export-data/import-and-export-payment-service-provider-data.md index 9e2b4366c85..ba674c29239 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/import-and-export-data/payment-service-provider-data-import-and-export.md +++ b/docs/pbc/all/payment-service-provider/202212.0/import-and-export-data/import-and-export-payment-service-provider-data.md @@ -1,5 +1,5 @@ --- -title: Payment Service Provider data import and export +title: Import Payment Service Provider data description: Details about the data importers for Payment Service Provider last_updated: Jun 23, 2023 template: concept-topic-template diff --git a/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/install-and-upgrade/install-the-payments-feature.md b/docs/pbc/all/payment-service-provider/202212.0/install-and-upgrade/install-the-payments-feature.md similarity index 76% rename from docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/install-and-upgrade/install-the-payments-feature.md rename to docs/pbc/all/payment-service-provider/202212.0/install-and-upgrade/install-the-payments-feature.md index 370c14d04ef..06b2f17919d 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/install-and-upgrade/install-the-payments-feature.md +++ b/docs/pbc/all/payment-service-provider/202212.0/install-and-upgrade/install-the-payments-feature.md @@ -6,18 +6,21 @@ template: feature-integration-guide-template originalLink: https://documentation.spryker.com/2021080/docs/payments-feature-integration originalArticleId: 31957fa5-b32a-4227-b6d5-42b89c6e1855 redirect_from: + - /2021080/docs/payments-feature-integration + - /2021080/docs/en/payments-feature-integration + - /docs/payments-feature-integration + - /docs/en/payments-feature-integration - /docs/scos/dev/feature-integration-guides/201811.0/payments-feature-integration.html - /docs/scos/dev/feature-integration-guides/201903.0/payments-feature-integration.html - /docs/scos/dev/feature-integration-guides/201907.0/payments-feature-integration.html - /docs/scos/dev/feature-integration-guides/202212.0/payments-feature-integration.html - - /docs/pbc/all/payment-service-provider/202212.0/install-and-upgrade/install-the-payments-feature.html related: - title: Glue API - Payments feature integration link: docs/scos/dev/feature-integration-guides/page.version/glue-api/glue-api-payments-feature-integration.html - title: Payments feature walkthrough - link: docs/pbc/all/payment-service-provider/page.version/spryker-pay/base-shop/payments-feature-overview.html + link: docs/pbc/all/payment-service-provider/page.version/payments-feature-overview.html - title: Payments feature overview - link: docs/pbc/all/payment-service-provider/page.version/spryker-pay/base-shop/payments-feature-overview.html + link: docs/pbc/all/payment-service-provider/page.version/payments-feature-overview.html --- {% include pbc/all/install-features/202212.0/install-the-payments-feature.md %} diff --git a/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/install-and-upgrade/install-the-payments-glue-api.md b/docs/pbc/all/payment-service-provider/202212.0/install-and-upgrade/install-the-payments-glue-api.md similarity index 72% rename from docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/install-and-upgrade/install-the-payments-glue-api.md rename to docs/pbc/all/payment-service-provider/202212.0/install-and-upgrade/install-the-payments-glue-api.md index 628a8829311..849b9f5cd66 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/install-and-upgrade/install-the-payments-glue-api.md +++ b/docs/pbc/all/payment-service-provider/202212.0/install-and-upgrade/install-the-payments-glue-api.md @@ -5,14 +5,17 @@ template: feature-integration-guide-template originalLink: https://documentation.spryker.com/2021080/docs/glue-api-payments-feature-integration originalArticleId: 37aaeca3-9205-4ca3-8332-6a1ab7b31c80 redirect_from: + - /2021080/docs/glue-api-payments-feature-integration + - /2021080/docs/en/glue-api-payments-feature-integration + - /docs/glue-api-payments-feature-integration + - /docs/en/glue-api-payments-feature-integration - /docs/scos/dev/feature-integration-guides/202200.0/glue-api/glue-api-payments-feature-integration.html - /docs/scos/dev/feature-integration-guides/202212.0/glue-api/glue-api-payments-feature-integration.html - - /docs/pbc/all/payment-service-provider/202212.0/install-and-upgrade/install-the-payments-glue-api.html related: - title: Payments feature integration - link: docs/pbc/all/payment-service-provider/page.version/spryker-pay/base-shop/install-and-upgrade/install-the-payments-feature.html + link: docs/pbc/all/payment-service-provider/page.version/install-and-upgrade/install-the-payments-feature.html - title: Payments feature walkthrough - link: docs/pbc/all/payment-service-provider/page.version/spryker-pay/base-shop/payments-feature-overview.html + link: docs/pbc/all/payment-service-provider/page.version/payments-feature-overview.html - title: Check out purchases link: docs/scos/dev/glue-api-guides/page.version/checking-out/checking-out-purchases.html - title: Updating payment data diff --git a/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/install-and-upgrade/upgrade-the-payment-module.md b/docs/pbc/all/payment-service-provider/202212.0/install-and-upgrade/upgrade-the-payment-module.md similarity index 73% rename from docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/install-and-upgrade/upgrade-the-payment-module.md rename to docs/pbc/all/payment-service-provider/202212.0/install-and-upgrade/upgrade-the-payment-module.md index e21b5236fc4..ac134f3fbc2 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/install-and-upgrade/upgrade-the-payment-module.md +++ b/docs/pbc/all/payment-service-provider/202212.0/install-and-upgrade/upgrade-the-payment-module.md @@ -6,6 +6,22 @@ template: module-migration-guide-template originalLink: https://documentation.spryker.com/2021080/docs/mg-payment originalArticleId: fe27c0bc-2f52-42f0-8dbf-5a7ba050bc34 redirect_from: + - /2021080/docs/mg-payment + - /2021080/docs/en/mg-payment + - /docs/mg-payment + - /docs/en/mg-payment + - /v1/docs/mg-payment + - /v1/docs/en/mg-payment + - /v2/docs/mg-payment + - /v2/docs/en/mg-payment + - /v3/docs/mg-payment + - /v3/docs/en/mg-payment + - /v4/docs/mg-payment + - /v4/docs/en/mg-payment + - /v5/docs/mg-payment + - /v5/docs/en/mg-payment + - /v6/docs/mg-payment + - /v6/docs/en/mg-payment - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-payment.html - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-payment.html - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-payment.html @@ -14,7 +30,6 @@ redirect_from: - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-payment.html - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-payment.html - /docs/scos/dev/module-migration-guides/migration-guide-payment.html - - /docs/pbc/all/payment-service-provider/202212.0/install-and-upgrade/upgrade-the-payment-module.html --- {% include pbc/all/upgrade-modules/upgrade-the-payment-module.md %} diff --git a/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/interact-with-third-party-payment-providers-using-glue-api.md b/docs/pbc/all/payment-service-provider/202212.0/interact-with-third-party-payment-providers-using-glue-api.md similarity index 91% rename from docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/interact-with-third-party-payment-providers-using-glue-api.md rename to docs/pbc/all/payment-service-provider/202212.0/interact-with-third-party-payment-providers-using-glue-api.md index fd715859de1..7a900bd2cbc 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/interact-with-third-party-payment-providers-using-glue-api.md +++ b/docs/pbc/all/payment-service-provider/202212.0/interact-with-third-party-payment-providers-using-glue-api.md @@ -6,10 +6,20 @@ template: howto-guide-template originalLink: https://documentation.spryker.com/2021080/docs/t-interacting-with-third-party-payment-providers-via-glue-api originalArticleId: c9d486b4-ac75-46f5-917e-f3935043f018 redirect_from: + - /2021080/docs/t-interacting-with-third-party-payment-providers-via-glue-api + - /2021080/docs/en/t-interacting-with-third-party-payment-providers-via-glue-api + - /docs/t-interacting-with-third-party-payment-providers-via-glue-api + - /docs/en/t-interacting-with-third-party-payment-providers-via-glue-api + - /v6/docs/t-interacting-with-third-party-payment-providers-via-glue-api + - /v6/docs/en/t-interacting-with-third-party-payment-providers-via-glue-api + - /v5/docs/t-interacting-with-third-party-payment-providers-via-glue-api + - /v5/docs/en/t-interacting-with-third-party-payment-providers-via-glue-api + - /v4/docs/t-interacting-with-third-party-payment-providers-via-glue-api + - /v4/docs/en/t-interacting-with-third-party-payment-providers-via-glue-api + - /v3/docs/t-interacting-with-third-party-payment-providers-via-glue-api + - /v3/docs/en/t-interacting-with-third-party-payment-providers-via-glue-api - /docs/scos/dev/tutorials/201907.0/advanced/glue-api/tutorial-interacting-with-third-party-payment-providers-via-glue-api.html - /docs/scos/dev/tutorials-and-howtos/advanced-tutorials/glue-api/tutorial-interacting-with-third-party-payment-providers-via-glue-api.html - - /docs/pbc/all/payment-service-provider/202212.0/interact-with-third-party-payment-providers-using-glue-api.html - - /docs/pbc/all/payment-service-provider/202212.0/interact-with-third-party-payment-providers-using-glue-api.html related: - title: Technology Partner Integration link: docs/scos/user/technology-partners/page.version/technology-partners.html diff --git a/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/manage-in-the-back-office/edit-payment-methods.md b/docs/pbc/all/payment-service-provider/202212.0/manage-in-the-back-office/edit-payment-methods.md similarity index 89% rename from docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/manage-in-the-back-office/edit-payment-methods.md rename to docs/pbc/all/payment-service-provider/202212.0/manage-in-the-back-office/edit-payment-methods.md index b590543a456..660ec8ce539 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/manage-in-the-back-office/edit-payment-methods.md +++ b/docs/pbc/all/payment-service-provider/202212.0/manage-in-the-back-office/edit-payment-methods.md @@ -6,15 +6,18 @@ template: back-office-user-guide-template originalLink: https://documentation.spryker.com/2021080/docs/managing-payment-methods originalArticleId: d0dc8732-295d-4072-8dc2-63f439feb324 redirect_from: + - /2021080/docs/managing-payment-methods + - /2021080/docs/en/managing-payment-methods + - /docs/managing-payment-methods + - /docs/en/managing-payment-methods - /docs/scos/user/back-office-user-guides/201811.0/administration/payment-methods/managing-payment-methods.html - /docs/scos/user/back-office-user-guides/201903.0/administration/payment-methods/managing-payment-methods.html - /docs/scos/user/back-office-user-guides/201907.0/administration/payment-methods/managing-payment-methods.html - /docs/scos/user/back-office-user-guides/202204.0/administration/payment-methods/managing-payment-methods.html - - /docs/scos/user/back-office-user-guides/202212.0/administration/payment-methods/edit-payment-methods.html - - /docs/pbc/all/payment-service-provider/202212.0/manage-in-the-back-office/edit-payment-methods.html + - /docs/scos/user/back-office-user-guides/202212.0/administration/payment-methods/edit-payment-methods.html related: - title: Payments feature overview - link: docs/pbc/all/payment-service-provider/page.version/spryker-pay/base-shop/payments-feature-overview.html + link: docs/pbc/all/payment-service-provider/page.version/payments-feature-overview.html --- To edit a payment method in the Back Office, follow the steps: diff --git a/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/manage-in-the-back-office/log-into-the-back-office.md b/docs/pbc/all/payment-service-provider/202212.0/manage-in-the-back-office/log-into-the-back-office.md similarity index 72% rename from docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/manage-in-the-back-office/log-into-the-back-office.md rename to docs/pbc/all/payment-service-provider/202212.0/manage-in-the-back-office/log-into-the-back-office.md index 15b1354b5a9..2961c341733 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/manage-in-the-back-office/log-into-the-back-office.md +++ b/docs/pbc/all/payment-service-provider/202212.0/manage-in-the-back-office/log-into-the-back-office.md @@ -9,5 +9,5 @@ template: back-office-user-guide-template ## Next steps -* [View payment methods](/docs/pbc/all/payment-service-provider/{{page.version}}/spryker-pay/base-shop/manage-in-the-back-office/view-payment-methods.html) -* [Edit payment methods](/docs/pbc/all/payment-service-provider/{{page.version}}/spryker-pay/base-shop/manage-in-the-back-office/edit-payment-methods.html) +* [View payment methods](/docs/pbc/all/payment-service-provider/{{page.version}}/manage-in-the-back-office/view-payment-methods.html) +* [Edit payment methods](/docs/pbc/all/payment-service-provider/{{page.version}}/manage-in-the-back-office/edit-payment-methods.html) diff --git a/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/manage-in-the-back-office/view-payment-methods.md b/docs/pbc/all/payment-service-provider/202212.0/manage-in-the-back-office/view-payment-methods.md similarity index 80% rename from docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/manage-in-the-back-office/view-payment-methods.md rename to docs/pbc/all/payment-service-provider/202212.0/manage-in-the-back-office/view-payment-methods.md index e930ec880f9..e4d488d0e14 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/manage-in-the-back-office/view-payment-methods.md +++ b/docs/pbc/all/payment-service-provider/202212.0/manage-in-the-back-office/view-payment-methods.md @@ -5,10 +5,9 @@ last_updated: June 2, 2022 template: back-office-user-guide-template redirect_from: - /docs/scos/user/back-office-user-guides/202212.0/administration/payment-methods/view-payment-methods.html - - /docs/pbc/all/payment-service-provider/202212.0/manage-in-the-back-office/view-payment-methods.html related: - title: Payments feature overview - link: docs/pbc/all/payment-service-provider/page.version/spryker-pay/base-shop/payments-feature-overview.html + link: docs/pbc/all/payment-service-provider/page.version/payments-feature-overview.html --- To view a payment methods in the Back Office, follow the steps: @@ -28,4 +27,4 @@ To view a payment methods in the Back Office, follow the steps: ## Next steps -[Edit payment methods](/docs/pbc/all/payment-service-provider/{{page.version}}/spryker-pay/base-shop/manage-in-the-back-office/edit-payment-methods.html) +[Edit payment methods](/docs/pbc/all/payment-service-provider/{{page.version}}/manage-in-the-back-office/edit-payment-methods.html) diff --git a/docs/pbc/all/payment-service-provider/202212.0/payment-service-provider.md b/docs/pbc/all/payment-service-provider/202212.0/payment-service-provider.md index 7fcab639ce4..aeb57e8d85a 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/payment-service-provider.md +++ b/docs/pbc/all/payment-service-provider/202212.0/payment-service-provider.md @@ -3,27 +3,8 @@ title: Payment Service Provider description: Different payment methods for your shop last_updated: Apr 23, 2023 template: concept-topic-template -redirect_from: - - /docs/pbc/all/payment-service-providers/psp.html - - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payment-service-provider-integrations.html --- The *Payment Service Provider* PBC enables different kinds of payment methods, like credit cards of gift cards, to be used by customers. You can configure multiple payment methods to be available in your shop. The variety of third-party payment solutions let you find the best payment methods for your business requirements. -The capability consists of a base shop and the marketplace addon. The base shop features are needed for running a regular shop in which your company is the only entity fulfilling orders. To run a marketplace, the features from both the base shop and the marketplace addon are required. - -Spryker offers the following Payment Service Providers (PSP) integrations: - -| NAME | MARKETPLACE COMPATIBLE | AVAILABLE IN ACP | -| --- | --- | --- | -| Spryker Pay | Yes | No | -| Adyen | No | No | -| After Pay | No | No | -| Braintree | No | No | -| Crefo Pay | No | No | -| Computop | No | No | -| Easycredit | No | No | -| Optile | No | No | -| [Payone](/docs/pbc/all/payment-service-provider/{{page.version}}/payone/integration-in-the-back-office/payone-integration-in-the-back-office.html) | No | Yes | -| Ratepay | No | No | -| [Unzer](/docs/pbc/all/payment-service-provider/{{page.version}}/unzer/unzer.html) | Yes | No | +For more details, see [Payments feature overview](/docs/pbc/all/payment-service-provider/{{page.version}}/payments-feature-overview.html). diff --git a/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/payments-feature-domain-model-and-relationships.md b/docs/pbc/all/payment-service-provider/202212.0/payments-feature-domain-model-and-relationships.md similarity index 80% rename from docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/payments-feature-domain-model-and-relationships.md rename to docs/pbc/all/payment-service-provider/202212.0/payments-feature-domain-model-and-relationships.md index 1c3bbfe3097..7ea249c9b5f 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/payments-feature-domain-model-and-relationships.md +++ b/docs/pbc/all/payment-service-provider/202212.0/payments-feature-domain-model-and-relationships.md @@ -6,8 +6,6 @@ template: concept-topic-template redirect_from: - /docs/scos/dev/feature-walkthroughs/202200.0/payments-feature-walkthrough.html - /docs/scos/dev/feature-walkthroughs/202212.0/payments-feature-walkthrough.html - - /docs/pbc/all/payment-service-provider/202212.0/payments-feature-domain-model-and-relationships.html - - /docs/pbc/all/payment-service-provider/202212.0/payments-feature-domain-model-and-relationships.html --- The _Payments_ feature lets customers pay for orders with none, one, or multiple payment methods during the checkout process. diff --git a/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/payments-feature-overview.md b/docs/pbc/all/payment-service-provider/202212.0/payments-feature-overview.md similarity index 69% rename from docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/payments-feature-overview.md rename to docs/pbc/all/payment-service-provider/202212.0/payments-feature-overview.md index caec2f131de..facf57b45e1 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/payments-feature-overview.md +++ b/docs/pbc/all/payment-service-provider/202212.0/payments-feature-overview.md @@ -6,10 +6,12 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/payments-feature-overview originalArticleId: db728134-17d6-4023-8d7a-55177ee5af44 redirect_from: + - /2021080/docs/payments-feature-overview + - /2021080/docs/en/payments-feature-overview + - /docs/payments-feature-overview + - /docs/en/payments-feature-overview - /docs/scos/user/features/202200.0/payments-feature-overview.html - /docs/scos/user/features/202212.0/payments-feature-overview.html - - /docs/pbc/all/payment-service-provider/202212.0/payments-feature-overview.html - - /docs/pbc/all/payment-service-provider/202212.0/payments-feature-overview.html --- The *Payments* feature lets your customers pay for orders with none (for example, a [gift card](/docs/pbc/all/gift-cards/{{page.version}}/gift-cards.html)), one, or multiple payment methods during the checkout process. Most orders are paid with a single payment method, but in some cases, it may be useful to allow multiple payment methods. For example, the customer may want to use two credit cards or a gift card in addition to a traditional payment method. @@ -28,22 +30,22 @@ The Spryker Commerce OS offers integrations with several payment providers that The Spryker Commerce OS supports the integration of the following payment providers, which are our official partners: -* [Adyen](/docs/pbc/all/payment-service-provider/{{page.version}}/adyen/adyen.html) -* [AfterPay](/docs/pbc/all/payment-service-provider/{{page.version}}/afterpay/afterpay.html) -* [Amazon Pay](/docs/pbc/all/payment-service-provider/{{page.version}}/amazon-pay/amazon-pay.html) -* [Arvato](/docs/pbc/all/payment-service-provider/{{page.version}}/arvato/arvato.html) -* [Billie](/docs/pbc/all/payment-service-provider/{{page.version}}/billie.html) -* [Billpay](/docs/pbc/all/payment-service-provider/{{page.version}}/billpay/billpay.html) -* [Braintree](/docs/pbc/all/payment-service-provider/{{page.version}}/braintree/braintree.html) -* [BS Payone](/docs/pbc/all/payment-service-provider/{{page.version}}/bs-payone/bs-payone.html) -* [Computop](/docs/pbc/all/payment-service-provider/{{page.version}}/computop/computop.html) -* [CrefoPay](/docs/pbc/all/payment-service-provider/{{page.version}}/crefopay/crefopay.html) -* [Heidelpay](/docs/pbc/all/payment-service-provider/{{page.version}}/heidelpay/heidelpay.html) -* [Klarna](/docs/pbc/all/payment-service-provider/{{page.version}}/klarna/klarna.html) -* [Payolution](/docs/pbc/all/payment-service-provider/{{page.version}}/payolution/payolution.html) -* [Powerpay](/docs/pbc/all/payment-service-provider/{{page.version}}/powerpay.html) -* [ratenkauf by easyCredit](/docs/pbc/all/payment-service-provider/{{page.version}}/ratenkauf-by-easycredit/ratenkauf-by-easycredit.html) -* [RatePay](/docs/pbc/all/payment-service-provider/{{page.version}}/ratepay/ratepay.html) +* [Adyen](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/adyen/adyen.html) +* [AfterPay](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/afterpay/afterpay.html) +* [Amazon Pay](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/amazon-pay/amazon-pay.html) +* [Arvato](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/arvato/arvato.html) +* [Billie](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/billie.html) +* [Billpay](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/billpay/billpay.html) +* [Braintree](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/braintree/braintree.html) +* [BS Payone](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/bs-payone/bs-payone.html) +* [Computop](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/computop/computop.html) +* [CrefoPay](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/crefopay/crefopay.html) +* [Heidelpay](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/heidelpay/heidelpay.html) +* [Klarna](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/klarna/klarna.html) +* [Payolution](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/payolution/payolution.html) +* [Powerpay](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/powerpay.html) +* [ratenkauf by easyCredit](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/ratenkauf-by-easycredit/ratenkauf-by-easycredit.html) +* [RatePay](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/ratepay/ratepay.html) ## Dummy payment @@ -56,13 +58,13 @@ In the Back Office, you can view all payment methods available in the shop appli {% info_block warningBox "Note" %} -Before managing payment methods in the Back Office, you need to create them by [importing payment methods data using a .CSV file](/docs/pbc/all/payment-service-provider/{{page.version}}/spryker-pay/base-shop/import-and-export-data/import-file-details-payment-method.csv.html). +Before managing payment methods in the Back Office, you need to create them by [importing payment methods data using a .CSV file](/docs/pbc/all/payment-service-provider/{{page.version}}/import-and-export-data/file-details-payment-method.csv.html). {% endinfo_block %} ![List of payment methods](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Payment/Payment+Methods+Overview/payment-methods-list.png) -To learn more on how to make a payment method available during the checkout and assign it to a different store, see [Edit payment methods](/docs/pbc/all/payment-service-provider/{{page.version}}/spryker-pay/base-shop/manage-in-the-back-office/edit-payment-methods.html). +To learn more on how to make a payment method available during the checkout and assign it to a different store, see [Edit payment methods](/docs/pbc/all/payment-service-provider/{{page.version}}/manage-in-the-back-office/edit-payment-methods.html). \ No newline at end of file diff --git a/docs/pbc/all/ratings-reviews/202204.0/import-and-export-data/ratings-and-reviews-data-import.md b/docs/pbc/all/ratings-reviews/202204.0/import-and-export-data/ratings-and-reviews-data-import.md deleted file mode 100644 index 7ae8f86fc45..00000000000 --- a/docs/pbc/all/ratings-reviews/202204.0/import-and-export-data/ratings-and-reviews-data-import.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Ratings and Reviews data import -description: Details about data import files for the Ratings and Reviews PBC -template: concept-topic-template -last_updated: Jul 23, 2023 ---- - - -To learn how data import works and about different ways of importing data, see [Data import](/docs/scos/dev/data-import/{{page.version}}/data-import.html). This section describes the data import files that are used to import data related to the Ratings and Reviews PBC: [File details- product_review.csv](/docs/pbc/all/ratings-reviews/{{page.version}}/import-and-export-data/file-details-product-review.csv.html). diff --git a/docs/pbc/all/ratings-reviews/202204.0/manage-using-glue-api/manage-product-reviews-using-glue-api.md b/docs/pbc/all/ratings-reviews/202204.0/manage-using-glue-api/manage-product-reviews-using-glue-api.md index af391512062..f15f3e7890f 100644 --- a/docs/pbc/all/ratings-reviews/202204.0/manage-using-glue-api/manage-product-reviews-using-glue-api.md +++ b/docs/pbc/all/ratings-reviews/202204.0/manage-using-glue-api/manage-product-reviews-using-glue-api.md @@ -197,4 +197,4 @@ Also, all the endpoints that accept `abstract-products` and `concrete-products` | 311 | Abstract product ID is not specified. | | 901 | One or more of the following reasons:
  • The `nickname` attribute is empty or not specified.
  • The `rating` attribute is empty or not specified.
  • The `summary` attribute is empty or not specified.
| -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/ratings-reviews/202204.0/manage-using-glue-api/retrieve-product-reviews-when-retrieving-concrete-products.md b/docs/pbc/all/ratings-reviews/202204.0/manage-using-glue-api/retrieve-product-reviews-when-retrieving-concrete-products.md index d36969a949f..229d45b88ee 100644 --- a/docs/pbc/all/ratings-reviews/202204.0/manage-using-glue-api/retrieve-product-reviews-when-retrieving-concrete-products.md +++ b/docs/pbc/all/ratings-reviews/202204.0/manage-using-glue-api/retrieve-product-reviews-when-retrieving-concrete-products.md @@ -162,4 +162,4 @@ For the attributes product reviews, see [Retrieve product reviews](/docs/pbc/all | 302 | Concrete product is not found. | | 312 | Concrete product is not specified. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/ratings-reviews/202212.0/import-and-export-data/ratings-and-reviews-data-import.md b/docs/pbc/all/ratings-reviews/202212.0/import-and-export-data/ratings-and-reviews-data-import.md deleted file mode 100644 index 7ae8f86fc45..00000000000 --- a/docs/pbc/all/ratings-reviews/202212.0/import-and-export-data/ratings-and-reviews-data-import.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Ratings and Reviews data import -description: Details about data import files for the Ratings and Reviews PBC -template: concept-topic-template -last_updated: Jul 23, 2023 ---- - - -To learn how data import works and about different ways of importing data, see [Data import](/docs/scos/dev/data-import/{{page.version}}/data-import.html). This section describes the data import files that are used to import data related to the Ratings and Reviews PBC: [File details- product_review.csv](/docs/pbc/all/ratings-reviews/{{page.version}}/import-and-export-data/file-details-product-review.csv.html). diff --git a/docs/pbc/all/ratings-reviews/202212.0/manage-using-glue-api/manage-product-reviews-using-glue-api.md b/docs/pbc/all/ratings-reviews/202212.0/manage-using-glue-api/manage-product-reviews-using-glue-api.md index a8bedb0d776..8201e86f766 100644 --- a/docs/pbc/all/ratings-reviews/202212.0/manage-using-glue-api/manage-product-reviews-using-glue-api.md +++ b/docs/pbc/all/ratings-reviews/202212.0/manage-using-glue-api/manage-product-reviews-using-glue-api.md @@ -197,4 +197,4 @@ Also, all the endpoints that accept `abstract-products` and `concrete-products` | 311 | Abstract product ID is not specified. | | 901 | One or more of the following reasons:
  • The `nickname` attribute is empty or not specified.
  • The `rating` attribute is empty or not specified.
  • The `summary` attribute is empty or not specified.
| -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/ratings-reviews/202212.0/manage-using-glue-api/retrieve-product-reviews-when-retrieving-concrete-products.md b/docs/pbc/all/ratings-reviews/202212.0/manage-using-glue-api/retrieve-product-reviews-when-retrieving-concrete-products.md index 1f6ada9b04e..6c5b1848851 100644 --- a/docs/pbc/all/ratings-reviews/202212.0/manage-using-glue-api/retrieve-product-reviews-when-retrieving-concrete-products.md +++ b/docs/pbc/all/ratings-reviews/202212.0/manage-using-glue-api/retrieve-product-reviews-when-retrieving-concrete-products.md @@ -162,4 +162,4 @@ For the attributes product reviews, see [Retrieve product reviews](/docs/pbc/all | 302 | Concrete product is not found. | | 312 | Concrete product is not specified. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/ratings-reviews/202304.0/install-and-upgrade/install-the-product-rating-and-reviews-glue-api.md b/docs/pbc/all/ratings-reviews/202304.0/install-and-upgrade/install-the-product-rating-and-reviews-glue-api.md deleted file mode 100644 index 6264ca7bd7d..00000000000 --- a/docs/pbc/all/ratings-reviews/202304.0/install-and-upgrade/install-the-product-rating-and-reviews-glue-api.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: Install the Product Rating and Reviews Glue API -description: This guide contains step-by-step instructions on integrating Product Rating & Reviews API feature into a Spryker-based project. -last_updated: Jul 18, 2023 -template: feature-integration-guide-template -originalLink: https://documentation.spryker.com/2021080/docs/glue-api-product-rating-reviews-feature-integration -originalArticleId: 6634ada1-2f5a-454b-a5b3-9319b7e90cbf -redirect_from: - - /2021080/docs/glue-api-product-rating-reviews-feature-integration - - /2021080/docs/en/glue-api-product-rating-reviews-feature-integration - - /docs/glue-api-product-rating-reviews-feature-integration - - /docs/en/glue-api-product-rating-reviews-feature-integration - - /docs/scos/dev/feature-integration-guides/201811.0/glue-api/glue-api-product-rating-and-reviews-feature-integration.html - - /docs/scos/dev/feature-integration-guides/201903.0/glue-api/glue-api-product-rating-and-reviews-feature-integration.html - - /docs/scos/dev/feature-integration-guides/201907.0/glue-api/glue-api-product-rating-and-reviews-feature-integration.html - - /docs/scos/dev/feature-integration-guides/202212.0/glue-api/glue-api-product-rating-and-reviews-feature-integration.html - -related: - - title: Product Rating and Reviews feature integration - link: docs/scos/dev/feature-integration-guides/page.version/product-rating-and-reviews-feature-integration.html - - title: Product Rating and Reviews feature walkthrough - link: docs/scos/dev/feature-walkthroughs/page.version/product-rating-reviews-feature-walkthrough.html - - title: Retrieving abstract products - link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html - - title: Retrieving concrete products - link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html ---- - -{% include pbc/all/install-features/202304.0/install-glue-api/install-the-product-rating-and-reviews-glue-api.md %} diff --git a/docs/pbc/all/return-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-return-reasons.md b/docs/pbc/all/return-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-return-reasons.md index 47336d36fe7..b7dced653b8 100644 --- a/docs/pbc/all/return-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-return-reasons.md +++ b/docs/pbc/all/return-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-return-reasons.md @@ -89,4 +89,4 @@ Request sample: retrieve return reasons | --- | --- | --- | | reason | String | Predefined return reason. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/search/202212.0/base-shop/import-and-export-data/search-data-import.md b/docs/pbc/all/search/202212.0/base-shop/import-and-export-data/search-data-import.md deleted file mode 100644 index 019bccbf6ea..00000000000 --- a/docs/pbc/all/search/202212.0/base-shop/import-and-export-data/search-data-import.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Search data import -description: Details about data import files for the Search PBC -template: concept-topic-template -last_updated: Jul 23, 2023 ---- - - -To learn how data import works and about different ways of importing data, see [Data import](/docs/scos/dev/data-import/{{page.version}}/data-import.html). This section describes the data import files that are used to import data related to the Search PBC: - -* [File details: product_search_attribute_map.csv](/docs/pbc/all/search/{{page.version}}/base-shop/import-and-export-data/file-details-product-search-attribute-map.csv.html) -* [File details: product_search_attribute.csv](/docs/pbc/all/search/{{page.version}}/base-shop/import-and-export-data/file-details-product-search-attribute.csv.html) diff --git a/docs/pbc/all/search/202212.0/base-shop/import-and-export-data/file-details-product-search-attribute-map.csv.md b/docs/pbc/all/search/202212.0/base-shop/import-data/file-details-product-search-attribute-map.csv.md similarity index 95% rename from docs/pbc/all/search/202212.0/base-shop/import-and-export-data/file-details-product-search-attribute-map.csv.md rename to docs/pbc/all/search/202212.0/base-shop/import-data/file-details-product-search-attribute-map.csv.md index fda753cd8e4..f8d2864e7ac 100644 --- a/docs/pbc/all/search/202212.0/base-shop/import-and-export-data/file-details-product-search-attribute-map.csv.md +++ b/docs/pbc/all/search/202212.0/base-shop/import-data/file-details-product-search-attribute-map.csv.md @@ -10,7 +10,7 @@ redirect_from: - /docs/file-details-product-search-attribute-mapcsv - /docs/en/file-details-product-search-attribute-mapcsv - /docs/scos/dev/data-import/202212.0/data-import-categories/merchandising-setup/product-merchandising/file-details-product-search-attribute-map.csv.html - - /docs/pbc/all/search/202212.0/import-and-export-data/file-details-product-search-attribute-map.csv.html + - /docs/pbc/all/search/202212.0/import-data/file-details-product-search-attribute-map.csv.html related: - title: Execution order of data importers in Demo Shop link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html diff --git a/docs/pbc/all/search/202212.0/base-shop/import-and-export-data/file-details-product-search-attribute.csv.md b/docs/pbc/all/search/202212.0/base-shop/import-data/file-details-product-search-attribute.csv.md similarity index 96% rename from docs/pbc/all/search/202212.0/base-shop/import-and-export-data/file-details-product-search-attribute.csv.md rename to docs/pbc/all/search/202212.0/base-shop/import-data/file-details-product-search-attribute.csv.md index 8ce085bd644..3ccaca2ff37 100644 --- a/docs/pbc/all/search/202212.0/base-shop/import-and-export-data/file-details-product-search-attribute.csv.md +++ b/docs/pbc/all/search/202212.0/base-shop/import-data/file-details-product-search-attribute.csv.md @@ -10,7 +10,7 @@ redirect_from: - /docs/file-details-product-search-attributecsv - /docs/en/file-details-product-search-attributecsv - /docs/scos/dev/data-import/202212.0/data-import-categories/merchandising-setup/product-merchandising/file-details-product-search-attribute.csv.html - - /docs/pbc/all/search/202212.0/import-and-export-data/file-details-product-search-attribute.csv.html + - /docs/pbc/all/search/202212.0/import-data/file-details-product-search-attribute.csv.html related: - title: Execution order of data importers in Demo Shop link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html diff --git a/docs/pbc/all/search/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-autocomplete-and-search-suggestions.md b/docs/pbc/all/search/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-autocomplete-and-search-suggestions.md index 5e1812f3183..76ca3de26cc 100644 --- a/docs/pbc/all/search/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-autocomplete-and-search-suggestions.md +++ b/docs/pbc/all/search/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-autocomplete-and-search-suggestions.md @@ -241,8 +241,8 @@ To retrieve a search suggestion, send the request: {% info_block infoBox "SEO-friendly URLs" %} -The `url` attribute of categories and abstract products exposes a SEO-friendly URL of the resource that represents the respective category or product. For information on how to resolve such a URL and retrieve the corresponding resource, see [Resolving search engine friendly URLs](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/resolving-search-engine-friendly-urls.html). +The `url` attribute of categories and abstract products exposes a SEO-friendly URL of the resource that represents the respective category or product. For information on how to resolve such a URL and retrieve the corresponding resource, see [Resolving search engine friendly URLs](/docs/scos/dev/glue-api-guides/{{page.version}}/resolving-search-engine-friendly-urls.html). {% endinfo_block %} -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/search/202212.0/base-shop/manage-using-glue-api/glue-api-search-the-product-catalog.md b/docs/pbc/all/search/202212.0/base-shop/manage-using-glue-api/glue-api-search-the-product-catalog.md index 745a10e5b0f..bb996aaa568 100644 --- a/docs/pbc/all/search/202212.0/base-shop/manage-using-glue-api/glue-api-search-the-product-catalog.md +++ b/docs/pbc/all/search/202212.0/base-shop/manage-using-glue-api/glue-api-search-the-product-catalog.md @@ -6711,4 +6711,4 @@ For other abstract product attributes, see: | 314 | Price mode is invalid. | | 503 | Invalid type (non-integer) of one of the request parameters:
  • rating
  • rating.min
  • rating.max
  • page.limit
  • page.offset
  • category
| -For generic Glue Application errors that can also occur, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +For generic Glue Application errors that can also occur, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/search/202212.0/base-shop/search-feature-overview/search-feature-overview.md b/docs/pbc/all/search/202212.0/base-shop/search-feature-overview/search-feature-overview.md index f62f5f61213..650155061d1 100644 --- a/docs/pbc/all/search/202212.0/base-shop/search-feature-overview/search-feature-overview.md +++ b/docs/pbc/all/search/202212.0/base-shop/search-feature-overview/search-feature-overview.md @@ -55,8 +55,8 @@ The feature has the following functional constraints which are going to be resol | INSTALLATION GUIDES | UPGRADE GUIDES | DATA IMPORT | GLUE API GUIDES | TUTORIALS AND HOWTOS | BEST PRACTICES | |---------|---------|-|-|-|-| -| [Install the Catalog Glue API](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-glue-api.html) | [Upgrade the Catalog module](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-catalog-module.html) | [File details: product_search_attribute_map.csv](/docs/pbc/all/search/{{page.version}}/base-shop/import-and-export-data/file-details-product-search-attribute-map.csv.html) | [Searching the product catalog](/docs/pbc/all/search/{{page.version}}/base-shop/manage-using-glue-api/glue-api-search-the-product-catalog.html) | [Tutorial: Content and search - attribute-cart-based catalog personalization](/docs/pbc/all/search/{{page.version}}/base-shop/tutorials-and-howtos/tutorial-content-and-search-attribute-cart-based-catalog-personalization/tutorial-content-and-search-attribute-cart-based-catalog-personalization.html) | [Data-driven ranking](/docs/pbc/all/search/{{page.version}}/base-shop/best-practices/data-driven-ranking.html) | -| [Install the Catalog + Category Management feature](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-catalog-category-management-feature.html) | [Upgrade the CatalogSearchRestApi module](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-catalogsearchrestapi–module.html) | [File details: product_search_attribute.csv](/docs/pbc/all/search/{{page.version}}/base-shop/import-and-export-data/file-details-product-search-attribute.csv.html) | [Retrieving autocomplete and search suggestions](/docs/pbc/all/search/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-autocomplete-and-search-suggestions.html) | [Tutorial: Boosting cart-based search](/docs/pbc/all/search/{{page.version}}/base-shop/tutorials-and-howtos/tutorial-content-and-search-attribute-cart-based-catalog-personalization/tutorial-boosting-cart-based-search.html) | [Full-text search](/docs/pbc/all/search/{{page.version}}/base-shop/best-practices/full-text-search.html) | +| [Install the Catalog Glue API](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-glue-api.html) | [Upgrade the Catalog module](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-catalog-module.html) | [File details: product_search_attribute_map.csv](/docs/pbc/all/search/{{page.version}}/base-shop/import-data/file-details-product-search-attribute-map.csv.html) | [Searching the product catalog](/docs/pbc/all/search/{{page.version}}/base-shop/manage-using-glue-api/glue-api-search-the-product-catalog.html) | [Tutorial: Content and search - attribute-cart-based catalog personalization](/docs/pbc/all/search/{{page.version}}/base-shop/tutorials-and-howtos/tutorial-content-and-search-attribute-cart-based-catalog-personalization/tutorial-content-and-search-attribute-cart-based-catalog-personalization.html) | [Data-driven ranking](/docs/pbc/all/search/{{page.version}}/base-shop/best-practices/data-driven-ranking.html) | +| [Install the Catalog + Category Management feature](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-catalog-category-management-feature.html) | [Upgrade the CatalogSearchRestApi module](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-catalogsearchrestapi–module.html) | [File details: product_search_attribute.csv](/docs/pbc/all/search/{{page.version}}/base-shop/import-data/file-details-product-search-attribute.csv.html) | [Retrieving autocomplete and search suggestions](/docs/pbc/all/search/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-autocomplete-and-search-suggestions.html) | [Tutorial: Boosting cart-based search](/docs/pbc/all/search/{{page.version}}/base-shop/tutorials-and-howtos/tutorial-content-and-search-attribute-cart-based-catalog-personalization/tutorial-boosting-cart-based-search.html) | [Full-text search](/docs/pbc/all/search/{{page.version}}/base-shop/best-practices/full-text-search.html) | | [Install the Catalog + Order Management feature](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-catalog-order-management-feature.html) | [Upgrade the CategoryPageSearch module](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-categorypagesearch–module.html) | | | [Configure a search query](/docs/pbc/all/search/{{page.version}}/base-shop/tutorials-and-howtos/configure-a-search-query.html) | [Generic faceted search](/docs/pbc/all/search/{{page.version}}/base-shop/best-practices/generic-faceted-search.html) | | [Install the Search Widget for Concrete Products feature](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-search-widget-for-concrete-products.html) | [Upgrade the CmsPageSearch module](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmspagesearch–module.html) | | | [Configure Elasticsearch](/docs/pbc/all/search/{{page.version}}/base-shop/tutorials-and-howtos/configure-elasticsearch.html) | [Multi-term autocompletion](/docs/pbc/all/search/{{page.version}}/base-shop/best-practices/multi-term-auto-completion.html) | | | [Upgrade the ProductLabelSearch module](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelsearch–module.html) | | | [Configure search features](/docs/pbc/all/search/{{page.version}}/base-shop/tutorials-and-howtos/configure-search-features.html) | [Naive product centric approach](/docs/pbc/all/search/{{page.version}}/base-shop/best-practices/naive-product-centric-approach.html) | diff --git a/docs/pbc/all/search/202212.0/base-shop/third-party-integrations/algolia.md b/docs/pbc/all/search/202212.0/base-shop/third-party-integrations/algolia.md index f0c0a1afc43..47625e80567 100644 --- a/docs/pbc/all/search/202212.0/base-shop/third-party-integrations/algolia.md +++ b/docs/pbc/all/search/202212.0/base-shop/third-party-integrations/algolia.md @@ -64,20 +64,12 @@ Here is an example of product data stored in Algolia: { "sku": "017_21748906", "name": "Sony Cyber-shot DSC-W800", - "abstract_name": "Sony Cyber-shot DSC-W800", "description": "Styled for your pocket Precision photography meets the portability of a smartphone. The W800 is small enough to take great photos, look good while doing it, and slip in your pocket. Shooting great photos and videos is easy with the W800. Buttons are positioned for ease of use, while a dedicated movie button makes shooting movies simple. The vivid 2.7-type Clear Photo LCD display screen lets you view your stills and play back movies with minimal effort. Whip out the W800 to capture crisp, smooth footage in an instant. At the press of a button, you can record blur-free 720 HD images with digital sound. Breathe new life into a picture by using built-in Picture Effect technology. There’s a range of modes to choose from – you don’t even have to download image-editing software.", "url": "/en/sony-cyber-shot-dsc-w800-17", "product_abstract_sku": "017", "rating": 4.5, "keywords": "Sony,Entertainment Electronics", - "images": { - "default": [ - { - "small": "https://images.icecat.biz/img/norm/medium/21748906-Sony.jpg", - "large": "https://images.icecat.biz/img/norm/high/21748906-Sony.jpg" - } - ] - }, + "image": "https://images.icecat.biz/img/norm/high/21748906-Sony.jpg", "category": [ "Demoshop", "Cameras & Camcorders", @@ -98,33 +90,18 @@ Here is an example of product data stored in Algolia: "upcs": "0013803252897", "usb_version": "2" }, - "merchant_name": [ // Marketplace only - "Video King", + "merchants": [ // Marketplace only + "Video King1", "Budget Cameras" ], - "merchant_reference": [ // Marketplace only - "MER000002", - "MER000005" - ], - "search_metadata": [], // Put inside this list all your ranking attributes - "concrete_prices": { - "eur": { - "gross": 345699, - "net": 311129 - }, - "chf": { - "gross": 397554, - "net": 357798 - } - }, "prices": { "eur": { - "gross": 345699, - "net": 311129 + "gross": 276559, + "net": 248903 }, "chf": { - "gross": 397554, - "net": 357798 + "gross": 318043, + "net": 286238 } }, "objectID": "017_21748906" diff --git a/docs/pbc/all/search/202212.0/base-shop/third-party-integrations/integrate-algolia.md b/docs/pbc/all/search/202212.0/base-shop/third-party-integrations/integrate-algolia.md index affae2a15ff..aec34c28064 100644 --- a/docs/pbc/all/search/202212.0/base-shop/third-party-integrations/integrate-algolia.md +++ b/docs/pbc/all/search/202212.0/base-shop/third-party-integrations/integrate-algolia.md @@ -7,7 +7,7 @@ redirect_from: - /docs/pbc/all/search/202212.0/third-party-integrations/integrate-algolia.html --- -This document describes how to integrate [Algolia](/docs/pbc/all/search/{{page.version}}/base-shop/third-party-integrations/algolia.html) into a Spryker shop. +This document describes how to integrate [Algolia](docs/pbc/all/search/{{page.version}}/base-shop/third-party-integrations/algolia.html) into a Spryker shop. ## Prerequisites diff --git a/docs/pbc/all/search/202212.0/best-practices/precise-search-by-super-attributes.md b/docs/pbc/all/search/202212.0/best-practices/precise-search-by-super-attributes.md new file mode 100644 index 00000000000..0db3035cd65 --- /dev/null +++ b/docs/pbc/all/search/202212.0/best-practices/precise-search-by-super-attributes.md @@ -0,0 +1,117 @@ +--- +title: Precise search by super attributes +description: This document describes precise search by super attributes +last_updated: Jun 16, 2021 +template: concept-topic-template +originalLink: https://documentation.spryker.com/2021080/docs/precise-search-by-super-attributes +originalArticleId: 0af5d38e-725f-44a1-9bfd-dd9f85cdf29b +redirect_from: + - /2021080/docs/precise-search-by-super-attributes + - /2021080/docs/en/precise-search-by-super-attributes + - /docs/scos/dev/best-practices/search-best-practices/precise-search-by-super-attributes.html + - /docs/precise-search-by-super-attributes + - /docs/en/precise-search-by-super-attributes + - /v6/docs/precise-search-by-super-attributes + - /v6/docs/en/precise-search-by-super-attributes +related: + - title: Data-driven ranking + link: docs/pbc/all/search/page.version/best-practices/data-driven-ranking.html + - title: Full-text search + link: docs/pbc/all/search/page.version/best-practices/full-text-search.html + - title: Generic faceted search + link: docs/pbc/all/search/page.version/best-practices/generic-faceted-search.html + - title: On-site search + link: docs/pbc/all/search/page.version/best-practices/on-site-search.html + - title: Other best practices + link: docs/pbc/all/search/page.version/best-practices/other-best-practices.html + - title: Multi-term autocompletion + link: docs/pbc/all/search/page.version/best-practices/multi-term-auto-completion.html + - title: Simple spelling suggestions + link: docs/pbc/all/search/page.version/best-practices/simple-spelling-suggestions.html + - title: Naive product centric approach + link: docs/pbc/all/search/page.version/best-practices/naive-product-centric-approach.html + - title: Personalization - dynamic pricing + link: docs/pbc/all/search/page.version/best-practices/personalization-dynamic-pricing.html + - title: Usage-driven schema and document structure + link: docs/pbc/all/search/page.version/best-practices/usage-driven-schema-and-document-structure.html +--- + +## Task to achieve + +Imagine a shop selling a laptop with 16/32Gb RAM and i5/i7 CPU options. One day there are only two models in stock: *16Gb + i5* and *32Gb + i7*. + +Selecting *RAM: 16Gb + CPU: i7* shows you this abstract product in the catalog/search, while none of its concretes match the requirements. + +As expected, only products with at least one concrete matching selected super-attribute values must be shown. In the previously mentioned example, the search result must be empty. + +## Possible solutions + +The following solutions require [Product Page Search 3.0.0](https://github.com/spryker/product-page-search/releases/tag/3.0.0) or newer. + +### Solution 1. Concrete products index as a support call +The solution consists of several steps: the idea, the implementation plan, and the possible downsides of the solution. + +#### Idea + +The Search is done in two steps: +1. In the **product concrete index**, search is performed by super attributes, and matching product abstract IDs are displayed. +2. Those from the main index for product abstracts are then retrieved. + +#### Implementation + +1. Extend `ProductConcretePageSearchTransfer` with the new field *attributes*, where the desired attributes are stored as an array of string values: + +``` + +``` + +2. Implement the Data expander with the interface `\Spryker\Zed\ProductPageSearchExtension\Dependency\Plugin\ProductConcretePageDataExpanderPluginInterface` to fill into `ProductConcretePageSearchTransfer` super attributes from the concrete. +3. Add this plugin in `ProductPageSearchDependencyProvider` into the plugins list `getProductConcretePageDataExpanderPlugins`. +3. Implement the query expander `ConcreteProductSearchQueryExpanderPlugin`, implementing the interface `QueryExpanderPluginInterface`. You have to add this plugin before `FacetQueryExpanderPlugin` in `CatalogDependencyProvider` into list `createCatalogSearchQueryExpanderPlugins`. + +This plugin does the following: +- Filters out from the request values for super attributes and doesn't include those in the query. +- Makes a sub-search request such as `CatalogClient::searchProductConcretesByFullText`, but searches by facets of super attributes from the request. +- Adds a list of unique abstract product IDs into the query. + +An example implementation looks as follows: + +``` +some code here +``` + +4. Extend `FacetQueryExpanderPlugin`, which doesn't take into account facets used in the plugin `ConcreteProductSearchQueryExpanderPlugin`. + +An example implementation looks as follows: + +``` +some code here +``` + +Make sure to use updated plugin in `CatalogDependencyProvider`. + +#### Downsides + +As you see from the implementation, the results of the last query abstract products index can't be actually paginated. You can't deal with smooth pagination since it's unknown how many concrete products to skip or query to get the next page with abstract products. + + +### Solution 2: Concrete products index is used as a main search index + +The solution consists of several steps: the idea, implementation plan, and possible downsides of the solution. + +#### Idea + +The search request is made on the concrete product index, which is extended with attributes, to allow filtering by those, and with abstract product data to fulfill the required abstract product information for catalog display. + +#### Implementation plan + +1. Update product concrete data loader. +2. Update `ProductConcretePageSearchPublisher` to load into `ProductConcreteTransfers` more data, needed to populate abstract product data. +3. Update `ProductConcreteSearchDataMapper` to use `productAbstractMapExpanderPlugins`. +4. Update the query plugin used to point to concrete index, using `ProductConcreteCatalogSearchQueryPlugin` in `CatalogDependencyProvider::createCatalogSearchQueryPlugin`. + +#### Downsides + +You get duplicate abstract products in the search results, accompanied by a single concrete product. + +Consider merging duplicated abstract products, if you don't want duplicates on the page. diff --git a/docs/pbc/all/service-points/202400.0/unified-commerce/install-the-service-points-feature.md b/docs/pbc/all/service-points/202400.0/unified-commerce/install-the-service-points-feature.md deleted file mode 100644 index 7d49ea59622..00000000000 --- a/docs/pbc/all/service-points/202400.0/unified-commerce/install-the-service-points-feature.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: Install the Service Points feature -description: Learn how to integrate the Service Points feature into your project -last_updated: June 20, 2023 -template: feature-integration-guide-template -redirect_from: - - /docs/uc/all/enhanced-click-collect/202304.0/install-and-upgrade/install-features/install-the-service-points-feature.html ---- - -{% include pbc/all/install-features/202400.0/install-the-service-points-feature.md %} diff --git a/docs/pbc/all/shopping-list-and-wishlist/202212.0/base-shop/manage-using-glue-api/glue-api-manage-shopping-list-items.md b/docs/pbc/all/shopping-list-and-wishlist/202212.0/base-shop/manage-using-glue-api/glue-api-manage-shopping-list-items.md index de433bf995d..af16678883d 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202212.0/base-shop/manage-using-glue-api/glue-api-manage-shopping-list-items.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202212.0/base-shop/manage-using-glue-api/glue-api-manage-shopping-list-items.md @@ -672,4 +672,4 @@ If the item is removed successfully, the endpoint returns the `204 No Content` s | 1504 | Specified shopping list item is not found. | | 1508 | Concrete product is not found. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/shopping-list-and-wishlist/202212.0/base-shop/manage-using-glue-api/glue-api-manage-shopping-lists.md b/docs/pbc/all/shopping-list-and-wishlist/202212.0/base-shop/manage-using-glue-api/glue-api-manage-shopping-lists.md index 329c982d1d0..30730e4ed82 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202212.0/base-shop/manage-using-glue-api/glue-api-manage-shopping-lists.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202212.0/base-shop/manage-using-glue-api/glue-api-manage-shopping-lists.md @@ -856,4 +856,4 @@ If the shopping list is deleted successfully, the endpoint returns the `204 No C | 1503 | Specified shopping list is not found. | | 1506 | Shopping list with given name already exists. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/shopping-list-and-wishlist/202212.0/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.md b/docs/pbc/all/shopping-list-and-wishlist/202212.0/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.md index 1eb8d1fd352..66053a164f4 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202212.0/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202212.0/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.md @@ -437,4 +437,4 @@ If the item is removed successfully, the endpoint returns the `204 No Content` s | 207 | Cannot remove the item. | | 208 | An item with the provided SKU does not exist in the wishlist. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/shopping-list-and-wishlist/202212.0/base-shop/manage-using-glue-api/glue-api-manage-wishlists.md b/docs/pbc/all/shopping-list-and-wishlist/202212.0/base-shop/manage-using-glue-api/glue-api-manage-wishlists.md index 05208b8f751..5fcb9cd778c 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202212.0/base-shop/manage-using-glue-api/glue-api-manage-wishlists.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202212.0/base-shop/manage-using-glue-api/glue-api-manage-wishlists.md @@ -852,4 +852,4 @@ If the wishlist is deleted successfully, the endpoint returns the `204 No Conten | 210 | Please enter the name using only letters, numbers, underscores, spaces or dashes. | | 901 | `name` field is empty. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-list-items.md b/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-list-items.md index 5bfc9dcd364..6d97f84105e 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-list-items.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-list-items.md @@ -562,4 +562,4 @@ If the item is removed successfully, the endpoint returns the `204 No Content` s | 1518 | Product is not equal to the current Store. | | 1519 | Product offer is not equal to the current Store. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists.md b/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists.md index 69dd1537d9f..085f49cc633 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists.md @@ -1070,4 +1070,4 @@ If the shopping list is deleted successfully, the endpoint returns the `204 No C | 1518 | Product is not equal to the current Store. | | 1519 | Product offer is not equal to the current Store. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlist-items.md b/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlist-items.md index d0b10837fdc..d4c02d377dc 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlist-items.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlist-items.md @@ -253,4 +253,4 @@ If the item is removed successfully, the endpoint returns the `204 No Content` s | 207 | Cannot remove the item. | | 208 | An item with the provided SKU does not exist in the wishlist. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.md b/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.md index 7500ab1a977..005281d5061 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.md @@ -2316,4 +2316,4 @@ If the wishlist is deleted successfully, the endpoint returns the `204 No Conten | 204 | Cannot update the wishlist. | | 205 | Cannot remove the wishlist. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/import-file-details-product-abstract.csv.md b/docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/import-tax-sets-for-abstract-products.md similarity index 95% rename from docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/import-file-details-product-abstract.csv.md rename to docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/import-tax-sets-for-abstract-products.md index d60a79c4d1a..a74d7bda4a5 100644 --- a/docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/import-file-details-product-abstract.csv.md +++ b/docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/import-tax-sets-for-abstract-products.md @@ -8,7 +8,7 @@ This document describes how to import taxes for abstract products via `product_ ## Import file dependencies -[tax.csv](/docs/pbc/all/tax-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-tax-sets.csv.html) +[tax.csv](/docs/pbc/all/tax-management/{{site.version}}/base-shop/import-and-export-data/import-tax-sets.html) ## Import file parameters diff --git a/docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/import-file-details-product-option.csv.md b/docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/import-tax-sets-for-product-options.md similarity index 96% rename from docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/import-file-details-product-option.csv.md rename to docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/import-tax-sets-for-product-options.md index 63e8a16a1a6..1e90877de73 100644 --- a/docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/import-file-details-product-option.csv.md +++ b/docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/import-tax-sets-for-product-options.md @@ -11,7 +11,7 @@ This document describes how to import taxes for product options via `product_op ## Dependencies * [product_abstract.csv](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/import-and-export-data/products-data-import/file-details-product-abstract.csv.html) -* [tax.csv](/docs/pbc/all/tax-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-tax-sets.csv.html) +* [tax.csv](/docs/pbc/all/tax-management/{{site.version}}/base-shop/import-and-export-data/import-tax-sets.html) ## Import file parameters diff --git a/docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/import-file-details-shipment.csv.md b/docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/import-tax-sets-for-shipment-methods.md similarity index 95% rename from docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/import-file-details-shipment.csv.md rename to docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/import-tax-sets-for-shipment-methods.md index 79ae2485248..91501b718cf 100644 --- a/docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/import-file-details-shipment.csv.md +++ b/docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/import-tax-sets-for-shipment-methods.md @@ -8,7 +8,7 @@ This document describes how to import taxes for shipment methods via `shipment. ## Import file dependencies -[tax.csv](/docs/pbc/all/tax-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-tax-sets.csv.html) +[tax.csv](/docs/pbc/all/tax-management/{{site.version}}/base-shop/import-and-export-data/import-tax-sets.html) ## Import file parameters diff --git a/docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/import-file-details-tax-sets.csv.md b/docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/import-tax-sets.md similarity index 100% rename from docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/import-file-details-tax-sets.csv.md rename to docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/import-tax-sets.md diff --git a/docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/tax-management-data-import.md b/docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/tax-management-data-import.md deleted file mode 100644 index 8a9e0429724..00000000000 --- a/docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/tax-management-data-import.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: Tax Management data import -description: Details about data import files for the Tax Management PBC -template: concept-topic-template -last_updated: Jul 23, 2023 ---- - - -To learn how data import works and about different ways of importing data, see [Data import](/docs/scos/dev/data-import/{{page.version}}/data-import.html). This section describes the data import files that are used to import data related to the Tax Management PBC: - -* [Import file details: tax_sets.csv](/docs/pbc/all/tax-management/{{page.version}}/base-shop/import-and-export-data/import-file-details-tax-sets.csv.html) -* [Import file details: product_abstract.csv](/docs/pbc/all/tax-management/{{page.version}}/base-shop/import-and-export-data/import-file-details-product-abstract.csv.html) -* [Import file details: product_option.csv](/docs/pbc/all/tax-management/{{page.version}}/base-shop/import-and-export-data/import-file-details-product-option.csv.html) -* [Import file details: shipment.csv](/docs/pbc/all/tax-management/{{page.version}}/base-shop/import-and-export-data/import-file-details-shipment.csv.html) diff --git a/docs/pbc/all/tax-management/202204.0/base-shop/manage-using-glue-api/retrieve-tax-sets.md b/docs/pbc/all/tax-management/202204.0/base-shop/manage-using-glue-api/retrieve-tax-sets.md index 91a29967a24..671dbdbf86c 100644 --- a/docs/pbc/all/tax-management/202204.0/base-shop/manage-using-glue-api/retrieve-tax-sets.md +++ b/docs/pbc/all/tax-management/202204.0/base-shop/manage-using-glue-api/retrieve-tax-sets.md @@ -170,4 +170,4 @@ Request sample: retrieve tax sets | 310 | Could not get tax set, product abstract with provided id not found. | | 311 | Abstract product SKU is not specified. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/tax-management/202204.0/base-shop/tax-feature-overview.md b/docs/pbc/all/tax-management/202204.0/base-shop/tax-feature-overview.md index 81dce84bf1c..6fe5d8d6e53 100644 --- a/docs/pbc/all/tax-management/202204.0/base-shop/tax-feature-overview.md +++ b/docs/pbc/all/tax-management/202204.0/base-shop/tax-feature-overview.md @@ -26,7 +26,7 @@ The *Tax Management* capability lets you define taxes for the items you sell. Th The tax rate is the percentage of the sales price that buyer pays as a tax. In the default Spryker implementation, the tax rate is defined per country where the tax applies. For details about how to create tax rates for countries in the Back Office, see [Create tax rates](/docs/pbc/all/tax-management/{{site.version}}/base-shop/manage-in-the-back-office/create-tax-rates.html). -A tax set is a set of tax rates. You can [define tax sets in the Back office](/docs/pbc/all/tax-management/{{site.version}}/base-shop/manage-in-the-back-office/create-tax-sets.html) or[ import tax sets](/docs/pbc/all/tax-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-tax-sets.csv.html) into your project. +A tax set is a set of tax rates. You can [define tax sets in the Back office](/docs/pbc/all/tax-management/{{site.version}}/base-shop/manage-in-the-back-office/create-tax-sets.html) or[ import tax sets](/docs/pbc/all/tax-management/{{site.version}}/base-shop/import-and-export-data/import-tax-sets.html) into your project. Tax sets can be applied to an abstract product, product option, and shipment: @@ -116,10 +116,10 @@ The capability has the following functional constraints: | INSTALLATION GUIDES | UPGRADE GUIDES | GLUE API GUIDES | DATA IMPORT | |---|---|---|---| -| [Integrate the Tax Glue API](/docs/pbc/all/tax-management/{{site.version}}/base-shop/install-and-upgrade/install-the-tax-glue-api.html) | [Upgrade the Tax module](/docs/pbc/all/tax-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-tax-module.html) | [Retrieve tax sets](/docs/pbc/all/tax-management/{{site.version}}/base-shop/manage-using-glue-api/retrieve-tax-sets.html) | [Import tax sets](/docs/pbc/all/tax-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-tax-sets.csv.html) | -| [Integrate the Product Tax Sets Glue API](/docs/pbc/all/tax-management/{{site.version}}/base-shop/install-and-upgrade/install-the-product-tax-sets-glue-api.html) | [Upgrade the ProductTaxSetsRestApi module](/docs/pbc/all/tax-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-producttaxsetsrestapi-module.html) | [Retrieve tax sets of abstract products](/docs/pbc/all/tax-management/{{site.version}}/base-shop/manage-using-glue-api/retrieve-tax-sets-when-retrieving-abstract-products.html) | [Import tax sets for abstract products](/docs/pbc/all/tax-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-product-abstract.csv.html) | -| | | | [Import tax sets for shipment methods](/docs/pbc/all/tax-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-shipment.csv.html) | -| | | | [Import tax sets for product options](/docs/pbc/all/tax-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-product-option.csv.html) | +| [Integrate the Tax Glue API](/docs/pbc/all/tax-management/{{site.version}}/base-shop/install-and-upgrade/install-the-tax-glue-api.html) | [Upgrade the Tax module](/docs/pbc/all/tax-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-tax-module.html) | [Retrieve tax sets](/docs/pbc/all/tax-management/{{site.version}}/base-shop/manage-using-glue-api/retrieve-tax-sets.html) | [Import tax sets](/docs/pbc/all/tax-management/{{site.version}}/base-shop/import-and-export-data/import-tax-sets.html) | +| [Integrate the Product Tax Sets Glue API](/docs/pbc/all/tax-management/{{site.version}}/base-shop/install-and-upgrade/install-the-product-tax-sets-glue-api.html) | [Upgrade the ProductTaxSetsRestApi module](/docs/pbc/all/tax-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-producttaxsetsrestapi-module.html) | [Retrieve tax sets of abstract products](/docs/pbc/all/tax-management/{{site.version}}/base-shop/manage-using-glue-api/retrieve-tax-sets-when-retrieving-abstract-products.html) | [Import tax sets for abstract products](/docs/pbc/all/tax-management/{{site.version}}/base-shop/import-and-export-data/import-tax-sets-for-abstract-products.html) | +| | | | [Import tax sets for shipment methods](/docs/pbc/all/tax-management/{{site.version}}/base-shop/import-and-export-data/import-tax-sets-for-shipment-methods.html) | +| | | | [Import tax sets for product options](/docs/pbc/all/tax-management/{{site.version}}/base-shop/import-and-export-data/import-tax-sets-for-product-options.html) | \ No newline at end of file +{% include pbc/all/install-features/{{page.version}}/install-the-inventory-management-feature.md %} \ No newline at end of file diff --git a/docs/pbc/all/warehouse-management-system/202304.0/base-shop/install-and-upgrade/install-features/install-the-order-management-inventory-management-feature.md b/docs/pbc/all/warehouse-management-system/202304.0/base-shop/install-and-upgrade/install-features/install-the-order-management-inventory-management-feature.md new file mode 100644 index 00000000000..09a13014d98 --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202304.0/base-shop/install-and-upgrade/install-features/install-the-order-management-inventory-management-feature.md @@ -0,0 +1,8 @@ +--- +title: Install the Order Management + Inventory Management feature +description: Install the Order Management + Inventory Management feature in your project +template: feature-integration-guide-template +last_updated: Feb 8, 2023 +--- + +{% include pbc/all/install-features/202304.0/install-the-order-management-inventory-management-feature.md %} \ No newline at end of file diff --git a/docs/pbc/all/warehouse-management-system/202304.0/base-shop/install-and-upgrade/install-the-warehouse-user-management-feature.md b/docs/pbc/all/warehouse-management-system/202304.0/base-shop/install-and-upgrade/install-the-warehouse-user-management-feature.md new file mode 100644 index 00000000000..2ef51aa6892 --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202304.0/base-shop/install-and-upgrade/install-the-warehouse-user-management-feature.md @@ -0,0 +1,8 @@ +--- +title: Install the Warehouse User Management feature +description: Install the Warehouse User Management feature in your project +template: feature-integration-guide-template +last_updated: June 1, 2023 +--- + +{% include pbc/all/install-features/202304.0/install-the-warehouse-user-management-feature.md %} diff --git a/docs/pbc/all/warehouse-management-system/202400.0/unified-commerce/install-and-upgrade/install-the-order-management-inventory-management-feature.md b/docs/pbc/all/warehouse-management-system/202400.0/unified-commerce/install-and-upgrade/install-the-order-management-inventory-management-feature.md deleted file mode 100644 index 384c3a1d0d8..00000000000 --- a/docs/pbc/all/warehouse-management-system/202400.0/unified-commerce/install-and-upgrade/install-the-order-management-inventory-management-feature.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: Install the Order Management + Inventory Management feature -description: Install the Order Management + Inventory Management feature in your project -template: feature-integration-guide-template -last_updated: Feb 8, 2023 -redirect_from: - - /docs/pbc/all/warehouse-management-system/202304.0/base-shop/install-and-upgrade/install-features/install-the-order-management-inventory-management-feature.html - ---- - -{% include pbc/all/install-features/{{page.version}}/install-the-order-management-inventory-management-feature.md %} \ No newline at end of file diff --git a/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-picker-user-login-feature.md b/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-picker-user-login-feature.md deleted file mode 100644 index 0ab1c7ba05a..00000000000 --- a/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-picker-user-login-feature.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: Install the Picker user login feature -description: Learn how to integrate the Picker user login feature into your project -last_updated: Mar 10, 2023 -template: feature-integration-guide-template -redirect_from: - - /docs/scos/dev/feature-integration-guides/202304.0/install-the-picker-user-login-feature.html ---- - -{% include pbc/all/install-features/202400.0/install-the-picker-user-login-feature.md %} diff --git a/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-feature.md b/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-feature.md deleted file mode 100644 index 9458b07362a..00000000000 --- a/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-feature.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: Install the Warehouse picking feature -description: Learn how to integrate the Warehouse picking feature into your project -last_updated: Feb 10, 2023 -template: feature-integration-guide-template -redirect_from: - - /docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-feature.html ---- - -{% include pbc/all/install-features/202400.0/install-the-warehouse-picking-feature.md %} diff --git a/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-inventory-management-feature.md b/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-inventory-management-feature.md deleted file mode 100644 index 0b48eb657f5..00000000000 --- a/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-inventory-management-feature.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Install the Warehouse picking + Inventory Management feature -description: Learn how to integrate the Warehouse picking + Inventory Management feature into your project -last_updated: Apr 10, 2023 -template: feature-integration-guide-template - - /docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-inventory-management-feature.html ---- - -{% include pbc/all/install-features/202400.0/install-the-warehouse-picking-inventory-management-feature.md %} diff --git a/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-order-management-feature.md b/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-order-management-feature.md deleted file mode 100644 index ae58ece0d1b..00000000000 --- a/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-order-management-feature.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: Install the Warehouse picking + Order Management feature -description: Learn how to integrate the Warehouse picking + Order Management feature into your project -last_updated: Mar 30, 2023 -template: feature-integration-guide-template -redirect_from: - - /docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-order-management-feature.html ---- - -{% include pbc/all/install-features/202400.0/install-the-warehouse-picking-order-management-feature.md %} diff --git a/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-product-feature.md b/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-product-feature.md deleted file mode 100644 index 41cc35b7bc0..00000000000 --- a/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-product-feature.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: Install the Warehouse picking + Product feature -description: Learn how to integrate the Warehouse picking + Product feature into your project -last_updated: Mar 30, 2023 -template: feature-integration-guide-template -redirect_from: - - /docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-product-feature.html ---- - -{% include pbc/all/install-features/202400.0/install-the-warehouse-picking-product-feature.md %} diff --git a/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-shipment-feature.md b/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-shipment-feature.md deleted file mode 100644 index ad60d737a5e..00000000000 --- a/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-shipment-feature.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: Install the Warehouse picking + Shipment feature -description: Learn how to integrate the Warehouse picking + Shipment feature into your project -last_updated: Apr 10, 2023 -template: feature-integration-guide-template -redirect_from: - - /docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-shipment-feature.html ---- - -{% include pbc/all/install-features/202400.0/install-the-warehouse-picking-shipment-feature.md %} diff --git a/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-spryker-core-back-office-feature.md b/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-spryker-core-back-office-feature.md deleted file mode 100644 index 3dd3e383d97..00000000000 --- a/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-spryker-core-back-office-feature.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: Install the Warehouse picking + Spryker Core Back Office feature -description: Learn how to integrate the Warehouse picking + Spryker Core Back Office feature into your project -last_updated: Apr 10, 2023 -template: feature-integration-guide-template -redirect_from: - - /docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-spryker-core-back-office-feature.html ---- - -{% include pbc/all/install-features/202400.0/install-the-warehouse-picking-spryker-core-back-office-feature.md %} diff --git a/docs/scos/dev/architecture/conceptual-overview.md b/docs/scos/dev/architecture/conceptual-overview.md index 6b3b4ee1385..092688fe701 100644 --- a/docs/scos/dev/architecture/conceptual-overview.md +++ b/docs/scos/dev/architecture/conceptual-overview.md @@ -57,7 +57,7 @@ The Spryker OS provides the following Application Layers: * [Yves](/docs/scos/dev/back-end-development/yves/yves.html)—provides frontend functionality with the light-weight data access. * [Zed](/docs/scos/dev/back-end-development/zed/zed.html)—provides back office/backend functionality with complicated calculations. -* [Glue](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/glue-infrastructure.html)—provides infrastructure for API with the mixed data access. +* [Glue](/docs/scos/dev/glue-api-guides/{{site.version}}/glue-infrastructure.html)—provides infrastructure for API with the mixed data access. * [Client](/docs/scos/dev/back-end-development/client/client.html)—provides data access infrastructure. * Shared—provides shared code abstractions to be used in other Application Layers of the same module. * Service—provides infrastructure for the stateless operations, usually utils. diff --git a/docs/scos/dev/back-end-development/data-manipulation/data-publishing/handle-data-with-publish-and-synchronization.md b/docs/scos/dev/back-end-development/data-manipulation/data-publishing/handle-data-with-publish-and-synchronization.md index 54f14c7c693..dbaa15bdf61 100644 --- a/docs/scos/dev/back-end-development/data-manipulation/data-publishing/handle-data-with-publish-and-synchronization.md +++ b/docs/scos/dev/back-end-development/data-manipulation/data-publishing/handle-data-with-publish-and-synchronization.md @@ -1,7 +1,7 @@ --- title: Handle data with Publish and Synchronization description: Use the tutorial to understand how Publish and Synchronization work and how to export data using a particular example. -last_updated: July 14, 2023 +last_updated: April 22, 2022 template: howto-guide-template originalLink: https://documentation.spryker.com/2021080/docs/handling-data-with-publish-and-synchronization originalArticleId: 67658ab1-da03-4cec-a059-2cd5d41c48df @@ -36,11 +36,11 @@ related: link: docs/scos/dev/back-end-development/data-manipulation/data-publishing/synchronization-behavior-enabling-multiple-mappings.html --- -_Publish and Synchronization_ (P&S) lets you export data from Spryker backend (Zed) to external endpoints. The default external endpoints are Redis and Elasticsearch. The endpoints are usually used by the frontend (Yves) or API (Glue). +_Publish and Synchronization_ (P&S) lets you export data from Spryker backend (Zed) to external endpoints. The default external endpoints are Redis and Elasticsearch. The endpoints are usually used by the frontend (Yves) or API (Glue). -This document shows how P&S works and how to export data using a HelloWorld P&S module example. The module synchronizes the data stored in a Zed database table to Redis. When a record is changed, created, or deleted in the table, the module automatically makes changes in Redis. +This document shows how P&S works and how to export data using a HelloWorld P&S module example. The module synchronizes the data stored in a Zed database table to Redis. When a record is changed, created, or deleted in the table, the module automatically makes changes in Redis. -## 1. Module and table +## 1. Module and table Follow these steps to create the following: * Data source module @@ -50,7 +50,7 @@ Follow these steps to create the following: 1. Create the `HelloWorld` module by creating the `HelloWorld` folder in Zed. The module is the source of data for publishing. 2. Create `spy_hello_world_message` table in the database:
- 1. In the `HelloWorld` module, define the table schema by creating `\Pyz\Zed\HelloWorld\Persistence\Propel\Schema\spy_hello_world.schema.xml`: + a. In the `HelloWorld` module, define the table schema by creating `\Pyz\Zed\HelloWorld\Persistence\Propel\Schema\spy_hello_world.schema.xml`: ```xml {% raw %} @@ -66,25 +66,25 @@ Follow these steps to create the following: {% endraw %} ``` - 2. Based on the schema, create the table in the database: + b. Based on the schema, create the table in the database: ```bash console propel:install ``` - 3. Create the `HelloWorldStorage` module by creating the `HelloWorldStorage` folder in Zed. The module is responsible for exporting data to Redis. + c. Create the `HelloWorldStorage` module by creating the `HelloWorldStorage` folder in Zed. The module is responsible for exporting data to Redis. {% info_block infoBox "Naming conventions" %} The following P&S naming conventions are applied: -- All the modules related to Redis should have the `Storage` suffix. -- All the modules related to Elasticsearch should have the `Search` suffix. +- All the modules related to Redis should have the `Storage` suffix. +- All the modules related to Elasticsearch should have the `Search` suffix. {% endinfo_block %} ## 2. Data structure -The data for Yves is structured differently than the data for Zed. It's because the data model used in Redis and Elasticsearch is optimized to be used by the frontend. With P&S, data is always carried in the form of [transfer objects](/docs/scos/dev/back-end-development/data-manipulation/data-ingestion/structural-preparations/create-use-and-extend-the-transfer-objects.html) between Zed and Yves. +The data for Yves is structured differently than the data for Zed. It's because the data model used in Redis and Elasticsearch is optimized to be used by the frontend. With P&S, data is always carried in the form of [transfer objects](/docs/scos/dev/back-end-development/data-manipulation/data-ingestion/structural-preparations/create-use-and-extend-the-transfer-objects.html) between Zed and Yves. Follow these steps to create a transfer object that represents the target data structure of the frontend. @@ -110,7 +110,7 @@ To publish changes in the Zed database table automatically, you need to enable a To enable events, follow the steps: -1. Activate Event Propel Behavior in `spy_hello_world.schema.xml` you've created in step 1 [Module and table](#module-and-table). +1. Activate Event Propel Behavior in `spy_hello_world.schema.xml` you've created in step 1 [Module and table](#module-and-table). ```xml {% raw %} @@ -137,7 +137,7 @@ To track changes in all the table columns, the _*_ (asterisk) for the `column` a console propel:install ``` -The `SpyHelloWorldMessage` entity model has three events for creating, updating, and deleting a record. These events are referred to as *publish events*. +The `SpyHelloWorldMessage` entity model has three events for creating, updating, and deleting a record. These events are referred to as *publish events*. 3. To map the events to the constants, which you can use in code later, create the `\Pyz\Shared\HelloWorldStorage\HelloWorldStorageConfig` configuration file: @@ -167,7 +167,7 @@ class HelloWorldStorageConfig extends AbstractBundleConfig } ``` -You have enabled events for the `SpyHelloWorldMessage` entity. +You have enabled events for the `SpyHelloWorldMessage` entity. ## 4. Publishers @@ -413,7 +413,7 @@ class IndexController extends AbstractController Ensure that the event has been created: 1. Open the RabbitMQ management GUI at `http(s)://{host_name}:15672/#/queues`. -2. You should see the event in the `publish.hello_world` queue: +2. You should see the event in the `publish.hello_world` queue: ![rabbitmq-event](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Publishing/Handling+data+with+Publish+and+Synchronization/rabbitmq-event.png) Ensure that the triggered event has the correct structure: @@ -443,10 +443,10 @@ Ensure that the triggered event has the correct structure: 2. Verify the data required for the publisher to process it: -* Event name: `Entity.spy_hello_spryker_message.create` -* Listener: `HelloWorldWritePublisherPlugin` -* Table name: `spy_hello_spryker_message` -* Modified columns: `spy_hello_spryker_message.name` and `spy_hello_spryker_message.message` +* Event name: `Entity.spy_hello_spryker_message.create` +* Listener: `HelloWorldWritePublisherPlugin` +* Table name: `spy_hello_spryker_message` +* Modified columns: `spy_hello_spryker_message.name` and `spy_hello_spryker_message.message` * ID: the primary key of the record * ForeignKey: the key to backtrack the updated Propel entities @@ -501,7 +501,7 @@ Ensure that the event has been processed correctly: - The `publish.hello_world` queue is empty: ![empty-rabbitmq-queue](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Publishing/Handling+data+with+Publish+and+Synchronization/empty-rabbitmq-queue.png) -For debugging purposes, use the `-k` option to keep messages in the queue `queue:task:start publish.hello_world -k`. +For debugging purposes, use the `-k` option to keep messages in the queue `queue:task:start publish.hello_world -k`. {% endinfo_block %} @@ -511,7 +511,7 @@ To synchronize data with Redis, an intermediate Zed database table is required. Follow the steps to create the table: -1. Create the table schema file in `Pyz\Zed\HelloWorldStorage\Persistence\Propel\Schema\spy_hello_world_storage.schema.xml`. +1. Create the table schema `Pyz\Zed\HelloWorldStorage\Persistance\Propel\Schema\spy_hello_world_storage.schema.xml`: ```xml {% raw %} @@ -550,18 +550,18 @@ The schema file defines the table as follows: - `ID` is a primary key of the table (`id_hello_world_message_storage` in the example). - `ForeignKey` is a foreign key to the main resource that you want to export (`fk_hello_world_message` for `spy_hello_world_message`). - `SynchronizationBehaviour` modifies the table as follows: - - Adds the `Data` column that stores data in the format that can be sent directly to Redis. The database field type is `TEXT`. - - Adds the `Key` column that stores the Redis Key. The data type is `VARCHAR`. + - Adds the `Data` column that stores data in the format that can be sent directly to Redis. The database field type is `TEXT`. + - Adds the `Key` column that stores the Redis Key. The data type is `VARCHAR`. - Defines `Resource` name for key generation. - Defines `Store` value for store-specific data. - Defines `Locale` value for localizable data. - Defines `Key Suffix Column` value for key generation. - - Defines `queue_group` to send a copy of the `data` column. + - Defines `queue_group` to send a copy of the `data` column. - Timestamp behavior is added to keep timestamps and use an incremental sync strategy. {% info_block infoBox "Incremental sync" %} -An *incremental sync* is a sync that only processes the data records that have changed (created or modified) since the last time the integration ran as opposed to processing the entire data set every time. +An *incremental sync* is a sync that only processes the data records that have changed (created or modified) since the last time the integration ran as opposed to processing the entire data set every time. {% endinfo_block %} @@ -585,7 +585,7 @@ To create complex keys to use more than one column, do the following: At this point, you can complete the publishing part. Follow the standard conventions and let publishers delegate the execution process through the facade to the models behind. -To do this, create facade and model classes to handle the logic of the publish part as follows. +To do this, create facade and model classes to handle the logic of the publish part as follows. The Facade methods are: @@ -593,7 +593,7 @@ The Facade methods are: - `deleteCollectionByHelloWorldEvents(array $eventTransfers)` -1. Create the `HelloWorldStorageWriter` model and implement the following method: +1. Create the `HelloWorldStorageWriter` model and implement the following method: ```php getFactory() - ->createMessageStorageReader() - ->getMessageById($messageId); - } -} -``` - -3. Add the factory `Pyz/Client/HelloWorldStorage/HelloWorldStorageFactory.php` for `$this->getFactory()` method call within the `HelloWorldStorageClient` methods. - -```php -getSynchronizationService(), $this->getStorageClient()); - } - - /** - * @return \Spryker\Service\Synchronization\SynchronizationServiceInterface - */ - public function getSynchronizationService(): SynchronizationServiceInterface - { - return $this->getProvidedDependency(HelloWorldStorageDependencyProvider::SERVICE_SYNCHRONIZATION); - } - - /** - * @return \Spryker\Client\Storage\StorageClientInterface - */ - public function getStorageClient(): StorageClientInterface - { - return $this->getProvidedDependency(HelloWorldStorageDependencyProvider::CLIENT_STORAGE); - } -} -``` - -4. The HelloWorldFactory needs a dependency provider to handle dependencies required by the Redis and reader classes. Add the `Pyz/Client/HelloWorldStorage/HelloWorldStorageDependencyProvider.php` dependency provider. +- `Client\Storage\MessageStorageReader` class: ```php addStorageClient($container); - $container = $this->addSynchronizationService($container); - - return $container; - } - - /** - * @param \Spryker\Client\Kernel\Container $container - * - * @return \Spryker\Client\Kernel\Container - */ - protected function addStorageClient(Container $container): Container - { - $container->set(static::CLIENT_STORAGE, function (Container $container) { - return $container->getLocator()->storage()->client(); - }); - - return $container; - } - - /** - * @param \Spryker\Client\Kernel\Container $container - * - * @return \Spryker\Client\Kernel\Container - */ - protected function addSynchronizationService(Container $container): Container - { - $container->set(static::SERVICE_SYNCHRONIZATION, function (Container $container) { - return $container->getLocator()->synchronization()->service(); - }); - - return $container; - } -} -``` - -5. To add an array of items that can be returned, update the transfer in `Pyz/Shared/HelloWorldStorage/Transfer/hello_world_storage.transfer.xml`: - -```xml - - - - - - - - - - -``` - -6. Run the following command: - -```bash - docker/sdk console transfer:generate -``` - -7. Add the `Pyz\Client\Reader\MessageStorageReaderInterface.php` interface. - -```php -synchronizationService = $synchronizationService; - $this->storageClient = $storageClient; - } - /** - * @param int $idMessage - * - * @return \Generated\Shared\Transfer\HelloWorldStorageTransfer - */ - public function getMessageById(int $idMessage): HelloWorldStorageTransfer + public function getMessageById($idMessage) { - $syncDataTransfer = new SynchronizationDataTransfer(); - $syncDataTransfer->setReference($idMessage); + $synchronizationDataTransfer = new SynchronizationDataTransfer(); + $synchronizationDataTransfer + ->setReference($idMessage); $key = $this->synchronizationService - ->getStorageKeyBuilder('message') - ->generateKey($syncDataTransfer); + ->getStorageKeyBuilder('message') // "message" is the resource name + ->generateKey($synchronizationDataTransfer); $data = $this->storageClient->get($key); @@ -1289,39 +1070,7 @@ class MessageStorageReader implements MessageStorageReaderInterface return $messageStorageTransfer; } -} -``` -9. Add thr endpoint to the controller in `Pyz/Zed/HelloWorld/Communication/Controller/IndexController.php`. - -```php - /** - * @param \Symfony\Component\HttpFoundation\Request $request - * - * @return \Symfony\Component\HttpFoundation\JsonResponse - */ - public function searchAction(Request $request): JsonResponse - { - $client = new HelloWorldStorageClient(); - $message = $client->getMessageById($request->get('id')); - - return $this->jsonResponse([ - 'status' => 'success', - 'message' => $message->toArray() - ]); - } -``` - -Update the routes for the Back Office using the following command: - -``` -docker/sdk console router:cache:warm-up:backoffice -``` - -You should now have another endpoint to get a message from the Redis storage via the newly created HelloWorldClient. - -Check the redis-commander to get ID of the message object that actually exists. Then access the message via the following endpoint: - -``` -http://[YOUR_BACKOFFICE_URL]/hello-world/index/search?id=[ID_IN_REDIS] + ... +} ``` diff --git a/docs/scos/dev/back-end-development/extend-spryker/development-strategies.md b/docs/scos/dev/back-end-development/extend-spryker/development-strategies.md index c31cd295829..ef1465910fa 100644 --- a/docs/scos/dev/back-end-development/extend-spryker/development-strategies.md +++ b/docs/scos/dev/back-end-development/extend-spryker/development-strategies.md @@ -56,7 +56,7 @@ In your project, you don't store prices in Spryker OS, but in an external system {% endinfo_block %} -If an extension point is missing, you can send a request to your Spryker account manager, and we will add it in future. +If an extension point is missing, register it in [Spryker Ideas](https://spryker.ideas.aha.io/), so we add it in future. Spryker OS support: High, you can safely take minor and patch releases. @@ -80,7 +80,7 @@ When specific OOTB Spryker behavior doesn't fit Project requirements, you can en {% info_block infoBox "Let us know which extension point is missing, so we can add it in the core" %} -If an extension point is missing, send a request to your Spryker account manager, and we will add it in future. +Register missing extension points in [Aha ideas](https://spryker.ideas.aha.io/). {% endinfo_block %} diff --git a/docs/scos/dev/data-import/202204.0/data-import-categories/commerce-setup/commerce-setup.md b/docs/scos/dev/data-import/202204.0/data-import-categories/commerce-setup/commerce-setup.md index db2220a1e60..ac270bc13da 100644 --- a/docs/scos/dev/data-import/202204.0/data-import-categories/commerce-setup/commerce-setup.md +++ b/docs/scos/dev/data-import/202204.0/data-import-categories/commerce-setup/commerce-setup.md @@ -21,14 +21,14 @@ The following table provides details about Commerce Setup data importers, their | Currency | Imports information about currencies used in the store(s). The `currency.csv` file provides an easy way to load information about currencies used in Spryker Demo Shop. It allows to load information like: ISO code, currency symbol, and the name of the currency.|`data:import:currency` | [currency.csv](/docs/pbc/all/price-management/{{site.version}}/base-shop/import-and-export-data/file-details-currency.csv.html) | None| | Customer | Imports information about customers.|`data:import:customer` | [customer.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/commerce-setup/file-details-customer.csv.html) | None| | Glossary | Imports information relative to the several locales.|`data:import:glossary` | [glossary.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/commerce-setup/file-details-glossary.csv.html) | None| -| Tax |Imports information about taxes.|`data:import:tax` | [tax.csv](/docs/pbc/all/tax-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-tax-sets.csv.html) | None| +| Tax |Imports information about taxes.|`data:import:tax` | [tax.csv](/docs/pbc/all/tax-management/{{site.version}}/base-shop/import-and-export-data/import-tax-sets.html) | None| | Shipment |Imports information about shipment methods.|`data:import:shipment` | [shipment.csv](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/import-and-export-data/file-details-shipment.csv.html) | None| | Shipment Price |Imports information about the price of each shipment method, applied in each store.|`data:import:shipment-price` | [shipment_price.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/commerce-setup/file-details-shipment-price.csv.html) |
  • [shipment.cs](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/import-and-export-data/file-details-shipment.csv.html)v
  • [currency.csv](/docs/pbc/all/price-management/{{site.version}}/base-shop/import-and-export-data/file-details-currency.csv.html)
  • `stores.php` configuration file of demo shop PHP project
| | Shipment Method Store | Links a *shipment method* to a specific *store*.|`data:import:shipment-method-store` | [shipment_method_store.csv](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/import-and-export-data/file-details-shipment-method-store.csv.html) |
  • [shipment.csv](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/import-and-export-data/file-details-shipment.csv.html)
  • `stores.php` configuration file of demo shop PHP project
| | Sales Order Threshold | Imports information about sales order thresholds. The CSV file content defines certain thresholds for specific stores and currencies.|`data:import:sales-order-threshold` | [sales_order_threshold.csv](/docs/pbc/all/cart-and-checkout/{{site.version}}/import-and-export-data/file-details-sales-order-threshold.csv.html) |
  • [currency.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/commerce-setup/file-details-currency.csv.html)
  • [glossary.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/commerce-setup/file-details-glossary.csv.html)
  • `stores.php` configuration file of demo shop PHP project
| -| Warehouse | Imports information about warehouses (for example, name of the warehouse, and if it is available or not).|`data:import:stock` | [warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/file-details-warehouse.csv.html) | None| -| Warehouse Store | Imports information about the Warehouse / Store relation configuration indicating which warehouse serves which store(s).|` data:import:stock-store`| [warehouse_store.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/file-details-warehouse-store.csv.html) |
  • [warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/file-details-warehouse.csv.html)
  • `stores.php` configuration file of demo shop PHP project
| +| Warehouse | Imports information about warehouses (for example, name of the warehouse, and if it is available or not).|`data:import:stock` | [warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-data/file-details-warehouse.csv.html) | None| +| Warehouse Store | Imports information about the Warehouse / Store relation configuration indicating which warehouse serves which store(s).|` data:import:stock-store`| [warehouse_store.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-data/file-details-warehouse-store.csv.html) |
  • [warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-data/file-details-warehouse.csv.html)
  • `stores.php` configuration file of demo shop PHP project
| | Payment Method | Imports information about *payment methods* as well as *payment providers*.|`data:import:payment-method` | [payment_method.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/commerce-setup/file-details-payment-method.csv.html) | None| | Payment Method Store |Imports information about payment methods per store. The CSV file links the *payment method* with each *store*.|`data:import:payment-method-store`| [payment_method_store.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/commerce-setup/file-details-payment-method-store.csv.html) |
  • [payment_method.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/commerce-setup/file-details-payment-method.csv.html)
  • `stores.php` configuration file of demo shop PHP project
| -| Warehouse address |Imports warehouse address information to be used as shipping origin address.|`data:import:stock-address`| [warehouse_address.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/file-details-warehouse-address.csv.html) |[warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/file-details-warehouse-store.csv.html)| +| Warehouse address |Imports warehouse address information to be used as shipping origin address.|`data:import:stock-address`| [warehouse_address.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-data/file-details-warehouse-address.csv.html) |[warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-data/file-details-warehouse-store.csv.html)| | Order |Updates the status of the order item.|`order-oms:status-import order-status`| [order-status.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/commerce-setup/file-details-order-status.csv.html) | | diff --git a/docs/scos/dev/data-import/202212.0/data-import-categories/commerce-setup/commerce-setup.md b/docs/scos/dev/data-import/202212.0/data-import-categories/commerce-setup/commerce-setup.md index 209b737cd6a..e97fe3880a9 100644 --- a/docs/scos/dev/data-import/202212.0/data-import-categories/commerce-setup/commerce-setup.md +++ b/docs/scos/dev/data-import/202212.0/data-import-categories/commerce-setup/commerce-setup.md @@ -21,14 +21,14 @@ The table below provides details on Commerce Setup data importers, their purpose | Currency | Imports information about currencies used in the store(s). The `currency.csv` file provides an easy way to load information about currencies used in Spryker Demo Shop. It allows to load information like: ISO code, currency symbol, and the name of the currency.|`data:import:currency` | [currency.csv](/docs/pbc/all/price-management/{{page.version}}/base-shop/import-and-export-data/file-details-currency.csv.html) | None| | Customer | Imports information about customers.|`data:import:customer` | [customer.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/commerce-setup/file-details-customer.csv.html) | None| | Glossary | Imports information relative to the several locales.|`data:import:glossary` | [glossary.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/commerce-setup/file-details-glossary.csv.html) | None| -| Tax |Imports information about taxes.|`data:import:tax` | [tax.csv](/docs/pbc/all/tax-management/{{page.version}}/base-shop/import-and-export-data/import-file-details-tax-sets.csv.html) | None| +| Tax |Imports information about taxes.|`data:import:tax` | [tax.csv](/docs/pbc/all/tax-management/{{page.version}}/base-shop/import-and-export-data/import-tax-sets.html) | None| | Shipment |Imports information about shipment methods.|`data:import:shipment` | [shipment.csv](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/import-and-export-data/file-details-shipment.csv.html) | None| | Shipment Price |Imports information about the price of each shipment method, applied in each store.|`data:import:shipment-price` | [shipment_price.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/commerce-setup/file-details-shipment-price.csv.html) |
  • [shipment.cs](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/import-and-export-data/file-details-shipment.csv.html)v
  • [currency.csv](/docs/pbc/all/price-management/{{page.version}}/base-shop/import-and-export-data/file-details-currency.csv.html)
  • `stores.php` configuration file of demo shop PHP project
| | Shipment Method Store | Links a *shipment method* to a specific *store*.|`data:import:shipment-method-store` | [shipment_method_store.csv](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/import-and-export-data/file-details-shipment-method-store.csv.html) |
  • [shipment.csv](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/import-and-export-data/file-details-shipment.csv.html)
  • `stores.php` configuration file of demo shop PHP project
| | Sales Order Threshold | Imports information about sales order thresholds. The CSV file content defines certain thresholds for specific stores and currencies.|`data:import:sales-order-threshold` | [sales_order_threshold.csv](/docs/pbc/all/cart-and-checkout/{{page.version}}/import-and-export-data/file-details-sales-order-threshold.csv.html) |
  • [currency.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/commerce-setup/file-details-currency.csv.html)
  • [glossary.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/commerce-setup/file-details-glossary.csv.html)
  • `stores.php` configuration file of demo shop PHP project
| -| Warehouse | Imports information about warehouses (for example, name of the warehouse, and if it is available or not).|`data:import:stock` | [warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/file-details-warehouse.csv.html) | None| -| Warehouse Store | Imports information about the Warehouse / Store relation configuration indicating which warehouse serves which store(s).|` data:import:stock-store`| [warehouse_store.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/file-details-warehouse-store.csv.html) |
  • [warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/file-details-warehouse.csv.html)
  • `stores.php` configuration file of demo shop PHP project
| -| Payment Method | Imports information about *payment methods* as well as *payment providers*.|`data:import:payment-method` | [payment_method.csv](/docs/pbc/all/payment-service-provider/{{page.version}}/spryker-pay/base-shop/import-and-export-data/import-file-details-payment-method.csv.html) | None| -| Payment Method Store |Imports information about payment methods per store. The CSV file links the *payment method* with each *store*.|`data:import:payment-method-store`| [payment_method_store.csv](/docs/pbc/all/payment-service-provider/{{page.version}}/spryker-pay/base-shop/import-and-export-data/import-file-details-payment-method-store.csv.html) |
  • [payment_method.csv](/docs/pbc/all/payment-service-provider/{{page.version}}/spryker-pay/base-shop/import-and-export-data/import-file-details-payment-method.csv.html)
  • `stores.php` configuration file of demo shop PHP project
| -| Warehouse address |Imports warehouse address information to be used as shipping origin address.|`data:import:stock-address`| [warehouse_address.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/file-details-warehouse-address.csv.html) |[warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/file-details-warehouse-store.csv.html)| +| Warehouse | Imports information about warehouses (for example, name of the warehouse, and if it is available or not).|`data:import:stock` | [warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-data/file-details-warehouse.csv.html) | None| +| Warehouse Store | Imports information about the Warehouse / Store relation configuration indicating which warehouse serves which store(s).|` data:import:stock-store`| [warehouse_store.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-data/file-details-warehouse-store.csv.html) |
  • [warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-data/file-details-warehouse.csv.html)
  • `stores.php` configuration file of demo shop PHP project
| +| Payment Method | Imports information about *payment methods* as well as *payment providers*.|`data:import:payment-method` | [payment_method.csv](/docs/pbc/all/payment-service-provider/{{page.version}}/import-and-export-data/file-details-payment-method.csv.html) | None| +| Payment Method Store |Imports information about payment methods per store. The CSV file links the *payment method* with each *store*.|`data:import:payment-method-store`| [payment_method_store.csv](/docs/pbc/all/payment-service-provider/{{page.version}}/import-and-export-data/file-details-payment-method-store.csv.html) |
  • [payment_method.csv](/docs/pbc/all/payment-service-provider/{{page.version}}/import-and-export-data/file-details-payment-method.csv.html)
  • `stores.php` configuration file of demo shop PHP project
| +| Warehouse address |Imports warehouse address information to be used as shipping origin address.|`data:import:stock-address`| [warehouse_address.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-data/file-details-warehouse-address.csv.html) |[warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-data/file-details-warehouse-store.csv.html)| | Order |Updates the status of the order item.|`order-oms:status-import order-status`| [order-status.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/commerce-setup/file-details-order-status.csv.html) | | diff --git a/docs/scos/dev/data-import/202212.0/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.md b/docs/scos/dev/data-import/202212.0/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.md index 8fb90954afb..cd5fb5369c4 100644 --- a/docs/scos/dev/data-import/202212.0/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.md +++ b/docs/scos/dev/data-import/202212.0/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.md @@ -29,7 +29,7 @@ The following list illustrates the order followed to run the data importers and * [currency](/docs/pbc/all/price-management/{{page.version}}/base-shop/import-and-export-data/file-details-currency.csv.html) * [customer](/docs/pbc/all/customer-relationship-management/{{page.version}}/file-details-customer.csv.html) * [glossary](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/commerce-setup/file-details-glossary.csv.html) - * [tax](/docs/pbc/all/tax-management/{{page.version}}/base-shop/import-and-export-data/import-file-details-tax-sets.csv.html) + * [tax](/docs/pbc/all/tax-management/{{page.version}}/base-shop/import-and-export-data/import-tax-sets.html) * [shipment](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/import-and-export-data/file-details-shipment.csv.html) * [shipment-price](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/import-and-export-data/file-details-shipment-price.csv.html) * [shipment-method-store](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/import-and-export-data/file-details-shipment-method-store.csv.html) @@ -49,7 +49,7 @@ The following list illustrates the order followed to run the data importers and * [product-image](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/file-details-product-image.csv.html) * [product-price](/docs/pbc/all/price-management/{{page.version}}/base-shop/import-and-export-data/file-details-product-price.csv.html) * [product-price-schedule](/docs/pbc/all/price-management/{{page.version}}/base-shop/import-and-export-data/file-details-product-price-schedule.csv.html) - * [product-stock](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/file-details-product-stock.csv.html) + * [product-stock](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-data/file-details-product-stock.csv.html) * Special Products: * [product-option](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/product-options/file-details-product-option.csv.html) * [product-option-price](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/product-options/file-details-product-option-price.csv.html) @@ -92,8 +92,8 @@ The following list illustrates the order followed to run the data importers and * [product-review](/docs/pbc/all/ratings-reviews/{{page.version}}/import-and-export-data/file-details-product-review.csv.html) * [product-label](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/file-details-product-label.csv.html) * [product-set](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/file-details-product-set.csv.html) - * [product-search-attribute-map](/docs/pbc/all/search/{{page.version}}/base-shop/import-and-export-data/file-details-product-search-attribute-map.csv.html) - * [product-search-attribute](/docs/pbc/all/search/{{page.version}}/base-shop/import-and-export-data/file-details-product-search-attribute.csv.html) + * [product-search-attribute-map](/docs/pbc/all/search/{{page.version}}/base-shop/import-data/file-details-product-search-attribute-map.csv.html) + * [product-search-attribute](/docs/pbc/all/search/{{page.version}}/base-shop/import-data/file-details-product-search-attribute.csv.html) * [discount-amount](/docs/pbc/all/discount-management/{{page.version}}/base-shop/import-and-export-data/file-details-discount-amount.csv.html) * [product-discontinued](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/file-details-product-discontinued.csv.html) * [product-alternative](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/file-details-product-alternative.csv.html) diff --git a/docs/scos/dev/data-import/202212.0/importing-product-data-with-a-single-file.md b/docs/scos/dev/data-import/202212.0/importing-product-data-with-a-single-file.md index 74bb1febc5e..9627185786e 100644 --- a/docs/scos/dev/data-import/202212.0/importing-product-data-with-a-single-file.md +++ b/docs/scos/dev/data-import/202212.0/importing-product-data-with-a-single-file.md @@ -78,7 +78,7 @@ If you need to import other product data as well, for example, prices, images, e |
  • product_group.group_key
  • product_group.position
| [File details: product_group.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/merchandising-setup/product-merchandising/file-details-product-group.csv.html) | |
  • product_image.image_set_name
  • product_image.external_url_large
  • product_image.external_url_small
  • product_image.locale
  • product_image.sort_order
  • product_image.product_image_key
  • product_image.product_image_set_key
| [File details: product_image.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/catalog-setup/products/file-details-product-image.csv.html) | |
  • product_price.price_type
  • product_price.store
  • product_price.currency
  • product_price.value_net
  • product_price.value_gross
  • product_price.price_data.volume_prices
| [File details: product_price.csv](/docs/pbc/all/price-management/{{page.version}}/base-shop/import-and-export-data/file-details-product-price.csv.html) | -|
  • product_stock.name
  • product_stock.quantity
  • product_stock.is_never_out_of_stock
  • product_stock.is_bundle
| [File details: product_stock.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/file-details-product-stock.csv.html) | +|
  • product_stock.name
  • product_stock.quantity
  • product_stock.is_never_out_of_stock
  • product_stock.is_bundle
| [File details: product_stock.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-data/file-details-product-stock.csv.html) | diff --git a/docs/scos/dev/drafts-dev/roadmap.md b/docs/scos/dev/drafts-dev/roadmap.md index 633e7b0f8ff..d6b16c8f12e 100644 --- a/docs/scos/dev/drafts-dev/roadmap.md +++ b/docs/scos/dev/drafts-dev/roadmap.md @@ -27,6 +27,8 @@ redirect_from: **Updated: April 2021** We at Spryker are happy to share our plans with you. The plans below are guidelines that give us direction to continuously evolve and improve our product. However, we are also flexible, and we constantly listen and adapt. Therefore, our plans could change. So although we are good at fulfilling our commitments, we reserve the right to change our priorities, remove or add new features from time to time. If you are planning anything strategic based on this list, you might want to talk to us first, either by contacting your Spryker representative or one of our [Solution Partners](https://spryker.com/solution-partners/). +If you see a feature that you like, [create an idea in our Aha](https://spryker.ideas.aha.io/ideas/) and let us know why the feature is important to you. + {% info_block warningBox %} The roadmap contains features and not architectural items, enhancements, technology updates, or any other strategic releases we are working on. We kindly ask you not to base any business decisions on these lists without consulting with us first. diff --git a/docs/scos/dev/feature-integration-guides/202304.0/glue-api/dynamic-data-api/dynamic-data-api-integration.md b/docs/scos/dev/feature-integration-guides/202304.0/glue-api/dynamic-data-api/dynamic-data-api-integration.md deleted file mode 100644 index c4d1d629ee3..00000000000 --- a/docs/scos/dev/feature-integration-guides/202304.0/glue-api/dynamic-data-api/dynamic-data-api-integration.md +++ /dev/null @@ -1,362 +0,0 @@ ---- -title: Dynamic Data API integration -description: Integrate the Dynamic Data API into a Spryker project. -last_updated: June 22, 2023 -template: feature-integration-guide-template ---- - -This document describes how to integrate the Dynamic Data API into a Spryker project. - ---- - -The Dynamic Data API is a powerful tool that allows seamless interaction with your database. - -You can easily access your data by sending requests to the API endpoint. - -It enables you to retrieve, create, update, and manage data in a flexible and efficient manner. - -## Install feature core - -Follow the steps below to install the Dynamic Data API core. - -### Prerequisites - -To start feature integration, install the necessary features: - -| NAME | VERSION | INTEGRATION GUIDE | -| --- | --- | --- | -| Glue Backend Api Application | {{page.version}} | [Glue API - Glue Storefront and Backend API applications integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-glue-storefront-and-backend-api-applications-integration.html) | -| Glue Authentication | {{page.version}} | [Glue API - Authentication integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-authentication-integration.html) | - -### Install the required modules using Composer - -Install the required modules: - -```bash -composer require spryker/dynamic-entity-backend-api:"^0.1.0" --update-with-dependencies -``` - -{% info_block warningBox "Verification" %} - -Make sure that the following modules have been installed: - -| MODULE | EXPECTED DIRECTORY | -| --- | --- | -| DynamicEntity | vendor/spryker/dynamic-entity | -| DynamicEntityBackendApi | vendor/spryker/dynamic-entity-backend-api | - -{% endinfo_block %} - -### Set up the configuration - -1. Move the following commands into `setup-glue` section after `demodata` step: - -**config/install/docker.yml** - -```yaml -setup-glue: - controller-cache-warmup: - command: 'vendor/bin/glue glue-api:controller:cache:warm-up' - - api-generate-documentation: - command: 'vendor/bin/glue api:generate:documentation' -``` - -2. By default, requests are sent to `/dynamic-entity/{entity-alias}`. - Adjust `DynamicEntityBackendApiConfig` in order to replace `dynamic-entity` part with another one: - -**src/Pyz/Glue/DynamicEntityBackendApi/DynamicEntityBackendApiConfig.php** - -```php - -src/Pyz/Glue/Console/ConsoleDependencyProvider.php - -```php - - */ - public function getApplicationPlugins(Container $container): array - { - $applicationPlugins = parent::getApplicationPlugins($container); - - $applicationPlugins[] = new PropelApplicationPlugin(); - - return $applicationPlugins; - } -} -``` -
- -
-src/Pyz/Glue/DocumentationGeneratorApi/DocumentationGeneratorApiDependencyProvider.php - -```php -addExpander(new DynamicEntityApiSchemaContextExpanderPlugin(), [static::GLUE_BACKEND_API_APPLICATION_NAME]); - } -} -``` -
- -
-src/Pyz/Glue/DocumentationGeneratorOpenApi/DocumentationGeneratorOpenApiDependencyProvider.php - -```php - - */ - protected function getOpenApiSchemaFormatterPlugins(): array - { - return [ - new DynamicEntityOpenApiSchemaFormatterPlugin(), - ]; - } -} -``` -
- -
-src/Pyz/Glue/GlueBackendApiApplication/GlueBackendApiApplicationDependencyProvider.php - -```php - - */ - protected function getRouteProviderPlugins(): array - { - return [ - new DynamicEntityRouteProviderPlugin(), - ]; - } -} -``` -
- -{% info_block warningBox "Verification" %} - -If everything is set up correctly, you can operate with the data. Follow this link to discover how to perform it:[How to send request in Dynamic Data API](/docs/scos/dev/glue-api-guides/{{page.version}}/dynamic-data-api/how-to-guides/how-to-send-request-in-dynamic-data-api.html) - -{% endinfo_block %} diff --git a/docs/scos/dev/feature-integration-guides/202304.0/install-the-picker-user-login-feature.md b/docs/scos/dev/feature-integration-guides/202304.0/install-the-picker-user-login-feature.md new file mode 100644 index 00000000000..92867f5bea1 --- /dev/null +++ b/docs/scos/dev/feature-integration-guides/202304.0/install-the-picker-user-login-feature.md @@ -0,0 +1,8 @@ +--- +title: Install the Picker user login feature +description: Learn how to integrate the Picker user login feature into your project +last_updated: Mar 10, 2023 +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/{{page.version}}/install-the-picker-user-login-feature.md %} diff --git a/docs/pbc/all/offer-management/202400.0/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-feature.md b/docs/scos/dev/feature-integration-guides/202304.0/install-the-product-offer-service-points-feature.md similarity index 51% rename from docs/pbc/all/offer-management/202400.0/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-feature.md rename to docs/scos/dev/feature-integration-guides/202304.0/install-the-product-offer-service-points-feature.md index 75949e36e26..4c3625eef4a 100644 --- a/docs/pbc/all/offer-management/202400.0/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-feature.md +++ b/docs/scos/dev/feature-integration-guides/202304.0/install-the-product-offer-service-points-feature.md @@ -5,4 +5,4 @@ last_updated: July 04, 2023 template: feature-integration-guide-template --- -{% include pbc/all/install-features/202400.0/install-the-product-offer-service-points-feature.md %} +{% include pbc/all/install-features/{{page.version}}/install-the-product-offer-service-points-feature.md %} diff --git a/docs/scos/dev/feature-integration-guides/202304.0/install-the-product-offer-shipment-feature.md b/docs/scos/dev/feature-integration-guides/202304.0/install-the-product-offer-shipment-feature.md new file mode 100644 index 00000000000..90f822c3b8f --- /dev/null +++ b/docs/scos/dev/feature-integration-guides/202304.0/install-the-product-offer-shipment-feature.md @@ -0,0 +1,8 @@ +--- +title: Install the Product offer shipment feature +description: Learn how to integrate the Product offer shipment feature into your project +last_updated: June 20, 2023 +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/{{page.version}}/install-the-product-offer-shipment-feature.md %} diff --git a/docs/scos/dev/feature-integration-guides/202304.0/install-the-push-notification-feature.md b/docs/scos/dev/feature-integration-guides/202304.0/install-the-push-notification-feature.md new file mode 100644 index 00000000000..77202c62872 --- /dev/null +++ b/docs/scos/dev/feature-integration-guides/202304.0/install-the-push-notification-feature.md @@ -0,0 +1,8 @@ +--- +title: Install the Push notification feature +description: Learn how to integrate the Push notification feature into your project +last_updated: Jan 24, 2023 +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/{{page.version}}/install-the-push-notification-feature.md %} \ No newline at end of file diff --git a/docs/scos/dev/feature-integration-guides/202304.0/install-the-service-points-feature.md b/docs/scos/dev/feature-integration-guides/202304.0/install-the-service-points-feature.md new file mode 100644 index 00000000000..7fe136fc530 --- /dev/null +++ b/docs/scos/dev/feature-integration-guides/202304.0/install-the-service-points-feature.md @@ -0,0 +1,8 @@ +--- +title: Install the Service Points feature +description: Learn how to integrate the Service Points feature into your project +last_updated: July 05, 2023 +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/{{page.version}}/install-the-service-points-feature.md %} diff --git a/docs/scos/dev/feature-integration-guides/202304.0/install-the-shipment-service-points-feature.md b/docs/scos/dev/feature-integration-guides/202304.0/install-the-shipment-service-points-feature.md new file mode 100644 index 00000000000..1e587d35a75 --- /dev/null +++ b/docs/scos/dev/feature-integration-guides/202304.0/install-the-shipment-service-points-feature.md @@ -0,0 +1,8 @@ +--- +title: Install the Shipment + Service Points feature +description: Learn how to integrate the Shipment + Service Points feature into your project +last_updated: May 30, 2023 +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/{{page.version}}/install-the-shipment-service-points-feature.md %} diff --git a/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-feature.md b/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-feature.md new file mode 100644 index 00000000000..10b16e5fe7f --- /dev/null +++ b/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-feature.md @@ -0,0 +1,8 @@ +--- +title: Install the Warehouse picking feature +description: Learn how to integrate the Warehouse picking feature into your project +last_updated: Feb 10, 2023 +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/{{page.version}}/install-the-warehouse-picking-feature.md %} diff --git a/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-inventory-management-feature.md b/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-inventory-management-feature.md new file mode 100644 index 00000000000..dd88e1cb4c1 --- /dev/null +++ b/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-inventory-management-feature.md @@ -0,0 +1,8 @@ +--- +title: Install the Warehouse picking + Inventory Management feature +description: Learn how to integrate the Warehouse picking + Inventory Management feature into your project +last_updated: Apr 10, 2023 +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/{{page.version}}/install-the-warehouse-picking-inventory-management-feature.md %} diff --git a/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-order-management-feature.md b/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-order-management-feature.md new file mode 100644 index 00000000000..9d984c4558b --- /dev/null +++ b/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-order-management-feature.md @@ -0,0 +1,8 @@ +--- +title: Install the Warehouse picking + Order Management feature +description: Learn how to integrate the Warehouse picking + Order Management feature into your project +last_updated: Mar 30, 2023 +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/{{page.version}}/install-the-warehouse-picking-order-management-feature.md %} diff --git a/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-product-feature.md b/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-product-feature.md new file mode 100644 index 00000000000..776f6551392 --- /dev/null +++ b/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-product-feature.md @@ -0,0 +1,8 @@ +--- +title: Install the Warehouse picking + Product feature +description: Learn how to integrate the Warehouse picking + Product feature into your project +last_updated: Mar 30, 2023 +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/{{page.version}}/install-the-warehouse-picking-product-feature.md %} diff --git a/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-shipment-feature.md b/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-shipment-feature.md new file mode 100644 index 00000000000..f552144f3df --- /dev/null +++ b/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-shipment-feature.md @@ -0,0 +1,8 @@ +--- +title: Install the Warehouse picking + Shipment feature +description: Learn how to integrate the Warehouse picking + Shipment feature into your project +last_updated: Apr 10, 2023 +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/{{page.version}}/install-the-warehouse-picking-shipment-feature.md %} diff --git a/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-spryker-core-back-office-feature.md b/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-spryker-core-back-office-feature.md new file mode 100644 index 00000000000..bb329291154 --- /dev/null +++ b/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-spryker-core-back-office-feature.md @@ -0,0 +1,8 @@ +--- +title: Install the Warehouse picking + Spryker Core Back Office feature +description: Learn how to integrate the Warehouse picking + Spryker Core Back Office feature into your project +last_updated: Apr 10, 2023 +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/{{page.version}}/install-the-warehouse-picking-spryker-core-back-office-feature.md %} diff --git a/docs/pbc/all/warehouse-management-system/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-user-management-feature.md b/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-user-management-feature.md similarity index 54% rename from docs/pbc/all/warehouse-management-system/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-user-management-feature.md rename to docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-user-management-feature.md index 7b2aacae44e..beff1f5c034 100644 --- a/docs/pbc/all/warehouse-management-system/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-user-management-feature.md +++ b/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-user-management-feature.md @@ -1,10 +1,8 @@ --- title: Install the Warehouse User Management feature -description: Install the Warehouse User Management feature in your project +description: Learn how to install the Warehouse User Management feature in your project +last_updated: Jan 25, 2023 template: feature-integration-guide-template -last_updated: June 1, 2023 -redirect_from: - - /docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-user-management-feature.html --- -{% include pbc/all/install-features/{{page.version}}/install-the-warehouse-user-management-feature.md %} +{% include pbc/all/install-features/{{page.version}}/install-the-warehouse-user-management-feature.md %} \ No newline at end of file diff --git a/docs/scos/dev/feature-integration-guides/202304.0/spryker-core-feature-integration.md b/docs/scos/dev/feature-integration-guides/202304.0/spryker-core-feature-integration.md index a947fb10ad1..ee7b4a7093f 100644 --- a/docs/scos/dev/feature-integration-guides/202304.0/spryker-core-feature-integration.md +++ b/docs/scos/dev/feature-integration-guides/202304.0/spryker-core-feature-integration.md @@ -1,7 +1,7 @@ --- title: Spryker Core feature integration description: The procedure to integrate Spryker Core feature into your project. -last_updated: Jul 18, 2023 +last_updated: Feb 8, 2023 template: feature-integration-guide-template originalLink: https://documentation.spryker.com/2021080/docs/spryker-core-feature-integration originalArticleId: f99d3cf9-e933-4a3b-888e-72cf8f4ea31b diff --git a/docs/scos/dev/feature-walkthroughs/202204.0/payments-feature-walkthrough.md b/docs/scos/dev/feature-walkthroughs/202204.0/payments-feature-walkthrough.md index bf645f2ddde..02380f3b40d 100644 --- a/docs/scos/dev/feature-walkthroughs/202204.0/payments-feature-walkthrough.md +++ b/docs/scos/dev/feature-walkthroughs/202204.0/payments-feature-walkthrough.md @@ -30,4 +30,4 @@ The following schema illustrates relations between the _Payment_, _PaymentGui_, |---|---|---|---|---|---| | [Payments feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/payments-feature-integration.html) | [Payment migration guide](/docs/scos/dev/module-migration-guides/migration-guide-payment.html) | [Update payment data](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/manage-using-glue-api/check-out/update-payment-data.html) | [File details: payment_method.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/commerce-setup/file-details-payment-method-store.csv.html) | [HowTo: Hydrate payment methods for an order](/docs/scos/dev/tutorials-and-howtos/howtos/howto-hydrate-payment-methods-for-an-order.html) | [Payment partners](/docs/scos/user/technology-partners/{{page.version}}/payment-partners/adyen.html) | | | | | [File details: payment_method_store.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/commerce-setup/file-details-payment-method-store.csv.html) | [Implementing Direct Debit Payment](/docs/scos/dev/back-end-development/data-manipulation/payment-methods/direct-debit-example-implementation/implementing-direct-debit-payment.html) | | -| | | | | [Interact with third party payment providers using Glue API](/docs/pbc/all/payment-service-provider/{{site.version}}/spryker-pay/base-shop/interact-with-third-party-payment-providers-using-glue-api.html) | | +| | | | | [Interact with third party payment providers using Glue API](/docs/pbc/all/payment-service-provider/{{site.version}}/interact-with-third-party-payment-providers-using-glue-api.html) | | diff --git a/docs/scos/dev/front-end-development/202212.0/migration-guide-upgrade-nodejs-to-v18-and-npm-to-v9.md b/docs/scos/dev/front-end-development/202212.0/migration-guide-upgrade-nodejs-to-v18-and-npm-to-v9.md index d565ba47f6a..02d8ea88fe7 100644 --- a/docs/scos/dev/front-end-development/202212.0/migration-guide-upgrade-nodejs-to-v18-and-npm-to-v9.md +++ b/docs/scos/dev/front-end-development/202212.0/migration-guide-upgrade-nodejs-to-v18-and-npm-to-v9.md @@ -163,7 +163,7 @@ If the project uses CI, adjust `.github/workflows/ci.yml`: uses: actions/cache@v3 with: path: ~/.npm - key: ${% raw %}{{{% endraw %} runner.os {% raw %}}}{% endraw %}-node-${% raw %}{{{% endraw %} hashFiles('**/package-lock.json') {% raw %}}}{% endraw %} + key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} restore-keys: | - ${% raw %}{{{% endraw %} runner.os {% raw %}}}{% endraw %}-node- + ${{ runner.os }}-node- ``` diff --git a/docs/scos/dev/glue-api-guides/202204.0/glue-api-tutorials/interact-with-third-party-payment-providers-using-glue-api.md b/docs/scos/dev/glue-api-guides/202204.0/glue-api-tutorials/interact-with-third-party-payment-providers-using-glue-api.md index 996d40d9297..bb279aa2ee9 100644 --- a/docs/scos/dev/glue-api-guides/202204.0/glue-api-tutorials/interact-with-third-party-payment-providers-using-glue-api.md +++ b/docs/scos/dev/glue-api-guides/202204.0/glue-api-tutorials/interact-with-third-party-payment-providers-using-glue-api.md @@ -19,7 +19,7 @@ redirect_from: - /v3/docs/t-interacting-with-third-party-payment-providers-via-glue-api - /v3/docs/en/t-interacting-with-third-party-payment-providers-via-glue-api - /docs/scos/dev/tutorials/201907.0/advanced/glue-api/tutorial-interacting-with-third-party-payment-providers-via-glue-api.html - - /docs/scos/dev/glue-api-guides/202005.0/checking-out/docs/docs/pbc/all/payment-service-provider/{{site.version}}/spryker-pay/base-shop/interact-with-third-party-payment-providers-using-glue-api.html + - /docs/scos/dev/glue-api-guides/202005.0/checking-out/docs/docs/pbc/all/payment-service-provider/{{site.version}}/interact-with-third-party-payment-providers-using-glue-api.html - /docs/scos/dev/tutorials-and-howtos/advanced-tutorials/glue-api/tutorial-interacting-with-third-party-payment-providers-via-glue-api.html related: - title: Technology Partner Integration diff --git a/docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-api.md b/docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-api.md deleted file mode 100644 index 1fc0c5da4a6..00000000000 --- a/docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-api.md +++ /dev/null @@ -1,234 +0,0 @@ ---- -title: Decoupled Glue API -description: Learn about the process of handling API requests through GlueStorefront and GlueBackoffice layers. -last_updated: Jul 11, 2023 -template: glue-api-storefront-guide-template ---- - -The Spryker Decoupled Glue API is a set of a few API applications like *Glue Storefront API (SAPI)* and *Glue Backend API (BAPI)* of the Spryker Commerce OS. Those applications are built to be used as a contract for accessing Storefront or Backoffice functionality through API. Those applications know how to read and interpret API resources and leverage feature modules that expose existing Spryker functionality. - -## Existing Glue Applications - -Out of the box, Spryker Commerce OS provides three API applications: -* Old Glue API application that can be used as a fallback. -* New Glue Storefront API (SAPI) that is a replacement for the old Glue and can be used for the same purpose. -* Glue Backend API (BAPI) that can be used to provide API access for the Backoffice functionality directly without any additional RPC calls. - -## Difference between Decoupled Glue Api and the old Glue API - -There are a few differences between the current Glue infrastructure (Decoupled Glue API) and the old [Glue API](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/glue-rest-api.html). - -### Possibility to create new API applications - -With the current infrastructure, projects can easily [create](/docs/scos/dev/glue-api-guides/{{page.version}}/create-glue-api-applications.html) their own API applications that would be completely separated from others. This means that resources can be added only to the new application, and users can't access them with existing ones. - -### Decoupling from conventions - -Old Glue API was tightly coupled with a JSON:API convention, and all resources have to follow it. With the current infrastructure, resources can use any implemented conventions, create new ones, or even not use any. In this case, the "no convention" approach is used, and a request and response are formatted as a plain JSON. For more details, see [Create and change Glue API conventions](/docs/scos/dev/glue-api-guides/{{page.version}}/create-and-change-glue-api-conventions.html). - -### New type of application: Glue Backend API application - -With the current setup out of the box, we have an additional Glue Backend API (BAPI) application that is meant to be an API application for our Back Office. This means that with this new application, infrastructure has direct access to Zed facades from BAPI resources. Also, out of the box, we have a separate `/token` resource specifically for BAPI that uses Back Office users' credentials to issue a token for a BAPI resource. - -For more details about the difference between SAPI and BAPI, refer to [Backend and storefront API module differences](/docs/scos/dev/glue-api-guides/{{page.version}}/backend-and-storefront-api-module-differences.html). - -### Authentication servers -Current infrastructure lets you switch between different authentication servers. For example, this can be useful if you want to use Auth0 or any other server in addition to implemented servers. - -For more details and examples, see [Use authentication servers with Glue API](/docs/scos/dev/glue-api-guides/{{page.version}}/use-authentication-servers-with-glue-api.html). - - -## Glue Storefront API - -![Glue Storefront API](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-api/glue-storefront-api.jpeg) - -## Glue Backend API - -![Glue Backend API](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-api/glue-backend-api.jpeg) - -## Infrastructure - -Decoupled Glue API infrastructure is implemented in the same layer of Spryker Commerce OS and called Glue, as the old one. It is responsible for providing API endpoints, processing requests, and communicating with other layers of the OS to retrieve the necessary information. Separate applications are implemented as separate modules—for example, `GlueStorefrontApiApplication`, and `GlueBackendApiApplication`. Each application has its own bootstrapping and a separate virtual host on the Spryker web server (Nginx by default). - -Logically, the Glue layer can be divided into separate parts: - -* **`GlueApplication` module**: The `GlueApplication` module provides a framework for constructing API resources and selecting a proper application. It intercepts all HTTP requests at resource URLs (for example, `http://mysprykershop.com/resource/1`), selects a proper application based on a bootstrap file, does content negotiation and selects applicable convention, and executes request flow. Also, this module is used for the fallback to the old Glue API. -* **GlueStorefrontApiApplication module**: The `GlueStorefrontApiApplication` module is used for wiring everything related to the Glue Storefront API resources and route processing. All resources, routes, application plugins, and the rest of the required plugin stacks are wired into this module. -* **GlueBackendApiApplication module**: The `GlueBackendApiApplication` module is used for wiring everything related to the Glue Backend API resources and route processing. All resources, routes, application plugins, and the rest of the required plugin stacks are wired into this module. -* **Convention module**: Each convention module represents some specific convention and should include all required functionality to format API requests according to this convention. Out of the box, Spryker provides a `GlueJsonApiConvention` module that represents JSON:API convention. -* **Resource modules**: A `Resource` module implements a separate resource or a set of resources for a specific application. The `Resource` module *must* be dedicated to a specific application but can use different conventions. Such a module handles requests to a particular resource and provides them with responses. In the process of doing so, the module can communicate with the Storage, Search, or Spryker Commerce OS (Zed through RPC call) for the Glue Storefront API application, or it can communicate with a Zed directly through Facades for the Glue Backend API application. The modules do not handle request semantics or rules. Their only task is to provide the necessary data in a `GlueResponseTransfer` object. All formatting and processing are done by the convention or selected application module. -* **Relationship modules**: Such modules represent relationships between two different resources. Their task is to extend the response of one of the resources with data from related resources. Out of the box, these modules are only applicable for resources that are using JSON:API convention. - -To be able to process API requests correctly, the `Resource` modules need to implement resource plugins that facilitate the routing of requests to the module. Such plugins need to be registered in the application they are related to. Also, plugins must implement a convention resource interface if must implement one. - -## Request flow - -Glue executes a few steps in order to execute a request: - -### Application bootstrapping and running - -Upon receiving an API request, an API context transfer is created where we set up basic request data like host, path, and method. It can be used to select a required application from the provided applications list. After that, `ApiApplicationProxy` is used to bootstrap and run the selected application. If the selected application plugin is the instance of `RequestFlowAgnosticApiApplication`, the direct flow is used, and no additional Glue logic is executed. It's useful if we need to create a simple API application that just returns the result of execution as is. If the application plugin is the instance of `RequestFlowAwareApiApplication`, we execute the whole request flow. - -### Request flow preparation - -First, we hydrate `GlueRequestTransfer` with data from the `Request` object. This includes request body, query params, headers, and attributes. - -Then, `ContentNegotiator` tries to resolve what convention the application must use for this request and updates `GlueRequestTransfer` with the request format. The convention is optional, so if it isn't found, the application uses the requested and accepted format to prepare request and response data. - -With hydrated `GlueRequestTransfer` and selected or not convention, the application executes `RequestFlowExecutor`. - -### Executing request builders, request validators, and response formatting based on selected convention - -At this stage, a bunch of plugin stacks are executed to prepare the request and response. If the convention is selected, the application merges plugins from three different places: default plugins from `GlueApplicationDependencyProvider`, plugins from the selected convention, and application-specific plugins. If the convention isn't found, instead of convention plugins, default flow classes are executed before common and application-specific plugins. - -### Routing - -Routing tries to find required resources in two plugin stacks in the selected application dependency provider—for example, `\Pyz\Glue\GlueBackendApiApplication\GlueBackendApiApplicationDependencyProvider::getResourcePlugins()` and `\Pyz\Glue\GlueBackendApiApplication\GlueBackendApiApplicationDependencyProvider::getRouteProviderPlugins()`. If no route is found, `MissingResource` is selected and executed. - -For more details about creating a resource, see these documents: -* [Create storefront resources](/docs/scos/dev/glue-api-guides/{{page.version}}/routing/create-storefront-resources.html) -* [Create backend resources](/docs/scos/dev/glue-api-guides/{{page.version}}/routing/create-backend-resources.html) -* [Create routes](/docs/scos/dev/glue-api-guides/{{page.version}}/routing/create-routes.html) - -## Resource modules - -A `Resource` module is a module that implements a single resource or a set of resources. It is responsible for accepting a request in the form of `GlueRequestTransfer` and providing responses in the form of `GlueResponseTransfers`. For this purpose, the SAPI `Resource` module can communicate with the Storage or Search, for which purpose it implements a [Client](/docs/scos/dev/back-end-development/client/client.html). It can also communicate with the Spryker Commerce OS (Zed) through RPC calls. - -BAPI resources can use direct facade access through the dependency provider and access the database directly. `Resource` modules must implement all logic related to processing a request. It is not recommended to have any of the Business Logic, or a part of it, in the GlueApplication or specific application Module. If you need to extend any of the built-in Glue functionality, extending the relevant `Resource` module is always safer than infrastructure. - -### Module naming - -Resource modules have their own naming pattern to follow: -- Storefront resources must use the simple `Api` suffix and resource name in plural—for example, `ProductsApi`. -- Backend resources must use the `BackendApi` suffix and resource name in plural—for example, `ProductsBackendApi`. -### Module structure - -Recommended module structure: - -| RESOURCESRESTAPI | DESCRIPTION | -|----------------------------------------------------------------|------------------------------------------------------------------------------------------------------| -| `Glue/Resources(Backend)Api/Controller` | Folder for resource controllers. Controllers are used to handle API requests and responses. | -| `Glue/Resources(Backend)Api/Dependency` | Bridges to clients/facades from other modules. | -| `Glue/Resources(Backend)Api/Plugin` | Resource plugins. | -| `Glue/Resources(Backend)Api/Processor` | Folder where all resource processing logic, data mapping code and calls to other clients are located. | -| `Glue/Resources(Backend)Api/Resources(Backend)ApiConfig.php` | Contains resource-related configuration. | -| `Glue/Resources(Backend)Api/Resources(Backend)ApiDependencyProvider.php` | Provides external dependencies. | -| `Glue/Resources(Backend)Api/Resources(Backend)ApiFactory.php` | Factory that creates instances. | - -Also, a module must contain the transfer definition in `src/Pyz/Shared/Resources(Backend)Api/Transfer`: - -| RESOURCESRESTAPI | DESCRIPTION | -|----------------------------------------| --- | -| `resources_(backend_)api.transfer.xml` | Contains API transfer definitions. | - -The resulting folder structure on the example of the ServicePointsBackendApi Resource module looks as follows: - -![Module structure](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-api/glue-api-module-structure.png) - -## Glue request structure - -| FIELD | DESCRIPTION | -|----------------------|-------------------------------------------------------------------------------------------------------| -| pagination | `PaginationTransfer` object with request pagination data. | -| sortings | Collection of `SortTransfer` objects. | -| queryFields | Assoc array of query parameters with values. | -| resource | `GlueResourceTransfer` object with resource-related data. | -| path | Returns the path being requested relative to the executed script. | -| content | Request body content. | -| filters | Collection of `GlueFilterTransfer` objects. | -| attributes | Array of attributes from the `Request` object. | -| meta | Array of metadata from the `Request` object. | -| locale | Current locale. | -| host | Current host. | -| convention | Selected convention that was selected in `ContentNegotiator`. | -| application | Selected application. | -| method | Request "intended" method. | -| parametersString | Normalized query string from the `Request` object. | -| requestedFormat | `content-type` header value. | -| acceptedFormat | `accept` header value that was processed in `ContentNegotiator` | -| httpRequestAttributes | Request parameters from the `Request` object. | -| requestUser | Backend user requesting the resource (valid only for Glue Backend API). | -| requestCustomer | Storefront customer requesting the resource (valid only for Glue Storefront API). | - -## Glue response structure - -| FIELD | DESCRIPTION | -|---------------------|-------------------------------------------------------------------------------------------------------| -| httpStatus | Response status code. | -| meta | Return headers. | -| content | Response body. If the resource sets any data into it, the response body uses it instead of the `resources` field. | -| requestValidation | `GlueRequestValidationTransfer` object. | -| errors | Collection of `GlueErrorTransfer` objects. | -| filters | Collection of `GlueFilterTransfer` objects. | -| sortings | Collection of `SortTransfer` objects. | -| pagination | `PaginationTransfer` object. | -| resources | Collection of `GlueResourceTransfer` objects that are used to prepare the response body. | -| format | Response format—for example, `application/vnd.api+json` for JSON:API resources. | - -## HTTP status codes - -This section provides a list of common HTTP statuses returned by Glue endpoints. - -### GET - -| CODE | REASON | -| --- | --- | -| 200 | An entity or entities corresponding to the requested resource is/are sent in the response | -| 400| Bad request | -| 401| Unauthenticated | -| 403 | Unauthorized| -|404 | Resource not found | - -### POST - -| CODE | REASON | -| --- | --- | -| 201 | Resource created successfully | -| 400| Bad request | -| 401| Unauthenticated | -| 403 | Unauthorized| -|404 | Resource not found | - -### PATCH - -| CODE | REASON | -| --- | --- | -| 200 | Resource updated successfully | -| 400| Bad request | -| 401| Unauthenticated | -| 403 | Unauthorized| -| 404 | Resource not found | - -### DELETE - -| CODE | REASON | -| --- | --- | -| 204 | No content (deleted successfully) | -| 400| Bad request | -| 401| Unauthenticated | -| 403 | Unauthorized| -| 404 | Resource not found | - - -## Dates - -For date formatting, [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date/time format is used. For requests, any time zone is accepted; however, dates are stored and returned in UTC. - -Example: -* request: `1985-07-01T01:22:11+02:00` -* in storage and responses: `1985-06-30T23:22:11+00:00` - -## Request header - -| HEADER | SAMPLE VALUE | USED FOR | WHEN NOT PRESENT | -| --- | --- | --- | --- | -| Accept | application/vnd.api+json |Indicates the data format of the expected API response. | 406 Not acceptable | -| Content-Type | application/vnd.api+json; version=1.1 | Indicates the request content-type and resource version. | 415 Unsupported | -| Accept-Language | de;, en;q=0.5 | Indicates the desired language in which the content should be returned. | | - -## Response header - -| HEADER | SAMPLE VALUE | USED FOR | -| --- | --- | --- | -| Content-Type |application/vnd.api+json; version=1.1 |Response format and resource version. | -|Content-Language|de_DE|Indicates the language in which the content is returned.| \ No newline at end of file diff --git a/docs/scos/dev/glue-api-guides/202212.0/authentication-and-authorization.md b/docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-infrastructure/authentication-and-authorization.md similarity index 96% rename from docs/scos/dev/glue-api-guides/202212.0/authentication-and-authorization.md rename to docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-infrastructure/authentication-and-authorization.md index 4561526a2c9..cd4b27024c0 100644 --- a/docs/scos/dev/glue-api-guides/202212.0/authentication-and-authorization.md +++ b/docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-infrastructure/authentication-and-authorization.md @@ -10,7 +10,6 @@ related: link: docs/scos/dev/glue-api-guides/page.version/use-authentication-servers-with-glue-api.html redirect_from: - /docs/scos/dev/glue-api-guides/202204.0/glue-backend-api/how-to-guides/authentication-and-authorization.html - - /docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-infrastructure/authentication-and-authorization.html --- For authentication, Spryker implements the OAuth 2.0 mechanism. On the REST API level, it is represented by the Login API. diff --git a/docs/scos/dev/glue-api-guides/202212.0/backend-and-storefront-api-module-differences.md b/docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-infrastructure/backend-and-storefront-api-module-differences.md similarity index 97% rename from docs/scos/dev/glue-api-guides/202212.0/backend-and-storefront-api-module-differences.md rename to docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-infrastructure/backend-and-storefront-api-module-differences.md index c9351d10319..75f064ff385 100644 --- a/docs/scos/dev/glue-api-guides/202212.0/backend-and-storefront-api-module-differences.md +++ b/docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-infrastructure/backend-and-storefront-api-module-differences.md @@ -6,7 +6,6 @@ template: howto-guide-template redirect_from: - /docs/scos/dev/glue-api-guides/202204.0/glue-backend-api/how-to-guides/create-backend-vs-storefront-api-endpoint.html - /docs/scos/dev/glue-api-guides/202204.0/glue-backend-api/how-to-guides/backend-and-storefront-api-module-differences.html - - /docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-infrastructure/backend-and-storefront-api-module-differences.html --- This document describes differences between the backend and storefront code in API modules. diff --git a/docs/scos/dev/glue-api-guides/202212.0/create-glue-api-applications.md b/docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-infrastructure/create-glue-api-applications.md similarity index 99% rename from docs/scos/dev/glue-api-guides/202212.0/create-glue-api-applications.md rename to docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-infrastructure/create-glue-api-applications.md index 546208c6f94..c5f6342099a 100644 --- a/docs/scos/dev/glue-api-guides/202212.0/create-glue-api-applications.md +++ b/docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-infrastructure/create-glue-api-applications.md @@ -6,7 +6,6 @@ template: howto-guide-template redirect_from: - /docs/scos/dev/glue-api-guides/202204.0/glue-backend-api/how-to-guides/create-api-application.html - /docs/scos/dev/glue-api-guides/202204.0/glue-backend-api/how-to-guides/how-to-create-api-applications.html - - /docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-infrastructure/create-glue-api-applications.html --- New Glue projects can create API applications. This is what you need to do in order to create one. diff --git a/docs/scos/dev/glue-api-guides/202212.0/security-and-authentication.md b/docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-infrastructure/security-and-authentication.md similarity index 100% rename from docs/scos/dev/glue-api-guides/202212.0/security-and-authentication.md rename to docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-infrastructure/security-and-authentication.md diff --git a/docs/scos/dev/glue-api-guides/202212.0/glue-api-guides.md b/docs/scos/dev/glue-api-guides/202212.0/glue-api-guides.md index 955b4117958..8db37476b27 100644 --- a/docs/scos/dev/glue-api-guides/202212.0/glue-api-guides.md +++ b/docs/scos/dev/glue-api-guides/202212.0/glue-api-guides.md @@ -6,22 +6,13 @@ redirect_from: - /docs/scoc/dev/glue-api-guides/{{page.version}}/index.html --- -* [Decoupled Glue Api](/docs/scos/dev/glue-api-guides/{{page.version}}/decoupled-glue-api.html) -* [Create new Glue Application](/docs/scos/dev/glue-api-guides/{{page.version}}/create-glue-api-applications.html) -* [Differnece between Storefront and Backend application](/docs/scos/dev/glue-api-guides/{{page.version}}/backend-and-storefront-api-module-differences.html) -{% info_block warningBox %} - -This part of this document is related to the Old Glue infrastructure. For the new one, see [Decoupled Glue API](/docs/scos/dev/glue-api-guides/{{page.version}}/decoupled-glue-api.html) - -{% endinfo_block %} - -This section contains a collection of guides for working with the Old Spryker Glue API: -* [Glue REST API](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/glue-rest-api.html) -* [Rest API B2C reference](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/rest-api-b2c-reference.html) -* [Rest API B2B Reference](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/rest-api-b2b-reference.html) -* [Handling concurrent REST requests and caching with entity tags](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/handling-concurrent-rest-requests-and-caching-with-entity-tags.html) -* [Reference information – GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html) +This section contains a collection of guides for working with the Spryker Glue API: +* [Glue REST API](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-rest-api.html) +* [Rest API B2C reference](/docs/scos/dev/glue-api-guides/{{page.version}}/rest-api-b2c-reference.html) +* [Rest API B2B Reference](/docs/scos/dev/glue-api-guides/{{page.version}}/rest-api-b2b-reference.html) +* [Handling concurrent REST requests and caching with entity tags](/docs/scos/dev/glue-api-guides/{{page.version}}/handling-concurrent-rest-requests-and-caching-with-entity-tags.html) +* [Reference information – GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html) * [Glue Spryks](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-spryks.html) -* [Glue infrastructure](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/glue-infrastructure.html) +* [Glue infrastructure](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-infrastructure.html) * [Glue API tutorials](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-api-tutorials/glue-api-tutorials.html) diff --git a/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.md b/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.md index 9b71d0dd05a..81d92f55991 100644 --- a/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.md +++ b/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.md @@ -27,7 +27,7 @@ related: - title: Install B2C API React example link: docs/scos/dev/glue-api-guides/page.version/glue-api-tutorials/b2c-api-react-example/install-b2c-api-react-example.html - title: Glue REST API - link: docs/scos/dev/glue-api-guides/page.version/old-glue-infrastructure/glue-rest-api.html + link: docs/scos/dev/glue-api-guides/page.version/glue-rest-api.html --- As a part of documentation related to Spryker Glue REST API, we have also developed a B2C API React example. It is a [React](https://reactjs.org/) single-page application based on a [webpack](https://webpack.js.org/) dev server, Typescript, [Redux](https://redux.js.org/), and Material UI. diff --git a/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/document-glue-api-resources.md b/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/document-glue-api-resources.md index 359378de7bb..d0fdea0af4b 100644 --- a/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/document-glue-api-resources.md +++ b/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/document-glue-api-resources.md @@ -23,7 +23,7 @@ redirect_from: - /docs/scos/dev/tutorials-and-howtos/introduction-tutorials/glue-api/documenting-glue-api-resources.html related: - title: Glue infrastructure - link: docs/scos/dev/glue-api-guides/page.version/old-glue-infrastructure/glue-infrastructure.html + link: docs/scos/dev/glue-api-guides/page.version/glue-infrastructure.html - title: Glue API installation and configuration link: docs/scos/dev/feature-integration-guides/page.version/glue-api/glue-api-installation-and-configuration.html --- @@ -35,8 +35,8 @@ The resulting document is a full description of your REST API following the [Ope {% info_block warningBox %} REST API endpoints shipped by Spryker are covered by documentation by default. A snapshot of the latest state of Spryker REST API can be found in Spryker Documentation. For more information, see Rest API references: -* [REST API B2B Demo Shop reference](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/rest-api-b2b-reference.html) -* [REST API B2C Demo Shop reference](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/rest-api-b2c-reference.html) +* [REST API B2B Demo Shop reference](/docs/scos/dev/glue-api-guides/{{site.version}}/rest-api-b2b-reference.html) +* [REST API B2C Demo Shop reference](/docs/scos/dev/glue-api-guides/{{site.version}}/rest-api-b2c-reference.html) {% endinfo_block %} @@ -113,7 +113,7 @@ vendor/bin/console transfer:generate ### Describe resource relationships -Many REST API resources are related to each other. For example, the cart items resource is related to the products resources describing the products included in a cart, and so on. On the API side, such relationships are expressed with the help of [resource relationships](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/glue-infrastructure.html#resource-relationships). +Many REST API resources are related to each other. For example, the cart items resource is related to the products resources describing the products included in a cart, and so on. On the API side, such relationships are expressed with the help of [resource relationships](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-infrastructure.html#resource-relationships). The already existing resource relationships are added to the documentation automatically. However, some resources are only available through relationships, so they do not have their own resource route. In these cases, to facilitate the implementation of clients based on the Glue REST API of your project, you can describe such relationships in the generated documentation. To describe how two resources are related, add an additional annotation to the `ResourceRelationshipPlugin`, which links the resources together. For example, in the following code sample, `ResourceRelationshipPlugin` allows including items while requesting a cart is expanded with the specification of the relationship attributes type: @@ -130,7 +130,7 @@ The already existing resource relationships are added to the documentation autom {% info_block infoBox "Info" %} -For more information about `ResourceRelationshipPlugins`, see [Resource relationships](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/glue-infrastructure.html#resource-relationships). +For more information about `ResourceRelationshipPlugins`, see [Resource relationships](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-infrastructure.html#resource-relationships). {% endinfo_block %} diff --git a/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/extend-a-rest-api-resource.md b/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/extend-a-rest-api-resource.md index 97191e79682..51113c9a6e7 100644 --- a/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/extend-a-rest-api-resource.md +++ b/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/extend-a-rest-api-resource.md @@ -25,14 +25,14 @@ related: - title: Glue API installation and configuration link: docs/scos/dev/feature-integration-guides/page.version/glue-api/glue-api-installation-and-configuration.html - title: Glue infrastructure - link: docs/scos/dev/glue-api-guides/page.version/old-glue-infrastructure/glue-infrastructure.html + link: docs/scos/dev/glue-api-guides/page.version/glue-infrastructure.html --- Spryker Glue REST API comes with a set of predefined APIs out of the box. You can extend and customize them to your own project needs by extending the Glue API modules that provide the relevant functionality on your project level. {% info_block infoBox %} -The following guide relies on your knowledge of the structure of the Glue REST API resource module and the behavior of its constituents. For more details, see the [Resource modules](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/glue-infrastructure.html#resource-modules) section in *Glue Infrastructure*. +The following guide relies on your knowledge of the structure of the Glue REST API resource module and the behavior of its constituents. For more details, see the [Resource modules](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-infrastructure.html#resource-modules) section in *Glue Infrastructure*. {% endinfo_block %} diff --git a/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/implement-versioning-for-rest-api-resources.md b/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/implement-versioning-for-rest-api-resources.md index fa26c1b9ce3..ab2207824c9 100644 --- a/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/implement-versioning-for-rest-api-resources.md +++ b/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/implement-versioning-for-rest-api-resources.md @@ -22,7 +22,7 @@ redirect_from: - /docs/scos/dev/tutorials-and-howtos/introduction-tutorials/glue-api/versioning-rest-api-resources.html related: - title: Glue infrastructure - link: docs/scos/dev/glue-api-guides/page.version/old-glue-infrastructure/glue-infrastructure.html + link: docs/scos/dev/glue-api-guides/page.version/glue-infrastructure.html --- In the course of the development of your REST APIs, you may need to change the data contracts of API resources. However, you can also have clients that rely on the existing contracts. To preserve backward compatibility for such clients, we recommend implementing a versioning system for REST API resources. In this case, each resource version has its own contract in terms of data, and various clients can request the exact resource versions they are designed for. @@ -42,7 +42,7 @@ To add versioning to a resource, the route plugin of the `resource` module needs {% info_block warningBox %} -For more information on route plugins, see the [Resource routing](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/glue-infrastructure.html#resource-routing) section in *Glue Infrastructure*. +For more information on route plugins, see the [Resource routing](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-infrastructure.html#resource-routing) section in *Glue Infrastructure*. {% endinfo_block %} diff --git a/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/validate-rest-request-format.md b/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/validate-rest-request-format.md index c3faca23efa..b82ac0cb42c 100644 --- a/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/validate-rest-request-format.md +++ b/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/validate-rest-request-format.md @@ -25,7 +25,7 @@ related: - title: Glue API installation and configuration link: docs/scos/dev/feature-integration-guides/page.version/glue-api/glue-api-installation-and-configuration.html - title: Glue infrastructure - link: docs/scos/dev/glue-api-guides/page.version/old-glue-infrastructure/glue-infrastructure.html + link: docs/scos/dev/glue-api-guides/page.version/glue-infrastructure.html --- Glue API lets you validate requests sent to REST endpoints. It lets you check whether all required fields are present and whether the type and format of the fields are correct. diff --git a/docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/glue-infrastructure.md b/docs/scos/dev/glue-api-guides/202212.0/glue-infrastructure.md similarity index 98% rename from docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/glue-infrastructure.md rename to docs/scos/dev/glue-api-guides/202212.0/glue-infrastructure.md index 63f122c5db7..d7a48b36173 100644 --- a/docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/glue-infrastructure.md +++ b/docs/scos/dev/glue-api-guides/202212.0/glue-infrastructure.md @@ -1,7 +1,7 @@ --- title: Glue infrastructure description: The guide will walk you through the process of handling API requests at the Glue layer, including GlueApplication, Resource, and Relationship modules. -last_updated: Jul 16, 2023 +last_updated: Jun 16, 2021 template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/glue-infrastructure originalArticleId: dd27e960-56f8-4be6-bc6b-b479c71c5e02 @@ -16,18 +16,11 @@ redirect_from: - /v5/docs/en/glue-infrastructure - /docs/scos/dev/concepts/glue-api/glue-infrastructure.html - /docs/scos/dev/glue-api-guides/202200.0/glue-infrastructure.html - - /docs/scos/dev/glue-api-guides/202212.0/glue-infrastructure.html related: - title: Authentication and authorization link: docs/pbc/all/identity-access-management/page.version/glue-api-authentication-and-authorization.html --- -{% info_block warningBox %} - -This is a document related to the Old Glue infrastructure. For the new one, see [Decoupled Glue API](/docs/scos/dev/glue-api-guides/{{page.version}}/decoupled-glue-api.html) - -{% endinfo_block %} - Spryker API infrastructure is implemented as a separate layer of Spryker Cloud Commerce OS, called Glue. It is responsible for providing API endpoints, processing requests, as well as for communication with other layers of the OS in order to retrieve the necessary information. The layer is implemented as a separate Spryker application, the same as Yves or Zed. It has its own bootstrapping and a separate virtual host on the Spryker web server (Nginx by default). In addition to that, Glue has a separate programming namespace within Spryker Commerce OS, also called Glue. {% info_block infoBox %} @@ -42,8 +35,10 @@ Consider studying the following documents before you begin: Logically, the Glue layer can be divided into 3 parts: * **GlueApplication module**
The `GlueApplication` module provides a framework for constructing API resources. It intercepts all HTTP requests at resource URLs (e.g. `http://mysprykershop.com/resource/1`), handles call semantics, verifies requests, and also provides several utility interfaces that can be used to construct API responses. + * **Resource modules**
Each `Resource` module implements a separate resource or a set of resources. Such a module handles requests to a particular resource and provides them with responses. In the process of doing so, the module can communicate with the Storage, Search or Spryker Commerce OS (Zed). The modules do not handle request semantics or rules. Their only task is to provide the necessary data in a format that can be converted by the `GlueApplication` module into an API response. + * **Relationship modules**
Such modules represent relationships between two different resources. Their task is to extend the response of one of the resources with data of related resources. @@ -73,7 +68,7 @@ The plugin should not map the _OPTIONS_ verb which is mapped automatically. The plugin must provide routing information for the following: -| RESOURCE | DESCRIPTION | +| --- | --- | | --- | --- | | Resource Type | Type of the resource implemented by the current `Resource` module. Resource types are extracted by Glue from the request URL. For example, if the URL is `/carts/1`, the resource type is `carts`. To be able to process calls to this URL, Glue will need a route plugin for the resource type _carts_. | | Controller Name | Name of the controller that handles a specific resource type. | @@ -124,7 +119,7 @@ By default, all Resource modules are located in `vendor/spryker/resources-rest-a Recommended module structure: -| RESOURCESRESTAPI | DESCRIPTION | +| ResourcesRestApi | DESCRIPTION | | --- | --- | | `Glue/ResourcesRestApi/Controller` | Folder for resource controllers. Controllers are used to handle API requests and responses. Typically, includes the following:
  • `FeatureResourcesController.php` - contains methods for handling HTTP verbs.
| | `Glue/ResourcesRestApi/Dependency` | Bridges to clients from other modules. | @@ -137,7 +132,7 @@ Recommended module structure: Also, a module should contain the transfer definition in `src/Pyz/Shared/ResourcesRestApi/Transfer`: -| RESOURCESRESTAPI | DESCRIPTION | +| ResourcesRestApi | DESCRIPTION | | --- | --- | | `resources_rest_api.transfer.xml` | Contains API transfer definitions. | @@ -432,7 +427,6 @@ In addition to HTTP Status codes, Glue can return additional error codes to dist | 1001-1099 | Guest Cart API | | 1101-1199 | Checkout API| | 1201-1299| Product Labels API | -| 1301-1399| Dynamic Data API | ### Data formatting diff --git a/docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/glue-rest-api.md b/docs/scos/dev/glue-api-guides/202212.0/glue-rest-api.md similarity index 72% rename from docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/glue-rest-api.md rename to docs/scos/dev/glue-api-guides/202212.0/glue-rest-api.md index bb9d6bc5bc1..912f9839b3a 100644 --- a/docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/glue-rest-api.md +++ b/docs/scos/dev/glue-api-guides/202212.0/glue-rest-api.md @@ -1,6 +1,6 @@ --- title: Glue REST API -last_updated: Jul 13, 2023 +last_updated: Jun 16, 2021 template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/glue-rest-api originalArticleId: 0556fe67-9243-4b84-b81f-8e417ca3d270 @@ -10,20 +10,13 @@ redirect_from: - /docs/glue-rest-api - /docs/en/glue-rest-api - /docs/scos/dev/glue-api-guides/202200.0/glue-rest-api.html - - /docs/scos/dev/glue-api-guides/202212.0/glue-rest-api.html - /api/definition-api.htm related: - title: Reference information - GlueApplication errors - link: docs/scos/dev/glue-api-guides/page.version/old-glue-infrastructure/reference-information-glueapplication-errors.html + link: docs/scos/dev/glue-api-guides/page.version/reference-information-glueapplication-errors.html --- -{% info_block warningBox %} - -This document is related to the Old Glue infrastructure. For the new one, see [Decoupled Glue API](/docs/scos/dev/glue-api-guides/{{page.version}}/decoupled-glue-api.html) - -{% endinfo_block %} - -The *Spryker Glue REST API* is a JSON REST API that is an application of the Spryker Cloud Commerce OS (SCCOS). It is build to be used as a contract between the SCCOS backend and any possible touchpoint or integration with a third-party system. As an application, Glue knows how to read and interpret API resources and leverage feature modules that expose existing Spryker functionality. +The Spryker Glue REST API is a JSON REST API that is an application of the Spryker Cloud Commerce OS (SCCOS). It is build to be used as a contract between the SCCOS Backend and any possible touchpoint or integration with a third-party system. As an application, Glue knows how to read and interpret API resources and leverage feature modules that expose existing Spryker functionality. ![Glue REST API](https://spryker.s3.eu-central-1.amazonaws.com/docs/Glue+API/Glue+REST+API/glue-rest-api.jpg) @@ -31,7 +24,7 @@ The *Spryker Glue REST API* is a JSON REST API that is an application of the Spr The Spryker API infrastructure, which is implemented as a separate layer of the SCCOS, is called Glue. Glue is responsible for providing API endpoints, processing requests, and for communicating with other layers of the OS. -For more details, see [Glue Infrastructure](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/glue-infrastructure.html). +For more details, see [Glue Infrastructure](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-infrastructure.html). ## REST API @@ -39,25 +32,25 @@ The Glue REST API comes with a set of predefined APIs, which you can extend or a For more details, see REST API reference: -* [REST API B2B Demo Shop reference](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/rest-api-b2b-reference.html) -* [REST API B2C Demo Shop reference](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/rest-api-b2c-reference.html) +* [REST API B2B Demo Shop reference](/docs/scos/dev/glue-api-guides/{{site.version}}/rest-api-b2b-reference.html) +* [REST API B2C Demo Shop reference](/docs/scos/dev/glue-api-guides/{{site.version}}/rest-api-b2c-reference.html) ## B2C API React example -To help you understand possible use cases, we provide a sample app as an exemplary implementation (which is not a starting point for development). It can coexist with a shop as a second touchpoint in the project. From a technological perspective, it is based on our customers' interests. The app is single-page application based on a React JS library. +To help you understand possible use cases, we provide a sample app as an exemplary implementation (which is not a starting point for development). It can coexist with a shop as a second touchpoint in the project. From a technology perspective, it is based on our customers' interests. The app is single-page application based on a React JS library. -It delivers a full customer experience from browsing the catalog to placing an order. The application helps you understand how you can use the predefined APIs to create a B2C user experience. As an example, the full power of Elasticsearch, which is already present in our [B2B](/docs/scos/user/intro-to-spryker/b2b-suite.html) and [B2C Demo Shops](/docs/scos/user/intro-to-spryker/b2c-suite.html), is leveraged through dedicated endpoints to deliver catalog search functionality with autocompletion, autosuggestion, facets, sorting, and pagination. +It delivers a full customer experience from browsing the catalog to placing an order. The application helps you understand how you can use the predefined APIs to create a B2C user experience. As an example, the full power of Elasticsearch, which is already present in our [B2B](/docs/scos/user/intro-to-spryker/b2b-suite.html) and [B2C Demo Shops](/docs/scos/user/intro-to-spryker/b2c-suite.html), is leveraged via dedicated endpoints to deliver catalog search functionality with auto-completion, auto-suggestion, facets, sorting, and pagination. {% info_block infoBox %} -For more deatails about installing and running, see [B2C API React example](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.html). +[Install and run!](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.html) {% endinfo_block %} ### What can you use the REST API for? Glue API helps you to connect your Spryker Commerce OS with new or existing touch points. These touchpoints can be headless like voice commerce devices and chat bots, or they may come with a user interface like a mobile app. Alternative front ends also benefit from the APIs. Here are some examples: -* New frontend: Build a new frontend or use a frontend framework like Progressive Web Apps and power it by the Glue API. +* New front end: Build a new front end or use a front-end framework like Progressive Web Apps and power it by the Glue API. * Mobile app: a mobile app, no matter if it is native, hybrid or just a web-view, can support the same functionality as the existing demo shops do. * Voice commerce: Leverage the APIs for order history to inform your customers about the status of their delivery. * Chatbot: Use chatbots to identify the customer that are trying to reach out to you and help them answer basic questions about your products. diff --git a/docs/scos/dev/glue-api-guides/202212.0/glue-spryks.md b/docs/scos/dev/glue-api-guides/202212.0/glue-spryks.md index 96c351d8195..698b20c5d9e 100644 --- a/docs/scos/dev/glue-api-guides/202212.0/glue-spryks.md +++ b/docs/scos/dev/glue-api-guides/202212.0/glue-spryks.md @@ -32,8 +32,8 @@ To perform the requested operations, besides the Spryks called by the user, oth {% endinfo_block %} To call a Spryk, you can use the following console commands: -* `vendor/bin/spryk-run {SPRYK NAME}`: to call a _Spryk_ and input the arguments interactively, one-by-one. -* `vendor/bin/spryk-run {SPRYK NAME} --{argument name}={argument value}`: to call a _Spryk_ and pass the named arguments in one pass. +* `vendor/bin/console spryk:run {SPRYK NAME}` - to call a _Spryk_ and input the arguments interactively, one-by-one. +* `vendor/bin/console spryk:run {SPRYK NAME} --{argument name}={argument value}` - to call a _Spryk_ and pass the named arguments in one pass. ## Glue module management diff --git a/docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/handling-concurrent-rest-requests-and-caching-with-entity-tags.md b/docs/scos/dev/glue-api-guides/202212.0/handling-concurrent-rest-requests-and-caching-with-entity-tags.md similarity index 89% rename from docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/handling-concurrent-rest-requests-and-caching-with-entity-tags.md rename to docs/scos/dev/glue-api-guides/202212.0/handling-concurrent-rest-requests-and-caching-with-entity-tags.md index fce7d0d5011..4cb0c41116a 100644 --- a/docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/handling-concurrent-rest-requests-and-caching-with-entity-tags.md +++ b/docs/scos/dev/glue-api-guides/202212.0/handling-concurrent-rest-requests-and-caching-with-entity-tags.md @@ -10,20 +10,13 @@ redirect_from: - /2021080/docs/en/handling-concurrent-rest-requests-and-caching-with-entity-tags - /docs/handling-concurrent-rest-requests-and-caching-with-entity-tags - /docs/en/handling-concurrent-rest-requests-and-caching-with-entity-tags - - /docs/scos/dev/glue-api-guides/202212.0/handling-concurrent-rest-requests-and-caching-with-entity-tags.html related: - title: Glue Infrastructure - link: docs/scos/dev/glue-api-guides/page.version/old-glue-infrastructure/glue-infrastructure.html + link: docs/scos/dev/glue-api-guides/page.version/glue-infrastructure.html - title: Shared Cart Feature Overview link: docs/scos/user/features/page.version/shared-carts-feature-overview.html --- -{% info_block warningBox %} - -This document is related to the Old Glue infrastructure. For the new one, see [Decoupled Glue API](/docs/scos/dev/glue-api-guides/{{page.version}}/decoupled-glue-api.html) - -{% endinfo_block %} - Some Spryker Glue API resources allow concurrent changes from multiple sources. For example, a shared cart can be changed by multiple users that act independently. To ensure resource integrity and consistency, such resources implement *Entity Tags* (ETags). An ETag is a unique identifier of the state of a specific resource at a certain point in time. It allows a server to identify if the client initiating a change has received the last state of the resource known to the server prior to sending the change request. @@ -100,4 +93,4 @@ The following error responses can be returned by the server when a resource supp | 005 | Pre-condition required.
The `If-Match` header is missing. | | 006 | Pre-condition failed.
The `If-Match` header value is invalid or outdated.
Request the current state of the resource using a `GET` request to obtain a valid tag value. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/reference-information-glueapplication-errors.md b/docs/scos/dev/glue-api-guides/202212.0/reference-information-glueapplication-errors.md similarity index 70% rename from docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/reference-information-glueapplication-errors.md rename to docs/scos/dev/glue-api-guides/202212.0/reference-information-glueapplication-errors.md index 8756593201c..f02c32c02b1 100644 --- a/docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/reference-information-glueapplication-errors.md +++ b/docs/scos/dev/glue-api-guides/202212.0/reference-information-glueapplication-errors.md @@ -1,5 +1,5 @@ --- -title: Reference information - GlueApplication errors +title: Reference information- GlueApplication errors description: Find out what common GlueAplication errors you can come across when sending and receiving data via the Glue API. last_updated: Jun 16, 2021 template: glue-api-storefront-guide-template @@ -11,18 +11,11 @@ redirect_from: - /docs/reference-information-glueapplication-errors - /docs/en/reference-information-glueapplication-errors - /docs/scos/dev/glue-api-guides/202200.0/reference-information-glueapplication-errors.html - - /docs/scos/dev/glue-api-guides/202212.0/reference-information-glueapplication-errors.html related: - title: Glue REST API - link: docs/scos/dev/glue-api-guides/page.version/old-glue-infrastructure/glue-rest-api.html + link: docs/scos/dev/glue-api-guides/page.version/glue-rest-api.html --- -{% info_block warningBox %} - -This is a document related to the Old Glue infrastructure. For the new one, see [Decoupled Glue API](/docs/scos/dev/glue-api-guides/{{page.version}}/decoupled-glue-api.html) - -{% endinfo_block %} - This page lists the generic errors that originate from the Glue Application. These errors can occur for any resource, and they are always the same for all the resources. | ERROR | DESCRIPTION | diff --git a/docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/resolving-search-engine-friendly-urls.md b/docs/scos/dev/glue-api-guides/202212.0/resolving-search-engine-friendly-urls.md similarity index 94% rename from docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/resolving-search-engine-friendly-urls.md rename to docs/scos/dev/glue-api-guides/202212.0/resolving-search-engine-friendly-urls.md index 2661b5841c7..df4f4c8fe1b 100644 --- a/docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/resolving-search-engine-friendly-urls.md +++ b/docs/scos/dev/glue-api-guides/202212.0/resolving-search-engine-friendly-urls.md @@ -10,18 +10,11 @@ redirect_from: - /2021080/docs/en/resolving-search-engine-friendly-urls - /docs/resolving-search-engine-friendly-urls - /docs/en/resolving-search-engine-friendly-urls - - /docs/scos/dev/glue-api-guides/202212.0/resolving-search-engine-friendly-urls.html related: - title: Glue API - Spryker Core feature integration link: docs/pbc/all/miscellaneous/page.version/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html --- -{% info_block warningBox %} - -This is a document related to the Old Glue infrastructure. For the new one, see [Decoupled Glue API](/docs/scos/dev/glue-api-guides/{{page.version}}/decoupled-glue-api.html) - -{% endinfo_block %} - This endpoints allows resolving Search Engine Friendly (SEF) URLs into a resource URL in Glue API. For SEO purposes, Spryker automatically generates SEF URLs for products and categories. The URLs are returned as a `url` attribute in responses related to abstract products and product categories. For examples of such responses, see: @@ -159,4 +152,4 @@ Using the information from the response and the Glue server name, you can constr | 2801 | The `url` parameter is missing. | | 2802 | The provided URL does not exist. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/rest-api-b2b-reference.md b/docs/scos/dev/glue-api-guides/202212.0/rest-api-b2b-reference.md similarity index 78% rename from docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/rest-api-b2b-reference.md rename to docs/scos/dev/glue-api-guides/202212.0/rest-api-b2b-reference.md index 12fb9a3c6c2..b20bba61bf5 100644 --- a/docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/rest-api-b2b-reference.md +++ b/docs/scos/dev/glue-api-guides/202212.0/rest-api-b2b-reference.md @@ -3,19 +3,11 @@ title: REST API B2B Demo Shop reference description: This page provides an exhaustive reference for the REST API endpoints present in the Spryker B2B demo Shop by default with the corresponding parameters and data formats. last_updated: May 10, 2022 template: glue-api-storefront-guide-template -redirect_from: - - /docs/scos/dev/glue-api-guides/202212.0/rest-api-b2b-reference.html related: - title: Reference information- GlueApplication errors - link: docs/scos/dev/glue-api-guides/page.version/old-glue-infrastructure/reference-information-glueapplication-errors.html + link: docs/scos/dev/glue-api-guides/page.version/reference-information-glueapplication-errors.html --- -{% info_block warningBox %} - -This is a document related to the Old Glue infrastructure. For the new one, see [Decoupled Glue API](/docs/scos/dev/glue-api-guides/{{page.version}}/decoupled-glue-api.html) - -{% endinfo_block %} - This document provides an overview of REST API endpoints provided by the Spryker B2B Demo Shop by default. For each endpoint, you will find its URL relative to the server, REST request parameters, as well as the appropriate request and response data formats.
diff --git a/docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/rest-api-b2c-reference.md b/docs/scos/dev/glue-api-guides/202212.0/rest-api-b2c-reference.md similarity index 82% rename from docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/rest-api-b2c-reference.md rename to docs/scos/dev/glue-api-guides/202212.0/rest-api-b2c-reference.md index 48189b3351a..4542e40613d 100644 --- a/docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/rest-api-b2c-reference.md +++ b/docs/scos/dev/glue-api-guides/202212.0/rest-api-b2c-reference.md @@ -12,18 +12,11 @@ redirect_from: - /docs/en/rest-api-reference - /docs/scos/dev/glue-api-guides/202204.0/rest-api-reference.html - /docs/scos/dev/glue-api-guides/202200.0/rest-api-reference.html - - /docs/scos/dev/glue-api-guides/202212.0/rest-api-b2c-reference.html related: - title: Reference information- GlueApplication errors - link: docs/scos/dev/glue-api-guides/page.version/old-glue-infrastructure/reference-information-glueapplication-errors.html + link: docs/scos/dev/glue-api-guides/page.version/reference-information-glueapplication-errors.html --- -{% info_block warningBox %} - -This is a document related to the Old Glue infrastructure. For the new one, see [Decoupled Glue API](/docs/scos/dev/glue-api-guides/{{page.version}}/decoupled-glue-api.html) - -{% endinfo_block %} - This document provides an overview of REST API endpoints provided by the Spryker B2C Demo Shop by default. For each endpoint, you will find its URL relative to the server, REST request parameters, as well as the appropriate request and response data formats.
diff --git a/docs/scos/dev/glue-api-guides/202304.0/dynamic-data-api/how-to-guides/how-to-configure-dynamic-data-api.md b/docs/scos/dev/glue-api-guides/202304.0/dynamic-data-api/how-to-guides/how-to-configure-dynamic-data-api.md deleted file mode 100644 index 8b751ea3069..00000000000 --- a/docs/scos/dev/glue-api-guides/202304.0/dynamic-data-api/how-to-guides/how-to-configure-dynamic-data-api.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -title: How to configure Dynamic Data API endpoints. -description: This guide shows how to configure the Dynamic Data API endpoints. -last_updated: June 23, 2023 -template: howto-guide-template ---- - -This guide shows how to configure the Dynamic Data API endpoints. - -In order to incorporate a new endpoint for interacting with entities in the database, -it is necessary to add a corresponding row to the `spy_dynamic_entity_configuration` table. - -The `spy_dynamic_entity_configuration` table represents the configuration for dynamic entity endpoints in the system. It has the following columns: - -| COLUMN | SPECIFICATION | -| --- | --- | -| id_dynamic_entity_configuration | The unique ID for the configuration. | -| table_alias | An alias used in the request URL to refer to the endpoint. | -| table_name | The name of the corresponding table in the database to operate on. | -| is_active | Indicates whether the endpoint is enabled or disabled. | -| definition | A JSON-formatted string containing the configuration details for each field in the table. | -| created_at | Represents the date and time when the configuration was created. | -| updated_at | Represents the date and time when the configuration was last updated. | - -{% info_block infoBox %} - -Currently, the process entails manually executing SQL queries as there is no existing user interface (UI) feature in Spryker for it. -However, future releases are expected to introduce an UI solution for adding new rows to the `spy_dynamic_entity_configuration` table. - -{% endinfo_block %} - -Let's dive deeper into the configuration of the `spy_dynamic_entity_definition.definition` field. - -Below is an example snippet illustrating the structure of a possible definition value based on `spy_country` table: - -```json -{ - "identifier": "id_country", - "fields": [ - { - "fieldName": "id_country", - "fieldVisibleName": "id_country", - "isEditable": false, - "isCreatable": false, - "type": "integer", - "validation": { - "isRequired": false - } - }, - { - "fieldName": "iso2_code", - "fieldVisibleName": "iso2_code", - "type": "string", - "isEditable": true, - "isCreatable": true, - "validation": { - "isRequired": true, - "maxLength": 2, - "minLength": 2 - } - } - ] -} -``` - -And now, let's delve into the meaning of each field within the snippet. Here's a breakdown of the purpose of each field: - -| FIELD | SPECIFICATION | -| --- | --- | -| identifier | The name of the column in the table that serves as an identifier. It can be any chosen column from the table, typically used as a unique ID for each record. | -| fields | An array containing the descriptions of the columns from the table. It allows customization of which columns are included for interaction. By specifying the desired columns in the "fields" array, the API will only expose and operate on those specific columns. Any columns not included in the array will be inaccessible through API requests. | -| fieldName | The actual name of the column in the database table. | -| fieldVisibleName | The name used for interacting with the field through API requests. It provides a more user-friendly and descriptive name compared to the physical column name. | -| type | The data type of the field. It specifies the expected data format for the field, enabling proper validation and handling of values during API interactions. | -| isEditable | A flag indicating whether the field can be modified. When set to "true," the field is editable, allowing updates to its value. | -| isCreatable | A flag indicating whether the field can be set. If set to "true," the field can be included in requests to provide an initial value during record creation. | -| validation | Contains validation configurations. Proper validation ensures that the provided data meets the specified criteria. | -| required | A validation attribute that determines whether the field is required or optional. When set to "true," the field must be provided in API requests. | -| maxLength/minLength | An optional validation attribute that specifies the minimum/maximum length allowed for the field defined with a string type. It enforces a lower boundary, ensuring that the field's value meets or exceeds the defined minimum requirement. | -| max/min | An optional validation attribute that specifies the minimum/maximum value allowed for the field defined with an integer type. It enforces a lower boundary, ensuring that the field's value meets or exceeds the defined minimum requirement. | - -{% info_block infoBox %} - -It is recommended to set `isEditable` and `isCreatable` to `false` for fields that serve as identifiers or keys, ensuring their immutability and preserving the integrity of the data model. - -{% endinfo_block %} - -{% info_block infoBox %} - -When configuring the definition for the field responsible for the numerable values, keep in mind that an integer data type is a non-decimal number -between -2147483648 and 2147483647 in 32-bit systems, and between -9223372036854775808 and 9223372036854775807 in 64-bit systems. -However, if there is a need to use values outside this range or if the person providing the configuration anticipates -larger values, the field can be set as a string type instead. - -{% endinfo_block %} - -{% info_block infoBox %} - -So far the Dynamic Data API supports the following types for the configured fields: boolean, integer, string and decimal. - -{% endinfo_block %} - -Let's say you want to have a new endpoint `/dynamic-data/country` to operate with data in `spy_country` table in database. - -Based on the provided information, the SQL transaction for interacting with the `spy_country` table through the API request via `dynamic-entity/country` would be as follows: - -```sql -BEGIN; -INSERT INTO `spy_dynamic_entity_configuration` VALUES ('country', 'spy_country', 1, '{\"identifier\":\"id_country\",\"fields\":[{\"fieldName\":\"id_country\",\"fieldVisibleName\":\"id_country\",\"isEditable\":false,\"isCreatable\":false,\"type\":\"integer\",\"validation\":{\"isRequired\":false}},{\"fieldName\":\"iso2_code\",\"fieldVisibleName\":\"iso2_code\",\"type\":\"string\",\"isEditable\":true,\"isCreatable\":true,\"validation\":{\"isRequired\":true,\"maxLength\":2,\"minLength\":2}},{\"fieldName\":\"iso3_code\",\"fieldVisibleName\":\"iso3_code\",\"type\":\"string\",\"isEditable\":true,\"isCreatable\":true,\"validation\":{\"isRequired\":true,\"maxLength\":3,\"minLength\":3}},{\"fieldName\":\"name\",\"fieldVisibleName\":\"name\",\"type\":\"string\",\"isEditable\":true,\"isCreatable\":true,\"validation\":{\"isRequired\":true,\"maxLength\":255,\"minLength\":1}},{\"fieldName\":\"postal_code_mandatory\",\"fieldVisibleName\":\"postal_code_mandatory\",\"type\":\"boolean\",\"isEditable\":true,\"isCreatable\":true,\"validation\":{\"isRequired\":false}},{\"fieldName\":\"postal_code_regex\",\"isEditable\":\"false\",\"isCreatable\":\"false\",\"fieldVisibleName\":\"postal_code_regex\",\"type\":\"string\",\"validation\":{\"isRequired\":false,\"maxLength\":500,\"minLength\":1}}]}'); -COMMIT; -``` - -{% info_block warningBox "Verification" %} - -If everything is set up correctly, you can follow [How to send request in Dynamic Data API](/docs/scos/dev/glue-api-guides/{{page.version}}/dynamic-data-api/how-to-guides/how-to-send-request-in-dynamic-data-api.html) to discover how to request your API endpoint. -Or if you're in the middle of the integration process for the Dynamic Data API follow [Dynamic Data API integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/dynamic-data-api-integration.html) to proceed with it. - -{% endinfo_block %} diff --git a/docs/scos/dev/glue-api-guides/202304.0/dynamic-data-api/how-to-guides/how-to-send-request-in-dynamic-data-api.md b/docs/scos/dev/glue-api-guides/202304.0/dynamic-data-api/how-to-guides/how-to-send-request-in-dynamic-data-api.md deleted file mode 100644 index 13bc30f9000..00000000000 --- a/docs/scos/dev/glue-api-guides/202304.0/dynamic-data-api/how-to-guides/how-to-send-request-in-dynamic-data-api.md +++ /dev/null @@ -1,473 +0,0 @@ ---- -title: How send a request in Dynamic Data API -description: This guide shows how to send a request in Dynamic Data API. -last_updated: June 23, 2023 -template: howto-guide-template ---- - -This guide shows how to send a request in Dynamic Data API. - -{% info_block infoBox %} - -Ensure the Dynamic Data API is integrated (follow [Dynamic Data API integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/dynamic-data-api-integration.html)) -and configured (follow [How to configure Dynamic Data API](/docs/scos/dev/glue-api-guides/{{page.version}}/dynamic-data-api/how-to-guides/how-to-configure-dynamic-data-api.html)) -as described in the guides. - -{% endinfo_block %} - -Let's say you have an endpoint `/dynamic-data/country` to operate with data in `spy_country` table in database. - -The Dynamic Data API is a non-resource-based API and routes directly to a controller all specified endpoints. - -By default, all routes within the Dynamic Data API are protected to ensure data security. -To access the API, you need to obtain an access token by sending a POST request to the `/token/` endpoint with the appropriate credentials: - -```bash -POST /token/ HTTP/1.1 -Host: glue-backend.mysprykershop.com -Content-Type: application/x-www-form-urlencoded -Accept: application/json -Content-Length: 67 - -grant_type=password&username={username}&password={password} -``` - -### Sending a `GET` request - -To retrieve a collection of countries, a `GET` request should be sent to the `/dynamic-entity/country` endpoint. -This request needs to include the necessary headers, such as Content-Type, Accept, and Authorization, with the access token provided. - -The response body will contain all the columns from the `spy_country` table that have been configured in the `spy_dynamic_entity_definition.definition`. -Each column will be represented using the `fieldVisibleName` as the key, providing a comprehensive view of the table's data in the API response. - -Pagination allows for efficient data retrieval by specifying the desired range of results. -To implement pagination, include the desired page limit and offset in the request: - -```bash -GET /dynamic-entity/country?page[offset]=1&page[limit]=2 HTTP/1.1 -Host: glue-backend.mysprykershop.com -Content-Type: application/json -Accept: application/json -Authorization: Bearer {your_token} -``` - -{% info_block warningBox "Verification" %} - -If everything is set up correctly you will get the following response: - -```json -[ - { - "id_country": 2, - "iso2_code": "AD", - "iso3_code": "AND", - "name": "Andorra", - "postal_code_mandatory": true, - "postal_code_regex": "AD\\d{3}" - }, - { - "id_country": 3, - "iso2_code": "AE", - "iso3_code": "ARE", - "name": "United Arab Emirates", - "postal_code_mandatory": false, - "postal_code_regex": null - } -] -``` - -{% endinfo_block %} - -{% info_block infoBox %} - -Note, by default the API `GET` request returns up to 20 records. - -{% endinfo_block %} - -Filtering enables targeted data retrieval, refining the response to match the specified criteria. -To apply filtering to the results based on specific fields, include the appropriate filter parameter in the request: - -```bash -GET /dynamic-entity/country?filter[country.iso2_code]=AA HTTP/1.1 -Host: glue-backend.mysprykershop.com -Content-Type: application/json -Accept: application/json -Authorization: Bearer {your_token} -``` - -{% info_block warningBox "Verification" %} - -If everything is set up correctly you will get the following response: - -```json -[ - { - "id_country": 1, - "iso2_code": "AA", - "iso3_code": "UUD", - "name": "Create", - "postal_code_mandatory": false, - "postal_code_regex": null - } -] -``` - -{% endinfo_block %} - -{% info_block infoBox %} - -Note, so far when you combine multiple filters in a single request, the system applies an "AND" condition to the retrieved results. - -{% endinfo_block %} - -To retrieve a country by a specific ID, you can send a `GET` request with the following parameters: - -```bash -GET /dynamic-entity/country/3 HTTP/1.1 -Host: glue-backend.mysprykershop.com -Content-Type: application/json -Accept: application/json -Authorization: Bearer {your_token} -``` -{% info_block warningBox "Verification" %} - -If everything is set up correctly you will get the following response: - -```json -[ - { - "id_country": 3, - "iso2_code": "AE", - "iso3_code": "ARE", - "name": "United Arab Emirates", - "postal_code_mandatory": false, - "postal_code_regex": null - } -] -``` - -{% endinfo_block %} - -{% info_block infoBox %} - -Note if a current endpoint is not configured in `spy_dynamic_entity_configuration` and it's not found you'll get the following response: - -```json -[ - { - "message": "Not found", - "status": 404, - "code": "007" - } -] -``` - -{% endinfo_block %} - -### Sending `POST` request - -To create a collection of countries, submit the following HTTP request: - -```bash -POST /dynamic-entity/country HTTP/1.1 -Host: glue-backend.mysprykershop.com -Content-Type: application/json -Accept: application/json -Authorization: Bearer {your_token} -Content-Length: 154 - -{ - "data": [ - { - "iso2_code": "WA", - "iso3_code": "WWA", - "name": "FOO" - } - ] -} -``` - -{% info_block warningBox "Verification" %} - -If everything is set up correctly you will get the following response: - -```json -[ - { - "iso2_code": "WA", - "iso3_code": "WWA", - "name": "FOO", - "id_country": 257 - } -] -``` - -The response payload includes all the specified fields from the request body, along with the ID of the newly created entity. - -{% endinfo_block %} - -{% info_block infoBox %} - -Note that all fields included in the request payload are marked as `isCreatable: true` in the configuration. -Therefore, the API will create a new record with all the provided fields. -However, if any of the provided fields are configured as `isCreatable: false` it will result in an error. - -Let's configure `isCreatable: false` for `iso3_code` and send the same request. -You will receive the following error response because a non-creatable field `iso3_code` is provided: - -```json -[ - { - "message": "Modification of immutable field `iso3_code` is prohibited.", - "status": 400, - "code": "1304" - } -] -``` - -{% endinfo_block %} - -{% info_block infoBox %} - -It is important to consider that certain database-specific configurations may result in issues independent of entity configurations. - -For instance, in the case of MariaDB, it is not possible to set the ID value for an auto-incremented field. -Additionally, for the `iso2_code` field in the `spy_country` table, it must have a unique value. -Therefore, before creating a new record, it is necessary to verify that you do not pass a duplicated value for this field. -Otherwise, you will receive the following response: - -```json -[ - { - "message": "Failed to persist the data. Please verify the provided data and try again. Entry is duplicated.", - "status": 400, - "code": "1309" - } -] -``` - -This response is caused by a caught Propel exception, specifically an integrity constraint violation `(Integrity constraint violation: 1062 Duplicate entry 'WA' for key 'spy_country-iso2_code')`. - -{% endinfo_block %} - -### Sending `PATCH` request - -To update a collection of countries, submit the following HTTP request: - -```bash -PATCH /dynamic-entity/country HTTP/1.1 -Host: glue-backend.mysprykershop.com -Content-Type: application/json -Accept: application/json -Authorization: Bearer {your_token} -Content-Length: 174 -{ - "data": [ - { - "id_country": 1, - "iso2_code": "WB", - "iso3_code": "WWB", - "name": "FOO" - } - ] -} -``` - -{% info_block warningBox "Verification" %} - -If everything is set up correctly you will get the following response: - -```json -[ - { - "iso2_code": "WB", - "iso3_code": "WWB", - "name": "FOO", - "id_country": 1 - } -] -``` - -The response payload includes all the specified fields from the request body. - -{% endinfo_block %} - -{% info_block infoBox %} - -It is also possible to send a `PATCH` request for a specific ID instead of a collection, use the following request: - -```bash -PATCH /dynamic-entity/country/1 HTTP/1.1 -Host: glue-backend.mysprykershop.com -Content-Type: application/json -Accept: application/json -Authorization: Bearer {your_token} -Content-Length: 143 -{ - "data": { - "iso2_code": "WB", - "iso3_code": "WWB", - "name": "FOO" - } -} -``` - -{% endinfo_block %} - -{% info_block infoBox %} - -Note that all fields included in the request payload are marked as `isEditable: true` in the configuration. -Therefore, the API will update the found record with all the provided fields. -However, if any of the provided fields are configured as `isEditable: false` it will result in an error. - -Let's configure `isEditable: false` for `iso3_code` and send the same request. - -You will receive the following error response because a non-editable field `iso3_code` is provided: - -```json -[ - { - "message": "Modification of immutable field `iso3_code` is prohibited.", - "status": 400, - "code": "1304" - } -] -``` - -{% endinfo_block %} - -{% info_block infoBox %} - -If `id_country` is not provided you will get the following response: - -```json -[ - { - "message": "Incomplete Request - missing identifier.", - "status": 400, - "code": "1310" - } -] -``` - -If `id_country` is not found you will get the following response: - -```json -[ - { - "message": "The entity could not be found in the database.", - "status": 404, - "code": "1303" - } -] -``` - -{% endinfo_block %} - -{% info_block infoBox %} - -Similarly to the `POST` request, it is important to consider database-specific configurations when sending a `PATCH` request. - -{% endinfo_block %} - -### Sending `PUT` request - -When you send a PUT request, you provide the updated representation of the resource in the request -payload. The server then replaces the entire existing resource with the new representation provided. If the resource does not exist at the specified URL, a PUT request can also create a new resource. - -Let's send the following `PUT` request to update the existing entity: - -```bash -PUT /dynamic-entity/country HTTP/1.1 -Host: glue-backend.mysprykershop.com -Content-Type: application/json -Accept: application/json -Authorization: Bearer {your_token} -Content-Length: 263 -{ - "data": [ - { - "id_country": 1, - "iso2_code": "WB", - "iso3_code": "WWB", - "name": "FOO" - } - ] -} -``` - -{% info_block warningBox "Verification" %} - -If everything is set up correctly you will get the following response: - -```json -[ - { - "iso2_code": "WB", - "iso3_code": "WWB", - "name": "FOO", - "postal_code_mandatory": null, - "postal_code_regex": null, - "id_country": 1 - } -] -``` - -The response payload includes all touched fields for the provided resource. - -{% endinfo_block %} - -{% info_block infoBox %} - -It is also possible to send a `PUT` request for a specific ID instead of a collection using the following request: - -```bash -PUT /dynamic-entity/country/1 HTTP/1.1 -Host: glue-backend.mysprykershop.com -Content-Type: application/json -Accept: application/json -Authorization: Bearer {your_token} -Content-Length: 143 -{ - "data": { - "iso2_code": "WB", - "iso3_code": "WWB", - "name": "FOO" - } -} -``` - -{% endinfo_block %} - -{% info_block infoBox %} - -When using `PUT` requests, it's important to consider that the same rules and configurations apply -as with `PATCH` and `POST` requests. This means that the `isEditable` attribute determines whether existing -items can be modified during a `PUT` request. Additionally, the `isCreatable` attribute is used for non-existing -items that are created automatically according to the `PUT` request RFC. - -In technical terms, the `PUT` request follows the same guidelines as `PATCH` and `POST` requests in relation to -the definition and database-specific configurations. The `isEditable` attribute governs the update capability -of existing items during a `PUT` request, ensuring that only editable fields can be modified. Similarly, the `isCreatable` -attribute pertains to non-existing items and governs their automatic creation as part of the `PUT` request process, -adhering to the standards outlined in the `PUT` request RFC. It's crucial to adhere to these rules and configurations -to ensure accurate and consistent data manipulation during `PUT` operations. - -{% endinfo_block %} - -#### Error codes - -Bellow you can find a list of error codes that you can receive when sending `GET`, `POST`, `PATCH` or `PUT` requests. - -| Error code | Message | Description | -| --- | --- | --- | -| 1301 | Invalid or missing data format. Please ensure that the data is provided in the correct format. Example request body: `{'data':[{...},{...},..]}` | The request body is not valid. Please review the data format for validity. Ensure that the data is provided in the correct format. An example request body would be: `{'data':[{...data entity...},{...data entity...},...]}`. `data` If the data format is invalid or missing, an error message will be displayed. | -| 1302 | Failed to persist the data. Please verify the provided data and try again. | The data could not be persisted in the database. Please verify the provided data entities and try again. | -| 1303 | The entity could not be found in the database. | The requested entity could not be found in the database for retrieval or update. | -| 1304 | Modification of immutable field `field` is prohibited. | The field is prohibited from being modified. Please check the configuration for this field. | -| 1305 | Invalid data type for field: `field` | The specified field has an incorrect type. Please check the configuration for this field and correct the value. | -| 1306 | Invalid data value for field: `field`, row number: `row`. Field rules: `validation rules`. | The error indicates a data row and a field that does not comply with the validation rules in the configuration. Here is an example of the error: `Invalid data value for field: id, row number: 2. Field rules: min: 0, max: 127`. | -| 1307 | The required field must not be empty. Field: `field` | The specified field is required according to the configuration. The field was not provided. Please check the data you are sending and try again. | -| 1308 | Entity not found by identifier, and new identifier can not be persisted. Please update the request. | The entity could not be found using the provided identifier, and a new identifier cannot be persisted. Please update your request accordingly or check configuration for identifier field. | -| 1309 | Failed to persist the data. Please verify the provided data and try again. Entry is duplicated. | Failed to persist the data. Please verify the provided data and try again. This error may occur if a record with the same information already exists in the database. | -| 1310 | Incomplete Request - missing identifier. | The request is incomplete. The identifier is missing. Please check the request and try again. | \ No newline at end of file diff --git a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/additional-logic-in-dependency-provider.md b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/additional-logic-in-dependency-provider.md index 12613a17ce6..531f557345d 100644 --- a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/additional-logic-in-dependency-provider.md +++ b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/additional-logic-in-dependency-provider.md @@ -73,19 +73,22 @@ class ConsoleDependencyProvider extends SprykerConsoleDependencyProvider } ``` -## Example of an evaluator error message +## Example of an Evaluator error message ```bash ====================== MULTIDIMENSIONAL ARRAY ====================== -Message: The if ($alwaysTrue) {} condition statement is forbidden in DependencyProvider -Target: {PATH_TO_PROJECT}/Pyz/Zed/Checkout/CheckoutDependencyProvider.php ++---+------------------------------------------------------------------------------------+-------------------------------------------------------------------+ +| # | Message | Target | ++---+------------------------------------------------------------------------------------+-------------------------------------------------------------------+ +| 1 | The condition statement if ($alwaysTrue) {} is forbidden in the DependencyProvider | /Pyz/Zed/Checkout/CheckoutDependencyProvider.php | ++---+------------------------------------------------------------------------------------+-------------------------------------------------------------------+ ``` -## Example of code that causes an evaluator error +## Example of code that causes an upgradability error The method `getFormPlugins` in `FormDependencyProvider` contains unsupported expressions in the `if` construct `$alwaysAddPlugin`. diff --git a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/dead-code-checker.md b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/dead-code-checker.md index df5fe6f2273..82367175e45 100644 --- a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/dead-code-checker.md +++ b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/dead-code-checker.md @@ -13,19 +13,20 @@ This results in unnecessary additional time investment from developers, as they This check examines potential obsolete classes, with a tendency to overlook important Spryker kernel classes like `Factory`, `Facade`, or `DependencyProvider`. If desired, you have the option to disable the dead code checker for a particular class using the `@evaluator-skip-dead-code` annotation. -## Example of an evaluator error message +## Example of an Evaluator error message ```bash ================= DEAD CODE CHECKER ================= -Message: The class "Pyz/Zed/Single/Communication/Plugin/SinglePlugin" is not used in the project. -Target: Pyz/Zed/Single/Communication/Plugin/SinglePlugin ++---+---------------------------------------------------------------------------------+--------------------------------------------------+ +| # | Message | Target | ++---+---------------------------------------------------------------------------------+--------------------------------------------------+ +| 1 | Class "Pyz/Zed/Single/Communication/Plugin/SinglePlugin" is not used in project | Pyz/Zed/Single/Communication/Plugin/SinglePlugin | ++---+---------------------------------------------------------------------------------+--------------------------------------------------+ ``` -## Example of code that causes an evaluator error - Unused class `Pyz/Zed/Single/Communication/Plugin/SinglePlugin` that produces an error: ```bash diff --git a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/minimum-allowed-shop-version.md b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/minimum-allowed-shop-version.md index 890a5fda464..ca6b3f97cfa 100644 --- a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/minimum-allowed-shop-version.md +++ b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/minimum-allowed-shop-version.md @@ -12,7 +12,7 @@ To enable smooth upgradability of the project using the [Spryker Code Upgrader]( In case the project does not utilize the feature packages, it is necessary to ensure that the corresponding Spryker module versions are used. -## Example of an evaluator error message +## Example of an Evaluator error message Below is an example of when a used feature package version doesn't correspond to the minimum required version: @@ -28,17 +28,18 @@ MINIMUM ALLOWED SHOP VERSION +---+---------------------------------------------------------------------------------------------------------------------------+---------------------------------------+ ``` -## Example of code that causes an evaluator error - -The following is an example of when the used Spryker package version doesn't correspond to the minimum required version: +Below is an example of when the used Spryker package version doesn't correspond to the minimum required version: ```shell ============================ MINIMUM ALLOWED SHOP VERSION ============================ -Message: The package "spryker/availability-gui" version 6.5.9 is not supported. The minimum allowed version is 6.6.0. -Target: spryker/availability-gui:6.5.9 ++---+-----------------------------------------------------------------------------------------------------------------+--------------------------------+ +| # | Message | Target | ++---+-----------------------------------------------------------------------------------------------------------------+--------------------------------+ +| 1 | The package "spryker/availability-gui" version "6.5.9" is not supported. The minimum allowed version is "6.6.0" | spryker/availability-gui:6.5.9 | ++---+-----------------------------------------------------------------------------------------------------------------+--------------------------------+ ``` ### Resolving the error diff --git a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/multidimensional-array.md b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/multidimensional-array.md index 1e608a40954..79435a3ea7d 100644 --- a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/multidimensional-array.md +++ b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/multidimensional-array.md @@ -11,19 +11,23 @@ This check checks that project doesn't use the deeply nested multidimensional ar If a plugins stack is used on the project level, not all structures are necessarily required. Deeply nested multidimensional arrays make configuration hard to upgrade. This check verifies that multidimensional arrays have a maximum of two levels of nesting inside. -## Example of an evaluator error message +## Example of an Evaluator error message ```bash ====================== MULTIDIMENSIONAL ARRAY ====================== -Message: Reached max level of nesting for the plugin registration in the {FormDependencyProvider::getPlugins()}. - The maximum allowed nesting level is 2. Refactor the code; otherwise, it can cause upgradability issues in the future. -Target: Pyz\Yves\Module\ModuleDependencyProvider ++---+----------------------------------------------------------------------------------------------------------------------------+------------------------------------------+ +| # | Message | Target | ++---+----------------------------------------------------------------------------------------------------------------------------+------------------------------------------+ +| 1 | Reached max level of nesting for the plugin registration in the {FormDependencyProvider::getPlugins()}. | Pyz\Yves\Module\ModuleDependencyProvider | +| | The maximum allowed nesting level is 2. Please, refactor code, otherwise it will cause upgradability issues in the future. | | ++---+----------------------------------------------------------------------------------------------------------------------------+------------------------------------------+ + ``` -## Example of code that causes an evaluator error +## Example of code that causes an upgradability error The methods `ModuleDependencyProvider` contains unsupported multidimensional arrays, which have more than two nesting levels inside. diff --git a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/php-version.md b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/php-version.md index 87f87b30d1d..e4a16cf97dc 100644 --- a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/php-version.md +++ b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/php-version.md @@ -47,7 +47,7 @@ image: ... ``` -## Example of an evaluator error message +## Example of an Evaluator error message Below is an example of an unsupported [Spryker SDK](https://docs.spryker.com/docs/sdk/dev/spryker-sdk.html) PHP version being used in the `composer.json` file: @@ -56,8 +56,11 @@ Below is an example of an unsupported [Spryker SDK](https://docs.spryker.com/doc PHP VERSION CHECKER =================== -Message: Composer json PHP constraint 7.2 does not match allowed PHP versions. -Target: `{PATH_TO_PROJECT}/composer.json` ++---+------------------------------------------------------------------------+---------------------------------+ +| # | Message | Target | ++---+------------------------------------------------------------------------+---------------------------------+ +| 1 | Composer json PHP constraint "7.2" does not match allowed PHP versions | /composer.json | ++---+------------------------------------------------------------------------+---------------------------------+ ``` A `composer.json` file that produces the error message: @@ -81,9 +84,12 @@ Below is an example of an unsupported [Spryker SDK](https://docs.spryker.com/doc PHP VERSION CHECKER =================== -Message: The deploy file uses a not allowed PHP image version "spryker/php:7.2-alpine3.12". - The image tag must contain an allowed PHP version (image:abc-8.0) -Target: {PATH_TO_PROJECT}/deploy.yml ++---+-----------------------------------------------------------------------------------+------------------------------+ +| # | Message | Target | ++---+-----------------------------------------------------------------------------------+------------------------------+ +| 1 | The deploy file uses a not allowed PHP image version "spryker/php:7.2-alpine3.12" | /deploy.yml | +| | The image tag must contain an allowed PHP version (image:abc-8.0) | | ++---+-----------------------------------------------------------------------------------+------------------------------+ ``` A `deploy.yml` file that produces the error message: @@ -106,11 +112,14 @@ Below is an example of inconsistent PHP versions being used in the `composer.jso PHP VERSION CHECKER =================== -Message: Not all the targets have the same PHP versions -Target: Current php version $phpVersion: php7.2 - tests/Acceptance/_data/InvalidProject/composer.json: - - tests/Acceptance/_data/InvalidProject/deploy**.yml: - - SDK php versions: php7.2, php8.2 ++---+--------------------------------------------+--------------------------------------------------------+ +| # | Message | Target | ++---+--------------------------------------------+--------------------------------------------------------+ +| 1 | Not all the targets have the same PHP versions | Current php version $phpVersion: php7.2 | +| | | tests/Acceptance/_data/InvalidProject/composer.json: - | +| | | tests/Acceptance/_data/InvalidProject/deploy**.yml: - | +| | | SDK php versions: php7.2, php8.2 | ++---+--------------------------------------------+--------------------------------------------------------+ ``` The `composer.json` file uses PHP version `7.2`: @@ -140,7 +149,7 @@ image: ... ``` -Inconsistent PHP versions produce the error message output. +Inconsistent PHP versions produces the error message output. ### Resolving the error diff --git a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/plugin-registration-with-restrintions.md b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/plugin-registration-with-restrintions.md index bddff57f4ff..7ab1887a127 100644 --- a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/plugin-registration-with-restrintions.md +++ b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/plugin-registration-with-restrintions.md @@ -51,18 +51,21 @@ Below is an example of the annotation syntax needed to register a plugin only af new DefaultProductOfferReferenceStrategyPlugin(), ``` -## Example of an evaluator error message +## Example of an Evaluator error message ```shell ============================================== PLUGINS REGISTRATION WITH RESTRICTIONS CHECKER ============================================== -Message: Restriction rule does not match the pattern "/^\* - (before|after) \{@link (?.+)\}( .*\.|)$/". -Target: CategoryDependencyProvider.php ++---+------------------------------------------------------------------------------------------------------+--------------------------------+ +| # | Message | Target | ++---+------------------------------------------------------------------------------------------------------+--------------------------------+ +| 1 | Restriction rule does not match the pattern "/^\* - (before|after) \{@link (?.+)\}( .*\.|)$/" | CategoryDependencyProvider.php | ++---+------------------------------------------------------------------------------------------------------+--------------------------------+ ``` -## Example of code that causes an evaluator error +## Example of code that causes an upgradability error ```php namespace Pyz\Zed\Category; diff --git a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/security.md b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/security.md index 18fbe5f20fe..e00fe2bb237 100644 --- a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/security.md +++ b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/security.md @@ -10,18 +10,21 @@ Security Checker is a tool that checks if your PHP application depends on PHP pa A project can sometimes use dependencies that contain known vulnerabilities.. To minimize the security risk for the project, such dependencies should be updated to the version that has the vulnerability fixed. -## Example of an evaluator error message +## Example of an Evaluator error message ```bash ================ SECURITY CHECKER ================ -Message: Improper header validation (CVE-2023-29197): https://github.com/guzzle/psr7/security/advisories/GHSA-wxmh-65f7-jcvw -Target: guzzlehttp/psr7:2.4.1 ++---+---------------------------------------------------------------------------------------------------------------------+-----------------------+ +| # | Message | Target | ++---+---------------------------------------------------------------------------------------------------------------------+-----------------------+ +| 1 | Improper header validation (CVE-2023-29197): https://github.com/guzzle/psr7/security/advisories/GHSA-wxmh-65f7-jcvw | guzzlehttp/psr7:2.4.1 | ++---+---------------------------------------------------------------------------------------------------------------------+-----------------------+ ``` -## Example of code that causes an evaluator error +## Example of code that causes an upgradability error Your `composer.lock` file contains package versions that have security issues: diff --git a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/single-plugin-argument.md b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/single-plugin-argument.md index 46edf7fab1c..bfac10e6573 100644 --- a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/single-plugin-argument.md +++ b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/single-plugin-argument.md @@ -4,11 +4,11 @@ description: Reference information for evaluator tools. template: howto-guide-template --- -This check makes sure that the plugins don't require complicated constructor arguments. +This check makes sure that the plugins don't require the complicated constructor arguments. ## Problem description -Inside of the dependency provider, you can register the plugin directly in the method or through another wrap method, with and without constructor arguments. +Inside of the dependency provider you can register the plugin directly in the method or through another wrap method, with and without constructor arguments. To keep the plugins simple, they shouldn't require complicated objects as constructor arguments. Supported argument types: @@ -22,20 +22,23 @@ Supported argument types: ## Example of evaluator error message ```bash -====================== +================ SINGLE PLUGIN ARGUMENT -====================== - -Message: The "\Spryker\Zed\Console\Communication\Plugin\MonitoringConsolePlugin" plugin - should not have unsupported constructor parameters. - Supported argument types: int, float, string, const, bool, int, usage of new statement to - instantiate a class (without further methods calls). -Target: {PATH_TO_PROJECT}\ConsoleDependencyProvider::getMonitoringConsoleMethod() +================ + ++---+-------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| # | Message | Target | ++---+-------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| 1 | Plugin \Spryker\Zed\Console\Communication\Plugin\MonitoringConsolePlugin | | +| | should not have unsupported constructor parameters. | \ConsoleDependencyProvider::getMonitoringConsoleMethod | +| | Supported argument types: int, float, string, const, bool, int, usage of new statement to | | +| | instantiate a class (without further methods calls) | | ++---+-------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ ``` -## Example of code that causes an evaluator error +## Example of code that causes an upgradability error -The dependency provider method returns the plugin with the unwanted argument: +The dependency provider method returns the plugin with unwanted argument: ```bash namespace Pyz\Zed\SinglePluginArgument; @@ -59,5 +62,5 @@ class ConsoleDependencyProvider ### Resolving the error To resolve the error: -1. Refactor the plugin - remove the usage of the complicated constructor arguments. +1. Rework the plugin - remove the usage of the complicated constructor arguments. diff --git a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/upgradability-guidelines.md b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/upgradability-guidelines.md index 9425b961638..423907eb3a5 100644 --- a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/upgradability-guidelines.md +++ b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/upgradability-guidelines.md @@ -14,8 +14,13 @@ Example: DEPENDENCY PROVIDER ADDITIONAL LOGIC CHECKER ============================================ -Message: In DependencyProvider, the "if (!static::IS_DEV) {}" conditional statement is forbidden. -Target: tests/Acceptance/_data/InvalidProject/src/Pyz/Zed/Console/ConsoleDependencyProvider.php ++---+----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| # | Message | Target | ++---+----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| 1 | The condition statement if (!static::IS_DEV) {} is forbidden in the DependencyProvider | tests/Acceptance/_data/InvalidProject/src/Pyz/Zed/Console/ConsoleDependencyProvider.php | ++---+----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ + + ``` In the example, the name is `DEPENDENCY PROVIDER ADDITIONAL LOGIC CHECKER`. The table bellow describes the error and documentation about it. diff --git a/docs/scos/dev/guidelines/project-development-guidelines.md b/docs/scos/dev/guidelines/project-development-guidelines.md index e7165b42235..8ec20e61661 100644 --- a/docs/scos/dev/guidelines/project-development-guidelines.md +++ b/docs/scos/dev/guidelines/project-development-guidelines.md @@ -56,7 +56,7 @@ For example, customize the names by adding the project name. ## Avoid using, extending, and overriding Private API -Instead of using, extending, and overriding [Private API](/docs/scos/dev/architecture/module-api/declaration-of-module-apis-public-and-private.html), send a request about the missing endpoints to your Spryker account manager. In future, we will add the extension points, and you will be able to extend it via Public API. +Instead of using, extending, and overriding [Private API](/docs/scos/dev/architecture/module-api/declaration-of-module-apis-public-and-private.html), register the missing extension points in [Spryker ideas](https://spryker.ideas.aha.io/). In future, we will add the registered extension points, and you will be able to extend it via Public API. ## Keep modules up to date diff --git a/docs/scos/dev/guidelines/security-guidelines.md b/docs/scos/dev/guidelines/security-guidelines.md index 825a6212a07..e001026cc8b 100644 --- a/docs/scos/dev/guidelines/security-guidelines.md +++ b/docs/scos/dev/guidelines/security-guidelines.md @@ -49,94 +49,6 @@ You can force HTTPS for the Storefront, Back Office, and Glue using the `Strict- * `HttpConstants::GLUE_HTTP_STRICT_TRANSPORT_SECURITY_ENABLED` * `HttpConstants::GLUE_HTTP_STRICT_TRANSPORT_SECURITY_CONFIG` -## Security Headers - -Security headers are directives used by web applications to configure security defenses in web browsers. -Based on these directives, browsers can make it harder to exploit client-side vulnerabilities such as Cross-Site Scripting or Clickjacking. -Headers can also be used to configure the browser to only allow valid TLS communication and enforce valid certificates, -or even enforce using a specific server certificate. - -The sections below detail configure places for various security headers. You can change them at the project level. - -### X-Content-Type-Options, X-Frame-Options, X-XSS-Protection, Content-Security-Policy - -#### Yves -For Yves set of default security headers in: `\Spryker\Yves\Application\ApplicationConfig::getSecurityHeaders()`. - -Default values: - -``` -X-Content-Type-Options: nosniff -X-Frame-Options: SAMEORIGIN -X-XSS-Protection: 1; mode=block -Content-Security-Policy: frame-ancestors 'self'; sandbox allow-downloads allow-forms allow-modals allow-pointer-lock allow-popups allow-popups-to-escape-sandbox allow-same-origin allow-scripts allow-top-navigation; base-uri 'self'; form-action 'self' -``` - -#### Zed - -For Zed set of default security headers in: `\Spryker\Zed\Application\ApplicationConfig::getSecurityHeaders()`. - -Default values: - -``` -X-Content-Type-Options: nosniff -X-Frame-Options: SAMEORIGIN -X-XSS-Protection: 1; mode=block -Content-Security-Policy: frame-ancestors 'self' -``` - -#### Glue - -For Glue set of default security headers in: `\Spryker\Glue\GlueApplication\GlueApplicationConfig::getSecurityHeaders()`. - -Default values: - -``` -X-Content-Type-Options: nosniff -X-Frame-Options: SAMEORIGIN -X-XSS-Protection: 1; mode=block -Content-Security-Policy: frame-ancestors 'self' -``` - -#### Glue Storefront - -Glue is in the set of default security headers in: `\Spryker\Glue\GlueStorefrontApiApplication\GlueStorefrontApiApplicationConfig:::getSecurityHeaders()`. - -Default values: - -``` -X-Content-Type-Options: nosniff -X-Frame-Options: SAMEORIGIN -X-XSS-Protection: 1; mode=block -Content-Security-Policy: frame-ancestors 'self' -``` - -#### Glue Backend - -Glue is in the set of default security headers in: `\Spryker\Glue\GlueBackendApiApplication\GlueBackendApiApplicationConfig::getSecurityHeaders()`. - -Default values: - -``` -X-Content-Type-Options: nosniff -X-Frame-Options: SAMEORIGIN -X-XSS-Protection: 1; mode=block -Content-Security-Policy: frame-ancestors 'self' -``` - -#### Cache-Control header - -You can enable custom Cache-Control header for the Storefront, Back Office, and Glue using plugins: -* `Spryker\Zed\Http\Communication\Plugin\EventDispatcher\CacheControlHeaderEventDispatcherPlugin` plugin can be added into application specific method for Zed `\Pyz\Zed\EventDispatcher::getEventDispatcherPlugins()` -and configure using: `Spryker\Shared\Http\HttpConstants::ZED_HTTP_CACHE_CONTROL_ENABLED`, `Spryker\Shared\Http\HttpConstants::ZED_HTTP_CACHE_CONTROL_CONFIG`. -* `Spryker\Yves\Http\Plugin\EventDispatcher\CacheControlHeaderEventDispatcherPlugin` plugin can be added into application specific method for Yves `\Pyz\Yves\EventDispatcher::getEventDispatcherPlugins()` - and configure using: `Spryker\Shared\Http\HttpConstants::YVES_HTTP_CACHE_CONTROL_ENABLED`, `Spryker\Shared\Http\HttpConstants::YVES_HTTP_CACHE_CONTROL_CONFIG`. -* `Spryker\Glue\Http\Plugin\EventDispatcher\CacheControlHeaderEventDispatcherPlugin` plugin can be added into application specific method for Glue `\Pyz\Glue\EventDispatcher::getEventDispatcherPlugins()` - and configure using: `Spryker\Shared\Http\HttpConstants::GLUE_HTTP_CACHE_CONTROL_ENABLED`, `Spryker\Shared\Http\HttpConstants::GLUE_HTTP_CACHE_CONTROL_CONFIG`. - - - - ## Session security and hijacking Websites include many third-party JavaScript libraries that can access the content of a page. diff --git a/docs/scos/dev/set-up-spryker-locally/install-spryker/install-docker-prerequisites/install-docker-prerequisites-on-linux.md b/docs/scos/dev/set-up-spryker-locally/install-spryker/install-docker-prerequisites/install-docker-prerequisites-on-linux.md index da2be2d05ea..6eed0ad99cb 100644 --- a/docs/scos/dev/set-up-spryker-locally/install-spryker/install-docker-prerequisites/install-docker-prerequisites-on-linux.md +++ b/docs/scos/dev/set-up-spryker-locally/install-spryker/install-docker-prerequisites/install-docker-prerequisites-on-linux.md @@ -57,15 +57,33 @@ Signup for Docker Hub is not required. {% endinfo_block %} -2. Optional: Configure the `docker` group to manage Docker as a non-root user. See [Manage Docker as a non-root user](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user) for configuration instructions. +2. To enable BuildKit, create or update `/etc/docker/daemon.json`: + +```php +{ + ... + "features" : { + ... + "buildkit" : true + } +} +``` + +3. Restart Docker: + +```bash +/etc/init.d/docker restart +``` + +4. Optional: Configure the `docker` group to manage Docker as a non-root user. See [Manage Docker as a non-root user](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user) for configuration instructions. -3. Install Docker-compose: +5. Install Docker-compose: ```bash sudo curl -L "https://github.com/docker/compose/releases/download/2.18.1/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose ``` -4. Apply executable permissions to the binary: +6. Apply executable permissions to the binary: ```bash sudo chmod +x /usr/local/bin/docker-compose diff --git a/docs/scos/dev/set-up-spryker-locally/install-spryker/install/install-in-demo-mode-on-macos-and-linux.md b/docs/scos/dev/set-up-spryker-locally/install-spryker/install/install-in-demo-mode-on-macos-and-linux.md index 54eb3f639d7..8d5bae025bb 100644 --- a/docs/scos/dev/set-up-spryker-locally/install-spryker/install/install-in-demo-mode-on-macos-and-linux.md +++ b/docs/scos/dev/set-up-spryker-locally/install-spryker/install/install-in-demo-mode-on-macos-and-linux.md @@ -41,37 +41,38 @@ This document describes how to install Spryker in [Demo Mode](/docs/scos/dev/set ## Clone a Demo Shop and the Docker SDK 1. Open a terminal. -2. Clone *one* of the following Demo Shops and navigate into its folder: +2. Create a folder for the project and navigate into it: +```bash +mkdir spryker-shop && cd spryker-shop +``` + +3. Clone *one* of the following Demo Shops: * B2C Demo Shop: ```shell - git clone https://github.com/spryker-shop/b2c-demo-shop.git -b 202212.0-p2 --single-branch ./b2c-demo-shop && \ - cd b2c-demo-shop + git clone https://github.com/spryker-shop/b2c-demo-shop.git -b 202212.0-p2 --single-branch ./ ``` * B2B Demo Shop: ```shell - git clone https://github.com/spryker-shop/b2b-demo-shop.git -b 202212.0-p2 --single-branch ./b2b-demo-shop && \ - cd b2c-demo-shop + git clone https://github.com/spryker-shop/b2b-demo-shop.git -b 202212.0-p2 --single-branch ./ ``` * B2C Marketplace Demo Shop ```shell - git clone https://github.com/spryker-shop/b2c-demo-marketplace.git -b 202212.0-p2 --single-branch ./b2c-demo-marketplace && \ - cd b2c-demo-marketplace + git clone https://github.com/spryker-shop/b2c-demo-marketplace.git -b 202212.0-p2 --single-branch ./ ``` * B2B Marketplace Demo Shop ```shell - git clone https://github.com/spryker-shop/b2b-demo-marketplace.git -b 202212.0-p2 --single-branch ./b2b-demo-marketplace && \ - cd b2b-demo-marketplace + git clone https://github.com/spryker-shop/b2b-demo-marketplace.git -b 202212.0-p2 --single-branch ./ ``` -3. Clone the Docker SDK: +5. Clone the Docker SDK: ```shell git clone https://github.com/spryker/docker-sdk.git --single-branch docker diff --git a/docs/scos/dev/set-up-spryker-locally/install-spryker/install/install-in-demo-mode-on-windows.md b/docs/scos/dev/set-up-spryker-locally/install-spryker/install/install-in-demo-mode-on-windows.md index 2761203d503..0e8febf2a87 100644 --- a/docs/scos/dev/set-up-spryker-locally/install-spryker/install/install-in-demo-mode-on-windows.md +++ b/docs/scos/dev/set-up-spryker-locally/install-spryker/install/install-in-demo-mode-on-windows.md @@ -28,62 +28,58 @@ Depending on the needed WSL version, follow one of the guides: * [Install Docker prerequisites on Windows with WSL2](/docs/scos/dev/set-up-spryker-locally/install-spryker/install-docker-prerequisites/install-docker-prerequisites-on-windows-with-wsl2.html). -## Clone a Demo Shop and the Docker SDK +## Install Spryker in Demo mode on Windows 1. Open Ubuntu. 2. Open a terminal. 3. Create a new folder and navigate into it. -4. Clone *one* of the [Demo Shops](/docs/scos/user/intro-to-spryker/intro-to-spryker.html#spryker-b2bb2c-demo-shops) and navigate into its folder: +4. Clone *one* of the [Demo Shops](/docs/scos/user/intro-to-spryker/intro-to-spryker.html#spryker-b2bb2c-demo-shops): * B2C Demo Shop: ```shell - git clone https://github.com/spryker-shop/b2c-demo-shop.git -b 202212.0-p2 --single-branch ./b2c-demo-shop && \ - cd b2c-demo-shop + git clone https://github.com/spryker-shop/b2c-demo-shop.git -b 202212.0-p2 --single-branch ./b2c-demo-shop ``` * B2B Demo Shop: ```shell - git clone https://github.com/spryker-shop/b2b-demo-shop.git -b 202212.0-p2 --single-branch ./b2b-demo-shop && \ - cd b2c-demo-shop + git clone https://github.com/spryker-shop/b2b-demo-shop.git -b 202212.0-p2 --single-branch ./b2b-demo-shop ``` - * B2C Marketplace Demo Shop +5. Depending on the cloned Demo Shop, navigate into the cloned folder: - ```shell - git clone https://github.com/spryker-shop/b2c-demo-marketplace.git -b 202212.0-p2 --single-branch ./b2c-demo-marketplace && \ - cd b2c-demo-marketplace + * B2C Demo Shop: + + ```bash + cd b2c-demo-shop ``` - * B2B Marketplace Demo Shop + * B2B Demo Shop: - ```shell - git clone https://github.com/spryker-shop/b2b-demo-marketplace.git -b 202212.0-p2 --single-branch ./b2b-demo-marketplace && \ - cd b2b-demo-marketplace + ```bash + cd b2b-demo-shop ``` {% info_block warningBox "Verification" %} -Make sure that you are in the Demo Shop's folder by running the `pwd` command. +Make sure that you are in the correct folder by running the `pwd` command. -{% endinfo_block %} +{% endinfo_block %} -5. Clone the Docker SDK repository into the same folder: +6. Clone the Docker SDK repository into the same folder: ```shell git clone https://github.com/spryker/docker-sdk.git --single-branch docker ``` -## Configure and start the instance - -1. Add your user to the `docker` group: +7. Add your user to the `docker` group: ```bash sudo usermod -aG docker $USER ``` -2. Bootstrap the local Docker setup for demo: +8. Bootstrap the local Docker setup for demo: ```shell docker/sdk bootstrap @@ -95,7 +91,7 @@ Once you finish the setup, you don't need to run `bootstrap` to start the instan {% endinfo_block %} -3. Update the `hosts` file: +9. Update the `hosts` file: 1. Open the Start menu. 2. In the search field, enter `Notepad`. 3. Right-click *Notepad* and select **Run as administrator**. @@ -122,7 +118,7 @@ Once you finish the setup, you don't need to run `bootstrap` to start the instan 9. Select **File > Save**. 10. Close the file. -4. Build and start the instance: +10. Build and start the instance: ```shell docker/sdk up diff --git a/docs/scos/dev/set-up-spryker-locally/install-spryker/install/install-in-development-mode-on-macos-and-linux.md b/docs/scos/dev/set-up-spryker-locally/install-spryker/install/install-in-development-mode-on-macos-and-linux.md index 2b89cb8e821..8c6dc3e6910 100644 --- a/docs/scos/dev/set-up-spryker-locally/install-spryker/install/install-in-development-mode-on-macos-and-linux.md +++ b/docs/scos/dev/set-up-spryker-locally/install-spryker/install/install-in-development-mode-on-macos-and-linux.md @@ -47,37 +47,38 @@ This document describes how to install Spryker in [Development Mode](/docs/scos/ ## Clone a Demo Shop and the Docker SDK 1. Open a terminal. -2. Clone *one* of the following Demo Shops and navigate into its folder: +2. Create a folder for the project and navigate into it: +```bash +mkdir spryker-shop && cd spryker-shop +``` + +3. Clone *one* of the following Demo Shops: * B2C Demo Shop: ```shell - git clone https://github.com/spryker-shop/b2c-demo-shop.git -b 202212.0-p2 --single-branch ./b2c-demo-shop && \ - cd b2c-demo-shop + git clone https://github.com/spryker-shop/b2c-demo-shop.git -b 202212.0-p2 --single-branch ./b2c-demo-shop ``` * B2B Demo Shop: ```shell - git clone https://github.com/spryker-shop/b2b-demo-shop.git -b 202212.0-p2 --single-branch ./b2b-demo-shop && \ - cd b2c-demo-shop + git clone https://github.com/spryker-shop/b2b-demo-shop.git -b 202212.0-p2 --single-branch ./b2b-demo-shop ``` * B2C Marketplace Demo Shop ```shell - git clone https://github.com/spryker-shop/b2c-demo-marketplace.git -b 202212.0-p2 --single-branch ./b2c-demo-marketplace && \ - cd b2c-demo-marketplace + git clone https://github.com/spryker-shop/b2c-demo-marketplace.git -b 202212.0-p2 --single-branch ./ ``` * B2B Marketplace Demo Shop ```shell - git clone https://github.com/spryker-shop/b2b-demo-marketplace.git -b 202212.0-p2 --single-branch ./b2b-demo-marketplace && \ - cd b2b-demo-marketplace + git clone https://github.com/spryker-shop/b2b-demo-marketplace.git -b 202212.0-p2 --single-branch ./ ``` -3. Clone the Docker SDK: +5. Clone the Docker SDK: ```bash git clone https://github.com/spryker/docker-sdk.git --single-branch docker diff --git a/docs/scos/dev/set-up-spryker-locally/install-spryker/install/install-in-development-mode-on-windows.md b/docs/scos/dev/set-up-spryker-locally/install-spryker/install/install-in-development-mode-on-windows.md index c360854065e..e3214bb2715 100644 --- a/docs/scos/dev/set-up-spryker-locally/install-spryker/install/install-in-development-mode-on-windows.md +++ b/docs/scos/dev/set-up-spryker-locally/install-spryker/install/install-in-development-mode-on-windows.md @@ -29,7 +29,7 @@ This document describes how to install Spryker in [Development Mode](/docs/scos/ * [Install Docker prerequisites on Windows with WSL2](/docs/scos/dev/set-up-spryker-locally/install-spryker/install-docker-prerequisites/install-docker-prerequisites-on-windows-with-wsl2.html). -## Clone a Demo Shop and the Docker SDK +## Install Spryker in Development mode on Windows {% info_block warningBox "Filesystems" %} @@ -49,48 +49,43 @@ Recommended: `/home/jdoe/workspace/project`. * B2C Demo Shop: - ```shell - git clone https://github.com/spryker-shop/b2c-demo-shop.git -b 202212.0-p2 --single-branch ./b2c-demo-shop && \ - cd b2c-demo-shop + ```bash + git clone https://github.com/spryker-shop/b2c-demo-shop.git -b 202212.0-p2 --single-branch ./b2c-demo-shop ``` * B2B Demo Shop: - ```shell - git clone https://github.com/spryker-shop/b2b-demo-shop.git -b 202212.0-p2 --single-branch ./b2b-demo-shop && \ - cd b2c-demo-shop + ```bash + git clone https://github.com/spryker-shop/b2b-demo-shop.git -b 202212.0-p2 --single-branch ./b2b-demo-shop ``` - * B2C Marketplace Demo Shop +5. Depending on the Demo Shop you've cloned, navigate into the cloned folder: + + * B2C Demo Shop: - ```shell - git clone https://github.com/spryker-shop/b2c-demo-marketplace.git -b 202212.0-p2 --single-branch ./b2c-demo-marketplace && \ - cd b2c-demo-marketplace + ```bash + cd b2c-demo-shop ``` - * B2B Marketplace Demo Shop + * B2B Demo Shop: - ```shell - git clone https://github.com/spryker-shop/b2b-demo-marketplace.git -b 202212.0-p2 --single-branch ./b2b-demo-marketplace && \ - cd b2b-demo-marketplace + ```bash + cd b2b-demo-shop ``` {% info_block warningBox "Verification" %} -Make sure that you are in the Demo Shop's folder by running the `pwd` command. +Make sure that you are in the correct folder by running the `pwd` command. {% endinfo_block %} -5. Clone the Docker SDK: +6. Clone the Docker SDK: ```bash git clone https://github.com/spryker/docker-sdk.git --single-branch docker ``` -## Configure and start the instance - - -1. In `{shop_name}/docker/context/php/debug/etc/php/debug.conf.d/69-xdebug.ini`, set `xdebug.remote_host` and `xdebug.client_host` to `host.docker.internal`: +7. In `{shop_name}/docker/context/php/debug/etc/php/debug.conf.d/69-xdebug.ini`, set `xdebug.remote_host` and `xdebug.client_host` to `host.docker.internal`: ```text ... @@ -99,13 +94,13 @@ xdebug.remote_host=host.docker.internal xdebug.client_host=host.docker.internal ``` -2. Add your user to the `docker` group: +8. Add your user to the `docker` group: ```bash sudo usermod -aG docker $USER ``` -3. Bootstrap local docker setup: +9. Bootstrap local docker setup: ```bash docker/sdk bootstrap deploy.dev.yml @@ -117,7 +112,7 @@ Once you finish the setup, you don't need to run `bootstrap` to start the instan {% endinfo_block %} -4. Update the hosts file based on the output of the previous step: +10. Update the hosts file based on the output of the previous step: 1. Open the Start menu. 2. In the search field, enter `Notepad`. 3. Right-click **Notepad** and select **Run as administrator**. @@ -137,7 +132,7 @@ Once you finish the setup, you don't need to run `bootstrap` to start the instan 9. Click **File > Save**. 10. Close the file. -5. Build and start the instance: +11. Build and start the instance: ```bash docker/sdk up diff --git a/docs/scos/dev/set-up-spryker-locally/set-up-spryker-locally.md b/docs/scos/dev/set-up-spryker-locally/set-up-spryker-locally.md index 0c033474312..531a0d48ca8 100644 --- a/docs/scos/dev/set-up-spryker-locally/set-up-spryker-locally.md +++ b/docs/scos/dev/set-up-spryker-locally/set-up-spryker-locally.md @@ -6,8 +6,6 @@ last_updated: Jun 23, 2023 redirect_from: - /docs/about-installation - /docs/scos/dev/setup/setup.html - - /docs/marketplace/dev/setup/202212.0/setup.html - - /docs/scos/dev/setup/installing-spryker-with-docker/installing-spryker-with-docker.html --- This section contains instructions for installing Spryker Cloud Commerce OS (SCCOS) locally. Local instances are used for development, demos, and experimentation purposes. To launch a live shop, [contact us](https://spryker.com/contact-us-commerce/). diff --git a/docs/scos/dev/system-requirements/202212.0/system-requirements.md b/docs/scos/dev/system-requirements/202212.0/system-requirements.md index 05f7a78839a..c5bfe2a20f4 100644 --- a/docs/scos/dev/system-requirements/202212.0/system-requirements.md +++ b/docs/scos/dev/system-requirements/202212.0/system-requirements.md @@ -26,7 +26,6 @@ redirect_from: - /v4/docs/en/supported-browsers - /docs/scos/dev/set-up-spryker-locally/system-requirements.html - /docs/scos/dev/set-up-spryker-locally/installing-spryker-with-development-virtual-machine/devvm-system-requirements.html -- /docs/marketplace/dev/setup/202212.0/system-requirements.html --- | REQUIREMENT | VALUE | |-------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -44,22 +43,3 @@ redirect_from: | npm | Version >= 8.0.0 | | Intranet | Back Office application (Zed) must be secured in an Intranet (using VPN, Basic Auth, IP Allowlist or DMZ.) | | Available languages | Spryker is available in the following languages:
  • German
  • English
Spryker offers full UTF-8 left-to-right language support. | - - -## Spryker Marketplace system requirements - -| OPERATING SYSTEM | NATIVE: LINUX-ONLY THROUGH VM: MACOS AND MS WINDOWS | -|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Web Server | NginX—preferred. But any webserver which supports PHP will work such as lighttpd, Apache, Cherokee. | -| Databases | Depending on the project, one of the databases: MariaDB >= 10.4—preferred, PostgreSQL >=9.6, or MySQL >=5.7. | -| PHP | Spryker supports PHP `>=8.0` with the following extensions: `curl`, `json`, `mysql`, `pdo-sqlite`, `sqlite3`, `gd`, `intl`, `mysqli`, `pgsql`, `ssh2`, `gmp`, `mcrypt`, `pdo-mysql`, `readline`, `twig`, `imagick`, `memcache`, `pdo-pgsql`, `redis`, `xml`, `bz2`, `mbstring`. For details about the supported PHP versions, see [Supported Versions of PHP](/docs/scos/user/intro-to-spryker/whats-new/supported-versions-of-php.html). | -| SSL | For production systems, a valid security certificate is required for HTTPS. | -| Redis | Version >=3.2, >=5.0 | -| Elasticsearch | Version 6.*x* or 7.*x* | -| RabbitMQ | Version 3.6+ | -| Jenkins (for cronjob management) | Version 1.6.*x* or 2.*x* | -| Graphviz (for statemachine visualization) | 2.*x* | -| Symfony | Version >= 4.0 | -| Node.js | Version >= 16.0.0 | -| Intranet | Back Office application (Zed) must be secured in an Intranet (using VPN, Basic Auth, IP Allowlist, and DMZ) | -| Spryker Commerce OS | Version >= {{page.version}} | diff --git a/docs/scos/dev/system-requirements/202304.0/system-requirements.md b/docs/scos/dev/system-requirements/202304.0/system-requirements.md index e006769ac3f..d9be1c09d6e 100644 --- a/docs/scos/dev/system-requirements/202304.0/system-requirements.md +++ b/docs/scos/dev/system-requirements/202304.0/system-requirements.md @@ -43,22 +43,3 @@ redirect_from: | npm | Version >= 9.0.0 | | Intranet | Back Office application (Zed) must be secured in an Intranet (using VPN, Basic Auth, IP allowlist, or DMZ). | | Available languages | Spryker is available in the following languages:
  • German
  • English
Spryker offers full UTF-8 left-to-right language support. | - - -## Spryker Marketplace system requirements - -| OPERATING SYSTEM | NATIVE: LINUXONLY tHROUGH VM: MACOS AND MS WINDOWS | -|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Web Server | NginX—preferred. But any webserver which supports PHP will work such as lighttpd, Apache, Cherokee. | -| Databases | Depending on the project, one of the databases: MariaDB >= 10.4—preferred, PostgreSQL >=9.6, or MySQL >=5.7. | -| PHP | Spryker supports PHP `>=8.0` with the following extensions: `curl`, `json`, `mysql`, `pdo-sqlite`, `sqlite3`, `gd`, `intl`, `mysqli`, `pgsql`, `ssh2`, `gmp`, `mcrypt`, `pdo-mysql`, `readline`, `twig`, `imagick`, `memcache`, `pdo-pgsql`, `redis`, `xml`, `bz2`, `mbstring`. For details about the supported PHP versions, see [Supported Versions of PHP](/docs/scos/user/intro-to-spryker/whats-new/supported-versions-of-php.html). | -| SSL | For production systems, a valid security certificate is required for HTTPS. | -| Redis | Version >=3.2, >=5.0 | -| Elasticsearch | Version 6.*x* or 7.*x* | -| RabbitMQ | Version 3.6+ | -| Jenkins (for cronjob management) | Version 1.6.*x* or 2.*x* | -| Graphviz (for statemachine visualization) | 2.*x* | -| Symfony | Version >= 4.0 | -| Node.js | Version >= 18.0.0 | -| Intranet | Back Office application (Zed) must be secured in an Intranet (using VPN, Basic Auth, IP Allowlist, and DMZ) | -| Spryker Commerce OS | Version >= {{page.version}} | diff --git a/docs/scos/dev/technical-enhancement-integration-guides/integrate-multi-database-logic.md b/docs/scos/dev/technical-enhancement-integration-guides/integrate-multi-database-logic.md index f6a2cfc0e81..b924ba8c88c 100644 --- a/docs/scos/dev/technical-enhancement-integration-guides/integrate-multi-database-logic.md +++ b/docs/scos/dev/technical-enhancement-integration-guides/integrate-multi-database-logic.md @@ -28,8 +28,8 @@ regions: name: Spryker No-Reply email: no-reply@spryker.local databases: - eu-region-db-one: - eu-region-db-two: + eu-region-db-de: + eu-region-db-at: ... ``` diff --git a/docs/scos/dev/the-docker-sdk/202212.0/configure-services.md b/docs/scos/dev/the-docker-sdk/202212.0/configure-services.md index 4953e31903f..b00ec12f38e 100644 --- a/docs/scos/dev/the-docker-sdk/202212.0/configure-services.md +++ b/docs/scos/dev/the-docker-sdk/202212.0/configure-services.md @@ -72,7 +72,7 @@ When configuring a service, you need to define its version. The Docker SDK suppo | | | mariadb-10.3 | ✓ | | | | | mariadb-10.4 | ✓ | | | | | mariadb-10.5 | ✓ | | -| broker | rabbitmq | 3.7 | | | +| broke | rabbitmq | 3.7 | | | | | | 3.8 | ✓ | | | | | 3.9 | ✓ | | | session | redis | 5.0 | ✓ | | diff --git a/docs/scos/dev/the-docker-sdk/202212.0/the-docker-sdk.md b/docs/scos/dev/the-docker-sdk/202212.0/the-docker-sdk.md index 56cf95ed2a1..c26cc34eadc 100644 --- a/docs/scos/dev/the-docker-sdk/202212.0/the-docker-sdk.md +++ b/docs/scos/dev/the-docker-sdk/202212.0/the-docker-sdk.md @@ -238,7 +238,7 @@ To extend Docker/sdk, you can do the following: ``` This approach is compatible with SCCOS, but provides limited customization possibilities. -- To introduce "mocks" for development and CI/CD testing, you can use the [Docker-compose extension](https://docs.docker.com/compose/compose-file/11-extension/): +- To introduce "mocks" for development and CI/CD testing, you can use the [Docker-compose extension](https://docs.docker.com/compose/extends/): ``` docker: compose: diff --git a/docs/scos/dev/tutorials-and-howtos/howtos/about-howtos.md b/docs/scos/dev/tutorials-and-howtos/howtos/about-howtos.md index fb71a90cda9..426d7913f53 100644 --- a/docs/scos/dev/tutorials-and-howtos/howtos/about-howtos.md +++ b/docs/scos/dev/tutorials-and-howtos/howtos/about-howtos.md @@ -34,7 +34,7 @@ HowTos are simple step-by-step instructions to guide you through the process of -**Glue API HowTos** provide guides and instructions for tasks related to [Spryker Glue Rest API](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/glue-rest-api.html). These guides walk you through the following topics: +**Glue API HowTos** provide guides and instructions for tasks related to [Spryker Glue Rest API](/docs/scos/dev/glue-api-guides/{{site.version}}/glue-rest-api.html). These guides walk you through the following topics: * [Configuring visibility of the included section](/docs/scos/dev/tutorials-and-howtos/howtos/glue-api-howtos/configuring-visibility-of-the-included-section.html) * [Configuring Glue for cross-origin requests](/docs/scos/dev/tutorials-and-howtos/howtos/glue-api-howtos/configuring-glue-for-cross-origin-requests.html) diff --git a/docs/scos/dev/tutorials-and-howtos/howtos/glue-api-howtos/glue-api-howtos.md b/docs/scos/dev/tutorials-and-howtos/howtos/glue-api-howtos/glue-api-howtos.md index d1206c01a1d..c40ff8aed60 100644 --- a/docs/scos/dev/tutorials-and-howtos/howtos/glue-api-howtos/glue-api-howtos.md +++ b/docs/scos/dev/tutorials-and-howtos/howtos/glue-api-howtos/glue-api-howtos.md @@ -21,10 +21,10 @@ redirect_from: - /v2/docs/en/about-glue-api-howtos related: - title: Glue REST API - link: docs/scos/dev/glue-api-guides/page.version/old-glue-infrastructure/glue-rest-api.html + link: docs/scos/dev/glue-api-guides/page.version/glue-rest-api.html --- -Glue API HowTo tutorials provide guides and instructions for tasks related to [Spryker Glue Rest API](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/glue-rest-api.html). +Glue API HowTo tutorials provide guides and instructions for tasks related to [Spryker Glue Rest API](/docs/scos/dev/glue-api-guides/{{site.version}}/glue-rest-api.html). From these guides, you can learn how to perform the following tasks: diff --git a/docs/pbc/all/push-notification/202400.0/unified-commerce/push-notification-feature-overview.md b/docs/scos/user/features/202304.0/push-notification-feature-overview.md similarity index 98% rename from docs/pbc/all/push-notification/202400.0/unified-commerce/push-notification-feature-overview.md rename to docs/scos/user/features/202304.0/push-notification-feature-overview.md index ab65aea1d02..66ca7f3269f 100644 --- a/docs/pbc/all/push-notification/202400.0/unified-commerce/push-notification-feature-overview.md +++ b/docs/scos/user/features/202304.0/push-notification-feature-overview.md @@ -3,8 +3,6 @@ title: Push Notification feature overview description: The Push Notifications feature lets you receive push notifications last_updated: Feb 2, 2023 template: concept-topic-template -redirect_from: - - /docs/scos/user/features/202304.0/push-notification-feature-overview.html --- The *Push Notification* feature lets users subscribe to the web push notifications, which are sent from the server to all registered subscriptions. @@ -47,5 +45,4 @@ The following sequence diagram shows how sending and receiving push notification |INSTALLATION GUIDES | |---------| -| [Install the Push Notification feature](/docs/pbc/all/push-notification/{{page.version}}/unified-commerce/install-and-upgrade/install-the-push-notification-feature.html) | - \ No newline at end of file +| [Install the Push Notification feature](/docs/scos/dev/feature-integration-guides/{{page.version}}/install-the-push-notification-feature.html) | diff --git a/docs/scos/user/intro-to-spryker/b2b-suite.md b/docs/scos/user/intro-to-spryker/b2b-suite.md index b7a5f94b47d..66bfbb7ab5f 100644 --- a/docs/scos/user/intro-to-spryker/b2b-suite.md +++ b/docs/scos/user/intro-to-spryker/b2b-suite.md @@ -65,7 +65,7 @@ The Spryker B2B Suite is a collection of ready-to-use B2B-specific features. Of - [Reorder](/docs/pbc/all/customer-relationship-management/{{site.version}}/reorder-feature-overview.html) - [Shipment](/docs/scos/user/features/{{site.version}}/shipment-feature-overview.html) - [Agent Assist](/docs/pbc/all/user-management/{{site.version}}/agent-assist-feature-overview.html) -- [Payments](/docs/pbc/all/payment-service-provider/{{site.version}}/spryker-pay/base-shop/payments-feature-overview.html) +- [Payments](/docs/pbc/all/payment-service-provider/{{site.version}}/payments-feature-overview.html) - [Checkout](/docs/scos/user/features/{{site.version}}/checkout-feature-overview/checkout-feature-overview.html) - [Mailing & Notifications](/docs/pbc/all/emails/{{site.version}}/emails.html) diff --git a/docs/scos/user/intro-to-spryker/b2c-suite.md b/docs/scos/user/intro-to-spryker/b2c-suite.md index 190c9442c09..fbaca67f655 100644 --- a/docs/scos/user/intro-to-spryker/b2c-suite.md +++ b/docs/scos/user/intro-to-spryker/b2c-suite.md @@ -51,7 +51,7 @@ The Spryker B2С Suite is a collection of ready-to-use B2С-specific features. O - [Reorder](/docs/pbc/all/customer-relationship-management/{{site.version}}/reorder-feature-overview.html) - [Shipment](/docs/scos/user/features/{{site.version}}/shipment-feature-overview.html) - [Agent Assist](/docs/pbc/all/user-management/{{site.version}}/agent-assist-feature-overview.html) -- [Payments](/docs/pbc/all/payment-service-provider/{{site.version}}/spryker-pay/base-shop/payments-feature-overview.html) +- [Payments](/docs/pbc/all/payment-service-provider/{{site.version}}/payments-feature-overview.html) - [Gift cards](/docs/pbc/all/gift-cards/{{site.version}}/gift-cards.html) - [Checkout](/docs/scos/user/features/{{site.version}}/checkout-feature-overview/checkout-feature-overview.html) diff --git a/docs/scos/user/intro-to-spryker/docs-release-notes.md b/docs/scos/user/intro-to-spryker/docs-release-notes.md index 7f045132293..ed1eedb0930 100644 --- a/docs/scos/user/intro-to-spryker/docs-release-notes.md +++ b/docs/scos/user/intro-to-spryker/docs-release-notes.md @@ -10,27 +10,27 @@ In June 2023, we have added and updated the following pages: ### New pages - [Security release notes 202306.0](/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202306.0/security-release-notes-202306.0.html). - [Oryx: Presets](/docs/scos/dev/front-end-development/202212.0/oryx/oryx-presets.html): Learn how you can use presets to install predefined applications. -- [Service Points feature integration guide](/docs/pbc/all/service-points/202400.0/unified-commerce/install-the-service-points-feature.html). -- [Shipment + Service Points feature integration guide](/docs/pbc/all/carrier-management/202400.0/unified-commerce/install-and-upgrade/install-the-shipment-service-points-feature.html). +- [Service Points feature integration guide](/docs/scos/dev/feature-integration-guides/202304.0/install-the-service-points-feature.html). +- [Shipment + Service Points feature integration guide](/docs/scos/dev/feature-integration-guides/202304.0/install-the-shipment-service-points-feature.html). - [Backend API - Glue JSON:API Convention integration](/docs/scos/dev/feature-integration-guides/202304.0/glue-api/install-backend-api-glue-json-api-convention.html). - Documentation on shipment data import: - - [File details - shipment_method_shipment_type.csv](/docs/pbc/all/carrier-management/202400.0/unified-commerce/import-and-export-data/file-details-shipment-method-shipment-type.csv.html). - - [File details - shipment_type_store.csv](/docs/pbc/all/carrier-management/202400.0/unified-commerce/import-and-export-data/file-details-shipment-type-store.csv.html). - - [File details - shipment_type.csv](/docs/pbc/all/carrier-management/202400.0/unified-commerce/import-and-export-data/file-details-shipment-type.csv.html). + - [File details - shipment_method_shipment_type.csv](/docs/pbc/all/carrier-management/202304.0/base-shop/import-and-export-data/file-details-shipment-method-shipment-type.csv.html). + - [File details - shipment_type_store.csv](/docs/pbc/all/carrier-management/202304.0/base-shop/import-and-export-data/file-details-shipment-type-store.csv.html). + - [File details - shipment_type.csv](/docs/pbc/all/carrier-management/202304.0/base-shop/import-and-export-data/file-details-shipment-type.csv.html). - [Migration guide - Upgrade Node.js to v18 and npm to v9](/docs/scos/dev/front-end-development/202212.0/migration-guide-upgrade-nodejs-to-v18-and-npm-to-v9.html). - [Spryker documentation style guide](/docs/scos/user/intro-to-spryker/contribute-to-the-documentation/spryker-documentation-style-guide/spryker-documentation-style-guide.html): - [Examples](/docs/scos/user/intro-to-spryker/contribute-to-the-documentation/spryker-documentation-style-guide/examples.html). - [Spelling](/docs/scos/user/intro-to-spryker/contribute-to-the-documentation/spryker-documentation-style-guide/spelling.html). ## Updated pages -- [Shipment feature integration guide](/docs/pbc/all/carrier-management/202400.0/unified-commerce/install-and-upgrade/install-the-shipment-feature.html). +- [Shipment feature integration guide](/docs/pbc/all/carrier-management/202304.0/base-shop/install-and-upgrade/install-the-shipment-feature.html). - [Environments overview](/docs/cloud/dev/spryker-cloud-commerce-os/environments-overview.html). -- [Spryker Core Back Office + Warehouse User Management feature integration guide](/docs/pbc/all/back-office/202400.0/unified-commerce/install-and-upgrade/install-the-spryker-core-back-office-warehouse-user-management-feature.html). -- [Warehouse User Management feature integration guide](/docs/pbc/all/warehouse-management-system/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-user-management-feature.html). -- [Warehouse picking feature integration guide](/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-feature.html). -- [Push notification feature integration guide](/docs/pbc/all/push-notification/202400.0/unified-commerce/install-and-upgrade/install-the-push-notification-feature.html). -- [Product offer shipment feature integration guide](/docs/pbc/all/offer-management/202400.0/unified-commerce/install-and-upgrade/install-the-product-offer-shipment-feature.html). -- [Service Points feature integration guide](/docs/pbc/all/service-points/202400.0/unified-commerce/install-the-service-points-feature.html). +- [Spryker Core Back Office + Warehouse User Management feature integration guide](/docs/pbc/all/back-office/202304.0/install-spryker-core-back-office-warehouse-user-management-feature.html). +- [Warehouse User Management feature integration guide](/docs/pbc/all/warehouse-management-system/202304.0/base-shop/install-and-upgrade/install-the-warehouse-user-management-feature.html). +- [Warehouse picking feature integration guide](/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-feature.html). +- [Push notification feature integration guide](/docs/scos/dev/feature-integration-guides/202304.0/install-the-push-notification-feature.html). +- [Product Offer Shipment feature integration guide](/docs/scos/dev/feature-integration-guides/202304.0/install-the-product-offer-shipment-feature.html). +- [Service Points feature integration guide](/docs/scos/dev/feature-integration-guides/202304.0/install-the-service-points-feature.html). - [Additional logic in dependency provider](/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/additional-logic-in-dependency-provider.html): Resolve issues with additional logic in dependency provider. - [Dead code checker](/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/dead-code-checker.html): Check if there is dead code that extends core classes in your project. - [Minimum allowed shop version](/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/minimum-allowed-shop-version.html): Learn how to resolve issues with project upgradability when your projects contains old package dependencies that are already not supported. @@ -116,20 +116,20 @@ In April 2023, we have added and updated the following pages: - [Connect the Upgrader to a project self-hosted with GitLab](/docs/scu/dev/onboard-to-spryker-code-upgrader/connect-spryker-ci-to-a-project-self-hosted-with-gitlab.html): Learn how to connect the Spryker Code Upgrader manually using a Gitlab CE/EE access token. - [Updating Spryker](/docs/scos/dev/updating-spryker/updating-spryker.html#spryker-product-structure): Learn how and when to update your Spryker project. - Warehouse picking feature integration guides: - - [Install the Warehouse picking feature](/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-feature.html) + - [Install the Warehouse picking feature](/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-feature.html) - [Install the Picker user login feature](/docs/scos/dev/feature-integration-guides/202304.0/install-the-picker-user-login-feature.html) - - [Install the Warehouse picking + Inventory Management feature](/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-inventory-management-feature.html) + - [Install the Warehouse picking + Inventory Management feature](/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-inventory-management-feature.html) - [Install the Warehouse picking + Order Management feature](/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-order-management-feature.html) - - [Install the Warehouse picking + Product feature](/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-order-management-feature.html) - - [Install the Warehouse picking + Shipment feature](/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-shipment-feature.html) - - [Install the Warehouse picking + Spryker Core Back Office feature](/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-spryker-core-back-office-feature.html) + - [Install the Warehouse picking + Product feature](/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-product-feature.html) + - [Install the Warehouse picking + Shipment feature](/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-shipment-feature.html) + - [Install the Warehouse picking + Spryker Core Back Office feature](/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-spryker-core-back-office-feature.html) - [Security release notes 202304.0](/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202304.0/security-release-notes-202304.0.html) - [Releases vs Customization types](/docs/sdk/dev/releases-vs-customization-types.html): Learn about the customization strategies and release types you can use to integrate releases and customize your project. ### Updated pages -- [Install the Spryker Core Back Office + Warehouse User Management feature](/docs/pbc/all/back-office/202400.0/unified-commerce/install-and-upgrade/install-the-spryker-core-back-office-warehouse-user-management-feature.html) +- [Install the Spryker Core Back Office + Warehouse User Management feature](/docs/pbc/all/back-office/202304.0/install-spryker-core-back-office-warehouse-user-management-feature.html) - [Install the Spryker Core Back Office feature](/docs/pbc/all/back-office/202304.0/install-the-spryker-core-back-office-feature.html) - [Product + Category feature integration](/docs/pbc/all/product-information-management/202304.0/base-shop/install-and-upgrade/install-features/install-the-product-category-feature.html) -- [Install the Shipment feature](/docs/pbc/all/carrier-management/202400.0/unified-commerce//install-and-upgrade/install-the-shipment-feature.html) +- [Install the Shipment feature](/docs/pbc/all/carrier-management/202304.0/base-shop/install-and-upgrade/install-the-shipment-feature.html) -For more details about the latest additions and updates to the Spryker docs, refer to the [docs release notes page on GitHub](https://github.com/spryker/spryker-docs/releases). +For more details on the latest additions and updates to the Spryker docs, refer to the [docs release notes page on GitHub](https://github.com/spryker/spryker-docs/releases). diff --git a/docs/scos/user/intro-to-spryker/intro-to-spryker.md b/docs/scos/user/intro-to-spryker/intro-to-spryker.md index 7d0a198a84f..72ed4e3b769 100644 --- a/docs/scos/user/intro-to-spryker/intro-to-spryker.md +++ b/docs/scos/user/intro-to-spryker/intro-to-spryker.md @@ -105,6 +105,6 @@ This documentation site contains lots of information on Spryker Commerce OS. Sel * [What's new](/docs/scos/user/intro-to-spryker/whats-new/whats-new.html): general information about Spryker, news, and release notes. * [Setup](/docs/scos/dev/set-up-spryker-locally/set-up-spryker-locally.html): installation of Spryker. * [Packaged Business Capabilities](/docs/pbc/all/pbc.html): catalogue of functionality and related guides. -* [Glue REST API](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/glue-rest-api.html): Spryker Glue REST API overview, reference, and features. +* [Glue REST API](/docs/scos/dev/glue-api-guides/{{site.version}}/glue-rest-api.html): Spryker Glue REST API overview, reference, and features. * [Developer Guides](/docs/scos/dev/developer-getting-started-guide.html): technical information and guides for developers. * [Tutorials](/docs/scos/dev/tutorials-and-howtos/tutorials-and-howtos.html): tutorials and HowTos. diff --git a/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-2018.12.0.md b/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-2018.12.0.md index f310a6d06a6..9ee460091b4 100644 --- a/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-2018.12.0.md +++ b/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-2018.12.0.md @@ -72,8 +72,8 @@ Your customers can benefit from the same shop experience with the customer accou To help you keep track of your API development, we implemented a simple command that will create a YAML file to be used in your Swagger implementation to share the progress of development in your company. **Documentation**: -* [REST API B2B Demo Shop reference](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/rest-api-b2b-reference.html). -* [REST API B2C Demo Shop reference](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/rest-api-b2c-reference.html) +* [REST API B2B Demo Shop reference](/docs/scos/dev/glue-api-guides/{{site.version}}/rest-api-b2b-reference.html). +* [REST API B2C Demo Shop reference](/docs/scos/dev/glue-api-guides/{{site.version}}/rest-api-b2c-reference.html) ## B2C API React Example ![B2C API React example](https://spryker.s3.eu-central-1.amazonaws.com/docs/About/Releases/Release+notes/Release+Notes+2018.12.0/image2.png) diff --git a/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-201903.0/release-notes-201903.0.md b/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-201903.0/release-notes-201903.0.md index a82ad429454..71a3ec5bae9 100644 --- a/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-201903.0/release-notes-201903.0.md +++ b/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-201903.0/release-notes-201903.0.md @@ -164,7 +164,7 @@ With the market showing an increasing number of marketplaces, Spryker has integr Customer payments can now be split in the background and assigned to the corresponding vendors when a client buys a product delivered by different vendors. This feature ensures customers can buy several units of the same product sold by different vendors while still going through the checkout with one single order and one single payment. -**Documentation**: [Integrating the Split-payment Marketplace payment method for Heidelpay](/docs/pbc/all/payment-service-provider/{{site.version}}/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.html). +**Documentation**: [Integrating the Split-payment Marketplace payment method for Heidelpay](/docs/pbc/all/payment-service-provider/{{site.version}}/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.html). ### Adyen Our recently finished Adyen integration covers a wide range of payment methods used both in the DACH region as well as outside of it, thus making sure customers can select the most appropriate payment method. diff --git a/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-201907.0/release-notes-201907.0.md b/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-201907.0/release-notes-201907.0.md index ce851f313c1..6ef62c85bd7 100644 --- a/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-201907.0/release-notes-201907.0.md +++ b/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-201907.0/release-notes-201907.0.md @@ -148,7 +148,7 @@ In many cases, you may decide to provide your buyers and users with alternative **Documentation**: -* [Interact with third party payment providers using Glue API](/docs/pbc/all/payment-service-provider/{{site.version}}/spryker-pay/base-shop/interact-with-third-party-payment-providers-using-glue-api.html) +* [Interact with third party payment providers using Glue API](/docs/pbc/all/payment-service-provider/{{site.version}}/interact-with-third-party-payment-providers-using-glue-api.html) * [B2B-B2C Checking Out Purchases and Getting Checkout Data](/docs/scos/dev/glue-api-guides/201907.0/checking-out/checking-out-purchases.html) Additionally, the following APIs were modified to support B2B use cases (they work now both for B2C and B2B) : @@ -260,7 +260,7 @@ We have extended our Payone module with the cash-on-delivery payment method. Thi ### Heidelpay Easycredit We have extended our existing Heidelpay module with the payment method Easycredit, which allows customers to pay via an installment plan. This can help to increase your conversion rates of more expensive products and services. -**Documentation**: [Integrating the Easy Credit payment method for Heidelpay](/docs/pbc/all/payment-service-provider/{{site.version}}/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html) +**Documentation**: [Integrating the Easy Credit payment method for Heidelpay](/docs/pbc/all/payment-service-provider/{{site.version}}/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html) ### RatePay We have extended our partner portfolio with a RatePay integration that offers 4 payment methods out-of-the-box: @@ -285,7 +285,7 @@ We now have a new integration of our new partner Episerver and their online plat ### Easycredit Direct Integration We have now a new integration of our new partner TeamBank AG and their payment method ratenkauf by easyCredit, which allows customers to pay via an installment plan. This can help to increase your conversion rates of the more expensive products and services. -**Documentation**: [Installing and configuring ratenkauf by easyCredit](/docs/pbc/all/payment-service-provider/{{site.version}}/ratenkauf-by-easycredit/install-and-configure-ratenkauf-by-easycredit.html) +**Documentation**: [Installing and configuring ratenkauf by easyCredit](/docs/pbc/all/payment-service-provider/{{site.version}}/third-party-integrations/ratenkauf-by-easycredit/install-and-configure-ratenkauf-by-easycredit.html) ### CrefoPay We now have an integration with our new payment partner CrefoPay, which will provide the following payment methods out-of-the-box including partial operations and B2B: @@ -297,7 +297,7 @@ We now have an integration with our new payment partner CrefoPay, which will pro * Sofort * Cash on Delivery -**Documentation**: [CrefoPay](/docs/pbc/all/payment-service-provider/{{site.version}}/crefopay/install-and-configure-crefopay.html) +**Documentation**: [CrefoPay](/docs/pbc/all/payment-service-provider/{{site.version}}/third-party-integrations/crefopay/install-and-configure-crefopay.html) *** ## Technical Enhancements diff --git a/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202306.0/security-release-notes-202306.0.md b/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202306.0/security-release-notes-202306.0.md index a6b0b2cbca0..c252b8254c6 100644 --- a/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202306.0/security-release-notes-202306.0.md +++ b/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202306.0/security-release-notes-202306.0.md @@ -174,10 +174,6 @@ console transfer:generate 8. Add configuration to `config/Shared/config_default.php`: ```php -use Spryker\Shared\SecurityBlockerBackoffice\SecurityBlockerBackofficeConstants; -use Spryker\Shared\SecurityBlockerStorefrontAgent\SecurityBlockerStorefrontAgentConstants; -use Spryker\Shared\SecurityBlockerStorefrontCustomer\SecurityBlockerStorefrontCustomerConstants; - // >>> Redis Security Blocker $config[SecurityBlockerConstants::SECURITY_BLOCKER_REDIS_PERSISTENT_CONNECTION] = true; $config[SecurityBlockerConstants::SECURITY_BLOCKER_REDIS_SCHEME] = 'tcp://'; @@ -582,7 +578,7 @@ composer update spryker/event-dispatcher spryker/glue-backend-api-application sp 2. Register `Spryker\Glue\Http\Plugin\EventDispatcher\CacheControlHeaderEventDispatcherPlugin` in `Pyz\Glue\EventDispatcher::getEventDispatcherPlugins()`. -3. Register `Spryker\Glue\GlueBackendApiApplication\Plugin\GlueApplication\StrictTransportSecurityHeaderResponseFormatterPlugin` in `Pyz\Glue\GlueBackendApiApplication\GlueBackendApiApplicationDependencyProvider::getResponseFormatterPlugins()`. +3. Register `Spryker\Glue\GlueBackendApiApplication\Plugin\GlueApplication\StrictTransportSecurityHeaderResponseFormatterPlugin` in `Pyz\Glue\GlueBackendApiApplication::getResponseFormatterPlugins()`. 4. In `Pyz\Glue\GlueStorefrontApiApplication\GlueStorefrontApiApplicationDependencyProvider::getResponseFormatterPlugins()`, register `Spryker\Glue\GlueStorefrontApiApplication\Plugin\GlueApplication\StrictTransportSecurityHeaderResponseFormatterPlugin`. @@ -623,17 +619,17 @@ public function getSecurityHeaders(): array use Spryker\Shared\Http\HttpConstants; $config[HttpConstants::YVES_HTTP_CACHE_CONTROL_CONFIG] = [ - 'public' => true, - 'max-age' => 3600, + 'public' = true, + 'max-age' = 3600, ]; $config[HttpConstants::ZED_HTTP_CACHE_CONTROL_CONFIG] = [ - 'public' => true, - 'max-age' => 3600, + 'public' = true, + 'max-age' = 3600, ]; $config[HttpConstants::GLUE_HTTP_CACHE_CONTROL_CONFIG] = [ - 'public' => true, - 'max-age' => 3600, + 'public' = true, + 'max-age' = 3600, ]; ``` diff --git a/docs/scos/user/intro-to-spryker/support/getting-support.md b/docs/scos/user/intro-to-spryker/support/getting-support.md index 87062d0ea11..3fe11c922ac 100644 --- a/docs/scos/user/intro-to-spryker/support/getting-support.md +++ b/docs/scos/user/intro-to-spryker/support/getting-support.md @@ -21,7 +21,6 @@ redirect_from: - /v1/docs/en/getting-support - /v6/docs/getting-support - /v6/docs/en/getting-support - - /docs/scos/user/intro-to-spryker/support/handling-new-feature-requests.html related: - title: How to use the Support Portal link: docs/scos/user/intro-to-spryker/support/how-to-use-the-support-portal.html @@ -29,7 +28,7 @@ related: link: docs/scos/user/intro-to-spryker/support/how-spryker-support-works.html - title: How to get the most out of Spryker Support link: docs/scos/user/intro-to-spryker/support/how-to-get-the-most-out-of-spryker-support.html - + --- If you need technical help for issues that can't be resolved with our documentation, you can always count on our support team. diff --git a/_drafts/deprecated/handling-new-feature-requests.md b/docs/scos/user/intro-to-spryker/support/handling-new-feature-requests.md similarity index 100% rename from _drafts/deprecated/handling-new-feature-requests.md rename to docs/scos/user/intro-to-spryker/support/handling-new-feature-requests.md diff --git a/docs/scos/user/intro-to-spryker/support/handling-security-issues.md b/docs/scos/user/intro-to-spryker/support/handling-security-issues.md index f0c4c3a0dbf..6a1f967e46e 100644 --- a/docs/scos/user/intro-to-spryker/support/handling-security-issues.md +++ b/docs/scos/user/intro-to-spryker/support/handling-security-issues.md @@ -28,7 +28,7 @@ If you find a security issue in a Spryker product, please report it to us. ## Reporting a security issue -Do not use public Slack channels or other public channels to report a security issue. Instead, send an e-mail to [security@spryker.com](mailto:security@spryker.com) in English and include system configuration details, reproduction steps, and received results. Your email will be forwarded to our internal team and we will confirm that we received your email and ask for more details if needed. +Do not use public AHA Ideas, public Slack channels, or other public channels to report a security issue. Instead, send an e-mail to [security@spryker.com](mailto:security@spryker.com) in English and include system configuration details, reproduction steps, and received results. Your email will be forwarded to our internal team and we will confirm that we received your email and ask for more details if needed. ## How we are handling security reports diff --git a/docs/scos/user/intro-to-spryker/supported-browsers.md b/docs/scos/user/intro-to-spryker/supported-browsers.md index ca92725c9c6..aa0f32a6bb7 100644 --- a/docs/scos/user/intro-to-spryker/supported-browsers.md +++ b/docs/scos/user/intro-to-spryker/supported-browsers.md @@ -1,22 +1,15 @@ --- title: Supported browsers -description: This document lists browsers supported by Spryker Cloud Commerce OS. +description: This document lists browsers supported by Spryker Commerce OS. last_updated: Jun 8, 2022 template: howto-guide-template redirect_from: - /docs/scos/dev/set-up-spryker-locally/installing-spryker-with-development-virtual-machine/scos-supported-browsers.html - /docs/scos/dev/system-requirements/202212.0/scos-supported-browsers.html - - /docs/marketplace/dev/setup/202212.0/marketplace-supported-browsers.html --- -Spryker Cloud Commerce OS supports the following browsers for all frontend-related projects and products—[B2B Demo Shop](/docs/scos/user/intro-to-spryker/b2b-suite.html), [B2C Demo Shop](/docs/scos/user/intro-to-spryker/b2c-suite.html), [Master Suite](/docs/scos/user/intro-to-spryker/master-suite.html): +The Spryker Commerce OS supports the following browsers for all frontend-related projects and products—[B2B Demo Shop](/docs/scos/user/intro-to-spryker/b2b-suite.html), [B2C Demo Shop](/docs/scos/user/intro-to-spryker/b2c-suite.html), [Master Suite](/docs/scos/user/intro-to-spryker/master-suite.html): | DESKTOP: BACK OFFICE AND STOREFRONT | MOBILE: STOREFRONT | TABLET: STOREFRONT | | --- | --- | --- | | *Browsers*:
  • Windows, macOS: Chrome (latest version)
  • Windows: Firefox (latest version)
  • Windows: Edge (latest version)
  • macOS: Safari (latest version)
*Windows versions*:
  • Windows 10
  • Windows 7
*macOS versions*:
  • Catalina 10 or later
*Screen resolutions*:
  • 1024-1920 width
|*Browsers*:
  • iOS: Safari
  • Android: Chrome
*Screen resolutions*:
  • 360x640—for example, Samsung Galaxy S8 or S9
  • 375x667—for example, iPhone 7 or 8
  • iPhone X, Xs, Xr
*Android versions*:
  • 8.0
*iOS versions*:
  • iOS 13 or later
| *Browsers*:
  • iOS: Safari
  • Android: Chrome
*iOS versions*:
  • iOS 13
*Screen resolutions*:
  • 1024x703—for example, iPad Air
| - -Spryker Marketplace supports the following browsers: - -| DESKTOP (MARKETPLACE AND MERCHANT PORTAL) | MOBILE (MARKETPLACE ONLY) | TABLET (MARKETPLACE AND MERCHANT PORTAL) | -| --- | --- | --- | -| *Browsers*:
  • Windows, macOS: Chrome (latest version)
  • Windows: Firefox (latest version)
  • Windows: Edge (latest version)
  • macOS: Safari (latest version)
*Windows versions*:
  • Windows 10
  • Windows 7
*macOS versions*:
  • Catalina 10 or later
*Screen resolutions*:
  • 1024-1920 width
| *Browsers*:
  • iOS: Safari
  • Android: Chrome
*Screen resolutions*:
  • 360x640—for example, Samsung Galaxy S8 or S9)
  • 375x667—for example, iPhone 7 or 8
  • iPhone X, Xs, Xr
*Android versions*:
  • 8.0
*iOS versions*:
  • iOS 13 or later
| *Browsers*:
  • iOS: Safari
  • Android: Chrome
*iOS versions*:
  • iOS 13
*Screen resolutions*:
  • 1024x703—for example, iPad Air
| diff --git a/docs/scos/user/intro-to-spryker/whats-new/security-updates.md b/docs/scos/user/intro-to-spryker/whats-new/security-updates.md index 64f84abc44b..3eeab10bb3a 100644 --- a/docs/scos/user/intro-to-spryker/whats-new/security-updates.md +++ b/docs/scos/user/intro-to-spryker/whats-new/security-updates.md @@ -1,7 +1,7 @@ --- title: Security updates -description: Learn about the security updates that happened to the Spryker Commerce OS. -last_updated: Jul 12, 2023 +description: This article contains information about the security updates that happened to the Spryker Commerce OS. +last_updated: Jun 16, 2021 template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/security-updates originalArticleId: 52f64151-dd88-406c-8408-9c08d9c0bb2d @@ -23,10 +23,6 @@ redirect_from: - /v6/docs/security-updates - /v6/docs/en/security-updates related: - - title: Security release notes 202306.0 - link: docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202306.0/security-release-notes-202306.0.html - - title: Security release notes 202304.0 - link: docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202304.0/security-release-notes-202304.0.html - title: Security release notes 202212.0 link: docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202212.0/security-release-notes-202212.0.html - title: Security release notes 202108.0 diff --git a/docs/scu/dev/onboard-to-spryker-code-upgrader/prepare-a-project-for-spryker-code-upgrader.md b/docs/scu/dev/onboard-to-spryker-code-upgrader/prepare-a-project-for-spryker-code-upgrader.md index cb24278475c..334fae59f95 100644 --- a/docs/scu/dev/onboard-to-spryker-code-upgrader/prepare-a-project-for-spryker-code-upgrader.md +++ b/docs/scu/dev/onboard-to-spryker-code-upgrader/prepare-a-project-for-spryker-code-upgrader.md @@ -26,6 +26,14 @@ Upgrades are provided as PRs that are automatically created in a project’s rep Currently, the Upgrader supports GitHub, GitLab and Azure. If you want to use a different version control system, [contact support](https://spryker.force.com/support/s/), so we can implement its support in future. +## Optional: Implement headless design + +The Upgrader does not evaluate frontend customizations. You can either move to headless or apply frontend upgrades manually. + +## Optional: Ensure your code is compliant with the supported extensions scenarios. + +To ensure the successful delivery of Spryker updates, we recommend using the extension points that exist in the [Keeping a project upgradable](/docs/scos/dev/guidelines/keeping-a-project-upgradable/keeping-a-project-upgradable.html). + ## Migrate to Spryker Cloud Commerce OS The Upgrader supports only projects that run on [Spryker Cloud Commerce OS (SCCOS)](/docs/cloud/dev/spryker-cloud-commerce-os/getting-started-with-the-spryker-cloud-commerce-os.html). If you are running Spryker on premises, migrate to SCCOS. From 7535c5b96a43d8a9e9f226d0067a8240f94eb42e Mon Sep 17 00:00:00 2001 From: AlexSlawinski Date: Thu, 27 Jul 2023 04:42:46 +0200 Subject: [PATCH 08/10] Revert "Revert "Sidebar fix"" This reverts commit ce1be11191fef74b5b169a63d2c384b1f8e6cdb5. --- Rakefile | 15 +- _config.yml | 6 +- _data/sidebars/cloud_dev_sidebar.yml | 5 + _data/sidebars/marketplace_dev_sidebar.yml | 119 +--- _data/sidebars/pbc_all_sidebar.yml | 648 +++++++++--------- _data/sidebars/scos_dev_sidebar.yml | 170 ++++- _data/sidebars/scos_user_sidebar.yml | 2 - .../handling-new-feature-requests.md | 0 .../install-the-checkout-glue-api.md | 6 +- .../install-the-order-management-glue-api.md | 2 +- .../install-the-payments-glue-api.md | 2 +- .../install-the-shared-carts-glue-api.md | 2 +- .../install-the-shopping-lists-glue-api.md | 2 +- ...the-product-rating-and-reviews-glue-api.md | 614 +++++++++++++++++ .../install-the-gift-cards-feature.md | 2 +- .../install-the-spryker-core-feature.md | 5 + ...nstall-the-inventory-management-feature.md | 20 +- ...management-inventory-management-feature.md | 8 +- .../install-the-picker-user-login-feature.md | 4 +- ...he-product-offer-service-points-feature.md | 2 +- ...tall-the-product-offer-shipment-feature.md | 6 +- .../install-the-push-notification-feature.md | 2 +- .../install-the-service-points-feature.md | 0 .../install-the-shipment-feature.md | 263 ++++++- ...all-the-shipment-service-points-feature.md | 4 +- ...ffice-warehouse-user-management-feature.md | 2 +- .../install-the-warehouse-picking-feature.md | 14 +- ...se-picking-inventory-management-feature.md | 6 +- ...ehouse-picking-order-management-feature.md | 6 +- ...l-the-warehouse-picking-product-feature.md | 4 +- ...-the-warehouse-picking-shipment-feature.md | 2 +- ...icking-spryker-core-back-office-feature.md | 6 +- ...l-the-warehouse-user-management-feature.md | 8 +- ...ce-product-offer-service-points-feature.md | 2 +- _internal/faq-migration-to-opensearch.md | 128 ++++ _scripts/sidebar_checker/sidebar_checker.sh | 2 +- algolia_config/_cloud_dev.yml | 2 +- algolia_config/_sdk_dev.yml | 2 +- .../app-composition-platform-installation.md | 66 +- docs/acp/user/app-manifest.md | 2 +- docs/acp/user/developing-an-app.md | 2 +- .../best-practices/best-practices.md | 1 + .../best-practises-jenkins-stability.md | 26 + ...ormance-testing-in-staging-enivronments.md | 591 +++++++++++++++- .../data-import/202108.0/marketplace-setup.md | 2 +- .../file-details-merchant-stock.csv.md | 2 +- .../file-details-product-offer-stock.csv.md | 2 +- .../data-import/202204.0/marketplace-setup.md | 2 +- .../dev/data-import/202212.0/data-import.md | 10 - .../file-details-merchant-store.csv.md | 44 -- .../202212.0/feature-integration-guides.md | 8 - ...place-dummy-payment-feature-integration.md | 8 - .../dev/front-end/202212.0/web-components.md | 2 +- .../resolving-search-engine-friendly-urls.md | 2 +- ...ing-autocomplete-and-search-suggestions.md | 4 +- docs/marketplace/dev/howtos/howtos.md | 10 - .../marketplace-supported-browsers.md | 14 - docs/marketplace/dev/setup/202212.0/setup.md | 10 - .../dev/setup/202212.0/system-requirements.md | 26 - .../dev/setup/202304.0/system-requirements.md | 28 - .../202212.0/technical-enhancement.md | 9 - ...omotions-and-discounts-feature-overview.md | 13 +- ...e-inventory-management-feature-overview.md | 2 +- ...omotions-and-discounts-feature-overview.md | 38 +- .../logging-in-to-the-merchant-portal.md | 11 +- ...fice-warehouse-user-management-feature.md} | 1 + .../retrieve-shipments-in-orders.md | 2 +- ...tails-shipment-method-shipment-type.csv.md | 2 + .../file-details-shipment-type-store.csv.md | 2 + .../file-details-shipment-type.csv.md | 2 + .../install-the-shipment-feature.md | 2 +- ...all-the-shipment-service-points-feature.md | 10 + .../check-out/update-payment-data.md | 4 +- .../manage-carts-of-registered-users.md | 2 +- ...nage-items-in-carts-of-registered-users.md | 2 +- .../manage-guest-cart-items.md | 2 +- .../manage-guest-carts/manage-guest-carts.md | 2 +- .../retrieve-customer-carts.md | 2 +- .../upgrade-the-checkoutrestapi-module.md | 2 +- .../check-out/update-payment-data.md | 4 +- .../manage-carts-of-registered-users.md | 2 +- ...nage-items-in-carts-of-registered-users.md | 2 +- .../manage-guest-cart-items.md | 2 +- .../manage-guest-carts/manage-guest-carts.md | 2 +- .../retrieve-customer-carts.md | 2 +- ...ll-the-cart-marketplace-product-feature.md | 8 + .../manage-carts-of-registered-users.md | 2 +- ...nage-items-in-carts-of-registered-users.md | 2 +- .../guest-carts/manage-guest-cart-items.md | 2 +- .../guest-carts/manage-guest-carts.md | 2 +- .../import-content-management-system-data.md | 2 +- ...eve-abstract-product-list-content-items.md | 2 +- .../retrieve-banner-content-items.md | 2 +- .../retrieve-navigation-trees.md | 2 +- .../password-management-overview.md | 2 +- ...ue-api-retrieve-business-unit-addresses.md | 2 +- .../glue-api-retrieve-business-units.md | 2 +- .../glue-api-retrieve-companies.md | 2 +- .../glue-api-retrieve-company-roles.md | 2 +- .../glue-api-retrieve-company-users.md | 2 +- .../glue-api-search-by-company-users.md | 2 +- .../glue-api-manage-customer-addresses.md | 2 +- .../customers/glue-api-manage-customers.md | 2 +- .../glue-api-retrieve-customer-orders.md | 2 +- ...-discounts-to-carts-of-registered-users.md | 2 +- ...add-items-with-discounts-to-guest-carts.md | 2 +- ...t-vouchers-in-carts-of-registered-users.md | 2 +- ...manage-discount-vouchers-in-guest-carts.md | 2 +- ...-discounts-in-carts-of-registered-users.md | 2 +- .../retrieve-discounts-in-customer-carts.md | 2 +- .../retrieve-discounts-in-guest-carts.md | 2 +- ...-discounts-to-carts-of-registered-users.md | 2 +- ...add-items-with-discounts-to-guest-carts.md | 2 +- ...t-vouchers-in-carts-of-registered-users.md | 2 +- ...manage-discount-vouchers-in-guest-carts.md | 2 +- ...-discounts-in-carts-of-registered-users.md | 2 +- .../retrieve-discounts-in-customer-carts.md | 2 +- .../retrieve-discounts-in-guest-carts.md | 2 +- ...e-promotions-discounts-feature-overview.md | 30 +- .../manage-gift-cards-of-guest-users.md | 2 +- .../manage-gift-cards-of-registered-users.md | 2 +- ...gift-cards-in-carts-of-registered-users.md | 2 +- .../retrieve-gift-cards-in-guest-carts.md | 2 +- .../manage-gift-cards-of-guest-users.md | 2 +- .../manage-gift-cards-of-registered-users.md | 2 +- ...gift-cards-in-carts-of-registered-users.md | 2 +- .../retrieve-gift-cards-in-guest-carts.md | 2 +- .../glue-api-security-and-authentication.md | 4 +- ...glue-api-authenticate-as-a-company-user.md | 2 +- .../glue-api-authenticate-as-a-customer.md | 2 +- ...lue-api-authenticate-as-an-agent-assist.md | 2 +- .../glue-api-confirm-customer-registration.md | 2 +- ...nage-agent-assist-authentication-tokens.md | 2 +- ...nage-company-user-authentication-tokens.md | 2 +- ...mer-authentication-tokens-via-oauth-2.0.md | 2 +- ...i-manage-customer-authentication-tokens.md | 2 +- .../glue-api-manage-customer-passwords.md | 2 +- .../glue-api-retrieve-protected-resources.md | 2 +- .../file-details-merchant-stock.csv.md | 2 +- ...er-customer-account-management-feature.md} | 2 +- .../install-the-merchant-switcher-feature.md} | 2 +- ...the-merchant-switcher-wishlist-feature.md} | 2 +- .../glue-api-retrieve-merchant-addresses.md | 2 +- ...lue-api-retrieve-merchant-opening-hours.md | 2 +- .../glue-api-retrieve-merchants.md | 2 +- .../create-gui-table-column-types.md} | 4 +- .../glue-api-retrieve-store-configuration.md | 2 +- .../glue-api-retrieve-product-offers.md | 2 +- ...ce-product-offer-service-points-feature.md | 8 - ...ce-product-offer-service-points-feature.md | 10 + ...he-product-offer-service-points-feature.md | 2 +- ...tall-the-product-offer-shipment-feature.md | 10 + .../base-shop/glue-api-retrieve-orders.md | 2 +- .../adyen/adyen.md | 23 +- ...-filtering-of-payment-methods-for-adyen.md | 12 +- .../adyen/install-and-configure-adyen.md | 30 +- .../adyen/integrate-adyen-payment-methods.md | 12 +- .../adyen/integrate-adyen.md | 17 +- .../afterpay/afterpay.md | 11 +- .../install-and-configure-afterpay.md | 3 +- .../afterpay/integrate-afterpay.md | 3 +- .../amazon-pay-sandbox-simulations.md | 15 +- .../amazon-pay/amazon-pay-state-machine.md | 15 +- .../amazon-pay/amazon-pay.md | 23 +- .../amazon-pay/configure-amazon-pay.md | 9 +- .../handling-orders-with-amazon-pay-api.md | 9 +- ...nd-information-about-shipping-addresses.md | 9 +- .../arvato/arvato-risk-check.md | 9 +- .../arvato/arvato-store-order.md | 8 +- .../arvato/arvato.md | 13 +- .../arvato/install-and-configure-arvato.md | 14 +- .../{third-party-integrations => }/billie.md | 1 + ...invoice-payments-to-a-preauthorize-mode.md | 7 +- .../billpay/billpay.md | 9 +- .../billpay/integrate-billpay.md | 7 +- .../braintree-performing-requests.md | 11 +- .../braintree/braintree-request-workflow.md | 11 +- .../braintree/braintree.md | 21 +- .../install-and-configure-braintree.md | 11 +- .../braintree/integrate-braintree.md | 13 +- .../computop/computop-api-calls.md | 24 +- .../computop/computop-oms-plugins.md | 25 +- .../computop/computop.md | 33 +- .../install-and-configure-computop.md | 21 +- .../computop/integrate-computop.md | 11 +- ...credit-card-payment-method-for-computop.md | 27 +- ...te-the-crif-payment-method-for-computop.md | 25 +- ...irect-debit-payment-method-for-computop.md | 25 +- ...easy-credit-payment-method-for-computop.md | 21 +- ...e-the-ideal-payment-method-for-computop.md | 17 +- ...e-paydirekt-payment-method-for-computop.md | 25 +- ...-the-paynow-payment-method-for-computop.md | 25 +- ...-the-paypal-payment-method-for-computop.md | 25 +- ...-the-sofort-payment-method-for-computop.md | 25 +- .../crefopay/crefopay-callbacks.md | 17 +- .../crefopay-capture-and-refund-processes.md | 15 +- .../crefopay/crefopay-enable-b2b-payments.md | 15 +- .../crefopay/crefopay-notifications.md | 1 + .../crefopay/crefopay-payment-methods.md | 15 +- .../crefopay/crefopay.md | 21 +- .../install-and-configure-crefopay.md | 19 +- .../crefopay/integrate-crefopay.md | 17 +- .../heidelpay/configure-heidelpay.md | 19 +- .../heidelpay/heidelpay-oms-workflow.md | 1 + .../heidelpay-workflow-for-errors.md | 19 +- .../heidelpay/heidelpay.md | 34 +- .../heidelpay/install-heidelpay.md | 19 +- .../heidelpay/integrate-heidelpay.md | 19 +- ...ard-secure-payment-method-for-heidelpay.md | 23 +- ...rect-debit-payment-method-for-heidelpay.md | 21 +- ...asy-credit-payment-method-for-heidelpay.md | 21 +- ...-the-ideal-payment-method-for-heidelpay.md | 23 +- ...ecured-b2c-payment-method-for-heidelpay.md | 21 +- ...-authorize-payment-method-for-heidelpay.md | 23 +- ...ypal-debit-payment-method-for-heidelpay.md | 23 +- ...the-sofort-payment-method-for-heidelpay.md | 23 +- ...arketplace-payment-method-for-heidelpay.md | 21 +- .../klarna/klarna-invoice-pay-in-14-days.md | 15 +- .../klarna/klarna-part-payment-flexible.md | 15 +- .../klarna/klarna-payment-workflow.md | 13 +- ...a-state-machine-commands-and-conditions.md | 13 +- .../klarna/klarna.md | 21 +- .../202212.0/payment-service-provider.md | 21 +- .../install-and-configure-payolution.md | 11 +- .../payolution/integrate-payolution.md | 17 +- ...stallment-payment-method-for-payolution.md | 15 +- ...e-invoice-payment-method-for-payolution.md | 17 +- .../payolution-performing-requests.md | 15 +- .../payolution/payolution-request-flow.md | 19 +- .../payolution/payolution.md | 17 +- .../disconnect-payone.md | 1 + .../integrate-payone.md | 1 + .../payone-integration-in-the-back-office.md | 6 +- .../manual-integration/integrate-payone.md | 23 +- .../payone-cash-on-delivery.md | 17 +- .../payone-manual-integration.md | 21 +- .../payone-paypal-express-checkout-payment.md | 5 +- .../payone-risk-check-and-address-check.md | 19 +- .../powerpay.md | 1 + ...l-and-configure-ratenkauf-by-easycredit.md | 10 +- .../integrate-ratenkauf-by-easycredit.md | 9 +- .../ratenkauf-by-easycredit.md | 9 +- ...rom-the-backend-application-for-ratepay.md | 5 +- .../integrate-payment-methods-for-ratepay.md | 12 + ...direct-debit-payment-method-for-ratepay.md | 9 +- ...-installment-payment-method-for-ratepay.md | 9 +- ...-the-invoice-payment-method-for-ratepay.md | 8 +- ...e-prepayment-payment-method-for-ratepay.md | 7 +- .../ratepay-core-module-structure-diagram.md | 5 +- .../ratepay/ratepay-facade-methods.md | 7 +- .../ratepay/ratepay-payment-workflow.md | 7 +- ...y-state-machine-commands-and-conditions.md | 9 +- .../ratepay/ratepay-state-machines.md | 2 +- .../ratepay/ratepay.md | 25 +- .../hydrate-payment-methods-for-an-order.md | 12 +- ...-file-details-payment-method-store.csv.md} | 7 +- ...import-file-details-payment-method.csv.md} | 5 +- ...ervice-provider-data-import-and-export.md} | 2 +- .../install-the-payments-feature.md | 9 +- .../install-the-payments-glue-api.md | 9 +- .../upgrade-the-payment-module.md | 17 +- ...-party-payment-providers-using-glue-api.md | 14 +- .../edit-payment-methods.md | 9 +- .../log-into-the-back-office.md | 4 +- .../view-payment-methods.md | 5 +- ...-feature-domain-model-and-relationships.md | 2 + .../base-shop}/payments-feature-overview.md | 52 +- .../install-marketplace-dummy-payment.md | 9 +- .../payment-service-provider-integrations.md | 23 - .../integrate-payment-methods-for-ratepay.md | 12 - .../unzer/whats-changed-in-unzer.md | 41 -- .../add-unzer-marketplace-credentials.md | 1 + .../add-unzer-standard-credentails.md | 0 ...redit-card-display-in-your-payment-step.md | 3 +- ...ew-payment-methods-on-the-project-level.md | 5 +- .../refund-shipping-costs.md | 1 + ...tand-payment-method-in-checkout-process.md | 1 + .../install-and-configure-unzer.md | 5 +- .../install-unzer/integrate-unzer-glue-api.md | 5 +- .../unzer/install-unzer/integrate-unzer.md | 7 +- .../unzer-domain-model-and-relationships.md | 1 + .../unzer/unzer.md | 2 + docs/pbc/all/pbc.md | 2 +- .../retrieve-abstract-product-prices.md | 2 +- .../retrieve-concrete-product-prices.md | 2 +- ...rices-when-retrieving-concrete-products.md | 2 +- .../retrieve-abstract-product-prices.md | 2 +- .../retrieve-concrete-product-prices.md | 2 +- ...rices-when-retrieving-concrete-products.md | 2 +- .../glue-api-retrieve-product-offer-prices.md | 2 +- .../import-product-data-with-a-single-file.md | 2 +- .../import-product-data-with-a-single-file.md | 2 +- ...etrieve-image-sets-of-abstract-products.md | 2 +- .../glue-api-retrieve-category-nodes.md | 2 +- .../glue-api-retrieve-category-trees.md | 2 +- .../glue-api-retrieve-concrete-products.md | 2 +- ...etrieve-image-sets-of-concrete-products.md | 2 +- .../glue-api-retrieve-sales-units.md | 2 +- .../glue-api-retrieve-alternative-products.md | 2 +- .../glue-api-retrieve-bundled-products.md | 2 +- ...-retrieve-configurable-bundle-templates.md | 2 +- .../glue-api-retrieve-measurement-units.md | 2 +- .../glue-api-retrieve-product-attributes.md | 2 +- .../glue-api-retrieve-product-labels.md | 2 +- ...feature-domain-model-and-relationships.md} | 13 +- ...l-the-marketplace-product-cart-feature.md} | 4 +- .../retrieve-abstract-products.md | 2 +- .../retrieve-concrete-products.md | 2 +- ...tal-product-management-feature-overview.md | 16 + ...tplace-product-options-feature-overview.md | 2 +- .../glue-api-retrieve-related-products.md | 2 +- .../install-the-push-notification-feature.md | 10 + .../push-notification-feature-overview.md | 5 +- .../ratings-and-reviews-data-import.md | 9 + .../manage-product-reviews-using-glue-api.md | 2 +- ...views-when-retrieving-concrete-products.md | 2 +- .../ratings-and-reviews-data-import.md | 9 + .../manage-product-reviews-using-glue-api.md | 2 +- ...views-when-retrieving-concrete-products.md | 2 +- ...the-product-rating-and-reviews-glue-api.md | 29 + .../glue-api-retrieve-return-reasons.md | 2 +- ...etails-product-search-attribute-map.csv.md | 2 +- ...le-details-product-search-attribute.csv.md | 2 +- .../search-data-import.md | 12 + ...eve-autocomplete-and-search-suggestions.md | 4 +- .../glue-api-search-the-product-catalog.md | 2 +- .../search-feature-overview.md | 4 +- .../third-party-integrations/algolia.md | 37 +- .../integrate-algolia.md | 2 +- .../precise-search-by-super-attributes.md | 117 ---- .../install-the-service-points-feature.md | 10 + .../glue-api-manage-shopping-list-items.md | 2 +- .../glue-api-manage-shopping-lists.md | 2 +- .../glue-api-manage-wishlist-items.md | 2 +- .../glue-api-manage-wishlists.md | 2 +- ...-manage-marketplace-shopping-list-items.md | 2 +- ...e-api-manage-marketplace-shopping-lists.md | 2 +- ...e-api-manage-marketplace-wishlist-items.md | 2 +- .../glue-api-manage-marketplace-wishlists.md | 2 +- ...port-file-details-product-abstract.csv.md} | 2 +- ...import-file-details-product-option.csv.md} | 2 +- ...md => import-file-details-shipment.csv.md} | 2 +- ...md => import-file-details-tax-sets.csv.md} | 0 .../tax-management-data-import.md | 14 + .../retrieve-tax-sets.md | 2 +- .../base-shop/tax-feature-overview.md | 10 +- ...port-file-details-product-abstract.csv.md} | 7 +- ...import-file-details-product-option.csv.md} | 6 +- ...md => import-file-details-shipment.csv.md} | 6 +- ...md => import-file-details-tax-sets.csv.md} | 5 +- .../tax-management-data-import.md | 14 + .../retrieve-tax-sets.md | 2 +- .../base-shop/tax-feature-overview.md | 10 +- ...mpersonate-customers-as-an-agent-assist.md | 2 +- ...-search-by-customers-as-an-agent-assist.md | 2 +- .../file-details-product-stock.csv.md | 3 +- .../file-details-warehouse-address.csv.md | 5 +- .../file-details-warehouse-store.csv.md | 5 +- .../file-details-warehouse.csv.md | 7 +- ...warehouse-management-system-data-import.md | 14 + .../inventory-management-feature-overview.md | 14 +- .../file-details-product-stock.csv.md | 2 +- .../file-details-warehouse-address.csv.md | 4 +- .../file-details-warehouse-store.csv.md | 4 +- .../file-details-warehouse.csv.md | 6 +- ...warehouse-management-system-data-import.md | 14 + .../inventory-management-feature-overview.md | 14 +- .../manage-availability-notifications.md | 2 +- .../retrieve-abstract-product-availability.md | 2 +- ...ility-when-retrieving-concrete-products.md | 2 +- .../retrieve-concrete-product-availability.md | 2 +- ...criptions-to-availability-notifications.md | 2 +- ...api-retrieve-product-offer-availability.md | 2 +- .../file-details-merchant-stock.csv.md | 2 +- .../file-details-product-offer-stock.csv.md | 2 +- ...e-inventory-management-feature-overview.md | 2 +- ...management-inventory-management-feature.md | 8 - ...l-the-warehouse-user-management-feature.md | 8 - ...nstall-the-inventory-management-feature.md | 4 +- ...management-inventory-management-feature.md | 11 + ...l-the-warehouse-user-management-feature.md | 8 +- .../install-the-picker-user-login-feature.md | 10 + .../install-the-warehouse-picking-feature.md | 10 + ...se-picking-inventory-management-feature.md | 9 + ...ehouse-picking-order-management-feature.md | 10 + ...l-the-warehouse-picking-product-feature.md | 10 + ...-the-warehouse-picking-shipment-feature.md | 10 + ...icking-spryker-core-back-office-feature.md | 10 + .../dev/architecture/conceptual-overview.md | 2 +- ...e-data-with-publish-and-synchronization.md | 357 ++++++++-- .../extend-spryker/development-strategies.md | 4 +- .../commerce-setup/commerce-setup.md | 8 +- .../commerce-setup/commerce-setup.md | 12 +- ...on-order-of-data-importers-in-demo-shop.md | 8 +- ...porting-product-data-with-a-single-file.md | 2 +- .../202212.0/marketplace-data-import.md} | 8 +- docs/scos/dev/drafts-dev/roadmap.md | 2 - .../dynamic-data-api-integration.md | 362 ++++++++++ .../install-the-picker-user-login-feature.md | 8 - ...tall-the-product-offer-shipment-feature.md | 8 - .../install-the-push-notification-feature.md | 8 - .../install-the-service-points-feature.md | 8 - ...all-the-shipment-service-points-feature.md | 8 - .../install-the-warehouse-picking-feature.md | 8 - ...se-picking-inventory-management-feature.md | 8 - ...ehouse-picking-order-management-feature.md | 8 - ...l-the-warehouse-picking-product-feature.md | 8 - ...-the-warehouse-picking-shipment-feature.md | 8 - ...icking-spryker-core-back-office-feature.md | 8 - .../spryker-core-feature-integration.md | 2 +- .../202204.0/payments-feature-walkthrough.md | 2 +- ...ide-upgrade-nodejs-to-v18-and-npm-to-v9.md | 4 +- ...-party-payment-providers-using-glue-api.md | 2 +- .../authentication-and-authorization.md | 1 + ...d-and-storefront-api-module-differences.md | 1 + .../create-glue-api-applications.md | 1 + .../202212.0/decoupled-glue-api.md | 234 +++++++ .../202212.0/glue-api-guides.md | 23 +- .../b2c-api-react-example.md | 2 +- .../document-glue-api-resources.md | 10 +- .../extend-a-rest-api-resource.md | 4 +- ...ement-versioning-for-rest-api-resources.md | 4 +- .../validate-rest-request-format.md | 2 +- .../glue-api-guides/202212.0/glue-spryks.md | 4 +- .../glue-infrastructure.md | 18 +- .../glue-rest-api.md | 27 +- ...t-requests-and-caching-with-entity-tags.md | 11 +- ...ence-information-glueapplication-errors.md | 11 +- .../resolving-search-engine-friendly-urls.md | 9 +- .../rest-api-b2b-reference.md | 10 +- .../rest-api-b2c-reference.md | 9 +- .../security-and-authentication.md | 0 .../how-to-configure-dynamic-data-api.md | 118 ++++ ...how-to-send-request-in-dynamic-data-api.md | 473 +++++++++++++ ...additional-logic-in-dependency-provider.md | 11 +- .../dead-code-checker.md | 11 +- .../minimum-allowed-shop-version.md | 13 +- .../multidimensional-array.md | 14 +- .../upgradability-guidelines/php-version.md | 33 +- .../plugin-registration-with-restrintions.md | 11 +- .../upgradability-guidelines/security.md | 11 +- .../single-plugin-argument.md | 29 +- .../upgradability-guidelines.md | 9 +- .../project-development-guidelines.md | 2 +- .../dev/guidelines/security-guidelines.md | 88 +++ .../upgrade-to-angular-12.md} | 11 +- .../upgrade-to-angular-15.md} | 34 +- .../upgrade-to-marketplace.md} | 17 +- .../install-docker-prerequisites-on-linux.md | 24 +- ...install-in-demo-mode-on-macos-and-linux.md | 21 +- .../install-in-demo-mode-on-windows.md | 42 +- ...-in-development-mode-on-macos-and-linux.md | 21 +- .../install-in-development-mode-on-windows.md | 45 +- .../set-up-spryker-locally.md | 2 + .../202212.0/system-requirements.md | 20 + .../202304.0/system-requirements.md | 19 + .../integrate-multi-database-logic.md | 4 +- .../202212.0/configure-services.md | 2 +- .../the-docker-sdk/202212.0/the-docker-sdk.md | 2 +- .../howtos/about-howtos.md | 2 +- .../howtos/glue-api-howtos/glue-api-howtos.md | 4 +- ...ate-an-angular-module-with-application.md} | 4 +- .../howtos/howto-split-products-by-stores.md} | 4 +- docs/scos/user/intro-to-spryker/b2b-suite.md | 2 +- docs/scos/user/intro-to-spryker/b2c-suite.md | 2 +- .../intro-to-spryker/docs-release-notes.md | 40 +- .../user/intro-to-spryker/intro-to-spryker.md | 2 +- .../release-notes/release-notes-2018.12.0.md | 4 +- .../release-notes-201903.0.md | 2 +- .../release-notes-201907.0.md | 8 +- .../security-release-notes-202306.0.md | 18 +- .../support/getting-support.md | 3 +- .../support/handling-security-issues.md | 2 +- .../intro-to-spryker/supported-browsers.md | 11 +- .../whats-new/security-updates.md | 8 +- ...are-a-project-for-spryker-code-upgrader.md | 8 - 476 files changed, 5531 insertions(+), 2652 deletions(-) rename {docs/scos/user/intro-to-spryker/support => _drafts/deprecated}/handling-new-feature-requests.md (100%) create mode 100644 _includes/pbc/all/install-features/202304.0/install-glue-api/install-the-product-rating-and-reviews-glue-api.md rename _includes/pbc/all/install-features/{202304.0 => 202400.0}/install-the-inventory-management-feature.md (97%) rename _includes/pbc/all/install-features/{202304.0 => 202400.0}/install-the-order-management-inventory-management-feature.md (85%) rename _includes/pbc/all/install-features/{202304.0 => 202400.0}/install-the-picker-user-login-feature.md (95%) rename _includes/pbc/all/install-features/{202304.0 => 202400.0}/install-the-product-offer-service-points-feature.md (99%) rename _includes/pbc/all/install-features/{202304.0 => 202400.0}/install-the-product-offer-shipment-feature.md (98%) rename _includes/pbc/all/install-features/{202304.0 => 202400.0}/install-the-push-notification-feature.md (99%) rename _includes/pbc/all/install-features/{202304.0 => 202400.0}/install-the-service-points-feature.md (100%) rename _includes/pbc/all/install-features/{202304.0 => 202400.0}/install-the-shipment-feature.md (77%) rename _includes/pbc/all/install-features/{202304.0 => 202400.0}/install-the-shipment-service-points-feature.md (92%) rename _includes/pbc/all/install-features/{202304.0 => 202400.0}/install-the-spryker-core-back-office-warehouse-user-management-feature.md (94%) rename _includes/pbc/all/install-features/{202304.0 => 202400.0}/install-the-warehouse-picking-feature.md (96%) rename _includes/pbc/all/install-features/{202304.0 => 202400.0}/install-the-warehouse-picking-inventory-management-feature.md (94%) rename _includes/pbc/all/install-features/{202304.0 => 202400.0}/install-the-warehouse-picking-order-management-feature.md (96%) rename _includes/pbc/all/install-features/{202304.0 => 202400.0}/install-the-warehouse-picking-product-feature.md (97%) rename _includes/pbc/all/install-features/{202304.0 => 202400.0}/install-the-warehouse-picking-shipment-feature.md (99%) rename _includes/pbc/all/install-features/{202304.0 => 202400.0}/install-the-warehouse-picking-spryker-core-back-office-feature.md (94%) rename _includes/pbc/all/install-features/{202304.0 => 202400.0}/install-the-warehouse-user-management-feature.md (96%) rename _includes/pbc/all/install-features/{202304.0 => 202400.0}/marketplace/install-the-marketplace-product-offer-service-points-feature.md (98%) create mode 100644 _internal/faq-migration-to-opensearch.md create mode 100644 docs/cloud/dev/spryker-cloud-commerce-os/best-practices/best-practises-jenkins-stability.md delete mode 100644 docs/marketplace/dev/data-import/202212.0/data-import.md delete mode 100644 docs/marketplace/dev/data-import/202212.0/file-details-merchant-store.csv.md delete mode 100644 docs/marketplace/dev/feature-integration-guides/202212.0/marketplace-dummy-payment-feature-integration.md delete mode 100644 docs/marketplace/dev/howtos/howtos.md delete mode 100644 docs/marketplace/dev/setup/202212.0/marketplace-supported-browsers.md delete mode 100644 docs/marketplace/dev/setup/202212.0/setup.md delete mode 100644 docs/marketplace/dev/setup/202212.0/system-requirements.md delete mode 100644 docs/marketplace/dev/setup/202304.0/system-requirements.md delete mode 100644 docs/marketplace/dev/technical-enhancement/202212.0/technical-enhancement.md rename docs/pbc/all/back-office/{202304.0/install-spryker-core-back-office-warehouse-user-management-feature.md => 202400.0/unified-commerce/install-and-upgrade/install-the-spryker-core-back-office-warehouse-user-management-feature.md} (82%) rename docs/pbc/all/carrier-management/{202304.0/base-shop => 202400.0/unified-commerce}/import-and-export-data/file-details-shipment-method-shipment-type.csv.md (92%) rename docs/pbc/all/carrier-management/{202304.0/base-shop => 202400.0/unified-commerce}/import-and-export-data/file-details-shipment-type-store.csv.md (92%) rename docs/pbc/all/carrier-management/{202304.0/base-shop => 202400.0/unified-commerce}/import-and-export-data/file-details-shipment-type.csv.md (91%) rename docs/pbc/all/carrier-management/{202304.0/base-shop => 202400.0/unified-commerce}/install-and-upgrade/install-the-shipment-feature.md (97%) create mode 100644 docs/pbc/all/carrier-management/202400.0/unified-commerce/install-and-upgrade/install-the-shipment-service-points-feature.md create mode 100644 docs/pbc/all/cart-and-checkout/202212.0/marketplace/install/install-features/install-the-cart-marketplace-product-feature.md rename docs/{marketplace/dev/feature-integration-guides/202212.0/merchant-switcher-customer-account-management-feature-integration.md => pbc/all/merchant-management/202212.0/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-customer-account-management-feature.md} (87%) rename docs/{marketplace/dev/feature-integration-guides/202212.0/merchant-switcher-feature-integration.md => pbc/all/merchant-management/202212.0/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-feature.md} (90%) rename docs/{marketplace/dev/feature-integration-guides/202212.0/merchant-switcher-wishlist-feature-integration.md => pbc/all/merchant-management/202212.0/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-wishlist-feature.md} (88%) rename docs/{marketplace/dev/howtos/how-to-add-new-guitable-column-type.md => pbc/all/merchant-management/202212.0/marketplace/tutorials-and-howtos/create-gui-table-column-types.md} (93%) delete mode 100644 docs/pbc/all/offer-management/202304.0/marketplace/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.md create mode 100644 docs/pbc/all/offer-management/202400.0/marketplace/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.md rename docs/{scos/dev/feature-integration-guides/202304.0 => pbc/all/offer-management/202400.0/unified-commerce/install-and-upgrade}/install-the-product-offer-service-points-feature.md (51%) create mode 100644 docs/pbc/all/offer-management/202400.0/unified-commerce/install-and-upgrade/install-the-product-offer-shipment-feature.md rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/adyen/adyen.md (65%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/adyen/enable-filtering-of-payment-methods-for-adyen.md (70%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/adyen/install-and-configure-adyen.md (85%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/adyen/integrate-adyen-payment-methods.md (96%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/adyen/integrate-adyen.md (94%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/afterpay/afterpay.md (89%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/afterpay/install-and-configure-afterpay.md (95%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/afterpay/integrate-afterpay.md (96%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/amazon-pay/amazon-pay-sandbox-simulations.md (88%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/amazon-pay/amazon-pay-state-machine.md (80%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/amazon-pay/amazon-pay.md (66%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/amazon-pay/configure-amazon-pay.md (94%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/amazon-pay/handling-orders-with-amazon-pay-api.md (95%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/amazon-pay/obtain-an-amazon-order-reference-and-information-about-shipping-addresses.md (90%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/arvato/arvato-risk-check.md (90%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/arvato/arvato-store-order.md (91%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/arvato/arvato.md (79%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/arvato/install-and-configure-arvato.md (85%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/billie.md (96%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/billpay/billpay-switch-invoice-payments-to-a-preauthorize-mode.md (98%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/billpay/billpay.md (89%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/billpay/integrate-billpay.md (93%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/braintree/braintree-performing-requests.md (88%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/braintree/braintree-request-workflow.md (71%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/braintree/braintree.md (76%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/braintree/install-and-configure-braintree.md (93%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/braintree/integrate-braintree.md (90%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/computop/computop-api-calls.md (61%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/computop/computop-oms-plugins.md (51%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/computop/computop.md (72%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/computop/install-and-configure-computop.md (90%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/computop/integrate-computop.md (99%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.md (69%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.md (82%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.md (64%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.md (66%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.md (66%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.md (63%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.md (86%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.md (60%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.md (66%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/crefopay/crefopay-callbacks.md (61%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/crefopay/crefopay-capture-and-refund-processes.md (73%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/crefopay/crefopay-enable-b2b-payments.md (66%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/crefopay/crefopay-notifications.md (92%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/crefopay/crefopay-payment-methods.md (85%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/crefopay/crefopay.md (70%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/crefopay/install-and-configure-crefopay.md (81%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/crefopay/integrate-crefopay.md (97%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/heidelpay/configure-heidelpay.md (78%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/heidelpay/heidelpay-oms-workflow.md (92%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/heidelpay/heidelpay-workflow-for-errors.md (62%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/heidelpay/heidelpay.md (50%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/heidelpay/install-heidelpay.md (51%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/heidelpay/integrate-heidelpay.md (88%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.md (83%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.md (90%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.md (92%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-ideal-payment-method-for-heidelpay.md (69%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-invoice-secured-b2c-payment-method-for-heidelpay.md (86%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.md (72%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-debit-payment-method-for-heidelpay.md (70%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-sofort-payment-method-for-heidelpay.md (70%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.md (57%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/klarna/klarna-invoice-pay-in-14-days.md (74%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/klarna/klarna-part-payment-flexible.md (75%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/klarna/klarna-payment-workflow.md (66%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/klarna/klarna-state-machine-commands-and-conditions.md (84%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/klarna/klarna.md (81%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/payolution/install-and-configure-payolution.md (89%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/payolution/integrate-payolution.md (85%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/payolution/integrate-the-installment-payment-method-for-payolution.md (81%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/payolution/integrate-the-invoice-payment-method-for-payolution.md (78%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/payolution/payolution-performing-requests.md (85%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/payolution/payolution-request-flow.md (55%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/payolution/payolution.md (75%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/payone/integration-in-the-back-office/disconnect-payone.md (88%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/payone/integration-in-the-back-office/integrate-payone.md (96%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/payone/integration-in-the-back-office/payone-integration-in-the-back-office.md (95%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/payone/manual-integration/integrate-payone.md (89%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/payone/manual-integration/payone-cash-on-delivery.md (68%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/payone/manual-integration/payone-manual-integration.md (92%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/payone/manual-integration/payone-paypal-express-checkout-payment.md (96%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/payone/manual-integration/payone-risk-check-and-address-check.md (86%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/powerpay.md (96%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/ratenkauf-by-easycredit/install-and-configure-ratenkauf-by-easycredit.md (79%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/ratenkauf-by-easycredit/integrate-ratenkauf-by-easycredit.md (98%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/ratenkauf-by-easycredit/ratenkauf-by-easycredit.md (81%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/ratepay/disable-address-updates-from-the-backend-application-for-ratepay.md (93%) create mode 100644 docs/pbc/all/payment-service-provider/202212.0/ratepay/integrate-payment-methods-for-ratepay/integrate-payment-methods-for-ratepay.md rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/ratepay/integrate-payment-methods-for-ratepay/integrate-the-direct-debit-payment-method-for-ratepay.md (84%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/ratepay/integrate-payment-methods-for-ratepay/integrate-the-installment-payment-method-for-ratepay.md (87%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/ratepay/integrate-payment-methods-for-ratepay/integrate-the-invoice-payment-method-for-ratepay.md (89%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/ratepay/integrate-payment-methods-for-ratepay/integrate-the-prepayment-payment-method-for-ratepay.md (89%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/ratepay/ratepay-core-module-structure-diagram.md (94%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/ratepay/ratepay-facade-methods.md (93%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/ratepay/ratepay-payment-workflow.md (91%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/ratepay/ratepay-state-machine-commands-and-conditions.md (85%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/ratepay/ratepay-state-machines.md (87%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/ratepay/ratepay.md (77%) rename docs/pbc/all/payment-service-provider/202212.0/{ => spryker-pay/base-shop}/hydrate-payment-methods-for-an-order.md (87%) rename docs/pbc/all/payment-service-provider/202212.0/{import-and-export-data/file-details-payment-method-store.csv.md => spryker-pay/base-shop/import-and-export-data/import-file-details-payment-method-store.csv.md} (85%) rename docs/pbc/all/payment-service-provider/202212.0/{import-and-export-data/file-details-payment-method.csv.md => spryker-pay/base-shop/import-and-export-data/import-file-details-payment-method.csv.md} (89%) rename docs/pbc/all/payment-service-provider/202212.0/{import-and-export-data/import-and-export-payment-service-provider-data.md => spryker-pay/base-shop/import-and-export-data/payment-service-provider-data-import-and-export.md} (93%) rename docs/pbc/all/payment-service-provider/202212.0/{ => spryker-pay/base-shop}/install-and-upgrade/install-the-payments-feature.md (76%) rename docs/pbc/all/payment-service-provider/202212.0/{ => spryker-pay/base-shop}/install-and-upgrade/install-the-payments-glue-api.md (72%) rename docs/pbc/all/payment-service-provider/202212.0/{ => spryker-pay/base-shop}/install-and-upgrade/upgrade-the-payment-module.md (73%) rename docs/pbc/all/payment-service-provider/202212.0/{ => spryker-pay/base-shop}/interact-with-third-party-payment-providers-using-glue-api.md (91%) rename docs/pbc/all/payment-service-provider/202212.0/{ => spryker-pay/base-shop}/manage-in-the-back-office/edit-payment-methods.md (89%) rename docs/pbc/all/payment-service-provider/202212.0/{ => spryker-pay/base-shop}/manage-in-the-back-office/log-into-the-back-office.md (72%) rename docs/pbc/all/payment-service-provider/202212.0/{ => spryker-pay/base-shop}/manage-in-the-back-office/view-payment-methods.md (80%) rename docs/pbc/all/payment-service-provider/202212.0/{ => spryker-pay/base-shop}/payments-feature-domain-model-and-relationships.md (80%) rename docs/pbc/all/payment-service-provider/202212.0/{ => spryker-pay/base-shop}/payments-feature-overview.md (69%) rename _includes/pbc/all/install-features/202212.0/marketplace/install-the-marketplace-dummy-payment-feature.md => docs/pbc/all/payment-service-provider/202212.0/spryker-pay/marketplace/install-marketplace-dummy-payment.md (96%) delete mode 100644 docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payment-service-provider-integrations.md delete mode 100644 docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-payment-methods-for-ratepay.md delete mode 100644 docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/unzer/whats-changed-in-unzer.md rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/unzer/configure-in-the-back-office/add-unzer-marketplace-credentials.md (97%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/unzer/configure-in-the-back-office/add-unzer-standard-credentails.md (100%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/unzer/extend-and-customize/customize-the-credit-card-display-in-your-payment-step.md (67%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/unzer/extend-and-customize/implement-new-payment-methods-on-the-project-level.md (98%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/unzer/howto-tips-use-cases/refund-shipping-costs.md (89%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/unzer/howto-tips-use-cases/understand-payment-method-in-checkout-process.md (95%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/unzer/install-unzer/install-and-configure-unzer.md (96%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/unzer/install-unzer/integrate-unzer-glue-api.md (97%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/unzer/install-unzer/integrate-unzer.md (99%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/unzer/unzer-domain-model-and-relationships.md (95%) rename docs/pbc/all/payment-service-provider/202212.0/{third-party-integrations => }/unzer/unzer.md (82%) rename docs/{marketplace/dev/feature-walkthroughs/202212.0/marketplace-merchant-portal-product-management-feature-walkthrough.md => pbc/all/product-information-management/202212.0/marketplace/domain-model-and-relationships/marketplace-merchant-portal-product-management-feature-domain-model-and-relationships.md} (50%) rename docs/{marketplace/dev/feature-integration-guides/202212.0/marketplace-product-cart-feature-integration.md => pbc/all/product-information-management/202212.0/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-cart-feature.md} (81%) create mode 100644 docs/pbc/all/product-information-management/202212.0/marketplace/marketplace-merchant-portal-product-management-feature-overview.md create mode 100644 docs/pbc/all/push-notification/202400.0/unified-commerce/install-and-upgrade/install-the-push-notification-feature.md rename docs/{scos/user/features/202304.0 => pbc/all/push-notification/202400.0/unified-commerce}/push-notification-feature-overview.md (98%) create mode 100644 docs/pbc/all/ratings-reviews/202204.0/import-and-export-data/ratings-and-reviews-data-import.md create mode 100644 docs/pbc/all/ratings-reviews/202212.0/import-and-export-data/ratings-and-reviews-data-import.md create mode 100644 docs/pbc/all/ratings-reviews/202304.0/install-and-upgrade/install-the-product-rating-and-reviews-glue-api.md rename docs/pbc/all/search/202212.0/base-shop/{import-data => import-and-export-data}/file-details-product-search-attribute-map.csv.md (95%) rename docs/pbc/all/search/202212.0/base-shop/{import-data => import-and-export-data}/file-details-product-search-attribute.csv.md (96%) create mode 100644 docs/pbc/all/search/202212.0/base-shop/import-and-export-data/search-data-import.md delete mode 100644 docs/pbc/all/search/202212.0/best-practices/precise-search-by-super-attributes.md create mode 100644 docs/pbc/all/service-points/202400.0/unified-commerce/install-the-service-points-feature.md rename docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/{import-tax-sets-for-abstract-products.md => import-file-details-product-abstract.csv.md} (95%) rename docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/{import-tax-sets-for-product-options.md => import-file-details-product-option.csv.md} (96%) rename docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/{import-tax-sets-for-shipment-methods.md => import-file-details-shipment.csv.md} (95%) rename docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/{import-tax-sets.md => import-file-details-tax-sets.csv.md} (100%) create mode 100644 docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/tax-management-data-import.md rename docs/pbc/all/tax-management/202212.0/base-shop/import-and-export-data/{import-tax-sets-for-abstract-products.md => import-file-details-product-abstract.csv.md} (84%) rename docs/pbc/all/tax-management/202212.0/base-shop/import-and-export-data/{import-tax-sets-for-product-options.md => import-file-details-product-option.csv.md} (87%) rename docs/pbc/all/tax-management/202212.0/base-shop/import-and-export-data/{import-tax-sets-for-shipment-methods.md => import-file-details-shipment.csv.md} (84%) rename docs/pbc/all/tax-management/202212.0/base-shop/import-and-export-data/{import-tax-sets.md => import-file-details-tax-sets.csv.md} (90%) create mode 100644 docs/pbc/all/tax-management/202212.0/base-shop/import-and-export-data/tax-management-data-import.md rename docs/pbc/all/warehouse-management-system/202204.0/base-shop/{import-data => import-and-export-data}/file-details-product-stock.csv.md (95%) rename docs/pbc/all/warehouse-management-system/202204.0/base-shop/{import-data => import-and-export-data}/file-details-warehouse-address.csv.md (91%) rename docs/pbc/all/warehouse-management-system/202204.0/base-shop/{import-data => import-and-export-data}/file-details-warehouse-store.csv.md (90%) rename docs/pbc/all/warehouse-management-system/202204.0/base-shop/{import-data => import-and-export-data}/file-details-warehouse.csv.md (87%) create mode 100644 docs/pbc/all/warehouse-management-system/202204.0/base-shop/import-and-export-data/warehouse-management-system-data-import.md rename docs/pbc/all/warehouse-management-system/202212.0/base-shop/{import-data => import-and-export-data}/file-details-product-stock.csv.md (97%) rename docs/pbc/all/warehouse-management-system/202212.0/base-shop/{import-data => import-and-export-data}/file-details-warehouse-address.csv.md (94%) rename docs/pbc/all/warehouse-management-system/202212.0/base-shop/{import-data => import-and-export-data}/file-details-warehouse-store.csv.md (93%) rename docs/pbc/all/warehouse-management-system/202212.0/base-shop/{import-data => import-and-export-data}/file-details-warehouse.csv.md (90%) create mode 100644 docs/pbc/all/warehouse-management-system/202212.0/base-shop/import-and-export-data/warehouse-management-system-data-import.md delete mode 100644 docs/pbc/all/warehouse-management-system/202304.0/base-shop/install-and-upgrade/install-features/install-the-order-management-inventory-management-feature.md delete mode 100644 docs/pbc/all/warehouse-management-system/202304.0/base-shop/install-and-upgrade/install-the-warehouse-user-management-feature.md rename docs/pbc/all/warehouse-management-system/{202304.0/base-shop/install-and-upgrade/install-features => 202400.0/unified-commerce/install-and-upgrade}/install-the-inventory-management-feature.md (60%) create mode 100644 docs/pbc/all/warehouse-management-system/202400.0/unified-commerce/install-and-upgrade/install-the-order-management-inventory-management-feature.md rename docs/{scos/dev/feature-integration-guides/202304.0 => pbc/all/warehouse-management-system/202400.0/unified-commerce/install-and-upgrade}/install-the-warehouse-user-management-feature.md (54%) create mode 100644 docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-picker-user-login-feature.md create mode 100644 docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-feature.md create mode 100644 docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-inventory-management-feature.md create mode 100644 docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-order-management-feature.md create mode 100644 docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-product-feature.md create mode 100644 docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-shipment-feature.md create mode 100644 docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-spryker-core-back-office-feature.md rename docs/{marketplace/dev/data-import/202212.0/marketplace-setup.md => scos/dev/data-import/202212.0/marketplace-data-import.md} (97%) create mode 100644 docs/scos/dev/feature-integration-guides/202304.0/glue-api/dynamic-data-api/dynamic-data-api-integration.md delete mode 100644 docs/scos/dev/feature-integration-guides/202304.0/install-the-picker-user-login-feature.md delete mode 100644 docs/scos/dev/feature-integration-guides/202304.0/install-the-product-offer-shipment-feature.md delete mode 100644 docs/scos/dev/feature-integration-guides/202304.0/install-the-push-notification-feature.md delete mode 100644 docs/scos/dev/feature-integration-guides/202304.0/install-the-service-points-feature.md delete mode 100644 docs/scos/dev/feature-integration-guides/202304.0/install-the-shipment-service-points-feature.md delete mode 100644 docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-feature.md delete mode 100644 docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-inventory-management-feature.md delete mode 100644 docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-order-management-feature.md delete mode 100644 docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-product-feature.md delete mode 100644 docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-shipment-feature.md delete mode 100644 docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-spryker-core-back-office-feature.md rename docs/scos/dev/glue-api-guides/202212.0/{decoupled-glue-infrastructure => }/authentication-and-authorization.md (96%) rename docs/scos/dev/glue-api-guides/202212.0/{decoupled-glue-infrastructure => }/backend-and-storefront-api-module-differences.md (97%) rename docs/scos/dev/glue-api-guides/202212.0/{decoupled-glue-infrastructure => }/create-glue-api-applications.md (99%) create mode 100644 docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-api.md rename docs/scos/dev/glue-api-guides/202212.0/{ => old-glue-infrastructure}/glue-infrastructure.md (98%) rename docs/scos/dev/glue-api-guides/202212.0/{ => old-glue-infrastructure}/glue-rest-api.md (72%) rename docs/scos/dev/glue-api-guides/202212.0/{ => old-glue-infrastructure}/handling-concurrent-rest-requests-and-caching-with-entity-tags.md (89%) rename docs/scos/dev/glue-api-guides/202212.0/{ => old-glue-infrastructure}/reference-information-glueapplication-errors.md (70%) rename docs/scos/dev/glue-api-guides/202212.0/{ => old-glue-infrastructure}/resolving-search-engine-friendly-urls.md (94%) rename docs/scos/dev/glue-api-guides/202212.0/{ => old-glue-infrastructure}/rest-api-b2b-reference.md (78%) rename docs/scos/dev/glue-api-guides/202212.0/{ => old-glue-infrastructure}/rest-api-b2c-reference.md (82%) rename docs/scos/dev/glue-api-guides/202212.0/{decoupled-glue-infrastructure => }/security-and-authentication.md (100%) create mode 100644 docs/scos/dev/glue-api-guides/202304.0/dynamic-data-api/how-to-guides/how-to-configure-dynamic-data-api.md create mode 100644 docs/scos/dev/glue-api-guides/202304.0/dynamic-data-api/how-to-guides/how-to-send-request-in-dynamic-data-api.md rename docs/{marketplace/dev/technical-enhancement/202212.0/migration-guide-upgrade-to-angular-v12.md => scos/dev/migration-concepts/upgrade-to-angular-12.md} (97%) rename docs/{marketplace/dev/technical-enhancement/202304.0/migration-guide-upgrade-to-angular-v15.md => scos/dev/migration-concepts/upgrade-to-angular-15.md} (96%) rename docs/{marketplace/dev/howtos/how-to-upgrade-spryker-instance-to-marketplace.md => scos/dev/migration-concepts/upgrade-to-marketplace.md} (94%) rename docs/{marketplace/dev/howtos/how-to-create-a-new-angular-module-with-application.md => scos/dev/tutorials-and-howtos/howtos/howto-create-an-angular-module-with-application.md} (96%) rename docs/{marketplace/dev/howtos/how-to-split-products-by-stores.md => scos/dev/tutorials-and-howtos/howtos/howto-split-products-by-stores.md} (99%) diff --git a/Rakefile b/Rakefile index 5f2df935727..dcea302de1d 100644 --- a/Rakefile +++ b/Rakefile @@ -118,7 +118,8 @@ task :check_mp_dev do /docs\/marketplace\/\w+\/[\w-]+\/202108\.0\/.+/, /docs\/sdk\/.+/, /docs\/marketplace\/\w+\/[\w-]+\/202204\.0\/.+/, - /docs\/marketplace\/\w+\/[\w-]+\/202304\.0\/.+/ + /docs\/marketplace\/\w+\/[\w-]+\/202304\.0\/.+/, + /docs\/marketplace\/\w+\/[\w-]+\/202400\.0\/.+/ ] HTMLProofer.check_directory("./_site", options).run end @@ -135,7 +136,8 @@ task :check_mp_user do /docs\/marketplace\/\w+\/[\w-]+\/202108\.0\/.+/, /docs\/pbc\/.+/, /docs\/sdk\/.+/, - /docs\/marketplace\/\w+\/[\w-]+\/202304\.0\/.+/ + /docs\/marketplace\/\w+\/[\w-]+\/202304\.0\/.+/, + /docs\/marketplace\/\w+\/[\w-]+\/202400\.0\/.+/ ] HTMLProofer.check_directory("./_site", options).run end @@ -159,7 +161,8 @@ task :check_scos_dev do /docs\/scos\/\w+\/[\w-]+\/202009\.0\/.+/, /docs\/scos\/\w+\/[\w-]+\/202108\.0\/.+/, /docs\/scos\/\w+\/[\w-]+\/202204\.0\/.+/, - /docs\/scos\/\w+\/[\w-]+\/202304\.0\/.+/ + /docs\/scos\/\w+\/[\w-]+\/202304\.0\/.+/, + /docs\/scos\/\w+\/[\w-]+\/202400\.0\/.+/ ] HTMLProofer.check_directory("./_site", options).run end @@ -183,7 +186,8 @@ task :check_scos_user do /docs\/scos\/\w+\/[\w-]+\/202009\.0\/.+/, /docs\/scos\/\w+\/[\w-]+\/202108\.0\/.+/, /docs\/scos\/\w+\/[\w-]+\/202204\.0\/.+/, - /docs\/scos\/\w+\/[\w-]+\/202304\.0\/.+/ + /docs\/scos\/\w+\/[\w-]+\/202304\.0\/.+/, + /docs\/scos\/\w+\/[\w-]+\/202400\.0\/.+/ ] HTMLProofer.check_directory("./_site", options).run end @@ -213,7 +217,8 @@ task :check_pbc do /docs\/acp\/.+/, /docs\/scu\/.+/, /docs\/pbc\/\w+\/[\w-]+\/202212\.0\/.+/, - /docs\/pbc\/\w+\/[\w-]+\/202304\.0\/.+/ + /docs\/pbc\/\w+\/[\w-]+\/202304\.0\/.+/, + /docs\/pbc\/\w+\/[\w-]+\/202400\.0\/.+/ ] HTMLProofer.check_directory("./_site", options).run end diff --git a/_config.yml b/_config.yml index 155eb424da8..a5f5c894d71 100644 --- a/_config.yml +++ b/_config.yml @@ -171,7 +171,6 @@ defaults: sidebar: "pbc_all_sidebar" role: "all" - versions: '201811.0': '201811.0' '201903.0': '201903.0' @@ -183,6 +182,7 @@ versions: '202204.0': '202204.0' '202212.0': '202212.0' '202304.0': 'Upcoming release' + '202400.0': 'Winter release' # versioned categories - these must match corresponding directories versioned_categories: @@ -250,6 +250,10 @@ versioned_categories: - tax-management - user-management - warehouse-management-system + - push notification + - warehouse-picking + - service-points + # these are defaults used for the front matter for these file types diff --git a/_data/sidebars/cloud_dev_sidebar.yml b/_data/sidebars/cloud_dev_sidebar.yml index 598cd84bbe2..89bf2d351d4 100644 --- a/_data/sidebars/cloud_dev_sidebar.yml +++ b/_data/sidebars/cloud_dev_sidebar.yml @@ -42,6 +42,11 @@ entries: url: /docs/cloud/dev/spryker-cloud-commerce-os/deploying-in-a-production-environment.html - title: Starting asynchronous commands url: /docs/cloud/dev/spryker-cloud-commerce-os/starting-asynchronous-commands.html + - title: Best practices + url: /docs/cloud/dev/spryker-cloud-commerce-os/best-practices/best-practices.html + nested: + - title: "Best practises: Jenkins stability" + url: /docs/cloud/dev/spryker-cloud-commerce-os/best-practices/best-practises-jenkins-stability.html - title: Manage maintenance mode nested: - title: Enable and disable maintenance mode diff --git a/_data/sidebars/marketplace_dev_sidebar.yml b/_data/sidebars/marketplace_dev_sidebar.yml index 9eae5e915df..9c498f8d0c4 100644 --- a/_data/sidebars/marketplace_dev_sidebar.yml +++ b/_data/sidebars/marketplace_dev_sidebar.yml @@ -5,25 +5,14 @@ entries: - product: Marketplace nested: - title: Setup - url: /docs/marketplace/dev/setup/setup.html + url: /docs/marketplace/dev/setup/spryker-marketplace-setup.html include_versions: + - "202204.0" nested: - title: System requirements url: /docs/marketplace/dev/setup/system-requirements.html - include_versions: - - "202204.0" - - title: Marketplace supported browsers url: /docs/marketplace/dev/setup/marketplace-supported-browsers.html - include_versions: - - "202204.0" - - "202212.0" - - - title: Setup - url: /docs/marketplace/dev/setup/spryker-marketplace-setup.html - include_versions: - - "202204.0" - - "202212.0" - title: Marketplace architecture overview url: /docs/marketplace/dev/architecture-overview/architecture-overview.html @@ -266,7 +255,6 @@ entries: include_versions: - "202108.0" - "202204.0" - - "202212.0" - title: Marketplace Inventory Management feature integration url: /docs/marketplace/dev/feature-integration-guides/marketplace-inventory-management-feature-integration.html @@ -321,13 +309,11 @@ entries: include_versions: - "202108.0" - "202204.0" - - "202212.0" - title: Merchant Switcher + Customer Account Management feature integration url: /docs/marketplace/dev/feature-integration-guides/merchant-switcher-customer-account-management-feature-integration.html include_versions: - "202204.0" - - "202212.0" - title: Merchant Switcher + Customer Account Management feature integration url: /docs/marketplace/dev/feature-integration-guides/merchant-switcher-customer-account-management-feature-integration.html @@ -339,7 +325,6 @@ entries: include_versions: - "202108.0" - "202204.0" - - "202212.0" - title: Marketplace Merchant Custom Prices url: /docs/marketplace/dev/feature-integration-guides/marketplace-merchant-custom-prices-feature-integration.html @@ -857,73 +842,41 @@ entries: - "202204.0" - title: Data import url: /docs/marketplace/dev/data-import/data-import.html + include_versions: + - "202204.0" nested: - title: Marketplace setup url: /docs/marketplace/dev/data-import/marketplace-setup.html - include_versions: - - "202108.0" - - "202204.0" - - "202212.0" - title: "File details: merchant.csv" url: /docs/marketplace/dev/data-import/file-details-merchant.csv.html - include_versions: - - "202108.0" - - "202204.0" - title: "File details: merchant-profile.csv" url: /docs/marketplace/dev/data-import/file-details-merchant-profile.csv.html - include_versions: - - "202108.0" - - "202204.0" - title: "File details: merchant-profile-address.csv" url: /docs/marketplace/dev/data-import/file-details-merchant-profile-address.csv.html - include_versions: - - "202108.0" - - "202204.0" - title: "File details: merchant-open-hours-week-day-schedule.csv" url: /docs/marketplace/dev/data-import/file-details-merchant-open-hours-week-day-schedule.csv.html - include_versions: - - "202108.0" - - "202204.0" - title: "File details: merchant_open_hours_date_schedule.csv" url: /docs/marketplace/dev/data-import/file-details-merchant-open-hours-date-schedule.csv.html - include_versions: - - "202108.0" - - "202204.0" - title: "File details: merchant-category.csv" url: /docs/marketplace/dev/data-import/file-details-merchant-category.csv.html - include_versions: - - "202108.0" - - "202204.0" - title: "File details: merchant-stock.csv" url: /docs/marketplace/dev/data-import/file-details-merchant-stock.csv.html - include_versions: - - "202108.0" - - "202204.0" - title: "File details: merchant-store.csv" url: /docs/marketplace/dev/data-import/file-details-merchant-store.csv.html - include_versions: - - "202108.0" - - "202204.0" - title: "File details: merchant-oms-process.csv" url: /docs/marketplace/dev/data-import/file-details-merchant-oms-process.csv.html - include_versions: - - "202108.0" - - "202204.0" - title: "File details: merchant-order-status.csv" url: /docs/marketplace/dev/data-import/file-details-merchant-order-status.csv.html - include_versions: - - "202108.0" - - "202204.0" - title: "File details: merchant_product_approval_status_default.csv" url: /docs/marketplace/dev/data-import/file-details-merchant-product-approval-status-default.csv.html @@ -932,21 +885,12 @@ entries: - title: "File details: merchant-product-offer.csv" url: /docs/marketplace/dev/data-import/file-details-merchant-product-offer.csv.html - include_versions: - - "202108.0" - - "202204.0" - title: "File details: merchant_user.csv" url: /docs/marketplace/dev/data-import/file-details-merchant-user.csv.html - include_versions: - - "202108.0" - - "202204.0" - title: "File details: price-product-offer.csv" url: /docs/marketplace/dev/data-import/file-details-price-product-offer.csv.html - include_versions: - - "202108.0" - - "202204.0" - title: "File details: product-offer-shopping-list.csv" url: /docs/marketplace/dev/data-import/file-details-product-offer-shopping-list.csv.html @@ -955,45 +899,24 @@ entries: - title: "File details: product-offer-stock.csv" url: /docs/marketplace/dev/data-import/file-details-product-offer-stock.csv.html - include_versions: - - "202108.0" - - "202204.0" - title: "File details: merchant-product-offer-store.csv" url: /docs/marketplace/dev/data-import/file-details-merchant-product-offer-store.csv.html - include_versions: - - "202108.0" - - "202204.0" - title: "File details: product-offer-validity.csv" url: /docs/marketplace/dev/data-import/file-details-product-offer-validity.csv.html - include_versions: - - "202108.0" - - "202204.0" - title: "File details: combined-merchant-product-offer.csv" url: /docs/marketplace/dev/data-import/file-details-combined-merchant-product-offer.csv.html - include_versions: - - "202108.0" - - "202204.0" - title: "File details: merchant-product.csv" url: /docs/marketplace/dev/data-import/file-details-merchant-product.csv.html - include_versions: - - "202108.0" - - "202204.0" - title: "File details: product-price.csv" url: /docs/marketplace/dev/data-import/file-details-product-price.csv.html - include_versions: - - "202108.0" - - "202204.0" - title: "File details: product-option-group.csv" url: /docs/marketplace/dev/data-import/file-details-merchant-product-option-group.csv.html - include_versions: - - "202108.0" - - "202204.0" - title: Front-end url: /docs/marketplace/dev/front-end/front-end.html @@ -1430,37 +1353,3 @@ entries: include_versions: - "202204.0" - "202212.0" - - - title: HowTos - url: /docs/marketplace/dev/howtos/howtos.html - nested: - - - title: "How-To: Upgrade Spryker instance to the Marketplace" - url: /docs/marketplace/dev/howtos/how-to-upgrade-spryker-instance-to-marketplace.html - - - title: "How-To: Create a new Angular module with application" - url: /docs/marketplace/dev/howtos/how-to-create-a-new-angular-module-with-application.html - - - title: "How-To: Split products by stores" - url: /docs/marketplace/dev/howtos/how-to-split-products-by-stores.html - - - title: "How-To: Create a new Gui table column type" - url: /docs/marketplace/dev/howtos/how-to-add-new-guitable-column-type.html - - - title: "How-To: Create a new Gui table filter type" - url: /docs/marketplace/dev/howtos/how-to-add-new-guitable-filter-type.html - - - title: Technical enhancement guides - url: /docs/marketplace/dev/technical-enhancement/technical-enhancement.html - nested: - - - title: "Migration guide - Upgrade to Angular v12" - url: /docs/marketplace/dev/technical-enhancement/migration-guide-upgrade-to-angular-v12.html - include_versions: - - "202204.0" - - "202212.0" - - - title: "Migration guide - Upgrade to Angular v15" - url: /docs/marketplace/dev/technical-enhancement/migration-guide-upgrade-to-angular-v15.html - include_versions: - - "202304.0" diff --git a/_data/sidebars/pbc_all_sidebar.yml b/_data/sidebars/pbc_all_sidebar.yml index 35f77216b17..fb47e2bca44 100644 --- a/_data/sidebars/pbc_all_sidebar.yml +++ b/_data/sidebars/pbc_all_sidebar.yml @@ -12,14 +12,6 @@ entries: url: /docs/pbc/all/back-office/back-office-translations-overview.html - title: Install the Spryker Core Back Office feature url: /docs/pbc/all/back-office/install-the-spryker-core-back-office-feature.html - - title: Install the Warehouse User Management feature - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-the-warehouse-user-management-feature.html - include_versions: - - "202304.0" - - title: Install the Spryker Core Back Office + Warehouse User Management feature - url: /docs/pbc/all/back-office/install-spryker-core-back-office-warehouse-user-management-feature.html - include_versions: - - "202304.0" - title: "HowTo: Add support of number formatting in the Back Office" url: /docs/pbc/all/back-office/howto-add-support-of-number-formatting-in-the-back-office.html - title: Manage in the Back Office @@ -192,14 +184,6 @@ entries: url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-feature.html - title: Cart + Non-splittable Products url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-non-splittable-products-feature.html - - title: Cart Notes - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-notes-feature.html - include_versions: - - "202304.0" - - title: Cart + Prices - url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-prices-feature.html - include_versions: - - "202304.0" - title: Cart + Product url: /docs/pbc/all/cart-and-checkout/base-shop/install-and-upgrade/install-features/install-the-cart-product-feature.html - title: Cart + Product Bundles @@ -395,6 +379,8 @@ entries: nested: - title: Marketplace Cart url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-marketplace-cart-feature.html + - title: Cart + Marketplace Product + url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-cart-marketplace-product-feature.html - title: Cart + Marketplace Product Offer url: /docs/pbc/all/cart-and-checkout/marketplace/install/install-features/install-the-cart-marketplace-product-offer-feature.html - title: Cart + Marketplace Product Options @@ -472,10 +458,6 @@ entries: url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-cms-product-lists-catalog-feature.html - title: Content Items url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-content-items-feature.html - - title: File Manager - url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-file-manager-feature.html - include_versions: - - "202304.0" - title: Navigation url: /docs/pbc/all/content-management-system/base-shop/install-and-upgrade/install-features/install-the-navigation-feature.html - title: Product Sets @@ -1186,6 +1168,12 @@ entries: url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-tax-feature.html - title: Merchant Portal - Marketplace Merchant Portal Product Offer Management url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.html + - title: Merchant Switcher + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-feature.html + - title: Merchant Switcher + Customer Account Management + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-customer-account-management-feature.html + - title: Merchant Switcher + Wishlist + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-wishlist-feature.html - title: Install Glue API nested: - title: Marketplace Merchant @@ -1241,6 +1229,8 @@ entries: url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-modules.html - title: Create Gui table filter types url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-table-filter-types.html + - title: Create Gui table column types + url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-table-column-types.html - title: Create Gui tables url: /docs/pbc/all/merchant-management/marketplace/tutorials-and-howtos/create-gui-tables.html - title: Extend Gui tables @@ -1695,304 +1685,310 @@ entries: include_versions: - "202212.0" nested: - - title: Payments feature overview - url: /docs/pbc/all/payment-service-provider/payments-feature-overview.html - - title: Install and upgrade + - title: Spryker Pay nested: - - title: Install features + - title: Base shop nested: - - title: Payments - url: /docs/pbc/all/payment-service-provider/install-and-upgrade/install-the-payments-feature.html - - title: Install Glue APIs - nested: - - title: Payments - url: /docs/pbc/all/payment-service-provider/install-and-upgrade/install-the-payments-glue-api.html - - title: Upgrade modules + - title: Payments feature overview + url: /docs/pbc/all/payment-service-provider/spryker-pay/base-shop/payments-feature-overview.html + - title: Install and upgrade + nested: + - title: Install features + nested: + - title: Payments + url: /docs/pbc/all/payment-service-provider/spryker-pay/base-shop/install-and-upgrade/install-the-payments-feature.html + - title: Install Glue APIs + nested: + - title: Payments + url: /docs/pbc/all/payment-service-provider/spryker-pay/base-shop/install-and-upgrade/install-the-payments-glue-api.html + - title: Upgrade modules + nested: + - title: Payment + url: /docs/pbc/all/payment-service-provider/spryker-pay/base-shop/install-and-upgrade/upgrade-the-payment-module.html + - title: Import and export data + url: /docs/pbc/all/payment-service-provider/spryker-pay/base-shop/import-and-export-data/payment-service-provider-data-import-and-export.html + nested: + - title: File details - payment_method.csv + url: /docs/pbc/all/payment-service-provider/spryker-pay/base-shop/import-and-export-data/import-file-details-payment-method.csv.html + - title: File details - payment_method_store.csv + url: /docs/pbc/all/payment-service-provider/spryker-pay/base-shop/import-and-export-data/import-file-details-payment-method-store.csv.html + - title: Manage in the Back Office + url: /docs/pbc/all/payment-service-provider/spryker-pay/base-shop/manage-in-the-back-office/log-into-the-back-office.html + nested: + - title: Edit payment methods + url: /docs/pbc/all/payment-service-provider/spryker-pay/base-shop/manage-in-the-back-office/edit-payment-methods.html + - title: View payment methods + url: /docs/pbc/all/payment-service-provider/spryker-pay/base-shop/manage-in-the-back-office/view-payment-methods.html + - title: Hydrate payment methods for an order + url: /docs/pbc/all/payment-service-provider/spryker-pay/base-shop/hydrate-payment-methods-for-an-order.html + - title: Interact with third party payment providers using Glue API + url: /docs/pbc/all/payment-service-provider/spryker-pay/base-shop/interact-with-third-party-payment-providers-using-glue-api.html + - title: "Payments feature: Domain model and relationships" + url: /docs/pbc/all/payment-service-provider/spryker-pay/base-shop/payments-feature-domain-model-and-relationships.html + - title: Domain model and relationships + url: /docs/pbc/all/payment-service-provider/unzer/unzer-domain-model-and-relationships.html + - title: Marketplace nested: - - title: Payment - url: /docs/pbc/all/payment-service-provider/install-and-upgrade/upgrade-the-payment-module.html - - title: Import and export data - url: /docs/pbc/all/payment-service-provider/import-and-export-data/import-and-export-payment-service-provider-data.html + - title: Install Marketplace Dummy Payment + url: /docs/pbc/all/payment-service-provider/spryker-pay/marketplace/install-marketplace-dummy-payment.html + + - title: Adyen + url: /docs/pbc/all/payment-service-provider/adyen/adyen.html nested: - - title: File details - payment_method.csv - url: /docs/pbc/all/payment-service-provider/import-and-export-data/file-details-payment-method.csv.html - - title: File details - payment_method_store.csv - url: /docs/pbc/all/payment-service-provider/import-and-export-data/file-details-payment-method-store.csv.html - - title: Manage in the Back Office - url: /docs/pbc/all/payment-service-provider/manage-in-the-back-office/log-into-the-back-office.html - include_versions: - - "202204.0" - - "202212.0" + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/adyen/install-and-configure-adyen.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/adyen/integrate-adyen.html + - title: Integrate payment methods + url: /docs/pbc/all/payment-service-provider/adyen/integrate-adyen-payment-methods.html + - title: Enable filtering of payment methods + url: /docs/pbc/all/payment-service-provider/adyen/enable-filtering-of-payment-methods-for-adyen.html + + - title: Afterpay + url: /docs/pbc/all/payment-service-provider/afterpay/afterpay.html nested: - - title: Edit payment methods - url: /docs/pbc/all/payment-service-provider/manage-in-the-back-office/edit-payment-methods.html - - title: View payment methods - url: /docs/pbc/all/payment-service-provider/manage-in-the-back-office/view-payment-methods.html - - title: Hydrate payment methods for an order - url: /docs/pbc/all/payment-service-provider/hydrate-payment-methods-for-an-order.html - - title: Interact with third party payment providers using Glue API - url: /docs/pbc/all/payment-service-provider/interact-with-third-party-payment-providers-using-glue-api.html - - title: "Payments feature: Domain model and relationships" - url: /docs/pbc/all/payment-service-provider/payments-feature-domain-model-and-relationships.html - - title: Third-party integrations - url: /docs/pbc/all/payment-service-provider/third-party-integrations/payment-service-provider-integrations.html - include_versions: - - "202212.0" + - title: Install and configure Afterpay + url: /docs/pbc/all/payment-service-provider/afterpay/install-and-configure-afterpay.html + - title: Integrate Afterpay + url: /docs/pbc/all/payment-service-provider/afterpay/integrate-afterpay.html + - title: Amazon Pay + url: /docs/pbc/all/payment-service-provider/amazon-pay/amazon-pay.html + nested: + - title: Configure Amazon Pay + url: /docs/pbc/all/payment-service-provider/amazon-pay/configure-amazon-pay.html + - title: Obtain an Amazon Order Reference and information about shipping addresses + url: /docs/pbc/all/payment-service-provider/amazon-pay/obtain-an-amazon-order-reference-and-information-about-shipping-addresses.html + - title: Sandbox Simulations + url: /docs/pbc/all/payment-service-provider/amazon-pay/amazon-pay-sandbox-simulations.html + - title: State machine + url: /docs/pbc/all/payment-service-provider/amazon-pay/amazon-pay-state-machine.html + - title: Handling orders with Amazon Pay API + url: /docs/pbc/all/payment-service-provider/amazon-pay/handling-orders-with-amazon-pay-api.html + + - title: Arvato + url: /docs/pbc/all/payment-service-provider/arvato/arvato.html nested: - - title: Adyen - url: /docs/pbc/all/payment-service-provider/third-party-integrations/adyen/adyen.html + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/arvato/install-and-configure-arvato.html + - title: Risk Check + url: /docs/pbc/all/payment-service-provider/arvato/arvato-risk-check.html + - title: Store Order + url: /docs/pbc/all/payment-service-provider/arvato/arvato-store-order.html + + - title: Billie + url: /docs/pbc/all/payment-service-provider/billie.html + - title: Billpay + url: /docs/pbc/all/payment-service-provider/billpay/billpay.html + nested: + - title: Integrate + url: /docs/pbc/all/payment-service-provider/billpay/integrate-billpay.html + - title: Switch invoice payments to a preauthorize mode + url: /docs/pbc/all/payment-service-provider/billpay/billpay-switch-invoice-payments-to-a-preauthorize-mode.html + - title: Braintree + url: /docs/pbc/all/payment-service-provider/braintree/braintree.html + nested: + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/braintree/install-and-configure-braintree.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/braintree/integrate-braintree.html + - title: Performing requests + url: /docs/pbc/all/payment-service-provider/braintree/braintree-performing-requests.html + - title: Request workflow + url: /docs/pbc/all/payment-service-provider/braintree/braintree-request-workflow.html + - title: Payone + nested: + - title: Integration in the Back Office + url: /docs/pbc/all/payment-service-provider/payone/integration-in-the-back-office/payone-integration-in-the-back-office.html nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/third-party-integrations/adyen/install-and-configure-adyen.html - title: Integrate - url: /docs/pbc/all/payment-service-provider/third-party-integrations/adyen/integrate-adyen.html - - title: Integrate payment methods - url: /docs/pbc/all/payment-service-provider/third-party-integrations/adyen/integrate-adyen-payment-methods.html - - title: Enable filtering of payment methods - url: /docs/pbc/all/payment-service-provider/third-party-integrations/adyen/enable-filtering-of-payment-methods-for-adyen.html - - title: Afterpay - url: /docs/pbc/all/payment-service-provider/third-party-integrations/afterpay/afterpay.html - nested: - - title: Install and configure Afterpay - url: /docs/pbc/all/payment-service-provider/third-party-integrations/afterpay/install-and-configure-afterpay.html - - title: Integrate Afterpay - url: /docs/pbc/all/payment-service-provider/third-party-integrations/afterpay/integrate-afterpay.html - - title: Amazon Pay - url: /docs/pbc/all/payment-service-provider/third-party-integrations/amazon-pay/amazon-pay.html - nested: - - title: Configure Amazon Pay - url: /docs/pbc/all/payment-service-provider/third-party-integrations/amazon-pay/configure-amazon-pay.html - - title: Obtain an Amazon Order Reference and information about shipping addresses - url: /docs/pbc/all/payment-service-provider/third-party-integrations/amazon-pay/obtain-an-amazon-order-reference-and-information-about-shipping-addresses.html - - title: Sandbox Simulations - url: /docs/pbc/all/payment-service-provider/third-party-integrations/amazon-pay/amazon-pay-sandbox-simulations.html - - title: State machine - url: /docs/pbc/all/payment-service-provider/third-party-integrations/amazon-pay/amazon-pay-state-machine.html - - title: Handling orders with Amazon Pay API - url: /docs/pbc/all/payment-service-provider/third-party-integrations/amazon-pay/handling-orders-with-amazon-pay-api.html - - title: Arvato - url: /docs/pbc/all/payment-service-provider/third-party-integrations/arvato/arvato.html - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/third-party-integrations/arvato/install-and-configure-arvato.html - - title: Risk Check - url: /docs/pbc/all/payment-service-provider/third-party-integrations/arvato/arvato-risk-check.html - - title: Store Order - url: /docs/pbc/all/payment-service-provider/third-party-integrations/arvato/arvato-store-order.html - - title: Billie - url: /docs/pbc/all/payment-service-provider/third-party-integrations/billie.html - - title: Billpay - url: /docs/pbc/all/payment-service-provider/third-party-integrations/billpay/billpay.html + url: /docs/pbc/all/payment-service-provider/payone/integration-in-the-back-office/integrate-payone.html + - title: Disconnect + url: /docs/pbc/all/payment-service-provider/payone/integration-in-the-back-office/disconnect-payone.html + - title: Manual integration + url: /docs/pbc/all/payment-service-provider/payone/manual-integration/payone-manual-integration.html nested: - title: Integrate - url: /docs/pbc/all/payment-service-provider/third-party-integrations/billpay/integrate-billpay.html - - title: Switch invoice payments to a preauthorize mode - url: /docs/pbc/all/payment-service-provider/third-party-integrations/billpay/billpay-switch-invoice-payments-to-a-preauthorize-mode.html - - title: Braintree - url: /docs/pbc/all/payment-service-provider/third-party-integrations/braintree/braintree.html + url: /docs/pbc/all/payment-service-provider/payone/manual-integration/integrate-payone.html + - title: Cash on Delivery + url: /docs/pbc/all/payment-service-provider/payone/manual-integration/payone-cash-on-delivery.html + - title: PayPal Express Checkout payment + url: /docs/pbc/all/payment-service-provider/payone/manual-integration/payone-paypal-express-checkout-payment.html + - title: Risk Check and Address Check + url: /docs/pbc/all/payment-service-provider/payone/manual-integration/payone-risk-check-and-address-check.html + - title: Computop + url: /docs/pbc/all/payment-service-provider/computop/computop.html + nested: + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/computop/install-and-configure-computop.html + - title: OMS plugins + url: /docs/pbc/all/payment-service-provider/computop/computop-oms-plugins.html + - title: API calls + url: /docs/pbc/all/payment-service-provider/computop/computop-api-calls.html + - title: Integrate payment methods + nested: + - title: Sofort + url: /docs/pbc/all/payment-service-provider/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html + - title: PayPal + url: /docs/pbc/all/payment-service-provider/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html + - title: Easy + url: /docs/pbc/all/payment-service-provider/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html + - title: CRIF + url: /docs/pbc/all/payment-service-provider/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.html + - title: iDeal + url: /docs/pbc/all/payment-service-provider/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html + - title: PayNow + url: /docs/pbc/all/payment-service-provider/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html + - title: Сredit Сard + url: /docs/pbc/all/payment-service-provider/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html + - title: Direct Debit + url: /docs/pbc/all/payment-service-provider/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html + - title: Paydirekt + url: /docs/pbc/all/payment-service-provider/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/computop/integrate-computop.html + - title: CrefoPay + url: /docs/pbc/all/payment-service-provider/crefopay/crefopay.html + nested: + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/crefopay/install-and-configure-crefopay.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/crefopay/integrate-crefopay.html + - title: Enable B2B payments + url: /docs/pbc/all/payment-service-provider/crefopay/crefopay-enable-b2b-payments.html + - title: Callbacks + url: /docs/pbc/all/payment-service-provider/crefopay/crefopay-callbacks.html + - title: Notifications + url: /docs/pbc/all/payment-service-provider/crefopay/crefopay-notifications.html + - title: Capture and refund processes + url: /docs/pbc/all/payment-service-provider/crefopay/crefopay-capture-and-refund-processes.html + - title: Payment methods + url: /docs/pbc/all/payment-service-provider/crefopay/crefopay-payment-methods.html + - title: Heidelpay + url: /docs/pbc/all/payment-service-provider/heidelpay/heidelpay.html + nested: + - title: Install + url: /docs/pbc/all/payment-service-provider/heidelpay/install-heidelpay.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/heidelpay/integrate-heidelpay.html + - title: Configure + url: /docs/pbc/all/payment-service-provider/heidelpay/configure-heidelpay.html + - title: Integrate payment methods + nested: + - title: Sofort + url: /docs/pbc/all/payment-service-provider/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-sofort-payment-method-for-heidelpay.html + - title: Invoice Secured B2C + url: /docs/pbc/all/payment-service-provider/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-invoice-secured-b2c-payment-method-for-heidelpay.html + - title: iDeal + url: /docs/pbc/all/payment-service-provider/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-ideal-payment-method-for-heidelpay.html + - title: Easy Credit + url: /docs/pbc/all/payment-service-provider/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html + - title: Direct Debit + url: /docs/pbc/all/payment-service-provider/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html + - title: Split-payment Marketplace + url: /docs/pbc/all/payment-service-provider/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.html + - title: Paypal Debit + url: /docs/pbc/all/payment-service-provider/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-debit-payment-method-for-heidelpay.html + - title: Paypal Authorize + url: /docs/pbc/all/payment-service-provider/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html + - title: Credit Card Secure + url: /docs/pbc/all/payment-service-provider/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html + - title: Workflow for errors + url: /docs/pbc/all/payment-service-provider/heidelpay/heidelpay-workflow-for-errors.html + - title: OMS workflow + url: /docs/pbc/all/payment-service-provider/heidelpay/heidelpay-oms-workflow.html + - title: Klarna + url: /docs/pbc/all/payment-service-provider/klarna/klarna.html + nested: + - title: Invoice Pay in 14 days + url: /docs/pbc/all/payment-service-provider/klarna/klarna-invoice-pay-in-14-days.html + - title: Part Payment Flexible + url: /docs/pbc/all/payment-service-provider/klarna/klarna-part-payment-flexible.html + - title: Payment workflow + url: /docs/pbc/all/payment-service-provider/klarna/klarna-payment-workflow.html + - title: State machine commands and conditions + url: /docs/pbc/all/payment-service-provider/klarna/klarna-state-machine-commands-and-conditions.html + - title: Payolution + url: /docs/pbc/all/payment-service-provider/payolution/payolution.html + nested: + - title: Install and configure Payolution + url: /docs/pbc/all/payment-service-provider/payolution/install-and-configure-payolution.html + - title: Integrate Payolution + url: /docs/pbc/all/payment-service-provider/payolution/integrate-payolution.html + - title: Integrate the invoice paymnet method + url: /docs/pbc/all/payment-service-provider/payolution/integrate-the-invoice-payment-method-for-payolution.html + - title: Integrate the installment payment method for + url: /docs/pbc/all/payment-service-provider/payolution/integrate-the-installment-payment-method-for-payolution.html + - title: Performing requests + url: /docs/pbc/all/payment-service-provider/payolution/payolution-performing-requests.html + - title: Payolution request flow + url: /docs/pbc/all/payment-service-provider/payolution/payolution-request-flow.html + - title: ratenkauf by easyCredit + url: /docs/pbc/all/payment-service-provider/ratenkauf-by-easycredit/ratenkauf-by-easycredit.html + nested: + - title: Install and configure + url: /docs/pbc/all/payment-service-provider/ratenkauf-by-easycredit/install-and-configure-ratenkauf-by-easycredit.html + - title: Integrate + url: /docs/pbc/all/payment-service-provider/ratenkauf-by-easycredit/integrate-ratenkauf-by-easycredit.html + - title: Powerpay + url: /docs/pbc/all/payment-service-provider/powerpay.html + - title: RatePay + url: /docs/pbc/all/payment-service-provider/ratepay/ratepay.html + nested: + - title: Facade methods + url: /docs/pbc/all/payment-service-provider/ratepay/ratepay-facade-methods.html + - title: Payment workflow + url: /docs/pbc/all/payment-service-provider/ratepay/ratepay-payment-workflow.html + - title: Disable address updates from the backend application + url: /docs/pbc/all/payment-service-provider/ratepay/disable-address-updates-from-the-backend-application-for-ratepay.html + - title: State machine commands and conditions + url: /docs/pbc/all/payment-service-provider/ratepay/ratepay-state-machine-commands-and-conditions.html + - title: Core module structure diagram + url: /docs/pbc/all/payment-service-provider/ratepay/ratepay-core-module-structure-diagram.html + - title: State machines + url: /docs/pbc/all/payment-service-provider/ratepay/ratepay-state-machines.html + - title: Integrate payment methods + nested: + - title: Direct Debit + url: /docs/pbc/all/payment-service-provider/ratepay/integrate-payment-methods-for-ratepay/integrate-the-direct-debit-payment-method-for-ratepay.html + - title: Prepayment + url: /docs/pbc/all/payment-service-provider/ratepay/integrate-payment-methods-for-ratepay/integrate-the-prepayment-payment-method-for-ratepay.html + - title: Installment + url: /docs/pbc/all/payment-service-provider/ratepay/integrate-payment-methods-for-ratepay/integrate-the-installment-payment-method-for-ratepay.html + - title: Invoice + url: /docs/pbc/all/payment-service-provider/ratepay/integrate-payment-methods-for-ratepay/integrate-the-invoice-payment-method-for-ratepay.html + - title: Unzer + url: /docs/pbc/all/payment-service-provider/unzer/unzer.html + nested: + - title: Install nested: - title: Install and configure - url: /docs/pbc/all/payment-service-provider/third-party-integrations/braintree/install-and-configure-braintree.html + url: /docs/pbc/all/payment-service-provider/unzer/install-unzer/install-and-configure-unzer.html - title: Integrate - url: /docs/pbc/all/payment-service-provider/third-party-integrations/braintree/integrate-braintree.html - - title: Performing requests - url: /docs/pbc/all/payment-service-provider/third-party-integrations/braintree/braintree-performing-requests.html - - title: Request workflow - url: /docs/pbc/all/payment-service-provider/third-party-integrations/braintree/braintree-request-workflow.html - - title: Payone - nested: - - title: Integration in the Back Office - url: /docs/pbc/all/payment-service-provider/third-party-integrations/payone/integration-in-the-back-office/payone-integration-in-the-back-office.html - nested: - - title: Integrate - url: /docs/pbc/all/payment-service-provider/third-party-integrations/payone/integration-in-the-back-office/integrate-payone.html - - title: Disconnect - url: /docs/pbc/all/payment-service-provider/third-party-integrations/payone/integration-in-the-back-office/disconnect-payone.html - - title: Manual integration - url: /docs/pbc/all/payment-service-provider/third-party-integrations/payone/manual-integration/payone-manual-integration.html - nested: - - title: Integrate - url: /docs/pbc/all/payment-service-provider/third-party-integrations/payone/manual-integration/integrate-payone.html - - title: Cash on Delivery - url: /docs/pbc/all/payment-service-provider/third-party-integrations/payone/manual-integration/payone-cash-on-delivery.html - - title: PayPal Express Checkout payment - url: /docs/pbc/all/payment-service-provider/third-party-integrations/payone/manual-integration/payone-paypal-express-checkout-payment.html - - title: Risk Check and Address Check - url: /docs/pbc/all/payment-service-provider/third-party-integrations/payone/manual-integration/payone-risk-check-and-address-check.html - - title: Computop - url: /docs/pbc/all/payment-service-provider/third-party-integrations/computop/computop.html - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/third-party-integrations/computop/install-and-configure-computop.html - - title: OMS plugins - url: /docs/pbc/all/payment-service-provider/third-party-integrations/computop/computop-oms-plugins.html - - title: API calls - url: /docs/pbc/all/payment-service-provider/third-party-integrations/computop/computop-api-calls.html - - title: Integrate payment methods - nested: - - title: Sofort - url: /docs/pbc/all/payment-service-provider/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html - - title: PayPal - url: /docs/pbc/all/payment-service-provider/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html - - title: Easy - url: /docs/pbc/all/payment-service-provider/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html - - title: CRIF - url: /docs/pbc/all/payment-service-provider/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.html - - title: iDeal - url: /docs/pbc/all/payment-service-provider/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html - - title: PayNow - url: /docs/pbc/all/payment-service-provider/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html - - title: Сredit Сard - url: /docs/pbc/all/payment-service-provider/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html - - title: Direct Debit - url: /docs/pbc/all/payment-service-provider/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html - - title: Paydirekt - url: /docs/pbc/all/payment-service-provider/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/third-party-integrations/computop/integrate-computop.html - - title: CrefoPay - url: /docs/pbc/all/payment-service-provider/third-party-integrations/crefopay/crefopay.html - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/third-party-integrations/crefopay/install-and-configure-crefopay.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/third-party-integrations/crefopay/integrate-crefopay.html - - title: Enable B2B payments - url: /docs/pbc/all/payment-service-provider/third-party-integrations/crefopay/crefopay-enable-b2b-payments.html - - title: Callbacks - url: /docs/pbc/all/payment-service-provider/third-party-integrations/crefopay/crefopay-callbacks.html - - title: Notifications - url: /docs/pbc/all/payment-service-provider/third-party-integrations/crefopay/crefopay-notifications.html - - title: Capture and refund processes - url: /docs/pbc/all/payment-service-provider/third-party-integrations/crefopay/crefopay-capture-and-refund-processes.html - - title: Payment methods - url: /docs/pbc/all/payment-service-provider/third-party-integrations/crefopay/crefopay-payment-methods.html - - title: Heidelpay - url: /docs/pbc/all/payment-service-provider/third-party-integrations/heidelpay/heidelpay.html - nested: - - title: Install - url: /docs/pbc/all/payment-service-provider/third-party-integrations/heidelpay/install-heidelpay.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/third-party-integrations/heidelpay/integrate-heidelpay.html - - title: Configure - url: /docs/pbc/all/payment-service-provider/third-party-integrations/heidelpay/configure-heidelpay.html - - title: Integrate payment methods - nested: - - title: Sofort - url: /docs/pbc/all/payment-service-provider/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-sofort-payment-method-for-heidelpay.html - - title: Invoice Secured B2C - url: /docs/pbc/all/payment-service-provider/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-invoice-secured-b2c-payment-method-for-heidelpay.html - - title: iDeal - url: /docs/pbc/all/payment-service-provider/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-ideal-payment-method-for-heidelpay.html - - title: Easy Credit - url: /docs/pbc/all/payment-service-provider/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html - - title: Direct Debit - url: /docs/pbc/all/payment-service-provider/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html - - title: Split-payment Marketplace - url: /docs/pbc/all/payment-service-provider/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.html - - title: Paypal Debit - url: /docs/pbc/all/payment-service-provider/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-debit-payment-method-for-heidelpay.html - - title: Paypal Authorize - url: /docs/pbc/all/payment-service-provider/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html - - title: Credit Card Secure - url: /docs/pbc/all/payment-service-provider/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html - - title: Workflow for errors - url: /docs/pbc/all/payment-service-provider/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.html - - title: OMS workflow - url: /docs/pbc/all/payment-service-provider/third-party-integrations/heidelpay/heidelpay-oms-workflow.html - - title: Klarna - url: /docs/pbc/all/payment-service-provider/third-party-integrations/klarna/klarna.html - nested: - - title: Invoice Pay in 14 days - url: /docs/pbc/all/payment-service-provider/third-party-integrations/klarna/klarna-invoice-pay-in-14-days.html - - title: Part Payment Flexible - url: /docs/pbc/all/payment-service-provider/third-party-integrations/klarna/klarna-part-payment-flexible.html - - title: Payment workflow - url: /docs/pbc/all/payment-service-provider/third-party-integrations/klarna/klarna-payment-workflow.html - - title: State machine commands and conditions - url: /docs/pbc/all/payment-service-provider/third-party-integrations/klarna/klarna-state-machine-commands-and-conditions.html - - title: Payolution - url: /docs/pbc/all/payment-service-provider/third-party-integrations/payolution/payolution.html - nested: - - title: Install and configure Payolution - url: /docs/pbc/all/payment-service-provider/third-party-integrations/payolution/install-and-configure-payolution.html - - title: Integrate Payolution - url: /docs/pbc/all/payment-service-provider/third-party-integrations/payolution/integrate-payolution.html - - title: Integrate the invoice paymnet method - url: /docs/pbc/all/payment-service-provider/third-party-integrations/payolution/integrate-the-invoice-payment-method-for-payolution.html - - title: Integrate the installment payment method for - url: /docs/pbc/all/payment-service-provider/third-party-integrations/payolution/integrate-the-installment-payment-method-for-payolution.html - - title: Performing requests - url: /docs/pbc/all/payment-service-provider/third-party-integrations/payolution/payolution-performing-requests.html - - title: Payolution request flow - url: /docs/pbc/all/payment-service-provider/third-party-integrations/payolution/payolution-request-flow.html - - title: ratenkauf by easyCredit - url: /docs/pbc/all/payment-service-provider/third-party-integrations/ratenkauf-by-easycredit/ratenkauf-by-easycredit.html - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/third-party-integrations/ratenkauf-by-easycredit/install-and-configure-ratenkauf-by-easycredit.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/third-party-integrations/ratenkauf-by-easycredit/integrate-ratenkauf-by-easycredit.html - - title: Powerpay - url: /docs/pbc/all/payment-service-provider/third-party-integrations/powerpay.html - - title: RatePay - url: /docs/pbc/all/payment-service-provider/third-party-integrations/ratepay/ratepay.html - nested: - - title: Facade methods - url: /docs/pbc/all/payment-service-provider/third-party-integrations/ratepay/ratepay-facade-methods.html - - title: Payment workflow - url: /docs/pbc/all/payment-service-provider/third-party-integrations/ratepay/ratepay-payment-workflow.html - - title: Disable address updates from the backend application - url: /docs/pbc/all/payment-service-provider/third-party-integrations/ratepay/disable-address-updates-from-the-backend-application-for-ratepay.html - - title: State machine commands and conditions - url: /docs/pbc/all/payment-service-provider/third-party-integrations/ratepay/ratepay-state-machine-commands-and-conditions.html - - title: Core module structure diagram - url: /docs/pbc/all/payment-service-provider/third-party-integrations/ratepay/ratepay-core-module-structure-diagram.html - - title: State machines - url: /docs/pbc/all/payment-service-provider/third-party-integrations/ratepay/ratepay-state-machines.html - - title: Integrate payment methods - nested: - - title: Direct Debit - url: /docs/pbc/all/payment-service-provider/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-direct-debit-payment-method-for-ratepay.html - - title: Prepayment - url: /docs/pbc/all/payment-service-provider/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-prepayment-payment-method-for-ratepay.html - - title: Installment - url: /docs/pbc/all/payment-service-provider/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-installment-payment-method-for-ratepay.html - - title: Invoice - url: /docs/pbc/all/payment-service-provider/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-invoice-payment-method-for-ratepay.html - - title: Unzer - url: /docs/pbc/all/payment-service-provider/third-party-integrations/unzer/unzer.html - nested: - - title: What's changed - url: /docs/pbc/all/payment-service-provider/third-party-integrations/unzer/whats-changed-in-unzer.html - - title: Install - nested: - - title: Install and configure - url: /docs/pbc/all/payment-service-provider/third-party-integrations/unzer/install-unzer/install-and-configure-unzer.html - - title: Integrate - url: /docs/pbc/all/payment-service-provider/third-party-integrations/unzer/install-unzer/integrate-unzer.html - - title: Integrate Glue API - url: /docs/pbc/all/payment-service-provider/third-party-integrations/unzer/install-unzer/integrate-unzer-glue-api.html - - title: Use cases, HowTos, and tips - nested: - - title: Refund shipping costs - url: /docs/pbc/all/payment-service-provider/third-party-integrations/unzer/howto-tips-use-cases/refund-shipping-costs.html - - title: Understand how payment methods are displayed in the checkout process - url: /docs/pbc/all/payment-service-provider/third-party-integrations/unzer/howto-tips-use-cases/understand-payment-method-in-checkout-process.html - - title: Configuration in the Back Office - nested: - - title: Add Unzer standard credentials - url: /docs/pbc/all/payment-service-provider/third-party-integrations/unzer/configure-in-the-back-office/add-unzer-standard-credentails.html - - title: Add Unzer marketplace credentials - url: /docs/pbc/all/payment-service-provider/third-party-integrations/unzer/configure-in-the-back-office/add-unzer-marketplace-credentials.html - - title: Extend and Customize - nested: - - title: Implement new payment methods on the project level - url: /docs/pbc/all/payment-service-provider/third-party-integrations/unzer/extend-and-customize/implement-new-payment-methods-on-the-project-level.html - - title: Customize the credit card display in your payment step - url: /docs/pbc/all/payment-service-provider/third-party-integrations/unzer/extend-and-customize/customize-the-credit-card-display-in-your-payment-step.html - - title: Domain model and relationships - url: /docs/pbc/all/payment-service-provider/third-party-integrations/unzer/unzer-domain-model-and-relationships.html + url: /docs/pbc/all/payment-service-provider/unzer/install-unzer/integrate-unzer.html + - title: Integrate Glue API + url: /docs/pbc/all/payment-service-provider/unzer/install-unzer/integrate-unzer-glue-api.html + - title: Use cases, HowTos, and tips + nested: + - title: Refund shipping costs + url: /docs/pbc/all/payment-service-provider/unzer/howto-tips-use-cases/refund-shipping-costs.html + - title: Understand how payment methods are displayed in the checkout process + url: /docs/pbc/all/payment-service-provider/unzer/howto-tips-use-cases/understand-payment-method-in-checkout-process.html + - title: Configuration in the Back Office + nested: + - title: Add Unzer standard credentials + url: /docs/pbc/all/payment-service-provider/unzer/configure-in-the-back-office/add-unzer-standard-credentails.html + - title: Add Unzer marketplace credentials + url: /docs/pbc/all/payment-service-provider/unzer/configure-in-the-back-office/add-unzer-marketplace-credentials.html + - title: Extend and Customize + nested: + - title: Implement new payment methods on the project level + url: /docs/pbc/all/payment-service-provider/unzer/extend-and-customize/implement-new-payment-methods-on-the-project-level.html + - title: Customize the credit card display in your payment step + url: /docs/pbc/all/payment-service-provider/unzer/extend-and-customize/customize-the-credit-card-display-in-your-payment-step.html + + + + - title: Price Management url: /docs/pbc/all/price-management/price-management.html nested: @@ -2624,6 +2620,8 @@ entries: url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-approval-process-feature.html - title: Marketplace Product url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-feature.html + - title: Marketplace Product + Cart + url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-cart-feature.html - title: Marketplace Product + Inventory Management url: /docs/pbc/all/product-information-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-inventory-management-feature.html - title: Marketplace Product + Marketplace Product Offer @@ -2821,6 +2819,7 @@ entries: - title: Install the Product Rating and Reviews Glue API url: /docs/pbc/all/ratings-reviews/install-and-upgrade/install-the-product-rating-and-reviews-glue-api.html - title: Import and export data + url: /docs/pbc/all/ratings-reviews/import-and-export-data/ratings-and-reviews-data-import.html nested: - title: File details- product_review.csv url: /docs/pbc/all/ratings-reviews/import-and-export-data/file-details-product-review.csv.html @@ -3024,11 +3023,12 @@ entries: - title: Search the product catalog url: /docs/pbc/all/search/base-shop/manage-using-glue-api/glue-api-search-the-product-catalog.html - title: Import and export data + url: /docs/pbc/all/search/base-shop/import-and-export-data/search-data-import.html nested: - title: "File details: product_search_attribute_map.csv" - url: /docs/pbc/all/search/base-shop/import-data/file-details-product-search-attribute-map.csv.html + url: /docs/pbc/all/search/base-shop/import-and-export-data/file-details-product-search-attribute-map.csv.html - title: "File details: product_search_attribute.csv" - url: /docs/pbc/all/search/base-shop/import-data/file-details-product-search-attribute.csv.html + url: /docs/pbc/all/search/base-shop/import-and-export-data/file-details-product-search-attribute.csv.html - title: Tutorials and Howtos nested: - title: "Tutorial: Content and search - attribute-cart-based catalog personalization" @@ -3231,15 +3231,16 @@ entries: - title: Retrieve tax sets when retrieving abstract products url: /docs/pbc/all/tax-management/base-shop/manage-using-glue-api/retrieve-tax-sets-when-retrieving-abstract-products.html - title: Import and export data - nested: - - title: Import tax sets - url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-tax-sets.html - - title: Import tax sets for abstract products - url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-tax-sets-for-abstract-products.html - - title: Import tax sets for product options - url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-tax-sets-for-product-options.html - - title: Import tax sets for shipment methoods - url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-tax-sets-for-shipment-methods.html + url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/tax-management-data-import.html + nested: + - title: "Import file details: tax_sets.csv" + url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-tax-sets.csv.html + - title: "Import file details: product_abstract.csv" + url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-product-abstract.csv.html + - title: "Import file details: product_option.csv" + url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-product-option.csv.html + - title: "Import file details: shipment.csv" + url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-shipment.csv.html - title: Extend and customize url: /docs/pbc/all/tax-management/base-shop/extend-and-customize/tax-module-reference-information.html - title: Domain model and relationships @@ -3330,10 +3331,6 @@ entries: url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-inventory-management-feature.html - title: Inventory Management + Alternative Products url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-inventory-management-alternative-products-feature.html - - title: Order Management + Inventory Management - url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-order-management-inventory-management-feature.html - include_versions: - - "202304.0" - title: Availability Notification Glue API url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/install-features/install-the-availability-notification-glue-api.html - title: Inventory Management Glue API @@ -3354,16 +3351,17 @@ entries: url: /docs/pbc/all/warehouse-management-system/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stockgui-module.html include_versions: - "202212.0" - - title: Import data + - title: Import and export data + url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/warehouse-management-system-data-import.html nested: - title: File details - warehouse.csv - url: /docs/pbc/all/warehouse-management-system/base-shop/import-data/file-details-warehouse.csv.html + url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/file-details-warehouse.csv.html - title: File details - warehouse_address.csv - url: /docs/pbc/all/warehouse-management-system/base-shop/import-data/file-details-warehouse-address.csv.html + url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/file-details-warehouse-address.csv.html - title: File details - warehouse_store.csv - url: /docs/pbc/all/warehouse-management-system/base-shop/import-data/file-details-warehouse-store.csv.html + url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/file-details-warehouse-store.csv.html - title: File details - product_stock.csv - url: /docs/pbc/all/warehouse-management-system/base-shop/import-data/file-details-product-stock.csv.html + url: /docs/pbc/all/warehouse-management-system/base-shop/import-and-export-data/file-details-product-stock.csv.html - title: Manage in the Back Office url: /docs/pbc/all/warehouse-management-system/base-shop/manage-in-the-back-office/log-into-the-back-office.html nested: diff --git a/_data/sidebars/scos_dev_sidebar.yml b/_data/sidebars/scos_dev_sidebar.yml index 1cce9088a4e..b24cd8e1ca9 100644 --- a/_data/sidebars/scos_dev_sidebar.yml +++ b/_data/sidebars/scos_dev_sidebar.yml @@ -658,35 +658,105 @@ entries: - "202005.0" - "202009.0" - "202108.0" - - - - - - - title: Glue API guides url: /docs/scos/dev/glue-api-guides/glue-api-guides.html nested: - title: Glue REST API url: /docs/scos/dev/glue-api-guides/glue-rest-api.html + include_versions: + - "201811.0" + - "201903.0" + - "201907.0" + - "202001.0" + - "202005.0" + - "202009.0" + - "202108.0" + - "202204.0" - title: Glue Spryks url: /docs/scos/dev/glue-api-guides/glue-spryks.html + - title: Decoupled Glue API + url: /docs/scos/dev/glue-api-guides/decoupled-glue-api.html + include_versions: + - "202212.0" - title: Glue infrastructure url: /docs/scos/dev/glue-api-guides/glue-infrastructure.html + include_versions: + - "201811.0" + - "201903.0" + - "201907.0" + - "202001.0" + - "202005.0" + - "202009.0" + - "202108.0" + - "202204.0" - title: Decoupled Glue infrastructure include_versions: - "202204.0" - - "202212.0" nested: - title: Backend and Storefront API module differences url: /docs/scos/dev/glue-api-guides/decoupled-glue-infrastructure/backend-and-storefront-api-module-differences.html + include_versions: + - "202204.0" - title: Create Glue API applications url: /docs/scos/dev/glue-api-guides/decoupled-glue-infrastructure/create-glue-api-applications.html + include_versions: + - "202204.0" - title: Authentication and authorization url: /docs/scos/dev/glue-api-guides/decoupled-glue-infrastructure/authentication-and-authorization.html + include_versions: + - "202204.0" - title: Security and authentication url: /docs/scos/dev/glue-api-guides/decoupled-glue-infrastructure/security-and-authentication.html - + include_versions: + - "202204.0" + - title: Backend and Storefront API module differences + url: /docs/scos/dev/glue-api-guides/backend-and-storefront-api-module-differences.html + include_versions: + - "202212.0" + - title: Create Glue API applications + url: /docs/scos/dev/glue-api-guides/create-glue-api-applications.html + include_versions: + - "202212.0" + - title: Authentication and authorization + url: /docs/scos/dev/glue-api-guides/authentication-and-authorization.html + include_versions: + - "202212.0" + - title: Security and authentication + url: /docs/scos/dev/glue-api-guides/security-and-authentication.html + include_versions: + - "202212.0" + - title: Old Glue infrastructure + include_versions: + - "202212.0" + nested: + - title: Glue REST API + url: /docs/scos/dev/glue-api-guides/old-glue-infrastructure/glue-rest-api.html + include_versions: + - "202212.0" + - title: Glue infrastructure + url: /docs/scos/dev/glue-api-guides/old-glue-infrastructure/glue-infrastructure.html + include_versions: + - "202212.0" + - title: Handling concurrent REST requests and caching with entity tags + url: /docs/scos/dev/glue-api-guides/old-glue-infrastructure/handling-concurrent-rest-requests-and-caching-with-entity-tags.html + include_versions: + - "202212.0" + - title: Resolving search engine friendly URLs + url: /docs/scos/dev/glue-api-guides/old-glue-infrastructure/resolving-search-engine-friendly-urls.html + include_versions: + - "202212.0" + - title: Reference information - GlueApplication errors + url: /docs/scos/dev/glue-api-guides/old-glue-infrastructure/reference-information-glueapplication-errors.html + include_versions: + - "202212.0" + - title: REST API B2B Demo Shop reference + url: /docs/scos/dev/glue-api-guides/old-glue-infrastructure/rest-api-b2b-reference.html + include_versions: + - "202212.0" + - title: REST API B2C Demo Shop reference + url: /docs/scos/dev/glue-api-guides/old-glue-infrastructure/rest-api-b2c-reference.html + include_versions: + - "202212.0" - title: Routing include_versions: - "202204.0" @@ -698,7 +768,6 @@ entries: url: /docs/scos/dev/glue-api-guides/routing/create-backend-resources.html - title: Create routes url: /docs/scos/dev/glue-api-guides/routing/create-routes.html - - title: Create and change Glue API conventions url: /docs/scos/dev/glue-api-guides/create-and-change-glue-api-conventions.html include_versions: @@ -706,6 +775,9 @@ entries: - "202212.0" - title: Create Glue API authorization strategies url: /docs/scos/dev/glue-api-guides/create-glue-api-authorization-strategies.html + include_versions: + - "202204.0" + - "202212.0" - title: Create Glue API resources with parent-child relationships url: /docs/scos/dev/glue-api-guides/create-glue-api-resources-with-parent-child-relationships.html include_versions: @@ -733,8 +805,21 @@ entries: - "202212.0" - title: Handling concurrent REST requests and caching with entity tags url: /docs/scos/dev/glue-api-guides/handling-concurrent-rest-requests-and-caching-with-entity-tags.html + include_versions: + - "201907.0" + - "202001.0" + - "202005.0" + - "202009.0" + - "202108.0" + - "202204.0" - title: Resolving search engine friendly URLs url: /docs/scos/dev/glue-api-guides/resolving-search-engine-friendly-urls.html + include_versions: + - "202001.0" + - "202005.0" + - "202009.0" + - "202108.0" + - "202204.0" - title: Use authentication servers with Glue API url: /docs/scos/dev/glue-api-guides/use-authentication-servers-with-glue-api.html include_versions: @@ -784,17 +869,14 @@ entries: - "202009.0" - "202108.0" - "202204.0" - - "202212.0" - title: REST API B2C Demo Shop reference url: /docs/scos/dev/glue-api-guides/rest-api-b2c-reference.html include_versions: - "202204.0" - - "202212.0" - title: REST API B2B Demo Shop reference url: /docs/scos/dev/glue-api-guides/rest-api-b2b-reference.html include_versions: - "202204.0" - - "202212.0" - title: Managing customers url: /docs/scos/dev/glue-api-guides/managing-customers/managing-customers.html include_versions: @@ -806,14 +888,25 @@ entries: - "202009.0" - "202108.0" - "202204.0" + nested: + - title: Managing customer addresses + url: /docs/scos/dev/glue-api-guides/managing-customers/managing-customer-addresses.html + include_versions: + - "202009.0" + - "202108.0" + - "202204.0" + - title: Retrieving customer orders + url: /docs/scos/dev/glue-api-guides/managing-customers/retrieving-customer-orders.html + include_versions: + - "201811.0" + - "201903.0" + - "202005.0" + - "202009.0" + - "202108.0" + - "202204.0" - title: Managing B2B account - url: /docs/scos/dev/glue-api-guidesmanaging-b2b-account/managing-b2b-account.html + url: /docs/scos/dev/glue-api-guides/managing-b2b-account/managing-b2b-account.html include_versions: - - "201907.0" - - "202001.0" - - "202005.0" - - "202009.0" - - "202108.0" - "202204.0" nested: - title: Searching by company users @@ -828,15 +921,21 @@ entries: url: /docs/scos/dev/glue-api-guides/managing-b2b-account/retrieving-company-roles.html - title: Retrieving business unit addresses url: /docs/scos/dev/glue-api-guides/managing-b2b-account/retrieving-business-unit-addresses.html - - - - title: Retrieve related products - url: /docs/scos/dev/glue-api-guides/retrieve-related-products.html + - title: Retrieving store configuration + url: /docs/scos/dev/glue-api-guides/retrieving-store-configuration.html include_versions: - - "202009.0" + - "201811.0" + - "201903.0" - "201907.0" + - "202001.0" + - "202005.0" + - "202009.0" - "202108.0" - "202204.0" + - title: Retrieve related products + url: /docs/scos/dev/glue-api-guides/retrieve-related-products.html + include_versions: + - "202204.0" - title: Searching the product catalog url: /docs/scos/dev/glue-api-guides/searching-the-product-catalog.html include_versions: @@ -858,13 +957,6 @@ entries: - "201907.0" - "202108.0" - "202204.0" - - - - - - - - title: Feature integration guides url: /docs/scos/dev/feature-integration-guides/feature-integration-guides.html nested: @@ -2861,6 +2953,10 @@ entries: - "202108.0" - "202204.0" - "202212.0" + - title: Marketplace data import + url: /docs/scos/dev/data-import/marketplace-data-import.html + include_versions: + - "202212.0" - title: "Tutorial: Replace a default data importer with the queue data importer" url: /docs/scos/dev/data-import/tutorial-replace-a-default-data-importer-with-the-queue-data-importer.html include_versions: @@ -3387,11 +3483,18 @@ entries: url: /docs/scos/dev/migration-concepts/silex-replacement/migrate-modules/migrate-the-validator-module.html - title: WebProfiler url: /docs/scos/dev/migration-concepts/silex-replacement/migrate-modules/migrate-the-webprofiler-module.html + - title: Update to Angular 12 + url: /docs/scos/dev/migration-concepts/upgrade-to-angular-12.html + - title: Update to Angular 15 + url: /docs/scos/dev/migration-concepts/upgrade-to-angular-15.html + - title: Upgrade to Marketplace + url: /docs/scos/dev/migration-concepts/upgrade-to-marketplace.html - title: Migrate to Docker url: /docs/scos/dev/migration-concepts/migrate-to-docker/migrate-to-docker.html nested: - title: Adjust Jenkins for a Docker environment url: /docs/scos/dev/migration-concepts/migrate-to-docker/adjust-jenkins-for-a-docker-environment.html + - title: - title: The Docker SDK url: /docs/scos/dev/the-docker-sdk/the-docker-sdk.html include_versions: @@ -3821,6 +3924,11 @@ entries: url: /docs/scos/dev/tutorials-and-howtos/howtos/howto-allow-zed-css-js-on-a-project-for-oryx-for-zed-2.13.0-and-later.html - title: "HowTo: Reduce Jenkins execution by up to 80% without P&S and Data importers refactoring" url: /docs/scos/dev/tutorials-and-howtos/howtos/howto-reduce-jenkins-execution-by-up-to-80-percent-without-ps-and-data-import-refactoring.html + - title: "HowTo: Create an Angular module with application" + url: /docs/scos/dev/tutorials-and-howtos/howtos/howto-create-an-angular-module-with-application.html + - title: "HowTo: Split products by stores" + url: /docs/scos/dev/tutorials-and-howtos/howtos/howto-split-products-by-stores.html + - title: Technology partner guides url: /docs/scos/dev/technology-partner-guides/technology-partner-guides.html include_versions: @@ -4703,4 +4811,4 @@ entries: url: /docs/scos/dev/updating-spryker/troubleshooting-updates.html - title: Code contribution guide url: /docs/scos/dev/code-contribution-guide.html -... +... \ No newline at end of file diff --git a/_data/sidebars/scos_user_sidebar.yml b/_data/sidebars/scos_user_sidebar.yml index d488f0d5a5c..02900a12eda 100644 --- a/_data/sidebars/scos_user_sidebar.yml +++ b/_data/sidebars/scos_user_sidebar.yml @@ -104,8 +104,6 @@ entries: nested: - title: How Spryker Support works url: /docs/scos/user/intro-to-spryker/support/how-spryker-support-works.html - - title: Handling new feature requests - url: /docs/scos/user/intro-to-spryker/support/handling-new-feature-requests.html - title: Case escalation url: /docs/scos/user/intro-to-spryker/support/case-escalation.html - title: Getting support diff --git a/docs/scos/user/intro-to-spryker/support/handling-new-feature-requests.md b/_drafts/deprecated/handling-new-feature-requests.md similarity index 100% rename from docs/scos/user/intro-to-spryker/support/handling-new-feature-requests.md rename to _drafts/deprecated/handling-new-feature-requests.md diff --git a/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-checkout-glue-api.md b/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-checkout-glue-api.md index 9a5a3c0ca60..a15d86b4a0f 100644 --- a/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-checkout-glue-api.md +++ b/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-checkout-glue-api.md @@ -16,7 +16,7 @@ To start feature integration, overview and install the necessary features: | Glue API: Spryker Core | {{page.version}} | [Glue API: Spryker Core feature integration](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html) | | Glue API: Cart | {{page.version}} | [Install the Cart Glue API](/docs/pbc/all/cart-and-checkout/{{page.version}}/base-shop/install-and-upgrade/install-glue-api/install-the-cart-glue-api.html) | | Glue API: Customer Account Management | {{page.version}} | [Install the Customer Account Management Glue API](/docs/pbc/all/identity-access-management/{{page.version}}/install-and-upgrade/install-the-customer-account-management-glue-api.html) | -| Glue API: Payments | {{page.version}} | [Glue API: Payments feature integration](/docs/pbc/all/payment-service-provider/{{page.version}}/install-and-upgrade/install-the-payments-glue-api.html) | +| Glue API: Payments | {{page.version}} | [Glue API: Payments feature integration](/docs/pbc/all/payment-service-provider/{{page.version}}/spryker-pay/base-shop/install-and-upgrade/install-the-payments-glue-api.html) | | Glue API: Shipment | {{page.version}} | [Integrate the Shipment Glue API](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/install-and-upgrade/install-the-shipment-glue-api.html) | ### 1) Install the required modules using Composer @@ -545,7 +545,7 @@ Ensure that `GuestCartByRestCheckoutDataResourceRelationshipPlugin` is set up co {% endinfo_block %} -For more details, see [Implementing Checkout Steps for Glue API](/docs/pbc/all/payment-service-provider/{{page.version}}/interact-with-third-party-payment-providers-using-glue-api.html). +For more details, see [Implementing Checkout Steps for Glue API](/docs/pbc/all/payment-service-provider/{{page.version}}/spryker-pay/base-shop/interact-with-third-party-payment-providers-using-glue-api.html). #### Configure mapping @@ -879,4 +879,4 @@ Integrate the following related features. | FEATURE | REQUIRED FOR THE CURRENT FEATURE | INTEGRATION GUIDE | | -------- | ----------------- | ---------------------- | | Glue API: Shipment | ✓ | [Glue API: Shipment feature integration](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/install-and-upgrade/install-the-shipment-glue-api.html) | -| Glue API: Payments | ✓ | [Glue API: Payments feature integration](/docs/pbc/all/payment-service-provider/{{page.version}}/install-and-upgrade/install-the-payments-glue-api.html) | +| Glue API: Payments | ✓ | [Glue API: Payments feature integration](/docs/pbc/all/payment-service-provider/{{page.version}}/spryker-pay/base-shop/install-and-upgrade/install-the-payments-glue-api.html) | diff --git a/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-order-management-glue-api.md b/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-order-management-glue-api.md index 7e490fffffe..b7efee899eb 100644 --- a/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-order-management-glue-api.md +++ b/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-order-management-glue-api.md @@ -69,7 +69,7 @@ Activate the following plugins: {% info_block infoBox %} -`OrdersResourceRoutePlugin` GET verb is a protected resource. For more details, see the `configure` function [Resource routing](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-infrastructure.html#resource-routing). +`OrdersResourceRoutePlugin` GET verb is a protected resource. For more details, see the `configure` function [Resource routing](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastucture/glue-infrastructure.html#resource-routing). {% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-payments-glue-api.md b/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-payments-glue-api.md index f118fa6db6f..a98f85fe2b8 100644 --- a/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-payments-glue-api.md +++ b/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-payments-glue-api.md @@ -18,7 +18,7 @@ To start the feature integration, overview and install the necessary features: | NAME | VERSION | INTEGRATION GUIDE | | --- | --- | --- | | Spryker Core | {{page.version}} | [Glue Application feature integration](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html) | -| Payments | {{page.version}} | [Payments feature integration](/docs/pbc/all/payment-service-provider/{{page.version}}/install-and-upgrade/install-the-payments-feature.html) | +| Payments | {{page.version}} | [Payments feature integration](/docs/pbc/all/payment-service-provider/{{page.version}}/spryker-pay/base-shop/install-and-upgrade/install-the-payments-feature.html) | ## 1) Install the required modules using Composer diff --git a/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-shared-carts-glue-api.md b/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-shared-carts-glue-api.md index cc9f8dc47b2..ed471760667 100644 --- a/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-shared-carts-glue-api.md +++ b/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-shared-carts-glue-api.md @@ -109,7 +109,7 @@ The result should be 0 records. * `CartPermissionGroupsResourceRoutePlugin` is a protected resource for the `GET` request. -For more details, see the `configure` function in [Resource Routing](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-infrastructure.html#resource-routing). +For more details, see the `configure` function in [Resource Routing](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastucture/glue-infrastructure.html#resource-routing). {% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-shopping-lists-glue-api.md b/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-shopping-lists-glue-api.md index dfd1941de5d..33d4391aa57 100644 --- a/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-shopping-lists-glue-api.md +++ b/_includes/pbc/all/install-features/202212.0/install-glue-api/install-the-shopping-lists-glue-api.md @@ -108,7 +108,7 @@ SELECT COUNT(*) FROM spy_shopping_list_item WHERE uuid IS NULL; {% info_block infoBox %} -`ShoppingListsResourcePlugin` GET, POST, PATCH and DELETE, `ShoppingListItemsResourcePlugin` POST, PATCH and DELETE verbs are protected resources. For details, refer to the Configure section of [Glue Infrastructure documentation](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-infrastructure.html#resource-routing). +`ShoppingListsResourcePlugin` GET, POST, PATCH and DELETE, `ShoppingListItemsResourcePlugin` POST, PATCH and DELETE verbs are protected resources. For details, refer to the Configure section of [Glue Infrastructure documentation](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastucture/glue-infrastructure.html#resource-routing). {% endinfo_block %} diff --git a/_includes/pbc/all/install-features/202304.0/install-glue-api/install-the-product-rating-and-reviews-glue-api.md b/_includes/pbc/all/install-features/202304.0/install-glue-api/install-the-product-rating-and-reviews-glue-api.md new file mode 100644 index 00000000000..a46bd7b851d --- /dev/null +++ b/_includes/pbc/all/install-features/202304.0/install-glue-api/install-the-product-rating-and-reviews-glue-api.md @@ -0,0 +1,614 @@ + + +This document describes how to integrate the [Product Raiting and Reviews](/docs/pbc/all/ratings-reviews/{{page.version}}/ratings-and-reviews.html) Glue API feature into a Spryker project. + +## Install feature core + +Follow the steps below to install the Product Raiting and Review Glue API feature core. + + +### Prerequisites + +To start feature integration, integrate the required features and Glue APIs: + +| NAME | VERSION | INTEGRATION GUIDE | +| --- | --- | --- | +| Spryker Core Glue API | {{page.version}} | [Install the Spryker Core Glue API](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-spryker-core-feature-integration.html) | +| Product Rating & Reviews | {{page.version}} | [Install the Product Rating and Reviews feature](/docs/pbc/all/ratings-reviews/{{page.version}}/install-and-upgrade/install-the-product-rating-and-reviews-feature.html) | + +### 1) Install the required modules using Composer + +```bash +composer require spryker/product-reviews-rest-api:"^1.1.0" --update-with-dependencies +``` +{% info_block warningBox "Verification" %} + +Make sure that the following module has been installed: + +| MODULE | EXPECTED DIRECTORY | +| --- | --- | +| ProductReviewsRestApi | vendor/spryker/product-reviews-rest-api | + +{% endinfo_block %} + +### 2) Set up database schema and transfer objects + +Generate transfer changes: + +```bash +console transfer:generate +console propel:install +console transfer:generate +``` +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been applied in the transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +|----------------------------------------| --- | --- |----------------------------------------------------------------------| +| RestProductReviewsAttributesTransfer | class | created | src/Generated/Shared/Transfer/RestProductReviewsAttributesTransfer | +| BulkProductReviewSearchRequestTransfer | class | created | src/Generated/Shared/Transfer/BulkProductReviewSearchRequestTransfer | +| StoreTransfer | class | created | src/Generated/Shared/Transfer/StoreTransfer | + + +Make sure that `SpyProductAbstractStorage` and `SpyProductConcreteStorage` are extended by synchronization behavior with these methods: + +| ENTITY | TYPE | EVENT | PATH | METHODS | +| --- | --- | --- | --- | --- | +| SpyProductAbstractStorage | class | extended |src/Orm/Zed/ProductStorage/Persistence/Base/SpyProductAbstractStorage | syncPublishedMessageForMappings(), syncUnpublishedMessageForMappings() | +| SpyProductConcreteStorage | class | extended | src/Orm/Zed/ProductStorage/Persistence/Base/SpyProductConcreteStorage | syncPublishedMessageForMappings(), yncUnpublishedMessageForMappings() | + +{% endinfo_block %} + +### 3) Reload data to storage + +Reload abstract and product data to storage. + +```bash +console event:trigger -r product_abstract +console event:trigger -r product_concrete +``` +{% info_block warningBox "Verification" %} + +Make sure that there is data in Redis with keys: + +- `kv:product_abstract:{% raw %}{{{% endraw %}store_name{% raw %}}}{% endraw %}:{% raw %}{{{% endraw %}locale_name{% raw %}}}{% endraw %}:sku:{% raw %}{{{% endraw %}sku_product_abstract{% raw %}}}{% endraw %}` +- `kv:product_concrete:{% raw %}{{{% endraw %}locale_name{% raw %}}}{% endraw %}:sku:{% raw %}{{{% endraw %}sku_product_concrete{% raw %}}}{% endraw %}` + +{% endinfo_block %} + +### 4) Enable resources + +Activate the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| AbstractProductsProductReviewsResourceRoutePlugin | Registers the product-reviews resource. | None | Spryker\Glue\ProductReviewsRestApi\Plugin\GlueApplication | + +**src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php** + +```php + +Example + +```json +{ + "data": [ + { + "type": "product-reviews", + "id": "21", + "attributes": { + "rating": 4, + "nickname": "Spencor", + "summary": "Donec vestibulum lectus ligula", + "description": "Donec vestibulum lectus ligula, non aliquet neque vulputate vel. Integer neque massa, ornare sit amet felis vitae, pretium feugiat magna. Suspendisse mollis rutrum ante, vitae gravida ipsum commodo quis. Donec eleifend orci sit amet nisi suscipit pulvinar. Nullam ullamcorper dui lorem, nec vehicula justo accumsan id. Sed venenatis magna at posuere maximus. Sed in mauris mauris. Curabitur quam ex, vulputate ac dignissim ac, auctor eget lorem. Cras vestibulum ex quis interdum tristique." + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/abstract-products/139/product-reviews/21" + } + }, + { + "type": "product-reviews", + "id": "22", + "attributes": { + "rating": 4, + "nickname": "Maria", + "summary": "Curabitur varius, dui ac vulputate ullamcorper", + "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc vel mauris consequat, dictum metus id, facilisis quam. Vestibulum imperdiet aliquam interdum. Pellentesque tempus at neque sed laoreet. Nam elementum vitae nunc fermentum suscipit. Suspendisse finibus risus at sem pretium ullamcorper. Donec rutrum nulla nec massa tristique, porttitor gravida risus feugiat. Ut aliquam turpis nisi." + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/abstract-products/139/product-reviews/22" + } + }, + { + "type": "product-reviews", + "id": "23", + "attributes": { + "rating": 4, + "nickname": "Maggie", + "summary": "Aliquam erat volutpat", + "description": "Morbi vitae ultricies libero. Aenean id lectus a elit sollicitudin commodo. Donec mattis libero sem, eu convallis nulla rhoncus ac. Nam tincidunt volutpat sem, eu congue augue cursus at. Mauris augue lorem, lobortis eget varius at, iaculis ac velit. Sed vulputate rutrum lorem, ut rhoncus dolor commodo ac. Aenean sed varius massa. Quisque tristique orci nec blandit fermentum. Sed non vestibulum ante, vitae tincidunt odio. Integer quis elit eros. Phasellus tempor dolor lectus, et egestas magna convallis quis. Ut sed odio nulla. Suspendisse quis laoreet nulla. Integer quis justo at velit euismod imperdiet. Ut orci dui, placerat ut ex ac, lobortis ullamcorper dui. Etiam euismod risus hendrerit laoreet auctor." + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/abstract-products/139/product-reviews/23" + } + }, + { + "type": "product-reviews", + "id": "25", + "attributes": { + "rating": 3, + "nickname": "Spencor", + "summary": "Curabitur ultricies, sapien quis placerat lacinia", + "description": "Etiam venenatis sit amet lorem eget tristique. Donec rutrum massa nec commodo cursus. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Suspendisse scelerisque scelerisque augue eget condimentum. Quisque quis arcu consequat, lacinia nulla tempor, venenatis ante. In ullamcorper, orci sit amet tempus tincidunt, massa augue molestie enim, in finibus metus odio at purus. Mauris ut semper sem, a ornare sapien. Fusce eget facilisis felis. Integer imperdiet massa a tortor varius, tincidunt laoreet ipsum viverra." + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/abstract-products/139/product-reviews/25" + } + }, + { + "type": "product-reviews", + "id": "26", + "attributes": { + "rating": 5, + "nickname": "Spencor", + "summary": "Cras porttitor", + "description": "Cras porttitor, odio vel ultricies commodo, erat turpis pulvinar turpis, id faucibus dolor odio a tellus. Mauris et nibh tempus, convallis ipsum luctus, mollis risus. Donec molestie orci ante, id tristique diam interdum eget. Praesent erat neque, sollicitudin sit amet pellentesque eget, gravida in lectus. Donec ultrices, nisl in laoreet ultrices, nunc enim lacinia felis, ac convallis tortor ligula non eros. Morbi semper ipsum non elit mollis, non commodo arcu porta. Mauris tincidunt purus rutrum erat ornare, varius egestas eros eleifend." + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/abstract-products/139/product-reviews/26" + } + } + ], + "links": { + "self": "http://glue.de.suite-nonsplit.local/abstract-products/139/product-reviews?page[offset]=0&page[limit]=5", + "last": "http://glue.de.suite-nonsplit.local/abstract-products/139/product-reviews?page[offset]=0&page[limit]=5", + "first": "http://glue.de.suite-nonsplit.local/abstract-products/139/product-reviews?page[offset]=0&page[limit]=5" + } +} +``` +
+ +* `https://glue.mysprykershop.com/abstract-products/{% raw %}{{{% endraw %}abstract_sku{% raw %}}}{% endraw %}/product-reviews/{% raw %}{{{% endraw %}review_id{% raw %}}}{% endraw %}` + +
+Example + +```json +{ + "data": { + "type": "product-reviews", + "id": "21", + "attributes": { + "rating": 4, + "nickname": "Spencor", + "summary": "Donec vestibulum lectus ligula", + "description": "Donec vestibulum lectus ligula, non aliquet neque vulputate vel. Integer neque massa, ornare sit amet felis vitae, pretium feugiat magna. Suspendisse mollis rutrum ante, vitae gravida ipsum commodo quis. Donec eleifend orci sit amet nisi suscipit pulvinar. Nullam ullamcorper dui lorem, nec vehicula justo accumsan id. Sed venenatis magna at posuere maximus. Sed in mauris mauris. Curabitur quam ex, vulputate ac dignissim ac, auctor eget lorem. Cras vestibulum ex quis interdum tristique." + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/abstract-products/139/product-reviews/21" + } + } +} +``` +
+ +{% endinfo_block %} + +### 5) Enable relationships + +Activate the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +| --- | --- | --- | --- | +| ProductReviewsRelationshipByProductAbstractSkuPlugin | Adds product-reviews relationship by abstract product sku. | None |\Spryker\Glue\ProductReviewsRestApi\Plugin\GlueApplication | +| ProductReviewsRelationshipByProductConcreteSkuPlugin | Adds product-reviews relationship by concrete product sku. | None | \Spryker\Glue\ProductReviewsRestApi\Plugin\GlueApplication | +| ProductReviewsAbstractProductsResourceExpanderPlugin | Expands abstract-products resource with reviews data. | None | Spryker\Glue\ProductReviewsRestApi\Plugin\ProductsRestApi | +| ProductReviewsConcreteProductsResourceExpanderPlugin | Expands concrete-products resource with reviews data. | None | Spryker\Glue\ProductReviewsRestApi\Plugin\ProductsRestApi | + +**src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php** + +```php +addRelationship( + ProductsRestApiConfig::RESOURCE_ABSTRACT_PRODUCTS, + new ProductReviewsRelationshipByProductAbstractSkuPlugin() + ); + $resourceRelationshipCollection->addRelationship( + ProductsRestApiConfig::RESOURCE_CONCRETE_PRODUCTS, + new ProductReviewsRelationshipByProductConcreteSkuPlugin() + ); + + return $resourceRelationshipCollection; + } +} +``` + +**src/Pyz/Glue/ProductsRestApi/ProductsRestApiDependencyProvider.php** + +```php + +Example + +```json +{ + "data": { + "type": "abstract-products", + "id": "139", + "attributes": { + "sku": "139", + "averageRating": 4, + "reviewCount": 5, + "name": "Asus Transformer Book T200TA", + "description": "As light as you like Transformer Book T200 is sleek, slim and oh so light—just 26mm tall and 1.5kg docked. And when need to travel even lighter, detach the 11.6-inch tablet for 11.95mm slenderness and a mere 750g weight! With up to 10.4 hours of battery life that lasts all day long, you’re free to work or play from dawn to dusk. And ASUS Instant On technology ensures that Transformer Book T200 is always responsive and ready for action! Experience outstanding performance from the latest Intel® quad-core processor. You’ll multitask seamlessly and get more done in less time. Transformer Book T200 also delivers exceptional graphics performance—with Intel HD graphics that are up to 30% faster than ever before! Transformer Book T200 is equipped with USB 3.0 connectivity for data transfers that never leave you waiting. Just attach your USB 3.0 devices to enjoy speeds that are up to 10X faster than USB 2.0!", + "attributes": { + "product_type": "Hybrid (2-in-1)", + "form_factor": "clamshell", + "processor_cache_type": "2", + "processor_frequency": "1.59 GHz", + "brand": "Asus", + "color": "Black" + }, + "superAttributesDefinition": [ + "form_factor", + "processor_frequency", + "color" + ], + "superAttributes": [], + "attributeMap": { + "product_concrete_ids": [ + "139_24699831" + ], + "super_attributes": [], + "attribute_variants": [] + }, + "metaTitle": "Asus Transformer Book T200TA", + "metaKeywords": "Asus,Entertainment Electronics", + "metaDescription": "As light as you like Transformer Book T200 is sleek, slim and oh so light—just 26mm tall and 1.5kg docked. And when need to travel even lighter, detach t", + "attributeNames": { + "product_type": "Product type", + "form_factor": "Form factor", + "processor_cache_type": "Processor cache", + "processor_frequency": "Processor frequency", + "brand": "Brand", + "color": "Color" + }, + "url": "/en/asus-transformer-book-t200ta-139" + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/abstract-products/139?include=product-reviews" + }, + "relationships": { + "product-reviews": { + "data": [ + { + "type": "product-reviews", + "id": "21" + }, + { + "type": "product-reviews", + "id": "22" + }, + { + "type": "product-reviews", + "id": "23" + }, + { + "type": "product-reviews", + "id": "25" + }, + { + "type": "product-reviews", + "id": "26" + } + ] + } + } + }, + "included": [ + { + "type": "product-reviews", + "id": "21", + "attributes": { + "rating": 4, + "nickname": "Spencor", + "summary": "Donec vestibulum lectus ligula", + "description": "Donec vestibulum lectus ligula, non aliquet neque vulputate vel. Integer neque massa, ornare sit amet felis vitae, pretium feugiat magna. Suspendisse mollis rutrum ante, vitae gravida ipsum commodo quis. Donec eleifend orci sit amet nisi suscipit pulvinar. Nullam ullamcorper dui lorem, nec vehicula justo accumsan id. Sed venenatis magna at posuere maximus. Sed in mauris mauris. Curabitur quam ex, vulputate ac dignissim ac, auctor eget lorem. Cras vestibulum ex quis interdum tristique." + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/product-reviews/21" + } + }, + { + "type": "product-reviews", + "id": "22", + "attributes": { + "rating": 4, + "nickname": "Maria", + "summary": "Curabitur varius, dui ac vulputate ullamcorper", + "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc vel mauris consequat, dictum metus id, facilisis quam. Vestibulum imperdiet aliquam interdum. Pellentesque tempus at neque sed laoreet. Nam elementum vitae nunc fermentum suscipit. Suspendisse finibus risus at sem pretium ullamcorper. Donec rutrum nulla nec massa tristique, porttitor gravida risus feugiat. Ut aliquam turpis nisi." + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/product-reviews/22" + } + }, + { + "type": "product-reviews", + "id": "23", + "attributes": { + "rating": 4, + "nickname": "Maggie", + "summary": "Aliquam erat volutpat", + "description": "Morbi vitae ultricies libero. Aenean id lectus a elit sollicitudin commodo. Donec mattis libero sem, eu convallis nulla rhoncus ac. Nam tincidunt volutpat sem, eu congue augue cursus at. Mauris augue lorem, lobortis eget varius at, iaculis ac velit. Sed vulputate rutrum lorem, ut rhoncus dolor commodo ac. Aenean sed varius massa. Quisque tristique orci nec blandit fermentum. Sed non vestibulum ante, vitae tincidunt odio. Integer quis elit eros. Phasellus tempor dolor lectus, et egestas magna convallis quis. Ut sed odio nulla. Suspendisse quis laoreet nulla. Integer quis justo at velit euismod imperdiet. Ut orci dui, placerat ut ex ac, lobortis ullamcorper dui. Etiam euismod risus hendrerit laoreet auctor." + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/product-reviews/23" + } + }, + { + "type": "product-reviews", + "id": "25", + "attributes": { + "rating": 3, + "nickname": "Spencor", + "summary": "Curabitur ultricies, sapien quis placerat lacinia", + "description": "Etiam venenatis sit amet lorem eget tristique. Donec rutrum massa nec commodo cursus. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Suspendisse scelerisque scelerisque augue eget condimentum. Quisque quis arcu consequat, lacinia nulla tempor, venenatis ante. In ullamcorper, orci sit amet tempus tincidunt, massa augue molestie enim, in finibus metus odio at purus. Mauris ut semper sem, a ornare sapien. Fusce eget facilisis felis. Integer imperdiet massa a tortor varius, tincidunt laoreet ipsum viverra." + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/product-reviews/25" + } + }, + { + "type": "product-reviews", + "id": "26", + "attributes": { + "rating": 5, + "nickname": "Spencor", + "summary": "Cras porttitor", + "description": "Cras porttitor, odio vel ultricies commodo, erat turpis pulvinar turpis, id faucibus dolor odio a tellus. Mauris et nibh tempus, convallis ipsum luctus, mollis risus. Donec molestie orci ante, id tristique diam interdum eget. Praesent erat neque, sollicitudin sit amet pellentesque eget, gravida in lectus. Donec ultrices, nisl in laoreet ultrices, nunc enim lacinia felis, ac convallis tortor ligula non eros. Morbi semper ipsum non elit mollis, non commodo arcu porta. Mauris tincidunt purus rutrum erat ornare, varius egestas eros eleifend." + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/product-reviews/26" + } + } + ] +} +``` +
+ + +4. Make a request to `https://glue.mysprykershop.com/concrete-products/{% raw %}{{{% endraw %}concrete_sku{% raw %}}}{% endraw %}?include=product-reviews`. + +5. Make sure that the response contains `product-reviews` as a relationship and `product-reviews` data included. + +
+Example + +```json +{ + "data": { + "type": "concrete-products", + "id": "139_24699831", + "attributes": { + "sku": "139_24699831", + "isDiscontinued": false, + "discontinuedNote": null, + "averageRating": 4, + "reviewCount": 5, + "name": "Asus Transformer Book T200TA", + "description": "As light as you like Transformer Book T200 is sleek, slim and oh so light—just 26mm tall and 1.5kg docked. And when need to travel even lighter, detach the 11.6-inch tablet for 11.95mm slenderness and a mere 750g weight! With up to 10.4 hours of battery life that lasts all day long, you’re free to work or play from dawn to dusk. And ASUS Instant On technology ensures that Transformer Book T200 is always responsive and ready for action! Experience outstanding performance from the latest Intel® quad-core processor. You’ll multitask seamlessly and get more done in less time. Transformer Book T200 also delivers exceptional graphics performance—with Intel HD graphics that are up to 30% faster than ever before! Transformer Book T200 is equipped with USB 3.0 connectivity for data transfers that never leave you waiting. Just attach your USB 3.0 devices to enjoy speeds that are up to 10X faster than USB 2.0!", + "attributes": { + "product_type": "Hybrid (2-in-1)", + "form_factor": "clamshell", + "processor_cache_type": "2", + "processor_frequency": "1.59 GHz", + "brand": "Asus", + "color": "Black" + }, + "superAttributesDefinition": [ + "form_factor", + "processor_frequency", + "color" + ], + "metaTitle": "Asus Transformer Book T200TA", + "metaKeywords": "Asus,Entertainment Electronics", + "metaDescription": "As light as you like Transformer Book T200 is sleek, slim and oh so light—just 26mm tall and 1.5kg docked. And when need to travel even lighter, detach t", + "attributeNames": { + "product_type": "Product type", + "form_factor": "Form factor", + "processor_cache_type": "Processor cache", + "processor_frequency": "Processor frequency", + "brand": "Brand", + "color": "Color" + } + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/concrete-products/139_24699831?include=product-reviews" + }, + "relationships": { + "product-reviews": { + "data": [ + { + "type": "product-reviews", + "id": "21" + }, + { + "type": "product-reviews", + "id": "22" + }, + { + "type": "product-reviews", + "id": "23" + }, + { + "type": "product-reviews", + "id": "25" + }, + { + "type": "product-reviews", + "id": "26" + } + ] + } + } + }, + "included": [ + { + "type": "product-reviews", + "id": "21", + "attributes": { + "rating": 4, + "nickname": "Spencor", + "summary": "Donec vestibulum lectus ligula", + "description": "Donec vestibulum lectus ligula, non aliquet neque vulputate vel. Integer neque massa, ornare sit amet felis vitae, pretium feugiat magna. Suspendisse mollis rutrum ante, vitae gravida ipsum commodo quis. Donec eleifend orci sit amet nisi suscipit pulvinar. Nullam ullamcorper dui lorem, nec vehicula justo accumsan id. Sed venenatis magna at posuere maximus. Sed in mauris mauris. Curabitur quam ex, vulputate ac dignissim ac, auctor eget lorem. Cras vestibulum ex quis interdum tristique." + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/product-reviews/21" + } + }, + { + "type": "product-reviews", + "id": "22", + "attributes": { + "rating": 4, + "nickname": "Maria", + "summary": "Curabitur varius, dui ac vulputate ullamcorper", + "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc vel mauris consequat, dictum metus id, facilisis quam. Vestibulum imperdiet aliquam interdum. Pellentesque tempus at neque sed laoreet. Nam elementum vitae nunc fermentum suscipit. Suspendisse finibus risus at sem pretium ullamcorper. Donec rutrum nulla nec massa tristique, porttitor gravida risus feugiat. Ut aliquam turpis nisi." + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/product-reviews/22" + } + }, + { + "type": "product-reviews", + "id": "23", + "attributes": { + "rating": 4, + "nickname": "Maggie", + "summary": "Aliquam erat volutpat", + "description": "Morbi vitae ultricies libero. Aenean id lectus a elit sollicitudin commodo. Donec mattis libero sem, eu convallis nulla rhoncus ac. Nam tincidunt volutpat sem, eu congue augue cursus at. Mauris augue lorem, lobortis eget varius at, iaculis ac velit. Sed vulputate rutrum lorem, ut rhoncus dolor commodo ac. Aenean sed varius massa. Quisque tristique orci nec blandit fermentum. Sed non vestibulum ante, vitae tincidunt odio. Integer quis elit eros. Phasellus tempor dolor lectus, et egestas magna convallis quis. Ut sed odio nulla. Suspendisse quis laoreet nulla. Integer quis justo at velit euismod imperdiet. Ut orci dui, placerat ut ex ac, lobortis ullamcorper dui. Etiam euismod risus hendrerit laoreet auctor." + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/product-reviews/23" + } + }, + { + "type": "product-reviews", + "id": "25", + "attributes": { + "rating": 3, + "nickname": "Spencor", + "summary": "Curabitur ultricies, sapien quis placerat lacinia", + "description": "Etiam venenatis sit amet lorem eget tristique. Donec rutrum massa nec commodo cursus. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Suspendisse scelerisque scelerisque augue eget condimentum. Quisque quis arcu consequat, lacinia nulla tempor, venenatis ante. In ullamcorper, orci sit amet tempus tincidunt, massa augue molestie enim, in finibus metus odio at purus. Mauris ut semper sem, a ornare sapien. Fusce eget facilisis felis. Integer imperdiet massa a tortor varius, tincidunt laoreet ipsum viverra." + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/product-reviews/25" + } + }, + { + "type": "product-reviews", + "id": "26", + "attributes": { + "rating": 5, + "nickname": "Spencor", + "summary": "Cras porttitor", + "description": "Cras porttitor, odio vel ultricies commodo, erat turpis pulvinar turpis, id faucibus dolor odio a tellus. Mauris et nibh tempus, convallis ipsum luctus, mollis risus. Donec molestie orci ante, id tristique diam interdum eget. Praesent erat neque, sollicitudin sit amet pellentesque eget, gravida in lectus. Donec ultrices, nisl in laoreet ultrices, nunc enim lacinia felis, ac convallis tortor ligula non eros. Morbi semper ipsum non elit mollis, non commodo arcu porta. Mauris tincidunt purus rutrum erat ornare, varius egestas eros eleifend." + }, + "links": { + "self": "http://glue.de.suite-nonsplit.local/product-reviews/26" + } + } + ] +} +``` +
+ +{% endinfo_block %} + + + diff --git a/_includes/pbc/all/install-features/202304.0/install-the-gift-cards-feature.md b/_includes/pbc/all/install-features/202304.0/install-the-gift-cards-feature.md index fb4c042d79e..f147dd1ca18 100644 --- a/_includes/pbc/all/install-features/202304.0/install-the-gift-cards-feature.md +++ b/_includes/pbc/all/install-features/202304.0/install-the-gift-cards-feature.md @@ -15,7 +15,7 @@ To start feature integration, integrate the required features: | Spryker Core | {{site.version}}| [Spryker Core feature integration](/docs/pbc/all/miscellaneous/{{site.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | | Cart | {{site.version}} |[Install the Cart feature](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-cart-feature.html)| |Product | {{site.version}} |[Product feature integration](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-product-feature.html)| -|Payments | {{site.version}} |[Payments feature integration](/docs/pbc/all/payment-service-provider/{{page.version}}/install-and-upgrade/install-the-payments-feature.html)| +|Payments | {{site.version}} |[Payments feature integration](/docs/pbc/all/payment-service-provider/{{page.version}}/spryker-pay/base-shop/install-and-upgrade/install-the-payments-feature.html)| | Shipment | {{site.version}} |[Integrate the Shipment feature](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/install-and-upgrade/install-the-shipment-feature.html)| | Order Management | {{site.version}} |[Order Management feature integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/order-management-feature-integration.html)| | Mailing & Notifications | {{site.version}} |[Mailing & Notifications feature integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/mailing-and-notifications-feature-integration.html)| diff --git a/_includes/pbc/all/install-features/202304.0/install-the-spryker-core-feature.md b/_includes/pbc/all/install-features/202304.0/install-the-spryker-core-feature.md index 4191227c41c..1c773f9d6b7 100644 --- a/_includes/pbc/all/install-features/202304.0/install-the-spryker-core-feature.md +++ b/_includes/pbc/all/install-features/202304.0/install-the-spryker-core-feature.md @@ -811,6 +811,11 @@ use SprykerShop\Yves\SecurityBlockerPage\SecurityBlockerPageConfig as SprykerSec class SecurityBlockerPageConfig extends SprykerSecurityBlockerPageConfig { + /** + * @var bool + */ + protected const USE_EMAIL_CONTEXT_FOR_LOGIN_SECURITY_BLOCKER = false; + /** * @return bool */ diff --git a/_includes/pbc/all/install-features/202304.0/install-the-inventory-management-feature.md b/_includes/pbc/all/install-features/202400.0/install-the-inventory-management-feature.md similarity index 97% rename from _includes/pbc/all/install-features/202304.0/install-the-inventory-management-feature.md rename to _includes/pbc/all/install-features/202400.0/install-the-inventory-management-feature.md index 89cf2db9a75..025400882d5 100644 --- a/_includes/pbc/all/install-features/202304.0/install-the-inventory-management-feature.md +++ b/_includes/pbc/all/install-features/202400.0/install-the-inventory-management-feature.md @@ -1,15 +1,15 @@ -This document describes how to ingrate the [Inventory Management](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/inventory-management-feature-overview.html) feature into a Spryker project. +This document describes how to ingrate the [Inventory Management](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/inventory-management-feature-overview.html) feature into a Spryker project. {% info_block errorBox %} The following feature integration guide expects the basic feature to be in place. The current feature integration guide adds the following functionality: -* [Warehouse Management](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/inventory-management-feature-overview.html#warehouse-management) -* [Add to cart from catalog page](/docs/scos/user/features/{{site.version}}/cart-feature-overview/quick-order-from-the-catalog-page-overview.html) -* [Warehouse address](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/inventory-management-feature-overview.html#defining-a-warehouse-address) +* [Warehouse Management](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/inventory-management-feature-overview.html#warehouse-management) +* [Add to cart from catalog page](/docs/scos/user/features/{{page.version}}/cart-feature-overview/quick-order-from-the-catalog-page-overview.html) +* [Warehouse address](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/inventory-management-feature-overview.html#defining-a-warehouse-address) {% endinfo_block %} @@ -23,12 +23,12 @@ To start feature integration, integrate the required features: | NAME | VERSION | INTEGRATION GUIDE | |--------------|------------------|------------------| -| Spryker Core | {{site.version}} | [Spryker core feature integration](/docs/pbc/all/miscellaneous/{{site.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) +| Spryker Core | {{page.version}} | [Spryker core feature integration](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) ### 1) Install the required modules using Composer ```bash -composer require spryker-feature/inventory-management:"{{site.version}}" --update-with-dependencies +composer require spryker-feature/inventory-management:"{{page.version}}" --update-with-dependencies ``` {% info_block warningBox "Verification" %} @@ -632,7 +632,7 @@ To start integration, integrate the required features: | NAME | VERSION | INTEGRATION GUIDE | |--------------|------------------|------------------| -| Inventory Management | {{site.version}} |[Inventory Mamagement feature integration](#install-feature-core) | +| Inventory Management | {{page.version}} |[Inventory Mamagement feature integration](#install-feature-core) | ### 1) Install the required modules using Composer @@ -721,6 +721,6 @@ Make sure that after the order is created, the new row in the `warehouse_allocat | FEATURE | REQUIRED FOR THE CURRENT FEATURE | INTEGRATION GUIDE | |--------------------------|----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Inventory Management API | | [Install the Inventory Management Glue API](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-inventory-management-glue-api.html) | -| Alternative Products | | [Alternative Products + Inventory Management feature integration - ongoing](/docs/scos/dev/feature-integration-guides/{{site.version}}/alternative-products-inventory-management-feature-integration.html) | -| Order Management | | [Order Management + Inventory Management feature integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/order-management-inventory-management-feature-integration.html) | +| Inventory Management API | | [Install the Inventory Management Glue API](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-inventory-management-glue-api.html) | +| Alternative Products | | [Alternative Products + Inventory Management feature integration - ongoing](/docs/scos/dev/feature-integration-guides/{{page.version}}/alternative-products-inventory-management-feature-integration.html) | +| Order Management | | [Order Management + Inventory Management feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/order-management-inventory-management-feature-integration.html) | diff --git a/_includes/pbc/all/install-features/202304.0/install-the-order-management-inventory-management-feature.md b/_includes/pbc/all/install-features/202400.0/install-the-order-management-inventory-management-feature.md similarity index 85% rename from _includes/pbc/all/install-features/202304.0/install-the-order-management-inventory-management-feature.md rename to _includes/pbc/all/install-features/202400.0/install-the-order-management-inventory-management-feature.md index 8d45eea2c26..764b35a0451 100644 --- a/_includes/pbc/all/install-features/202304.0/install-the-order-management-inventory-management-feature.md +++ b/_includes/pbc/all/install-features/202400.0/install-the-order-management-inventory-management-feature.md @@ -1,7 +1,7 @@ -This document describes how to ingrate the [Order Management](/docs/scos/user/features/{{page.version}}/order-management-feature-overview/order-management-feature-overview.html) + [Inventory Management](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/inventory-management-feature-overview.html) feature into a Spryker project. +This document describes how to ingrate the [Order Management](/docs/scos/user/features/{{page.version}}/order-management-feature-overview/order-management-feature-overview.html) + [Inventory Management](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/inventory-management-feature-overview.html) feature into a Spryker project. {% info_block errorBox %} @@ -10,7 +10,7 @@ The following features integration guide expects the basic feature to be in plac The current feature integration guide adds the following functionality: * [Order Management](/docs/scos/user/features/{{page.version}}/order-management-feature-overview/order-management-feature-overview.html) -* [Inventory Management](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/inventory-management-feature-overview.html) +* [Inventory Management](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/inventory-management-feature-overview.html) {% endinfo_block %} @@ -24,8 +24,8 @@ To start feature integration, integrate the required features: | NAME | VERSION | INTEGRATION GUIDE | |--------------|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------| -| Order Management | {{site.version}} | [Order Management feature integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/order-management-feature-integration.html) -| Inventory Management | {{site.version}} | [Inventory Management feature integration](docs/scos/dev/feature-integration-guides/{{site.version}}/install-the-inventory-management-feature.md) | +| Order Management | {{page.version}} | [Order Management feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/order-management-feature-integration.html) +| Inventory Management | {{page.version}} | [Inventory Management feature integration](docs/scos/dev/feature-integration-guides/{{page.version}}/install-the-inventory-management-feature.md) | ### 1) Set up behavior diff --git a/_includes/pbc/all/install-features/202304.0/install-the-picker-user-login-feature.md b/_includes/pbc/all/install-features/202400.0/install-the-picker-user-login-feature.md similarity index 95% rename from _includes/pbc/all/install-features/202304.0/install-the-picker-user-login-feature.md rename to _includes/pbc/all/install-features/202400.0/install-the-picker-user-login-feature.md index f9d487ba40c..a396e136ac9 100644 --- a/_includes/pbc/all/install-features/202304.0/install-the-picker-user-login-feature.md +++ b/_includes/pbc/all/install-features/202400.0/install-the-picker-user-login-feature.md @@ -13,8 +13,8 @@ To start feature integration, integrate the required features: | NAME | VERSION | INTEGRATION GUIDE | |-----------------------------------------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Warehouse User Management | {{site.version}} | [Install the Warehouse User Management feature](/docs/scos/dev/feature-integration-guides/{{site.version}}/install-the-warehouse-user-management-feature.html) | -| Order Management + Inventory Management | {{site.version}} | [Order Management and Inventory Management feature](/docs/scos/dev/feature-integration-guides/{{site.version}}/install-the-order-management-and-inventory-management-feature.html) | +| Warehouse User Management | {{page.version}} | [Install the Warehouse User Management feature](/docs/pbc/all/warehouse-management-system/{{page.version}}/unified-commerce/fulfillment-app/install-and-upgrade/install-features/install-the-warehouse-user-management-feature.html) | +| Order Management + Inventory Management | {{page.version}} | [Order Management + Inventory Management feature](/docs/pbc/all/warehouse-management-system/{{page.version}}/unified-commerce/fulfillment-app/install-and-upgrade/install-features/install-the-order-management-inventory-management-feature.html) | ### 1) Set up configuration diff --git a/_includes/pbc/all/install-features/202304.0/install-the-product-offer-service-points-feature.md b/_includes/pbc/all/install-features/202400.0/install-the-product-offer-service-points-feature.md similarity index 99% rename from _includes/pbc/all/install-features/202304.0/install-the-product-offer-service-points-feature.md rename to _includes/pbc/all/install-features/202400.0/install-the-product-offer-service-points-feature.md index 7c359aa3947..4a52053bd7c 100644 --- a/_includes/pbc/all/install-features/202304.0/install-the-product-offer-service-points-feature.md +++ b/_includes/pbc/all/install-features/202400.0/install-the-product-offer-service-points-feature.md @@ -13,7 +13,7 @@ To start feature integration, integrate the required features: | NAME | VERSION | INTEGRATION GUIDE | |----------------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Product Offer | {{page.version}} | [Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | -| Service Points | {{page.version}} | [Service Points feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/install-the-service-points-feature.html) | +| Service Points | {{page.version}} | [Service Points feature integration](/docs/pbc/all/servcie-points/{{page.version}}/install-and-upgrade/install-the-service-points-feature.html) | ### 1) Install the required modules using Composer diff --git a/_includes/pbc/all/install-features/202304.0/install-the-product-offer-shipment-feature.md b/_includes/pbc/all/install-features/202400.0/install-the-product-offer-shipment-feature.md similarity index 98% rename from _includes/pbc/all/install-features/202304.0/install-the-product-offer-shipment-feature.md rename to _includes/pbc/all/install-features/202400.0/install-the-product-offer-shipment-feature.md index 6ead3117e5e..59aca134523 100644 --- a/_includes/pbc/all/install-features/202304.0/install-the-product-offer-shipment-feature.md +++ b/_includes/pbc/all/install-features/202400.0/install-the-product-offer-shipment-feature.md @@ -12,13 +12,13 @@ To start feature integration, integrate the following required features: | NAME | VERSION | INTEGRATION GUIDE | |---------------|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| - | Product Offer | {{site.version}} | [Product Offer feature integration](/docs/pbc/all/offer-management/{{site.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | - | Shipment | {{site.version}} | [Shipment feature integration](/docs/pbc/all/carrier-management/{{page.version}}/install-and-upgrade/install-the-shipment-feature.html) | + | Product Offer | {{page.version}} | [Product Offer feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | + | Shipment | {{page.version}} | [Shipment feature integration](/docs/pbc/all/carrier-management/{{page.version}}/unified-commerce/enhanced-click-and-collect/install-and-upgrade/install-the-shipment-feature.html) | ## 1) Install the required modules using Composer ```bash -composer require spryker-feature/product-offer-shipment:"{{site.version}}" --update-with-dependencies +composer require spryker-feature/product-offer-shipment:"{{page.version}}" --update-with-dependencies ``` {% info_block warningBox "Verification" %} diff --git a/_includes/pbc/all/install-features/202304.0/install-the-push-notification-feature.md b/_includes/pbc/all/install-features/202400.0/install-the-push-notification-feature.md similarity index 99% rename from _includes/pbc/all/install-features/202304.0/install-the-push-notification-feature.md rename to _includes/pbc/all/install-features/202400.0/install-the-push-notification-feature.md index eaf17d8a837..4912044693b 100644 --- a/_includes/pbc/all/install-features/202304.0/install-the-push-notification-feature.md +++ b/_includes/pbc/all/install-features/202400.0/install-the-push-notification-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the [Push Notification feature](/docs/scos/user/features/202304.0/push-notification-feature-overview.html) into a Spryker project. +This document describes how to integrate the [Push Notification feature](/docs/pbc/all/push-notification/{{page.version}}/unified-commerce/push-notification-feature-overview.html) into a Spryker project. ## Install feature core diff --git a/_includes/pbc/all/install-features/202304.0/install-the-service-points-feature.md b/_includes/pbc/all/install-features/202400.0/install-the-service-points-feature.md similarity index 100% rename from _includes/pbc/all/install-features/202304.0/install-the-service-points-feature.md rename to _includes/pbc/all/install-features/202400.0/install-the-service-points-feature.md diff --git a/_includes/pbc/all/install-features/202304.0/install-the-shipment-feature.md b/_includes/pbc/all/install-features/202400.0/install-the-shipment-feature.md similarity index 77% rename from _includes/pbc/all/install-features/202304.0/install-the-shipment-feature.md rename to _includes/pbc/all/install-features/202400.0/install-the-shipment-feature.md index 9fdedc256a7..58bd000313f 100644 --- a/_includes/pbc/all/install-features/202304.0/install-the-shipment-feature.md +++ b/_includes/pbc/all/install-features/202400.0/install-the-shipment-feature.md @@ -3,9 +3,9 @@ {% info_block errorBox %} -The following feature integration guide expects the basic feature to be in place.
The current feature integration -guide only adds the following functionalities: +The following feature integration guide expects the basic feature to be in place. +The current feature integration guide only adds the following functionalities: * Shipment Back Office UI * Delivery method per store * Shipment data import @@ -24,12 +24,12 @@ To start the feature integration, integrate the required features: | NAME | VERSION | INTEGRATION GUIDE | |--------------|------------------|--------------------------------------------------------------------------------------------------------------------------------------| -| Spryker Core | {{site.version}} | [Spryker Core feature integration](/docs/pbc/all/miscellaneous/{{site.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | | +| Spryker Core | {{page.version}} | [Spryker Core feature integration](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | | ### 1) Install the required modules using Composer ```bash -composer require spryker-feature/shipment:"{{site.version}}" --update-with-dependencies +composer require spryker-feature/shipment:"{{page.version}}" --update-with-dependencies ``` {% info_block warningBox "Verification" %} @@ -42,6 +42,7 @@ Make sure that the following modules have been installed: | ShipmentGui | vendor/spryker/shipment-gui | | Shipment | vendor/spryker/shipment | | ShipmentType | vendor/spryker/shipment-type | +| ShipmentTypeCart | vendor/spryker/shipment-type-cart | | ShipmentTypeDataImport | vendor/spryker/shipment-type-data-import | | ShipmentTypeStorage | vendor/spryker/shipment-type-storage | | ShipmentTypesBackendApi | vendor/spryker/shipment-types-backend-api | @@ -50,7 +51,35 @@ Make sure that the following modules have been installed: ### 2) Set up configuration -To make the `shipment-types` resource protected, adjust the protected paths' configuration: +1. Add the following configuration to your project: + +| CONFIGURATION | SPECIFICATION | NAMESPACE | +|-----------------------------------------|-----------------------------------------------------------|----------------------| +| ShipmentConfig::getShipmentHashFields() | Used to group items by shipment using shipment type uuid. | Pyz\Service\Shipment | + +**src/Pyz/Service/Shipment/ShipmentConfig.php** + +```php + + */ + public function getShipmentHashFields(): array + { + return array_merge(parent::getShipmentHashFields(), [ShipmentTransfer::SHIPMENT_TYPE_UUID]); + } +} +``` + +2. To make the `shipment-types` resource protected, adjust the protected paths' configuration: **src/Pyz/Shared/GlueBackendApiApplicationAuthorizationConnector/GlueBackendApiApplicationAuthorizationConnectorConfig.php** @@ -145,7 +174,10 @@ Make sure that the following changes have been applied in transfer objects: | ShipmentTypeStorageTransfer | class | created | src/Generated/Shared/Transfer/ShipmentTypeStorageTransfer | | ShipmentTypeStorageCriteriaTransfer | class | created | src/Generated/Shared/Transfer/ShipmentTypeStorageCriteriaTransfer | | ShipmentTypeStorageConditionsTransfer | class | created | src/Generated/Shared/Transfer/ShipmentTypeStorageConditionsTransfer | +| ShipmentMethodCollectionTransfer | class | created | src/Generated/Shared/Transfer/ShipmentMethodCollectionTransfer | | ShipmentMethodTransfer.shipmentType | property | created | src/Generated/Shared/Transfer/ShipmentMethodTransfer | +| ShipmentTransfer.shipmentTypeUuid | property | created | src/Generated/Shared/Transfer/ShipmentTransfer | +| ItemTransfer.shipmentType | property | created | src/Generated/Shared/Transfer/ItemTransfer | {% endinfo_block %} @@ -188,7 +220,7 @@ Make sure that the configured data has been added to the `spy_glossary_key` and Configure tables to be published to `spy_shipment_type_storage` and synchronized to the Storage on create, edit, and delete changes: -1. In `src/Pyz/Client/RabbitMq/RabbitMqConfig.php`, adjust the `RabbitMq` module configuration: +1. In `src/Pyz/Client/RabbitMq/RabbitMqConfig.php`, adjust the `RabbitMq` module configuration: **src/Pyz/Client/RabbitMq/RabbitMqConfig.php** @@ -277,7 +309,7 @@ class ShipmentTypeStorageConfig extends SprykerShipmentTypeStorageConfig | ShipmentTypeStoreWriterPublisherPlugin | Publishes shipment type data by `SpyShipmentTypeStore` events. | | Spryker\Zed\ShipmentTypeStorage\Communication\Plugin\Publisher\ShipmentTypeStore | | ShipmentTypePublisherTriggerPlugin | Allows populating shipment type storage table with data and triggering further export to Redis. | | Spryker\Zed\ShipmentTypeStorage\Communication\Plugin\Publisher | -**src/Pyz/Zed/Publisher/PublisherDependencyProvider.php** +
src/Pyz/Zed/Publisher/PublisherDependencyProvider.php ```php 5. Set up synchronization plugins: @@ -381,6 +414,7 @@ In Redis, make sure data is represented in the following format: "_timestamp": 1684933897.870368 } ``` + {% endinfo_block %} ### 6) Import shipment methods @@ -817,7 +851,135 @@ class SalesDependencyProvider extends SprykerSalesDependencyProvider } ``` -4. To enable the Backend API, register these plugins: +4. Configure the shipment type expander plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|----------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------|---------------|---------------------------------------------------------| +| ShipmentTypeItemExpanderPlugin | Expands `CartChange.items.shipment` transfer with `shipmentTypeUuid` taken from `CartChange.items.shipmentType.uuid`. | | Spryker\Zed\ShipmentTypeCart\Communication\Plugin\Cart | +| ShipmentTypeQuoteExpanderPlugin | Expands `QuoteTransfer.items.shipment` transfer with `shipmentTypeUuid` taken from `QuoteTransfer.items.shipmentType.uuid`. | | Spryker\Zed\ShipmentTypeCart\Communication\Plugin\Quote | +| ShipmentTypeShipmentMethodCollectionExpanderPlugin | Expands `ShipmentMethodCollectionTransfer.shipmentMethod` with shipment type. | | Spryker\Zed\ShipmentType\Communication\Plugin\Shipment | + +**src/Pyz/Zed/Cart/CartDependencyProvider.php** + +```php + + */ + protected function getExpanderPlugins(Container $container): array + { + return [ + new ShipmentTypeItemExpanderPlugin(), + ]; + } +} + +``` + +**src/Pyz/Zed/Quote/QuoteDependencyProvider.php** + +```php + + */ + protected function getQuoteExpanderPlugins(): array + { + return [ + new ShipmentTypeQuoteExpanderPlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/Shipment/ShipmentDependencyProvider.php** + +```php + + */ + protected function getShipmentMethodCollectionExpanderPlugins(): array + { + return [ + new ShipmentTypeShipmentMethodCollectionExpanderPlugin(), + ]; + } +} +``` + +5. Configure shipment type filter plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|----------------------------------------------------|---------------|---------------|-----------| +| ShipmentTypeShipmentMethodFilterPlugin | | | | + +**src/Pyz/Zed/Shipment/ShipmentDependencyProvider.php** + +```php + + */ + protected function getMethodFilterPlugins(Container $container): array + { + return [ + new ShipmentTypeShipmentMethodFilterPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that during checkout on the Shipment step, you can only see shipment methods that have relation to active shipment types related to the current store or shipment methods without shipment type relation: + +1. In the `spy_shipment_type` DB table, set `isActive = 0` to deactivate one of the shipment types. +2. Set its ID as `fk_shipment_type` in `spy_shipment_method_table`. +3. In the Storefront, add an item to the cart, do a checkout, and proceed to the Shipment step. +4. Check that there's no shipment method related to inactive shipment type in the shipment form. + +{% endinfo_block %} + +6. To enable the Backend API, register these plugins: | PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | |------------------------------------|------------------------------------------|---------------|-----------------------------------------------------------------------| @@ -884,3 +1046,88 @@ Make sure that you can send the following requests: ``` {% endinfo_block %} + +## Install feature frontend + +Follow the steps below to install the feature frontend. + +### Prerequisites + +To start feature integration, integrate the required features: + +| NAME | VERSION | INTEGRATION GUIDE | +|--------------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Spryker Core | {{page.version}} | [Install the Spryker Сore feature](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | +| Product | {{page.version}} | [Isntall the Product feature](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-product-feature.html) | + +### 1) Install the required modules using Composer + +```bash +composer require spryker-feature/shipment:"{{page.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Ensure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +|--------------------|------------------------------------------| +| ShipmentTypeWidget | vendor/spryker-shop/shipment-type-widget | + +{% endinfo_block %} + +### 2) Set up Behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|--------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------|---------------|---------------------------------------------------------| +| ShipmentTypeCheckoutPageStepEnginePreRenderPlugin | Expands `Quote.items.shipment` transfer with `shipmentTypeUuid` taken from `Quote.items.shipmentType.uuid`. | | SprykerShop\Yves\ShipmentTypeWidget\Plugin\CheckoutPage | +| ShipmentTypeCheckoutAddressStepPreGroupItemsByShipmentPlugin | Cleans `Shipment.shipmentTypeUuid` from each item in `Quote.items`. | | SprykerShop\Yves\ShipmentTypeWidget\Plugin\CustomerPage | + +**src/Pyz/Yves/CheckoutPage/CheckoutPageDependencyProvider.php** + +```php + + */ + protected function getCheckoutPageStepEnginePreRenderPlugins(): array + { + return [ + new ShipmentTypeCheckoutPageStepEnginePreRenderPlugin(), + ]; + } +``` + +**src/Pyz/Yves/CustomerPage/CustomerPageDependencyProvider.php** + +```php + + */ + protected function getCheckoutAddressStepPreGroupItemsByShipmentPlugins(): array + { + return [ + new ShipmentTypeCheckoutAddressStepPreGroupItemsByShipmentPlugin(), + ]; + } +} +``` diff --git a/_includes/pbc/all/install-features/202304.0/install-the-shipment-service-points-feature.md b/_includes/pbc/all/install-features/202400.0/install-the-shipment-service-points-feature.md similarity index 92% rename from _includes/pbc/all/install-features/202304.0/install-the-shipment-service-points-feature.md rename to _includes/pbc/all/install-features/202400.0/install-the-shipment-service-points-feature.md index ea10c403487..cb6962536fc 100644 --- a/_includes/pbc/all/install-features/202304.0/install-the-shipment-service-points-feature.md +++ b/_includes/pbc/all/install-features/202400.0/install-the-shipment-service-points-feature.md @@ -14,8 +14,8 @@ To start feature integration, integrate the required features: | NAME | VERSION | INTEGRATION GUIDE | |----------------|------------------|------------------------------------------------------------------------------------------------------------------------------------------| -| Shipment | {{site.version}} | [Shipment feature integration](/docs/pbc/all/carrier-management/{{page.version}}/install-and-upgrade/install-the-shipment-feature.html) | -| Service Points | {{site.version}} | [Service Points feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/install-the-service-points-feature.html) | +| Shipment | {{page.version}} | [Shipment feature integration](/docs/pbc/all/carrier-management/{{page.version}}/unified-commerce/enhanced-click-and-collect/install-and-upgrade/install-the-shipment-feature.html) | +| Service Points | {{page.version}} | [Service Points feature integration](/docs/pbc/all/service-points/{{page.version}}/install-and-upgrade/install-the-service-points-feature.html) | ## 1) Install the required modules using Composer diff --git a/_includes/pbc/all/install-features/202304.0/install-the-spryker-core-back-office-warehouse-user-management-feature.md b/_includes/pbc/all/install-features/202400.0/install-the-spryker-core-back-office-warehouse-user-management-feature.md similarity index 94% rename from _includes/pbc/all/install-features/202304.0/install-the-spryker-core-back-office-warehouse-user-management-feature.md rename to _includes/pbc/all/install-features/202400.0/install-the-spryker-core-back-office-warehouse-user-management-feature.md index b25b2d8c07f..7ec66247822 100644 --- a/_includes/pbc/all/install-features/202304.0/install-the-spryker-core-back-office-warehouse-user-management-feature.md +++ b/_includes/pbc/all/install-features/202400.0/install-the-spryker-core-back-office-warehouse-user-management-feature.md @@ -11,7 +11,7 @@ To start feature integration, integrate the required features and Glue APIs: | NAME | VERSION | INTEGRATION GUIDE | |---------------------------|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------| | Spryker Core Back Office | {{page.version}} | [Install the Spryker Core Back Office feature](/docs/scos/dev/feature-integration-guides/{{page.version}}/spryker-core-back-office-feature-integration.html) | -| Warehouse User Management | {{page.version}} | [Install the Warehouse User Management feature](/docs/scos/dev/feature-integration-guides/{{page.version}}/install-the-warehouse-user-management-feature.html) | +| Warehouse User Management | {{page.version}} | [Install the Warehouse User Management feature](/docs/pbc/all/warehouse-management-system/{{page.version}}/unified-commerce/fulfillment-app/install-and-upgrade/install-features/install-the-warehouse-user-management-feature.html) | ## 1) Set up behavior diff --git a/_includes/pbc/all/install-features/202304.0/install-the-warehouse-picking-feature.md b/_includes/pbc/all/install-features/202400.0/install-the-warehouse-picking-feature.md similarity index 96% rename from _includes/pbc/all/install-features/202304.0/install-the-warehouse-picking-feature.md rename to _includes/pbc/all/install-features/202400.0/install-the-warehouse-picking-feature.md index 0c8cf983bd1..3f16eeb535f 100644 --- a/_includes/pbc/all/install-features/202304.0/install-the-warehouse-picking-feature.md +++ b/_includes/pbc/all/install-features/202400.0/install-the-warehouse-picking-feature.md @@ -13,16 +13,16 @@ To start feature integration, integrate the required features: | NAME | VERSION | INTEGRATION GUIDE | |-----------------------------------------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Warehouse User Management | {{site.version}} | [Install the Warehouse User Management feature](/docs/scos/dev/feature-integration-guides/{{site.version}}/install-the-warehouse-user-management-feature.html) | -| Order Management + Inventory Management | {{site.version}} | [Order Management and Inventory Management feature](/docs/scos/dev/feature-integration-guides/{{site.version}}/install-the-order-management-and-inventory-management-feature.html) | -| Shipment | {{site.version}} | [Install the Shipment feature](/docs/scos/dev/feature-integration-guides/{{site.version}}/shipment-feature-integration.html) | -| Push Notification | {{site.version}} | [Install the Push Notification feature](/docs/scos/dev/feature-integration-guides/{{site.version}}/install-the-push-notification-feature.html) | -| Spryker Core Back Office | {{site.version}} | [Install the Spryker Core Backoffice feature](/docs/scos/dev/feature-integration-guides/{{site.version}}/install-the-spryker-core-back-office-feature.html) | +| Warehouse User Management | {{page.version}} | [Install the Warehouse User Management feature](/docs/pbc/all/warehouse-management-system/{{page.version}}/unified-commerce/fulfillment-app/install-and-upgrade/install-features/install-the-warehouse-user-management-feature.html) | +| Order Management + Inventory Management | {{page.version}} | [Order Management and Inventory Management feature](/docs/scos/dev/feature-integration-guides/{{page.version}}/install-the-order-management-and-inventory-management-feature.html) | +| Shipment | {{page.version}} | [Install the Shipment feature](/docs/scos/dev/feature-integration-guides/{{page.version}}/shipment-feature-integration.html) | +| Push Notification | {{page.version}} | [Install the Push Notification feature](/docs/scos/dev/feature-integration-guides/{{page.version}}/install-the-push-notification-feature.html) | +| Spryker Core Back Office | {{page.version}} | [Install the Spryker Core Backoffice feature](/docs/scos/dev/feature-integration-guides/{{page.version}}/install-the-spryker-core-back-office-feature.html) | ### 1) Install the required modules using Composer ```bash -composer require spryker-feature/warehouse-picking: "{{site.version}}" --update-with-dependencies +composer require spryker-feature/warehouse-picking: "{{page.version}}" --update-with-dependencies ``` {% info_block warningBox "Verification" %} @@ -632,7 +632,7 @@ class GlueBackendApiApplicationGlueJsonApiConventionConnectorDependencyProvider As a prerequisite, you must take the following steps: -1. Attach a Back Office user to any warehouse you have in the system—use the [Install the Warehouse User Management feature](/docs/scos/dev/feature-integration-guides/{{site.version}}/install-the-warehouse-user-management-feature.html) guide. +1. Attach a Back Office user to any warehouse you have in the system—use the [Install the Warehouse User Management feature](/docs/pbc/all/warehouse-management-system/{{page.version}}/unified-commerce/fulfillment-app/install-and-upgrade/install-features/install-the-warehouse-user-management-feature.html) guide. 2. Place an order in the system so that the product is in the warehouse where you added the user in the previous step. 3. Obtain the access token of the warehouse user. 4. Use the warehouse user access token as the request header `Authorization: Bearer {{YOUR_ACCESS_TOKEN}}`. diff --git a/_includes/pbc/all/install-features/202304.0/install-the-warehouse-picking-inventory-management-feature.md b/_includes/pbc/all/install-features/202400.0/install-the-warehouse-picking-inventory-management-feature.md similarity index 94% rename from _includes/pbc/all/install-features/202304.0/install-the-warehouse-picking-inventory-management-feature.md rename to _includes/pbc/all/install-features/202400.0/install-the-warehouse-picking-inventory-management-feature.md index e32f0c3ca53..fa8f62544b0 100644 --- a/_includes/pbc/all/install-features/202304.0/install-the-warehouse-picking-inventory-management-feature.md +++ b/_includes/pbc/all/install-features/202400.0/install-the-warehouse-picking-inventory-management-feature.md @@ -1,4 +1,4 @@ -This document describes how to integrate the Warehouse picking + [Inventory Management](/docs/pbc/all/warehouse-management-system/{{site.version}}/inventory-management-feature-overview.html) feature into a Spryker project. +This document describes how to integrate the Warehouse picking + [Inventory Management](/docs/pbc/all/warehouse-management-system/{{page.version}}/inventory-management-feature-overview.html) feature into a Spryker project. ## Install feature core @@ -10,8 +10,8 @@ To start feature integration, integrate the required features: | NAME | VERSION | INTEGRATION GUIDE | |----------------------|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------| -| Warehouse Picking | {{site.version}} | [Warehouse Picking feature integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/install-the-warehouse-picking-feature.html) | -| Inventory Management | {{site.version}} | [Inventory Management feature integration](docs/scos/dev/feature-integration-guides/{{site.version}}/install-the-inventory-management-feature.md) | +| Warehouse Picking | {{page.version}} | [Warehouse Picking feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/install-the-warehouse-picking-feature.html) | +| Inventory Management | {{page.version}} | [Inventory Management feature integration](docs/scos/dev/feature-integration-guides/{{page.version}}/install-the-inventory-management-feature.md) | ## 1) Install the required modules using Composer diff --git a/_includes/pbc/all/install-features/202304.0/install-the-warehouse-picking-order-management-feature.md b/_includes/pbc/all/install-features/202400.0/install-the-warehouse-picking-order-management-feature.md similarity index 96% rename from _includes/pbc/all/install-features/202304.0/install-the-warehouse-picking-order-management-feature.md rename to _includes/pbc/all/install-features/202400.0/install-the-warehouse-picking-order-management-feature.md index 88db7ec3760..ecf8f6541ef 100644 --- a/_includes/pbc/all/install-features/202304.0/install-the-warehouse-picking-order-management-feature.md +++ b/_includes/pbc/all/install-features/202400.0/install-the-warehouse-picking-order-management-feature.md @@ -1,6 +1,6 @@ -This document describes how to integrate the Warehouse picking + [Order Management](/docs/scos/user/features/{{site.version}}/order-management-feature-overview/order-management-feature-overview.html) feature into a Spryker project. +This document describes how to integrate the Warehouse picking + [Order Management](/docs/scos/user/features/{{page.version}}/order-management-feature-overview/order-management-feature-overview.html) feature into a Spryker project. ## Install feature core @@ -12,8 +12,8 @@ To start feature integration, integrate the required features: | NAME | VERSION | INTEGRATION GUIDE | |-------------------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------| -| Warehouse Picking | {{site.version}} | [Warehouse Picking feature integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/install-the-warehouse-picking-feature.html) | -| Order Management | {{site.version}} | [Order Management feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/order-management-feature-integration.html) | +| Warehouse Picking | {{page.version}} | [Warehouse Picking feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/install-the-warehouse-picking-feature.html) | +| Order Management | {{page.version}} | [Order Management feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/order-management-feature-integration.html) | ## 1) Install the required modules using Composer diff --git a/_includes/pbc/all/install-features/202304.0/install-the-warehouse-picking-product-feature.md b/_includes/pbc/all/install-features/202400.0/install-the-warehouse-picking-product-feature.md similarity index 97% rename from _includes/pbc/all/install-features/202304.0/install-the-warehouse-picking-product-feature.md rename to _includes/pbc/all/install-features/202400.0/install-the-warehouse-picking-product-feature.md index b7f060a3687..ffec811ce84 100644 --- a/_includes/pbc/all/install-features/202304.0/install-the-warehouse-picking-product-feature.md +++ b/_includes/pbc/all/install-features/202400.0/install-the-warehouse-picking-product-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the Warehouse picking + [Product](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/feature-overviews/product-feature-overview/product-feature-overview.html) feature into a Spryker project. +This document describes how to integrate the Warehouse picking + [Product](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/product-feature-overview.html) feature into a Spryker project. ## Install feature core @@ -14,7 +14,7 @@ To start feature integration, integrate the required features: | NAME | VERSION | INTEGRATION GUIDE | |-------------------|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Warehouse Picking | {{page.version}} | [Warehouse Picking feature integration](/docs/pbc/all/install-features/{{page.version}}/install-the-warehouse-picking-order-management-feature.html) | -| Product | {{site.version}} | [Product feature integration](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-product-feature.html) | +| Product | {{page.version}} | [Product feature integration](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-product-feature.html) | ## 1) Install the required modules using Composer diff --git a/_includes/pbc/all/install-features/202304.0/install-the-warehouse-picking-shipment-feature.md b/_includes/pbc/all/install-features/202400.0/install-the-warehouse-picking-shipment-feature.md similarity index 99% rename from _includes/pbc/all/install-features/202304.0/install-the-warehouse-picking-shipment-feature.md rename to _includes/pbc/all/install-features/202400.0/install-the-warehouse-picking-shipment-feature.md index 9f2d489e6d6..1b7536ce820 100644 --- a/_includes/pbc/all/install-features/202304.0/install-the-warehouse-picking-shipment-feature.md +++ b/_includes/pbc/all/install-features/202400.0/install-the-warehouse-picking-shipment-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the Warehouse picking + [Shipment](/docs/scos/user/features/{{site.version}}/shipment/shipment-feature-overview.html) feature into a Spryker project. +This document describes how to integrate the Warehouse picking + [Shipment](/docs/scos/user/features/{{page.version}}/shipment/shipment-feature-overview.html) feature into a Spryker project. ## Install feature core diff --git a/_includes/pbc/all/install-features/202304.0/install-the-warehouse-picking-spryker-core-back-office-feature.md b/_includes/pbc/all/install-features/202400.0/install-the-warehouse-picking-spryker-core-back-office-feature.md similarity index 94% rename from _includes/pbc/all/install-features/202304.0/install-the-warehouse-picking-spryker-core-back-office-feature.md rename to _includes/pbc/all/install-features/202400.0/install-the-warehouse-picking-spryker-core-back-office-feature.md index fc3c09b2e89..e23a713f431 100644 --- a/_includes/pbc/all/install-features/202304.0/install-the-warehouse-picking-spryker-core-back-office-feature.md +++ b/_includes/pbc/all/install-features/202400.0/install-the-warehouse-picking-spryker-core-back-office-feature.md @@ -1,7 +1,7 @@ -This document describes how to integrate the Warehouse picking + [Spryker Core Back Office](/docs/scos/user/features/{{site.version}}/spryker-core-back-office-feature-overview/spryker-core-back-office-feature-overview.html) feature into a Spryker project. +This document describes how to integrate the Warehouse picking + [Spryker Core Back Office](/docs/scos/user/features/{{page.version}}/spryker-core-back-office-feature-overview/spryker-core-back-office-feature-overview.html) feature into a Spryker project. ## Install feature core @@ -14,8 +14,8 @@ To start feature integration, integrate the required features: | NAME | VERSION | INTEGRATION GUIDE | |--------------------------|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Warehouse Picking | {{site.version}} | [Warehouse Picking feature integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/install-the-warehouse-picking-feature.html) | -| Spryker Core Back Office | {{site.version}} | [Spryker Core Back Office feature integration](/docs/scos/dev/feature-integration-guides/{{site.version}}/spryker-core-back-office-feature-integration.html) | +| Warehouse Picking | {{page.version}} | [Warehouse Picking feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/install-the-warehouse-picking-feature.html) | +| Spryker Core Back Office | {{page.version}} | [Spryker Core Back Office feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/spryker-core-back-office-feature-integration.html) | ## 1) Install the required modules using Composer diff --git a/_includes/pbc/all/install-features/202304.0/install-the-warehouse-user-management-feature.md b/_includes/pbc/all/install-features/202400.0/install-the-warehouse-user-management-feature.md similarity index 96% rename from _includes/pbc/all/install-features/202304.0/install-the-warehouse-user-management-feature.md rename to _includes/pbc/all/install-features/202400.0/install-the-warehouse-user-management-feature.md index a1746a129cf..f56986cf2ad 100644 --- a/_includes/pbc/all/install-features/202304.0/install-the-warehouse-user-management-feature.md +++ b/_includes/pbc/all/install-features/202400.0/install-the-warehouse-user-management-feature.md @@ -13,14 +13,14 @@ To start feature integration, integrate the required features: | NAME | VERSION | INTEGRATION GUIDE | |--------------------------|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Spryker Core | {{site.version}} | [Spryker Core feature integration](/docs/pbc/all/miscellaneous/{{site.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | | -| Spryker Core Back Office | {{site.version}} | [Install the Spryker Core Back Office feature](/docs/scos/dev/feature-integration-guides/{{site.version}}/spryker-core-back-office-feature-integration.html) | -| Inventory Management | {{site.version}} | [Install the Inventory Management feature](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-inventory-management-feature.html) | +| Spryker Core | {{page.version}} | [Spryker Core feature integration](/docs/pbc/all/miscellaneous/{{page.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | | +| Spryker Core Back Office | {{page.version}} | [Install the Spryker Core Back Office feature](/docs/scos/dev/feature-integration-guides/{{page.version}}/spryker-core-back-office-feature-integration.html) | +| Inventory Management | {{page.version}} | [Install the Inventory Management feature](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-inventory-management-feature.html) | ### 1) Install the required modules using Composer ```bash -composer require spryker-feature/warehouse-user-management: "{{site.version}}" --update-with-dependencies +composer require spryker-feature/warehouse-user-management: "{{page.version}}" --update-with-dependencies ``` {% info_block warningBox "Verification" %} diff --git a/_includes/pbc/all/install-features/202304.0/marketplace/install-the-marketplace-product-offer-service-points-feature.md b/_includes/pbc/all/install-features/202400.0/marketplace/install-the-marketplace-product-offer-service-points-feature.md similarity index 98% rename from _includes/pbc/all/install-features/202304.0/marketplace/install-the-marketplace-product-offer-service-points-feature.md rename to _includes/pbc/all/install-features/202400.0/marketplace/install-the-marketplace-product-offer-service-points-feature.md index b97350b5001..41567065362 100644 --- a/_includes/pbc/all/install-features/202304.0/marketplace/install-the-marketplace-product-offer-service-points-feature.md +++ b/_includes/pbc/all/install-features/202400.0/marketplace/install-the-marketplace-product-offer-service-points-feature.md @@ -4,7 +4,7 @@ This document describes how to integrate the Marketplace Product Offer + Service ## Install feature core -Follow the steps below to install the Marketplace Product Offer + Product Offer Service Points feature core. +Follow the steps below to install the Marketplace Product Offer + Service Points feature core. ### Prerequisites diff --git a/_internal/faq-migration-to-opensearch.md b/_internal/faq-migration-to-opensearch.md new file mode 100644 index 00000000000..5f4f5922760 --- /dev/null +++ b/_internal/faq-migration-to-opensearch.md @@ -0,0 +1,128 @@ +# FAQ: Migration to OpenSearch + +This document provides answers to the frequently asked questions about the migration to OpenSearch. + +## What is OpenSearch, and how is it different from Elasticsearch? + +[OpenSearch](https://opensearch.org/) is an open-source search and analytics suite derived from Elasticsearch 7.10.2. It had been the same before it was forked. After the fork, the projects started to diverge slightly. OpenSearch consists of the OpenSearch search engine and OpenSearch Dashboards, which are based on Kibana. OpenSearch maintains compatibility with Elasticsearch 7.10.2 while introducing additional enhancements and features. It is fully open source and developed in a community-driven manner. + +## What is Amazon OpenSearch Service? + +Amazon OpenSearch Service is a managed search solution that is based on OpenSearch. As part of the service, AWS provides the OpenSearch suite and continues to support legacy Elasticsearch versions until 7.10. + +## How is OpenSearch different from the Amazon OpenSearch Service? + +OpenSearch refers to the community-driven open-source search and analytics technology. On the other hand, Amazon OpenSearch Service is a managed service provided by AWS that lets users deploy, secure, and run OpenSearch and Elasticsearch at scale without the need to manage the underlying infrastructure. It offers the benefits of a fully managed service, including simplified deployment and management, while leveraging the power and capabilities of OpenSearch and Elasticsearch. + +## How does Spryker Cloud Commerce OS leverage Amazon OpenSearch service? + +As a recognized AWS Partner, Spryker Cloud Commerce OS(SCCOS) relies on AWS-managed services. SCCOS leverages Amazon OpenSearch Service to securely unlock real-time search, monitoring, and analysis of business and operational data for use cases like application monitoring, log analytics, observability, and website search. + +## Does it mean that all SCCOS projects are already using Amazon OpenSearch Service? + +Yes, all SCCOS projects are already running Amazon OpenSearch Service, regardless of the engine version of Elasticsearch or OpenSearch you are currently using. + +## Can my project migrate to OpenSearch if it's running Spryker Commerce OS on-premises? + +Yes, you can enable OpenSearch until version 1.2 on-premises because OpenSearch is an open-source project that can be deployed and run on your own infrastructure. + +## If my SCCOS project is running Elasticsearch, do I need to prepare for the migration from Elasticsearch to OpenSearch? + +If you are running Elasticsearch version 6.8 or above, no action is required on your part. We will handle the migration from Elasticsearch to OpenSearch. For the projects running lower versions of Elasticsearch, before migrating, we recommend updating Elasticsearch to version 6.8. If you need technical guidance for updating Elasticsearch, [contact our Support team](https://spryker.my.site.com/support/s/). + +## How long does it take to migrate from Elasticsearch to OpenSearch? + +The migration takes a short time, usually within the maintenance window. We can migrate your project during the maintenance window or on demand. + +## Will there be any data loss during the migration? + +No, the migration to OpenSearch follows AWS's blue-green deployment strategy, which ensures data continuity and prevents any loss. Your data will remain intact and available in the upgraded environment. + +## Will any functionality be lost during the migration? + +No, there won't be any loss of functionality during the migration. Because OpenSearch 1 is backward compatible with Elasticsearch 7, all features and functions remain accessible after the migration. + +## Will there be any downtime during the migration or scaling process? + +No, AWS's blue-green deployment strategy ensures uninterrupted service during the migration. + +## I am currently using Elasticsearch 7 or older versions. What are the benefits of migrating to OpenSearch? + +Migration to OpenSearch provides several benefits: + +* Enhanced security: OpenSearch includes built-in security features to protect your data better. + +* Continued support: OpenSearch receives long-term support and updates, ensuring ongoing improvements and maintenance. + +* Advanced features: OpenSearch introduces new features such as better observability, anomaly detection, and data lifecycle management. + +* Active community: OpenSearch benefits from a thriving open-source community, driving continuous enhancement and innovation. + +## Why didn’t we get access to OpenSearch earlier? + +We prioritize our services' stability, security, and compatibility above all else. That's why we approach upgrades with the utmost caution, ensuring that we have extensively tested and verified their functionality and compatibility before they are introduced into our ecosystem. Elasticsearch has been a reliable and robust search engine, and many of our customers still use versions under 7.10. Despite Elastic's decision to deprecate some older versions of Elasticsearch, we've been able to maintain their service continuity through our partnership with AWS, which has committed to supporting these versions without deprecation notice. As a result, there was no immediate need to rush the migration to OpenSearch. + +However, we recognize the potential benefits and features that OpenSearch brings. After thorough testing and validation, we are confident that OpenSearch is a solid platform, and the transition will be smooth, backward compatible, and minimally disruptive. + +## Does the migration to OpenSearch entail any additional costs? + +No, we take care of the migration on our side as part of your existing agreement. The cost of running OpenSearch is similar to Elasticsearch. However, any changes in usage or scale can affect overall costs. + +## Can I continue using Elasticsearch APIs with OpenSearch? + +Yes, OpenSearch maintains backward compatibility with Elasticsearch 7.10. All your existing APIs, clients, and applications should continue to work as expected with OpenSearch. + +## How is backward compatibility maintained in OpenSearch? + +OpenSearch maintains backward compatibility by ensuring its APIs and core search functionality are compatible with Elasticsearch 7.10.2. When OpenSearch was forked from Elasticsearch 7.10.2, the goal was to keep the base functionality and APIs the same. This lets applications and tools built work with Elasticsearch 7.10.2 to continue functioning with OpenSearch. + +Also, OpenSearch includes a compatibility mode, which lets OpenSearch respond with a version number of 7.10.2. This can be useful for tools or clients that check the version of the search engine and expect to communicate with Elasticsearch 7.10.2. + +However, while backward compatibility is a priority, certain features or functionalities from older versions of Elasticsearch are not supported in OpenSearch. We recommend thoroughly testing your application in a non-production environment when upgrading or migrating to different software. + +Also, as OpenSearch continues to evolve and new versions are released, for the updates on backward compatibility, make sure to check the [OpenSearch documentation](https://opensearch.org/docs/latest/) or their [GitHub repository](https://github.com/opensearch-project/OpenSearch). + +## Does OpenSearch support all the plugins that I used with Elasticsearch? + +OpenSearch supports most plugins compatible with Elasticsearch 7.10.2. However, make sure to check the compatibility of specific plugins in the OpenSearch documentation or with a particular plugin's provider. Some cases require plugins to be updated or replaced with OpenSearch-compatible versions. To get the list of the plugins you are currently using, [contact our Support team](https://spryker.my.site.com/support/s/). Before the production environment is migrated, we will migrate your development and staging environments, so you can test backward compatibility. + +## How will the migration affect my configuration and settings? + +The migration from Elasticsearch to OpenSearch should not affect your current configuration and settings. OpenSearch is backward compatible with Elasticsearch 7.10.2, so it should respect your existing configuration and settings. However, when updating to a major version, we recommend always reviewing and updating documentation or notes provided by OpenSearch. + +## Can I roll back to Elasticsearch if I face issues after migrating to OpenSearch? + +While rolling back is generally not recommended, if you experience any significant issues after the migration, a rollback to Elasticsearch 7 is still possible. The rollback may require downtime and data migration, but we will facilitate this process. + +Because long-term support, security patches, and updates will be provided for OpenSearch, a rollback should be a temporary solution. After the compatibility issues are fixed, to ensure the project's security and long-term support, it should be migrated to OpenSearch. + +## Is there any change in the way I interact with the platform after the upgrade? + +No, OpenSearch maintains compatibility with the Elasticsearch APIs, so the operations, requests, and procedures you are accustomed to using with Elasticsearch will continue functioning as before. + +## How will the migration impact my data ingestion and query processes? + +The migration should not impact your data ingestion and query processes. OpenSearch is designed to be fully backward compatible with Elasticsearch. The APIs used for data ingestion, such as the Index and Bulk APIs, and the query DSL for searching your data, will work as they did in Elasticsearch. + +## Are there any security implications with the migration to OpenSearch? + +No, there are no security implications. OpenSearch includes improved security features, such as granular access control, audit logging, and integration with identity providers, which further enhance the security of your deployments. However, we recommend reviewing the security settings and ensuring they align with your organization's security policies. + +## Does OpenSearch support the languages and frameworks that Elasticsearch does? + +Yes, OpenSearch supports all the official clients supported by Elasticsearch, such as those for Java, JavaScript, Python, Ruby, Go, .NET, and PHP. You should be able to continue using the same languages and frameworks with OpenSearch. + +## Will SCCOS support Elasticsearch 8+? + + As SCCOS heavily relies on Amazon OpenSearch Service, which does not support Elasticsearch 8+, SCCOS does not support it by default. This decision is based on our commitment to ensuring the best possible stability, security, and compatibility for our users within the supported AWS ecosystem. We continue to closely monitor the developments in this area and adjust our strategies as needed to best serve the needs of our community. + +## My on-premises project is running Elasticsearch 8+. What steps should I take to ensure compatibility when migrating to SCCOS? + +To ensure compatibility with SCCOS, you need to migrate from Elasticsearch 8+ to OpenSearch 1. + +However, we understand that sophisticated business models have unique needs, and we are always open to exploring new patterns that enable our customers to leverage and extend SCCOS with their own solutions. Therefore, if you have ideas or requirements related to Elasticsearch 8+ or any other technology, we encourage you to contact us. Our primary goal is to ensure that SCCOS is a robust and reliable platform and a customizable solution that can adapt to your needs. + + +## When can we expect the upgrade to OpenSearch 2 within the Spryker ecosystem? + +OpenSearch 2 is already available. We are analyzing the changes to understand their implications and develop an upgrade strategy that ensures you experience no disruption in services during the upgrade. Once we have a robust and tested upgrade plan, we will provide detailed guidance on how to do it. diff --git a/_scripts/sidebar_checker/sidebar_checker.sh b/_scripts/sidebar_checker/sidebar_checker.sh index 56012a91568..7de2b0b77cf 100644 --- a/_scripts/sidebar_checker/sidebar_checker.sh +++ b/_scripts/sidebar_checker/sidebar_checker.sh @@ -10,7 +10,7 @@ SIDEBARS=("_data/sidebars/acp_user_sidebar.yml" "_data/sidebars/cloud_dev_sideba TITLES=("ACP User" "Cloud Dev" "Marketplace Dev" "Marketplace User" "PBC All" "SCOS Dev" "SCOS User" "SCU Dev" "SDK Dev") # Define the folders to ignore -IGNORED_FOLDERS=("201811.0" "201903.0" "201907.0" "202001.0" "202005.0" "202009.0" "202108.0" "202304.0") +IGNORED_FOLDERS=("201811.0" "201903.0" "201907.0" "202001.0" "202005.0" "202009.0" "202108.0", "202304.0", "202400.0") # Define output file path OUTPUT_FILE="_scripts/sidebar_checker/missing-documents.yml" diff --git a/algolia_config/_cloud_dev.yml b/algolia_config/_cloud_dev.yml index c88cbda94a5..9e3a4a949c9 100644 --- a/algolia_config/_cloud_dev.yml +++ b/algolia_config/_cloud_dev.yml @@ -13,4 +13,4 @@ algolia: - docs/fes/dev/**/*.md - docs/pbc/all/**/*.md - docs/acp/user/**/*.md - - docs/sdk/dev/**/*.md + - docs/sdk/dev/**/*.md diff --git a/algolia_config/_sdk_dev.yml b/algolia_config/_sdk_dev.yml index 6535ae7744c..4bcf9c8c96b 100644 --- a/algolia_config/_sdk_dev.yml +++ b/algolia_config/_sdk_dev.yml @@ -11,6 +11,6 @@ algolia: - docs/scos/dev/**/*.md - docs/scu/dev/**/*.md - docs/cloud/dev/spryker-cloud-commerce-os/**/*.md - - docs/acp/user/**/*.md + - docs/acp/user/**/*.md - docs/fes/dev/**/*.md - docs/pbc/all/**/*.md \ No newline at end of file diff --git a/docs/acp/user/app-composition-platform-installation.md b/docs/acp/user/app-composition-platform-installation.md index 5ee18e675db..a463f8a44e6 100644 --- a/docs/acp/user/app-composition-platform-installation.md +++ b/docs/acp/user/app-composition-platform-installation.md @@ -2,6 +2,7 @@ title: App Composition Platform installation description: Learn how to install the App Orchestration Platform. template: concept-topic-template +last_updated: Jul 11, 2023 redirect_from: - /docs/aop/user/intro-to-acp/acp-installation.html --- @@ -40,30 +41,30 @@ To make your project ACP-ready, different update steps are necessary depending o - SCCOS product release [202211.0](/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202211.0/release-notes-202211.0.html): All the changes required for ACP readiness are already included, but you should still verify them at the project level. - Older versions: To get the project ACP-ready, you should complete all steps described in this document. -{% info_block infoBox "Product version ealier than 202211.0" %} +{% info_block infoBox "Product version earlier than 202211.0" %} If you were onboarded with a version older than product release [202211.0](/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202211.0/release-notes-202211.0.html), please [contact us](https://support.spryker.com/). {% endinfo_block %} -### 1. Module updates for ACP +### Module updates for ACP To get your project ACP-ready, it is important to ensure that your project modules are updated to the necessary versions. -#### 1. ACP modules +#### ACP modules Starting with the Spryker product release [202211.0](/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202211.0/release-notes-202211.0.html), the ACP catalog is included by default in the Spryker Cloud product. However, you should still make sure that your Spryker project uses the latest versions of the following modules: -* `spryker/app-catalog-gui: ^1.2.0` or higher -* `spryker/message-broker:^1.4.0` or higher -* `spryker/message-broker-aws:^1.3.2` or higher -* `spryker/session:^4.15.1` or higher +* `spryker/app-catalog-gui: ^1.2.0` or later +* `spryker/message-broker:^1.4.0` or later +* `spryker/message-broker-aws:^1.3.2` or later +* `spryker/session:^4.15.1` or later -#### 2. App modules +#### App modules {% info_block warningBox "Apps- and PBC-specific modules" %} -Depending on the specific ACP apps or [PBCs](/docs/pbc/all/pbc.html) you intend to use via ACP, you will need to add or update the modules for each respective app or PBC as explained in the corresponding app guide. +Depending on the specific ACP apps or [PBCs](/docs/pbc/all/pbc.html#acp-app-composition-platform-apps) you intend to use through ACP, you will need to add or update the modules for each respective app or PBC as explained in the corresponding app guide. {% endinfo_block %} @@ -71,13 +72,19 @@ The Spryker ACP Apps are continuously enhanced and improved with new versions. T For [each app](https://docs.spryker.com/docs/acp/user/intro-to-acp/acp-overview.html#supported-apps) you wish to use, ensure that you have the latest app-related SCCOS modules installed. -### 2. Configure SCCOS +### Configure SCCOS + +{% info_block infoBox "This step can be omitted for Product version later than 202211.0" %} + +If your version is based on product release [202211.0](/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202211.0/release-notes-202211.0.html) or newer, you can skip this section! + +{% endinfo_block %} Once you have ensured that your project modules are up-to-date, proceed to configure your SCCOS project to activate the ACP catalog in the Back Office using the following steps: 1. Define the configuration and add plugins to the following files: -
+
config/Shared/config_default.php ```php @@ -139,10 +146,7 @@ $config[OauthClientConstants::OAUTH_OPTION_AUDIENCE_FOR_PAYMENT_AUTHORIZE] = 'ao ```
-2. In the `navigation.xml` file, add one more navigation item: - -
-config/Zed/navigation.xml +1. In the `navigation.xml` file, add one more navigation item: ```xml ... @@ -154,13 +158,12 @@ $config[OauthClientConstants::OAUTH_OPTION_AUDIENCE_FOR_PAYMENT_AUTHORIZE] = 'ao index index -... +... ``` -
3. In the `MessageBrokerDependencyProvider.php` file, enable the following module plugins: -
+
src/Pyz/Zed/MessageBroker/MessageBrokerDependencyProvider.php ```php @@ -245,10 +248,9 @@ class MessageBrokerDependencyProvider extends SprykerMessageBrokerDependencyProv ```
-4. In the `MessageBrokerConfig.php` file, adjust the following module config: +1. In the `MessageBrokerConfig.php` file, adjust the following module config: -
-src/Pyz/Zed/MessageBroker/MessageBrokerConfig.php +**src/Pyz/Zed/MessageBroker/MessageBrokerConfig.php**: ```php 5. In the `OauthClientDependencyProvider.php` file, enable the following module plugins: In the MessageBrokerConfig.php, adjust the following module config: -
+ +
src/Pyz/Zed/OauthClient/OauthClientDependencyProvider.php ```php @@ -335,12 +337,11 @@ You need to define the environment variables in the `deploy.yml` file of *each* {% info_block warningBox "Warning" %} -It is crucial to specify the keys for the environment variables. The infrastructure values, such as `SPRYKER_AOP_INFRASTRUCTURE` and `STORE_NAME_REFERENCE_MAP` are provided by Spryker OPS upon request. +It is crucial to specify the keys for the environment variables. The infrastructure values, such as `SPRYKER_AOP_INFRASTRUCTURE` and `STORE_NAME_REFERENCE_MAP`, are provided by Spryker OPS upon request. {% endinfo_block %} -
-General structure +General structure: ```json ENVIRONMENT_VARIABLE_NAME_A: '{ @@ -348,10 +349,8 @@ ENVIRONMENT_VARIABLE_NAME_A: '{ "CONFIGURATION_KEY_B":"SOME_VALUE_B" }' ``` -
-
-Data structure example for a demo environment connected to the Spryker ACP production +Data structure example for a demo environment connected to the Spryker ACP production: ```json #AOP @@ -384,11 +383,10 @@ SPRYKER_AOP_INFRASTRUCTURE: '{ } }' ``` -
#### General configurations: SPRYKER_AOP_APPLICATION variable -The configuration key `APP_CATALOG_SCRIPT_URL`is the URL for the App-Tenant-Registry-Service (ATRS) and path to the JS script to load the ACP catalog. +The configuration key `APP_CATALOG_SCRIPT_URL` is a URL for the App-Tenant-Registry-Service (ATRS) and the path to the JS script to load the ACP catalog. Example of the production ATRS_HOST and path: @@ -404,7 +402,6 @@ The StoreReference mapping is created by Spryker OPS, and they provide you with {% endinfo_block %} - Example of demo stores for DE and AT: ```json @@ -419,7 +416,6 @@ The app domains are provided by Spryker OPS. {% endinfo_block %} - Example of the app domain values: ```json @@ -467,7 +463,7 @@ Example of the `SPRYKER_MESSAGE_BROKER_HTTP_SENDER_CONFIG` configuration key val After configuring the files, updating all modules, and adding the requested keys with their corresponding values provided by Spryker OPS to the `deploy.yml` file, the SCCOS codebase is now up-to-date. Once redeployed, your environment is ACP-ready. -The next step is to get your newly updated and deployed ACP-ready SCCOS environment ACP-enabled. The ACP enablement step is fully handled by Spryker and implies registration of your ACP-ready SCCOS environment with ACP by connecting it with the ACP App-Tenant-Registry-Service (ATRS) as well as the Event Platform (EP), so that the ACP catalog is able to work with SCCOS. +The next step is to get your newly updated and deployed ACP-ready SCCOS environment ACP-enabled. The ACP enablement step is fully handled by Spryker and implies the registration of your ACP-ready SCCOS environment with ACP by connecting it with the ACP App-Tenant-Registry-Service (ATRS) as well as the Event Platform (EP) so that the ACP catalog is able to work with SCCOS. To get your project ACP-enabled, contact the [Spryker support](https://spryker.com/support/). @@ -478,6 +474,6 @@ Once all the steps of the ACP-enablement process are completed, the ACP catalog Once your projecrt is ACP-enabled, you can start integrating the apps: - [Integrate Algolia](/docs/pbc/all/search/{{site.version}}/base-shop/third-party-integrations/integrate-algolia.html) -- [Integrate Payone](/docs/pbc/all/payment-service-provider/{{site.version}}/third-party-integrations/payone/integration-in-the-back-office/integrate-payone.html) +- [Integrate Payone](/docs/pbc/all/payment-service-provider/{{site.version}}/payone/integration-in-the-back-office/integrate-payone.html) - [Integrate Usercentrics](/docs/pbc/all/usercentrics/integrate-usercentrics.html) - [Integrate Bazaarvoice](/docs/pbc/all/ratings-reviews/{{site.version}}/third-party-integrations/integrate-bazaarvoice.html) diff --git a/docs/acp/user/app-manifest.md b/docs/acp/user/app-manifest.md index 5f7be3c5a2d..a73118b5aec 100644 --- a/docs/acp/user/app-manifest.md +++ b/docs/acp/user/app-manifest.md @@ -117,7 +117,7 @@ For the manifest, make sure to follow these conditions: |url | URL to a homepage of the application provider (not visible in the AppCatalog). | "url": "https://www.payone.com/DE-en" | |isAvailable | Shows if the application is currently available. Possible values:
  • false—the application is not available, it isn't possible to connect and configure it.
  • true—the application is available, it’s possible to connect, configure, and use it.
| "isAvailable": true | |businessModels | An array of suite types that are compatible with the application. Possible values:
  • B2C
  • B2B
  • B2C_MARKETPLACE
  • B2B_MARKETPLACE
| See *businessModels example* under this table. | -|categories | An array of categories that the application belongs to. Possible values:
  • BI_ANALYTICS
  • CUSTOMER
  • LOYALTY
  • PAYMENT
  • PRODUCT_INFORMATION_SYSTEM
  • SEARCH
  • USER_GENERATED_CONTENT
| See *categories example* under this table. | +|categories | An array of categories that the application belongs to. Possible values:
  • BUSINESS_INTELLIGENCE
  • CONSENT_MANAGEMENT
  • LOYALTY_MANAGEMENT
  • PAYMENT
  • PRODUCT_INFORMATION_MANAGEMENT
  • SEARCH
  • USER_GENERATED_CONTENT
| See *categories example* under this table. | |pages | Adds additional content to the application detail page. This part contains an object with a page type and its blocks.
Possible page types (object keys):
  • Overview
  • Legal
Each page can contain no or multiple blocks. Each block should be specified by an object with the following keys:
  • title—header of the block;
  • type—the way the data is displayed. Possible values:
    • list
    • text
  • data—information that is displayed inside the block. Can be a string, if *type=text*, or an array of strings if *type=list*.
| See *pages example* under this table. | |assets | An array of objects represented as application assets. Each object has the following keys:
  • type—type of the asset. Possible values:
    • icon—displayed on the application tile and on top of the application detail page.
    • image—displayed in a carousel on the application detail page.
    • video—displayed in a carousel on the application detail page. Allows only videos hosted on https://wistia.com.
  • url—a relative path to the asset. Possible extensions:
    • jpeg
    • png
    • svg
    • url to a video hosted on https://wistia.com
| See *assets example* under this table. | |labels | An array of strings. Displays label icons on the application detail page according to the label. Possible values:
  • Silver Partner
  • Gold Partner
  • New
  • Popular
  • Free Trial
| See *labels example* under this table. | diff --git a/docs/acp/user/developing-an-app.md b/docs/acp/user/developing-an-app.md index 7c8a8ba0a22..a5c6e6eb517 100644 --- a/docs/acp/user/developing-an-app.md +++ b/docs/acp/user/developing-an-app.md @@ -122,7 +122,7 @@ For more details, see [App Configuration Translation](/docs/acp/user/app-configu The command defines Sync API and Async API. ##### Sync API -The Sync API defines the app's synchronous endpoints, or [Glue](/docs/scos/dev/glue-api-guides/{{site.version}}/glue-rest-api.html) endpoints. The workflow creates a boilerplate that you need to update with the required endpoints your app should have. See the [current OpenAPI specification](https://spec.openapis.org/oas/v3.1.0). +The Sync API defines the app's synchronous endpoints, or [Glue](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/glue-rest-api.html) endpoints. The workflow creates a boilerplate that you need to update with the required endpoints your app should have. See the [current OpenAPI specification](https://spec.openapis.org/oas/v3.1.0). For more details about the Sync API with information specific to Spryker, see [Sync API](/docs/acp/user/sync-api.html). diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/best-practices/best-practices.md b/docs/cloud/dev/spryker-cloud-commerce-os/best-practices/best-practices.md index 3b3d0f493ff..b0c91f3ad83 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/best-practices/best-practices.md +++ b/docs/cloud/dev/spryker-cloud-commerce-os/best-practices/best-practices.md @@ -2,6 +2,7 @@ title: Best practices description: Best practices for developers working on Spryker Cloud Commerce OS template: concept-topic-template +last_updated: Jun, 10, 2023 --- This section contains best practices for developing and working with the Spryker Cloud Commerce OS. diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/best-practices/best-practises-jenkins-stability.md b/docs/cloud/dev/spryker-cloud-commerce-os/best-practices/best-practises-jenkins-stability.md new file mode 100644 index 00000000000..1f1fd11d89f --- /dev/null +++ b/docs/cloud/dev/spryker-cloud-commerce-os/best-practices/best-practises-jenkins-stability.md @@ -0,0 +1,26 @@ +--- + title: "Best practises: Jenkins stability" + description: Improve the stability of the scheduler component. + template: best-practices-guide-template + last_updated: Jun 10, 2023 +--- + +Jenkins fulfills the role of a scheduler in the Spryker applications. It is used to run repetitive console commands and jobs. In Spryker Cloud Commerce OS, the Jenkins instance runs the commands configured directly in its container. This means that, when you run a command like the following one, it's executed within the Jenkins container, utilizing its resources: + +```bash +/vendor/bin/console queue:worker:start +``` + +Unlike in cloud, in a local environment, these commands are executed by a CLI container. This difference leads to some side effects where the same code and actions work fine in the local development environment but fail when deployed to cloud. + +## Memory management + +One of the most common issues encountered with Jenkins is excessive memory usage. In a local development environment, Docker containers are usually set up to use as much RAM as they need as long as they stay within the RAM limit configured in Docker. This limit often corresponds to the total RAM available on the machine. However, when deployed to cloud, the Jenkins container is deployed to its own dedicated server, which limits the available RAM based on the server's configuration. Non-production environments have different RAM configuration tiers, which can be found in our Service Description. Standard environments typically assign 2%nbspGB of RAM to Jenkins. This means that the server running Jenkins has a total of 2%nbspGB of RAM. Considering some overhead for the operating system, Docker, and Jenkins itself, around 1-1.5%nbspGB of memory is usually available for PHP code execution. This shared memory needs to accommodate all console commands run on Jenkins. Therefore, if you set `php memory_limit` to 1%nbspGB and have a job that requires 1%nbspGB at any given time, no other job can run in parallel without risking a memory constraint and potential job failures. The `php memory_limit` does not control the total memory consumption by any PHP process but limits the amount each individual process can take. + +We recommend profiling your application to understand how much RAM your Jenkins jobs require. A good way to do this is by utilizing XDebug Profiling in your local development environment. Jobs that may have unexpected memory demands are the `queue:worker:start` commands. These commands are responsible for spawning the `queue:task:start` commands, which consume messages from RabbitMQ. Depending on the complexity and configured chunk size of these messages, these jobs can easily consume multiple GBs of RAM. + +## Jenkins executors configuration + +Jenkins executors let you orchestrate Jenkins jobs and introduce parallel processing. By default, Jenkins instances have two executors configured, similar to local environment setups. You can adjust the executor count freely and run many console commands in parallel. While this may speed up processing in your application, it increases the importance of understanding the memory utilization profile of your application. For stable job execution, you need to ensure that no parallelized jobs collectively consume more memory than what is available to the Jenkins container. Also, it is common practice to set the number of executors to the count of CPUs available to Jenkins. Standard environments are equipped with two vCPUs, which means that configuring more than the standard two executors risks jobs "fighting" for CPU cycles. This severely limits the performance of all jobs run in parallel and potentially introduces instability to the container itself. + +We recommend sticking to the default executor count or the concurrent job limit recommended in the Spryker Service Description for your package. This will help ensure the stability of Jenkins, as configuring more Jenkins Executors is the most common cause of Jenkins instability and crashes. diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/performance-testing-in-staging-enivronments.md b/docs/cloud/dev/spryker-cloud-commerce-os/performance-testing-in-staging-enivronments.md index 315292be16a..6a00d0bee2a 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/performance-testing-in-staging-enivronments.md +++ b/docs/cloud/dev/spryker-cloud-commerce-os/performance-testing-in-staging-enivronments.md @@ -1,6 +1,7 @@ --- title: Performance testing in staging environments description: Learn about performance testing for the Spryker Cloud Commerce OS +last_updated: Sep 15, 2022 template: concept-topic-template redirect_from: - /docs/cloud/dev/spryker-cloud-commerce-os/performance-testing.html @@ -14,4 +15,592 @@ If you want to execute a full load test on a production-like dataset and traffic If you are unable to use real data for your load tests, you can use the [test data](https://drive.google.com/drive/folders/1QvwDp2wGz6C4aqGI1O9nK7G9Q_U8UUS-?usp=sharing) for an expanding amount of use cases. Please note that we do not provide support for this data. However, if your specific use case is not covered, you can [contact support](https://spryker.force.com/support/s/knowledge-center), and we will try to accommodate your needs. -Based on our experience, the [Load testing tool](https://github.com/spryker-sdk/load-testing) can greatly assist you in conducting more effective load tests. \ No newline at end of file +Based on our experience, the [Load testing tool](https://github.com/spryker-sdk/load-testing) can greatly assist you in conducting more effective load tests. + +# Load testing tool for Spryker + +To assist in performance testing, we have a [load testing tool](https://github.com/spryker-sdk/load-testing). The tool contains predefined test scenarios that are specific to Spryker. Test runs based on Gatling.io, an open-source tool. Web UI helps to manage runs and multiple target projects are supported simultaneously. + +The tool can be used as a package integrated into the Spryker project or as a standalone package. + +## What is Gatling? + +Gatling is a powerful performance testing tool that supports HTTP, WebSocket, Server-Sent-Events, and JMS. Gatling is built on top of Akka that enables thousands of virtual users on a single machine. Akka has a message-driven architecture, and this overrides the JVM limitation of handling many threads. Virtual users are not threads but messages. + +Gatling is capable of creating an immense amount of traffic from a single node, which helps obtain the most precise information during the load testing. + +## Prerequisites + +- Java 8+ +- Node 10.10+ + +## Including the load testing tool into an environment + +The purpose of this guide is to show you how to integrate Spryker's load testing tool into your environment. While the instructions here will focus on setting this up with using one of Spryker’s many available demo shops, it can also be implemented into an on-going project. + +For instructions on setting up a developer environment using one of the available Spryker shops, you can visit our [getting started guide](/docs/scos/dev/developer-getting-started-guide.html) which shows you how to set up the Spryker Commerce OS. + +Some of the following options are available to choose from: +- [B2B Demo Shop](/docs/scos/user/intro-to-spryker//b2b-suite.html): A boilerplate for B2B commerce projects. +- [B2C Demo Shop](/docs/scos/user/intro-to-spryker/b2c-suite.html): A starting point for B2C implementations. + +If you wish to start with a demo shop that has been pre-configured with the Spryker load testing module, you can use the [Spryker Suite Demo Shop](https://github.com/spryker-shop/suite). + +For this example, we will be using the B2C Demo Shop. While a demo shop is used in this example, this can be integrated into a pre-existing project. You will just need to integrate Gatling into your project and generate the necessary data from fixtures into your database. + +To begin, we will need to create a project folder and clone the B2C Demo Shop and the Docker SDK: + +```bash +mkdir spryker-b2c && cd spryker-b2c +git clone https://github.com/spryker-shop/b2c-demo-shop.git ./ +git clone git@github.com:spryker/docker-sdk.git docker +``` + +### Integrating Gatling + +With the B2C Demo Shop and Docker SDK cloned, you will need to make a few changes to integrate Gatling into your project. These changes include requiring the load testing tool with composer as well as updating the [Router module](/docs/scos/dev/migration-concepts/silex-replacement/router/router-yves.html) inside of Yves. + +{% info_block infoBox %} + +The required composer package as well as the changes to the Router module are needed on the project level. They are what help to run the appropriate tests and generate the data needed for the load test tool. + +It should be noted that the Spryker Suite already has these changes implemented in them and comes pre-configured for load testing. For either of the B2C or B2B Demo Shops, you will need to implement the below changes. + +{% endinfo_block %} + +1. Requires the *composer* package. This step is necessary if you are looking to implement the Gatling load testing tool into your project. This line will add the new package to your `composer.json` file. The `--dev` flag will install the requirements needed for development which have a version constraint (e.g. "spryker-sdk/load-testing": "^0.1.0"). + +```bash +composer require spryker-sdk/load-testing --dev +``` + +2. Add the Router provider plugin to `src/Pyz/Yves/Router/RouterDependencyProvider.php`. Please note that you must import the appropriate class, `LoadTestingRouterProviderPlugin` to initialize the load testing. We also need to build onto the available array, so the `return` clause should be updated to reflect the additions to the array with `$routeProviders`. + +```php + Depending on your requirements, you can select any combination of the following `up` command attributes. To fetch all the changes from the branch you switch to, we recommend running the command with all of them: +> - `--build` - update composer, generate transfer objects, etc. +> - `--assets` - build assets +> - `--data` - get new demo data + +You've set up your Spryker B2C Demo Shop and can now access your applications. + +### Data preparation + +With the integrations done and the environment set up, you will need to create and load the data fixtures. This is done by first generating the necessary fixtures before triggering a *publish* of all events and then running the *queue worker*. As this will be running tests for this data preparation step, this will need to be done in the [testing mode for the Docker SDK](/docs/scos/dev/the-docker-sdk/202204.0/running-tests-with-the-docker-sdk.html). + +These steps assume you are working from a local environment. If you are attempting to implement these changes to a production or staging environment, you will need to take separate steps to generate parity data between the load-testing tool and your cloud-based environment. + +#### Steps for using a cloud-hosted environment. + +The Gatling test tool uses pre-seeded data which is used locally for both testing and generating the fixtures in the project's database. If you wish to test a production or a staging environment, there are several factors which need to be addressed. + +- You may have data you wish to test with directly which the sample dummy data may not cover. +- Cloud-hosted applications are not able to be run in test mode. +- Cloud-hosted applications are not set up to run `codeception`. +- Jenkins jobs in a cloud-hosted application are set up to run differently than those found on a locally-hosted environment. +- Some cloud-hosted applications may require `BASIC AUTH` authentication or require being connected to a VPN to access. + +Data used for Gatling's load testing can be found in **/load-test-tool-dir/tests/_data**. Any data that you generate from your cloud-hosted environment will need to be stored here. + +##### Setting up for basic authentication. + +If your environment is set for `BASIC AUTH` authentication and requires a user name and password before the site can be loaded, Gatling needs additional configuration. Found within **/load-test-tool-dir/resources/scenarios/spryker/**, two files control the HTTP protocol which is used by each test within the same directory. `GlueProtocol.scala` and `YvesProtocol.scala` each have a value (`httpProtocol`) which needs an additional argument to account for this authentication mode. + +```scala +val httpProtocol = http + .baseUrl(baseUrl) + +... + .basicAuth("usernamehere","passwordhere") +... + + .userAgentHeader("Mozilla/5.0 (Macintosh; Intel Mac OS X 10.8; rv:16.0) Gecko/20100101 Firefox/16.0") +``` + +**usernamehere** and **passwordhere** should match the username and password used for your environment's basic authentication, and not an account created within Spryker. This username and password are typically set up within your deploy file. + +##### Generating product data + +{% info_block errorBox %} + +You will need to be connected to the appropriate VPN for whichever resource you are trying to access. + +{% endinfo_block %} + +Product data can be generated from existing product data for use with the load-testing tool. Within **/load-test-tool-dir/tests/_data**, you will find `product_concrete.csv` which stores the necessary **sku** and **pdp_url** for each product. This information can be parsed directly from the existing data of your cloud-hosted environment. To do so, connect to your store's database. Product data is stored in the `data` column found within the `spy_product_concrete_storage` table as a JSON entry. We can extract this information and format it with the appropriate column names with the following command: + +```sql +-- `us-docker` refers to your database name. Please make the appropriate adjustments in the SQL query below + +SELECT + JSON_UNQUOTE(JSON_EXTRACT(data, "$.sku")) as `sku`, + JSON_UNQUOTE(JSON_EXTRACT(data, "$.url")) as `url` +FROM `us-docker`.`spy_product_concrete_storage`; +``` + +This command parses through the JSON entry and extracts what we need. Once this information has been generated, it should be saved as `product_concrete.csv` and saved in the **/load-test-tool-dir/tests/_data** directory. + +##### Generating customer data + +{% info_block errorBox %} + +You will need to be connected to the appropriate VPN for whichever resource you are trying to access. + +{% endinfo_block %} + +Customer data can be generated from existing product data for use with the load-testing tool. Within **/load-test-tool-dir/tests/_data**, you will find `customer.csv` which stores the necessary fields for each user (email, password, auth_token, first_name, and last_name). Most of this information can be parsed directly from the existing data of your cloud-hosted environment. There are a number of caveats which come with generating this customer data: + +- To generate information for `auth_token`, a separate Glue call is required. +- Passwords are encrypted in the database, while the load-testing tool requires a password to use in plain-text. + +Because of these aforementioned issues, it is recommended that you create the test users you need first through the Zed or Backoffice interface. For help with creating users, please refer to [Managing customers](/docs/scos/user/back-office-user-guides/202009.0/customer/customer-customer-access-customer-groups/managing-customers.html). + +Once the users have been created, you will need to generate access tokens for each. This can be done using Glue with the `access-token` end point. You can review the [access-token](/docs/scos/dev/glue-api-guides/202108.0/managing-b2b-account/managing-company-user-authentication-tokens.html) documentation for further guidance, but below is a sample of the call to be made. + +Expected request body +```json +{ + "data": { + "type": "string", + "attributes": { + "username": "string", + "password": "string" + } + } +} +``` + +Sample call with CURL +```bash +curl -X POST "http://glue.de.spryker.local/access-tokens" -H "accept: application/json" -H "Content-Type: application/json" -d "{\"data\":{\"type\":\"access-tokens\",\"attributes\":{\"username\":\"emailgoeshere\",\"password\":\"passwordgoeshere\"}}}" +``` + +{% info_block infoBox %} + +For each of these, the username is typically the email of the user that was created. Within the response from Glue, you will also want the **accessToken** to be saved for the **auth_token** column. + +{% endinfo_block %} + +Once users have been created and access tokens generated, this information should be stored and formatted in `customer.csv` and saved in the **/load-test-tool-dir/tests/_data** directory. Make sure to put the correct information under the appropriate column name. + +#### Steps for using a local environment + +To start, entering testing mode with the following command: + +```bash +docker/sdk testing +``` + +Once inside the Docker SDK CLI, to create and load the fixtures, do the following: + +1. Generate fixtures and data for the load testing tool to utilize. As we are specifying a different location for the configuration files, we will need to use the `-c` or `--config` flag with our command. These tests will run to generate the data that is needed for load testing purposes. This can be done with the following: + +```bash +vendor/bin/codecept fixtures -c vendor/spryker-sdk/load-testing +``` + +2. As we generated fixtures to be used with the Spryker load testing tool, the data needs to be republished. To do this, we need to trigger all *publish* events to publish Zed resources, such as products and prices, to storage and search functionality. + +```bash +console publish:trigger-events +``` + +3. Run the *queue worker*. The [Queue System](/docs/scos/dev/back-end-development/data-manipulation/queue/queue.html) provides a protocol for managing asynchronous processing, meaning that the sender and the receiver do not have access to the same message at the same time. Queue Workers are commands which send the queued task to a background process and provides it with parallel processing. The `-s` or `--stop-when-empty` flag stops worker execution only when the queues are empty. + +```bash +console queue:worker:start -s +``` + +You should have the fixtures loaded into the databases and can now exit the CLI to install Gatling into the project. + +#### Alternative method to generate local fixtures. + +Jenkins is the default scheduler which ships with Spryker. It is an automation service which helps to automate tasks within Spryker. If you would like an alternative way to generate fixtures for your local environment, Jenkins can be used to schedule the necessary tasks you need for the data preparation step. + +1. From the Dashboard, select `New Item`. +![screenshot](https://lh3.googleusercontent.com/drive-viewer/AJc5JmTzW2A-gkFX6PC1YiG4r0EUQX5S2xWDRQWq4hkgzKn889xva_FwrEaDo-lYl2i3CWgXiMqebPA=w1920-h919) + +2. Enter an item name for the new job and select `Freestyle project`. Once you have done that, you can move to the next step with `OK`. +![screenshot](https://lh3.googleusercontent.com/drive-viewer/AJc5JmR2mN1q7_Du2JZPTw_CFqi9hjYnEqi8XvjXpgidcmcEeIEvUYwiEFX2GAAeLU105pz53guDHqI=w1920-h919) + +3. The next step will allow up to input the commands we need to run. While a description is optional, you can choose to set one here. There are also additional settings, such as a display name, which may also be toggled. As you only need the commands to run once, you can move down to the `Build` section to add the three build steps needed. + +Click on `Add build step` and select `Execute shell`. A Command field will appear, allowing you to input the following: + +```bash +APPLICATION_STORE="DE" COMMAND="$PHP_BIN vendor/bin/codecept fixtures -c vendor/spryker-sdk/load-testing" bash /usr/bin/spryker.sh +``` + +{% info_block errorBox %} + +Once these fixtures have been generated, attempting to rerun them in the future with the default data files found in **/vendor/spryker-sdk/load-testing/tests/_data/** will cause an error. New data should be considered if you wish to regenerate fixtures for whatever reason. + +{% endinfo_block %} + +You can change the store for which you wish to generate fixtures for (i.e., `AT` or `US`). This command allows Codeception to locate the proper configuration file with the `-c` flag for the load testing tool. Once the fixtures have been generated, the data needs to be republished. We can have Jenkins do that with the same job by adding an additional build step with `Add build step`. + +```bash +APPLICATION_STORE="DE" COMMAND="$PHP_BIN vendor/bin/console publish:trigger-events" bash /usr/bin/spryker.sh +``` + +From here, you can either add another build step to toggle the queue worker to run, or you can run the queue worker job already available within Jenkins, i.e. `DE__queue-worker-start`. + +```bash +APPLICATION_STORE="DE" COMMAND="$PHP_BIN vendor/bin/console queue:worker:start -s " bash /usr/bin/spryker.sh +``` +![screenshot](https://lh3.googleusercontent.com/drive-viewer/AJc5JmTeb8OPIZwA65e57LNg8fq_t7DnQ2T_okTLFBxcljKIXgqXcjWyt9yiCFiPKX50_Nb2LyE__Ao=w1920-h919) + +4. Once the build steps have been added, you can `Save` to be taken to the project status page for the newly-created job. As this is a job that you only need to run once and no schedule was set, you can select the `Build Now` option. +![screenshot](https://lh3.googleusercontent.com/drive-viewer/AJc5JmRTLzDFMolgcaZ_xE-nKMNBEiIDXkSjwEiInkEIJL3ZbMbIY5ygKXqc-7eE_H5N2X-m7ap1l8s=w1920-h919) + +5. With the job set to build and run, it will build a new workspace for the tasks and run each build step that you specified. Once the build has successfully completed, you can review the `Console Output` and then remove the project with `Delete Project` once you are finished, if you no longer need it. +![screenshot](https://lh3.googleusercontent.com/drive-viewer/AJc5JmSJmYXg2MyBlTWGbCU6BtzL4ye4y2YOiKNFSobALdDrnescyH8wgIIOzF84QfWQAeSVEmz5HnI=w1920-h919) + +{% info_block infoBox %} + +While it is possible to change the Jenkins cronjobs found at **/config/Zed/cronjobs/jenkins.php**, please note that these entries require a scheduled time and setting this will cause those jobs to run until they have been disabled in the Jenkins web UI. + +{% endinfo_block %} + +You are now done and can move on to [Installing Gatling](#installing-gatling)! + +### Installing Gatling + +{% info_block infoBox %} + +If you are running this tool, you will need to have access to the appropriate Yves and Glue addresses of your environment. This may require your device be white-listed or may need to be accessed through VPN. + +Both Java 8+ and Node 10.10+ are requirements to run Gatling from any system. This may also require further configuration on the standalone device. + +{% endinfo_block %} + +The last steps to getting the Spryker load testing tool set up with your project is to finally install Gatling. The load testing tool is set up with a PHP interface which makes calls to Gatling to run the tests that have been built into the tool. + +If you are attempting to load test your production or staging environment and are not testing your site locally, you can skip to the [steps for standalone installation](/docs/cloud/dev/spryker-cloud-commerce-os/performance-testing-in-staging-enivronments.html#installing-gatling-as-a-standalone-package). + +An installation script is included with the load testing tool and can be run with the following: + +1. Enter the tests directory: + +```bash +cd vendor/spryker-sdk/load-testing +``` + +2. Run the installation script: + +```bash +./install.sh +``` + +After this step has been finished, you will be able to run the Web UI and tool to perform load testing for your project on the local level. + +#### Installing Gatling as a standalone package + +It is possible for you to run Gatling as a standalone package. Fixtures and data are still needed to be generated on the project level to determine what loads to send with each test. However, as the Spryker load testing tool utilizes NPM to run a localized server for the Web UI, you can do the following to install it: + + +1. You will first need to clone to the package directory from the Spryker SDK repository and navigate to it: + +```bash +git clone git@github.com:spryker-sdk/load-testing.git +cd load-testing +``` +2. Once you have navigated to the appropriate folder, you can run the installation script as follows: + +```bash +./install.sh +``` + +This should install Gatling with Spryker's available Web UI, making it ready for load testing. + +### Running Gatling + +To get the Web UI of the Gatling tool, run: + +```bash +npm run run +``` + +{% info_block infoBox %} + +The tool runs on port 3000 by default. If you want to use a different port, specify it in the PORT environment variable. + +{% endinfo_block %} + +The tool should now be available at `http://localhost:3000`. The Web UI comes with a variety of pre-built tests. These tests can be run against either the front-end of Yves or through the Glue API. It allows you to set up an instance of a host using the Yves and Glue addresses which can have these tests applied against. Each of the available tests allows you to run with either a growing load or a constant load for a designated amount of time and number of requests per second. Gatling will run the tests specified through the Web UI and then out-put their results in a separate report with charts that can be further broken down. + +Below is a list of available tests which can be run through the Web UI: + +For *Yves*: +- `Home` - request to the Home page +- `Nope` - empty request +- `AddToCustomerCart` - scenario to add a random product from fixtures to a user cart +- `AddToGuestCart` - scenario to add a random product from fixtures to a guest cart +- `CatalogSearch` - search request for a random product from fixtures +- `Pdp` - request a random product detail page from fixtures +- `PlaceOrder` - request to place an order +- `PlaceOrderCustomer` - scenario to place an order + +For *Glue API*: +- `CatalogSearchApi` - search request for a random product from fixtures +- `CheckoutApi` - scenario to checkout for logged user +- `GuestCheckoutApi` - scenario to checkout for guest user +- `CartApi` - scenario to add a product to the cart for logged user +- `GuestCartApi` - scenario to add a product to cart for guest user +- `PdpApi` - request a random product detail page from fixtures + +{% info_block errorBox %} + +Tests like **CartApi** and **GuestCartApi** use an older method of the `cart` end-point and will need to have their scenarios updated. These and other tests may need to be updated to take this into account. Please visit the [Glue Cart](/docs/scos/dev/glue-api-guides/202108.0/managing-carts/carts-of-registered-users/managing-carts-of-registered-users.html#create-a-cart) reference for more details. + +{% endinfo_block %} + + +## Using Gatling + +In the testing tool Web UI, you can do the following: +- Create, edit, and delete instances. +- Run one of the available tests on a specific instance. +- View detailed reports on all the available instances and tests. + +You can perform all these actions from the main page: + +![screenshot](https://github.com/spryker-sdk/load-testing/raw/master/docs/images/main-page.png) + + +### Managing instances + +You can create new instances and edit or delete the existing ones. + +#### Creating an instance + +To create an instance: + +1. In the navigation bar, click **New instance**. The *Instance* page opens. +![screenshot](https://github.com/spryker-sdk/load-testing/raw/master/docs/images/instance.png) +2. Enter the instance name. +3. Optional: in the Yves URL field, enter the Yves server URL. +4. Optional: in the Glue URL field, enter the GLUE API server URL. +5. Click **Go**. + +Now, the new instance should appear in the navigation bar in *INSTANCES* section. + + +#### Editing an instance +For the already available instances, you can edit Yves URL and Glue URL. Instance names cannot be edited. + +To edit an instance: +1. In the navigation bar, click **New instance**. The *Instance* page opens. +2. Click the *edit* sign next to the instance you want to edit: +![screenshot](https://github.com/spryker-sdk/load-testing/raw/master/docs/images/edit-instance.png) +3. Edit the Yves URL or the Glue URL. +4. Click **Go**. + +Now, the instance data is updated. + +#### Deleting an instance +To delete an instance: +1. In the navigation bar, click **New instance**. The *Instance* page opens. +2. Click the X sign next to the instance you want to delete: +![screenshot](https://github.com/spryker-sdk/load-testing/raw/master/docs/images/delete-instance.png) +3. Click **Go**. + +Your instance is now deleted. + +### Running tests + +To run a new load test: + +1. In the navigation bar, click **New test**. The *Run a test* page opens: +![screenshot](https://github.com/spryker-sdk/load-testing/raw/master/docs/images/test.png) +2. Select the instance you want to run the test for. See [Managing instances](#managing-instances) for information on how you can create and manage instances. +3. In the *Test* field, select the test you want to run. +4. In the *Type* field, select one of the test types: + - *Ramp*: Test type with the growing load (request per second), identifies a Peak Load capacity. + - *Steady*: Test type with the constant load, confirms reliance of a system under the Peak Load. +5. In the *Target RPS* field, set the test RPS (request per second) value. +6. In the *Duration* field, set the test duration. +7. Optional: In the *Description*, provide the test description. +8. Click **Go**. + +That's it - your test should run now. While it runs, you see a page where logs are generated. Once the time you specified in the Duration field from step 6 elapses, the test stops, and you can view the detailed test report. + + +### Viewing the test reports + +On the main page, you can check what tests are currently being run as well as view the detailed log for the completed tests. + +--- +**Info** + +By default, information on all instances and tests is displayed on the main page. To check details for specific tests or instances, specify them in the *Test* or *Instance* columns, respectively: +![screenshot](https://github.com/spryker-sdk/load-testing/raw/master/docs/images/filter.png) + +--- + +To check what tests are being run, on the main page, expand the *Running* section. + +To view the reports of the completed tests, on the main page, in the *Done* section, click **Report log** for the test you need: +![screenshot](https://github.com/spryker-sdk/load-testing/raw/master/docs/images/reports.png) A new tab with the detailed Gatling reports is opened. + + + +## Example test: Measuring the capacity + +Let's consider the example of measuring the capacity with the `AddToCustomerCart` or `AddToGuestCart` test. + +During the test, Gatling calls Yves, Yves calls Zed, Zed operates with the database. Data flows through the entire infrastructure. + +For the *Ramp probe* test type, the following is done: + +- Ramping *Requests per second* (RPS) from 0 to 100 over 10 minutes. +- Measuring the RPS right before the outage. +- Measuring the average response time before the outage under maximum load. + [56 RPS, 250ms] +![screenshot](https://github.com/spryker-sdk/load-testing/raw/master/docs/images/ramp-probe.png) + +For the *Steady probe* test type, the following is done: + +- Keeping the RPS on the expected level for 30 minutes. [56 RPS] +- Checking that the response time is in acceptable boundaries. [< 400ms for 90% of requests] +![screenshot](https://github.com/spryker-sdk/load-testing/raw/master/docs/images/steady-probe.png) + +## Gatling Reports + +Gatling reports are a valuable source of information to read the performance data by providing some details about requests and response timing. + +There are the following report types in Gatling: +- Indicators +- Statistics +- Active users among time +- Response time distribution +- Response time percentiles over time (OK) +- Number of requests per second +- Number of responses per second +- Response time against Global RPS + + +### Indicators + +This chart shows how response times are distributed among the standard ranges. +The right panel shows the number of OK/KO requests. +![screenshot](https://github.com/spryker-sdk/load-testing/raw/master/docs/images/indicators.png) + +### Statistics + +This table shows some standard statistics such as min, max, average, standard deviation, and percentiles globally and per request. +![screenshot](https://github.com/spryker-sdk/load-testing/raw/master/docs/images/statistics.png) + +### Active users among time + +This chart displays the active users during the simulation: total and per scenario. + +“Active users” is neither “concurrent users” or “users arrival rate”. It’s a kind of mixed metric that serves for both open and closed workload models, and that represents “users who were active on the system under load at a given second”. + +It’s computed as: +``` +(number of alive users at previous second) ++ (number of users that were started during this second) +- (number of users that were terminated during the previous second) +``` +![screenshot](https://github.com/spryker-sdk/load-testing/raw/master/docs/images/active-users-among-time.png) + +### Response time distribution + +This chart displays the distribution of response times. +![screenshot](https://github.com/spryker-sdk/load-testing/raw/master/docs/images/response-time-distribution.png) + +### Response time percentiles over time (OK) + +This chart displays a variety of response time percentiles over time, but only for successful requests. As failed requests can end prematurely or be caused by timeouts, they would have a drastic effect on the computation for percentiles. +![screenshot](https://github.com/spryker-sdk/load-testing/raw/master/docs/images/response-time-percentiles-over-time-ok.png) + +### Number of requests per second + +This chart displays the number of requests sent per second overtime. +![screenshot](https://github.com/spryker-sdk/load-testing/raw/master/docs/images/number-of-requests-per-second.png) + +### Number of responses per second + +This chart displays the number of responses received per second overtime: total, successes, and failures. +![screenshot](https://github.com/spryker-sdk/load-testing/raw/master/docs/images/number-of-responses-per-second.png) + +### Response time against Global RPS + +This chart shows how the response time for the given request is distributed, depending on the overall number of requests at the same time. +![screenshot](https://github.com/spryker-sdk/load-testing/raw/master/docs/images/response-time-against-global-rps.png) \ No newline at end of file diff --git a/docs/marketplace/dev/data-import/202108.0/marketplace-setup.md b/docs/marketplace/dev/data-import/202108.0/marketplace-setup.md index efd3ebec626..0a63fe90465 100644 --- a/docs/marketplace/dev/data-import/202108.0/marketplace-setup.md +++ b/docs/marketplace/dev/data-import/202108.0/marketplace-setup.md @@ -19,7 +19,7 @@ The following table provides details about Marketplace setup data importers, the | Merchant category | Imports merchant categories. | `data:import merchant-category` | [merchant_category.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant-category.csv.html) | [merchant.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant.csv.html) | | Merchant users | Imports merchant users of the merchant. | `data:import merchant-user` | [merchant_user.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant-user.csv.html) | [merchant.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant.csv.html) | | Merchant stores | Imports merchant stores. | `data:import merchant-store` | [merchant_store.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant-store.csv.html) |
  • [merchant.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant.csv.html)
  • `stores.php` configuration file of Demo Shop
| -| Merchant stock | Imports merchant stock details. | `data:import merchant-stock` | [merchant_stock.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant-stock.csv.html) |
  • [merchant.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant.csv.html)
  • [File details: warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-data/file-details-warehouse.csv.html)
| +| Merchant stock | Imports merchant stock details. | `data:import merchant-stock` | [merchant_stock.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant-stock.csv.html) |
  • [merchant.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant.csv.html)
  • [File details: warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/file-details-warehouse.csv.html)
| | Merchant OMS processes | Imports Merchant OMS processes. | `data:import merchant-oms-process` | [merchant_oms_process.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant-oms-process.csv.html) |
  • [merchant.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant.csv.html)
  • OMS configuration that can be found at:
    • `project/config/Zed/oms project/config/Zed/StateMachine`
    • `project/config/Zed/StateMachine`
| | Merchant product offer | Imports basic merchant product offer information. | `data:import merchant-product-offer` | [merchant_product_offer.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant-product-offer.csv.html) |
  • [merchant.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant.csv.html)
  • [File details: product_concrete.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/catalog-setup/products/file-details-product-concrete.csv.html)
| | Merchant product offer price | Imports product offer prices. | `data:import price-product-offer` | [price-product-offer.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-price-product-offer.csv.html) |
  • [merchant_product_offer.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant-product-offer.csv.html)
  • [product_price.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/catalog-setup/pricing/file-details-product-price.csv.html)
| diff --git a/docs/marketplace/dev/data-import/202204.0/file-details-merchant-stock.csv.md b/docs/marketplace/dev/data-import/202204.0/file-details-merchant-stock.csv.md index 27d40f70692..92218c3e716 100644 --- a/docs/marketplace/dev/data-import/202204.0/file-details-merchant-stock.csv.md +++ b/docs/marketplace/dev/data-import/202204.0/file-details-merchant-stock.csv.md @@ -34,7 +34,7 @@ The file should have the following parameters: The file has the following dependencies: - [merchant.csv](/docs/marketplace/dev/data-import/{{site.version}}/file-details-merchant.csv.html) -- [warehouse.csv](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/import-data/file-details-warehouse.csv.html) +- [warehouse.csv](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/import-and-export-data/file-details-warehouse.csv.html) ## Import template file and content example diff --git a/docs/marketplace/dev/data-import/202204.0/file-details-product-offer-stock.csv.md b/docs/marketplace/dev/data-import/202204.0/file-details-product-offer-stock.csv.md index 1ad8c00357a..86fef577e8c 100644 --- a/docs/marketplace/dev/data-import/202204.0/file-details-product-offer-stock.csv.md +++ b/docs/marketplace/dev/data-import/202204.0/file-details-product-offer-stock.csv.md @@ -36,7 +36,7 @@ The file should have the following parameters: The file has the following dependencies: - [merchant_product_offer.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant-product-offer.csv.html) -- [warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-data/file-details-warehouse.csv.html) +- [warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/file-details-warehouse.csv.html) ## Import template file and content example diff --git a/docs/marketplace/dev/data-import/202204.0/marketplace-setup.md b/docs/marketplace/dev/data-import/202204.0/marketplace-setup.md index 420118b2494..5a446702ce9 100644 --- a/docs/marketplace/dev/data-import/202204.0/marketplace-setup.md +++ b/docs/marketplace/dev/data-import/202204.0/marketplace-setup.md @@ -23,7 +23,7 @@ The following table provides details about Marketplace setup data importers, the | Merchant OMS processes | Imports Merchant OMS processes. | `data:import merchant-oms-process` | [merchant_oms_process.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant-oms-process.csv.html) |
  • [merchant.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-data/file-details-merchant.csv.html)
  • OMS configuration that can be found at:
    • `project/config/Zed/oms project/config/Zed/StateMachine`
    • `project/config/Zed/StateMachine`
| | Merchant product offer | Imports basic merchant product offer information. | `data:import merchant-product-offer` | [merchant_product_offer.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant-product-offer.csv.html) |
  • [merchant.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-data/file-details-merchant.csv.html)
  • [File details: product_concrete.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/file-details-product-concrete.csv.html)
| | Merchant product offer price | Imports product offer prices. | `data:import price-product-offer` | [price-product-offer.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-price-product-offer.csv.html) |
  • [merchant_product_offer.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant-product-offer.csv.html)
  • [product_price.csv](/docs/pbc/all/price-management/{{site.version}}/base-shop/import-and-export-data/file-details-product-price.csv.html)
| -| Merchant product offer stock | Imports merchant product stock. | `data:import product-offer-stock` | [product_offer_stock.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-product-offer-stock.csv.html) |
  • [merchant_product_offer.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant-product-offer.csv.html)
  • [warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-data/file-details-warehouse.csv.html)
| +| Merchant product offer stock | Imports merchant product stock. | `data:import product-offer-stock` | [product_offer_stock.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-product-offer-stock.csv.html) |
  • [merchant_product_offer.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant-product-offer.csv.html)
  • [warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/file-details-warehouse.csv.html)
| | Merchant product offer stores | Imports merchant product offer stores. | `data:import merchant-product-offer-store` | [merchant_product_offer_store.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant-product-offer-store.csv.html) |
  • [merchant_product_offer.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant-product-offer.csv.html)
  • `stores.php` configuration file of Demo Shop
| | Validity of the merchant product offers | Imports the validity of the merchant product offers. | `data:import product-offer-validity` | [product_offer_validity.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-product-offer-validity.csv.html) | [merchant_product_offer.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant-product-offer.csv.html) | | Merchant product offers | Imports full product offer information via a single file. | `data:import --config data/import/common/combined_merchant_product_offer_import_config_{store}.yml` | [combined_merchant_product_offer.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-combined-merchant-product-offer.csv.html) |
  • [merchant.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-data/file-details-merchant.csv.html)
  • `stores.php` configuration file of Demo Shop
| diff --git a/docs/marketplace/dev/data-import/202212.0/data-import.md b/docs/marketplace/dev/data-import/202212.0/data-import.md deleted file mode 100644 index 2e829f14eb4..00000000000 --- a/docs/marketplace/dev/data-import/202212.0/data-import.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: Data import -description: Import data from other systems into your marketplace project -last_updated: Sep 7, 2022 -template: concept-topic-template ---- - -Spryker’s customers need to import data from other systems into their Spryker Marketplace project. The _Data import_ section holds all the needed information for that. For more details, see the following documents: - -* [Marketplace setup](/docs/marketplace/dev/data-import/{{page.version}}/marketplace-setup.html) diff --git a/docs/marketplace/dev/data-import/202212.0/file-details-merchant-store.csv.md b/docs/marketplace/dev/data-import/202212.0/file-details-merchant-store.csv.md deleted file mode 100644 index 0ceec9de088..00000000000 --- a/docs/marketplace/dev/data-import/202212.0/file-details-merchant-store.csv.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: "File details: merchant_store.csv" -last_updated: Feb 26, 2021 -description: This document describes the merchant_store.csv file to configure merchant store information in your Spryker shop. -template: import-file-template -related: - - title: Marketplace Merchant feature overview - link: docs/pbc/all/merchant-management/page.version/marketplace/marketplace-merchant-feature-overview/marketplace-merchant-feature-overview.html - - title: Execution order of data importers in Demo Shop - link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html ---- - -This document describes the `merchant_store.csv` file to configure merchant's stores in your Spryker shop. - -To import the file, run: - -```bash -data:import merchant-store -``` - -## Import file parameters - -The file should have the following parameters: - -| PARAMETER | REQUIRED | TYPE | DEFAULT VALUE | REQUIREMENTS OR COMMENTS | DESCRIPTION | -| -------------- | ----------- | ----- | -------------- | ------------------------ | ----------------------- | -| merchant_reference | ✓ | String | | Unique | Identifier of the merchant in the system. | -| store_name | ✓ | String | | Value previously defined in the *stores.php* project configuration. | Store where the merchant product offer belongs. | - -## Import file dependencies - -The file has the following dependencies: - -- [merchant.csv](/docs/pbc/all/merchant-management/{{site.version}}/marketplace/import-data/file-details-merchant.csv.html) -- `stores.php` configuration file of the demo shop PHP project, where stores are defined initially - -## Import template file and content example - -Find the template and an example of the file below: - -| FILE | DESCRIPTION | -| --------------------------- | ---------------------- | -| [template_merchant_store.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Marketplace+setup/template_merchant_store.csv) | Import file template with headers only. | -| [merchant_store.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Marketplace+setup/merchant_store.csv) | Example of the import file with Demo Shop data. | diff --git a/docs/marketplace/dev/feature-integration-guides/202212.0/feature-integration-guides.md b/docs/marketplace/dev/feature-integration-guides/202212.0/feature-integration-guides.md index b99527cc373..2e66536fa06 100644 --- a/docs/marketplace/dev/feature-integration-guides/202212.0/feature-integration-guides.md +++ b/docs/marketplace/dev/feature-integration-guides/202212.0/feature-integration-guides.md @@ -6,13 +6,5 @@ template: concept-topic-template --- This section contains the following Marketplace feature integration guides: -* [Marketplace Dummy Payment feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/marketplace-dummy-payment-feature-integration.html) * [Merchant Category feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/merchant-category-feature-integration.html) * [Merchant Opening Hours feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/merchant-opening-hours-feature-integration.html) -* [Merchant Switcher feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/merchant-switcher-feature-integration.html) -* [Merchant Switcher + Customer Account Management feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/merchant-switcher-customer-account-management-feature-integration.html) -* [Merchant Switcher + Wishlist feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/merchant-switcher-wishlist-feature-integration.html) -* [Merchant Portal feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/merchant-portal-feature-integration.html) -* [Merchant Portal - Marketplace Product feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/merchant-portal-marketplace-product-feature-integration.html) -* [Merchant Portal - Marketplace Product Options Management feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/merchant-portal-marketplace-product-options-management-feature-integration.html) -* [Merchant Portal - Marketplace Merchant Portal Product Offer Management feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/marketplace-merchant-portal-product-offer-management-feature-integration.html) diff --git a/docs/marketplace/dev/feature-integration-guides/202212.0/marketplace-dummy-payment-feature-integration.md b/docs/marketplace/dev/feature-integration-guides/202212.0/marketplace-dummy-payment-feature-integration.md deleted file mode 100644 index cbf5c66309c..00000000000 --- a/docs/marketplace/dev/feature-integration-guides/202212.0/marketplace-dummy-payment-feature-integration.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: Marketplace Dummy Payment -last_updated: Oct 05, 2021 -description: This document describes the process how to integrate the Marketplace Dummy Payment into a Spryker project. -template: feature-integration-guide-template ---- - -{% include pbc/all/install-features/202212.0/marketplace/install-the-marketplace-dummy-payment-feature.md %} diff --git a/docs/marketplace/dev/front-end/202212.0/web-components.md b/docs/marketplace/dev/front-end/202212.0/web-components.md index ac4fbc5874b..dcab6f47cb9 100644 --- a/docs/marketplace/dev/front-end/202212.0/web-components.md +++ b/docs/marketplace/dev/front-end/202212.0/web-components.md @@ -63,4 +63,4 @@ import { SomeComponentModule } from './some-component/some-component.module'; export class ComponentsModule {} ``` -The complete process of creating a new module and registering it as a web component can be found in the [How-To: Create a new Angular module with application](/docs/marketplace/dev/howtos/how-to-create-a-new-angular-module-with-application.html). +The complete process of creating a new module and registering it as a web component can be found in the [How-To: Create a new Angular module with application](/docs/scos/dev/tutorials-and-howtos/howtos/howto-create-an-angular-module-with-application.html). diff --git a/docs/marketplace/dev/glue-api-guides/202212.0/resolving-search-engine-friendly-urls.md b/docs/marketplace/dev/glue-api-guides/202212.0/resolving-search-engine-friendly-urls.md index 77dde79ca8d..c0e61dfbdcf 100644 --- a/docs/marketplace/dev/glue-api-guides/202212.0/resolving-search-engine-friendly-urls.md +++ b/docs/marketplace/dev/glue-api-guides/202212.0/resolving-search-engine-friendly-urls.md @@ -171,4 +171,4 @@ Using the information from the response and the Glue server name, you can constr | 404 | The provided URL does not exist. | | 422 | The `url` parameter is missing. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/marketplace/dev/glue-api-guides/202212.0/retrieving-autocomplete-and-search-suggestions.md b/docs/marketplace/dev/glue-api-guides/202212.0/retrieving-autocomplete-and-search-suggestions.md index e8b37d6ea61..391e3af7afd 100644 --- a/docs/marketplace/dev/glue-api-guides/202212.0/retrieving-autocomplete-and-search-suggestions.md +++ b/docs/marketplace/dev/glue-api-guides/202212.0/retrieving-autocomplete-and-search-suggestions.md @@ -1800,7 +1800,7 @@ To retrieve a search suggestion, send the request: {% info_block infoBox "SEO-friendly URLs" %} -The `url` attribute of categories and abstract products exposes a SEO-friendly URL of the resource that represents the respective category or product. For information about how to resolve such a URL and retrieve the corresponding resource, see [Resolving search engine friendly URLs](/docs/scos/dev/glue-api-guides/{{page.version}}/resolving-search-engine-friendly-urls.html). +The `url` attribute of categories and abstract products exposes a SEO-friendly URL of the resource that represents the respective category or product. For information about how to resolve such a URL and retrieve the corresponding resource, see [Resolving search engine friendly URLs](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/resolving-search-engine-friendly-urls.html). {% endinfo_block %} @@ -1810,4 +1810,4 @@ Although CMS pages also expose the `url` parameter, resolving of CMS page SEF UR {% endinfo_block %} -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/marketplace/dev/howtos/howtos.md b/docs/marketplace/dev/howtos/howtos.md deleted file mode 100644 index d07b038a3b7..00000000000 --- a/docs/marketplace/dev/howtos/howtos.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: HowTos -description: how-to guides for developers working with Marketplace -last_updated: Jan 12, 2023 -template: concept-topic-template ---- -This section contains the following Marketplace how-to guides: -* [How-To: Upgrade Spryker instance to the Marketplace](/docs/marketplace/dev/howtos/how-to-upgrade-spryker-instance-to-marketplace.html) -* [How-To: Create a new module with application](/docs/marketplace/dev/howtos/how-to-create-a-new-module-with-application.html) -* [How-To: Split products by stores](/docs/marketplace/dev/howtos/how-to-split-products-by-stores.html) diff --git a/docs/marketplace/dev/setup/202212.0/marketplace-supported-browsers.md b/docs/marketplace/dev/setup/202212.0/marketplace-supported-browsers.md deleted file mode 100644 index 61f1affb970..00000000000 --- a/docs/marketplace/dev/setup/202212.0/marketplace-supported-browsers.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: Marketplace supported browsers -description: This document lists browsers supported by the Spryker Marketplace. -last_updated: Jun 8, 2022 -template: howto-guide-template -redirect_from: - - /docs/marketplace/dev/setup/marketplace-supported-browsers.html ---- - -The Spryker Marketplace supports the following browsers: - -| DESKTOP (MARKETPLACE AND MERCHANT PORTAL) | MOBILE (MARKETPLACE ONLY) | TABLET (MARKETPLACE AND MERCHANT PORTAL) | -| --- | --- | --- | -| *Browsers*:
  • Windows, macOS: Chrome (latest version)
  • Windows: Firefox (latest version)
  • Windows: Edge (latest version)
  • macOS: Safari (latest version)
*Windows versions*:
  • Windows 10
  • Windows 7
*macOS versions*:
  • Catalina 10 or later
*Screen resolutions*:
  • 1024-1920 width
| *Browsers*:
  • iOS: Safari
  • Android: Chrome
*Screen resolutions*:
  • 360x640—for example, Samsung Galaxy S8 or S9)
  • 375x667—for example, iPhone 7 or 8
  • iPhone X, Xs, Xr
*Android versions*:
  • 8.0
*iOS versions*:
  • iOS 13 or later
| *Browsers*:
  • iOS: Safari
  • Android: Chrome
*iOS versions*:
  • iOS 13
*Screen resolutions*:
  • 1024x703—for example, iPad Air
| diff --git a/docs/marketplace/dev/setup/202212.0/setup.md b/docs/marketplace/dev/setup/202212.0/setup.md deleted file mode 100644 index d33b8ef24ce..00000000000 --- a/docs/marketplace/dev/setup/202212.0/setup.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: Setup -description: How to get started with the B2C Demo Marketplace -last_updated: Jan 12, 2023 -template: concept-topic-template ---- - -This section describes how to get started with the B2C Demo Marketplace, including requirements and supported browsers. It contains the following topics: -* [System requirements](/docs/marketplace/dev/setup/{{page.version}}/system-requirements.html) -* [Marketplace supported browsers](/docs/marketplace/dev/setup/{{page.version}}/marketplace-supported-browsers.html) diff --git a/docs/marketplace/dev/setup/202212.0/system-requirements.md b/docs/marketplace/dev/setup/202212.0/system-requirements.md deleted file mode 100644 index ada7a178bf8..00000000000 --- a/docs/marketplace/dev/setup/202212.0/system-requirements.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: System requirements -last_updated: May 15, 2023 -Descriptions: System infrastructure requirements for the Spryker Marketplace with Merchant Portal -template: howto-guide-template -redirect_from: - - /docs/marketplace/dev/setup/system-requirements.html - - /docs/marketplace/dev/setup/202212.0/infrastructure-requirements.html ---- - - -| OPERATING SYSTEM | NATIVE: LINUXONLY tHROUGH VM: MACOS AND MS WINDOWS | -|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Web Server | NginX—preferred. But any webserver which supports PHP will work such as lighttpd, Apache, Cherokee. | -| Databases | Depending on the project, one of the databases: MariaDB >= 10.4—preferred, PostgreSQL >=9.6, or MySQL >=5.7. | -| PHP | Spryker supports PHP `>=8.0` with the following extensions: `curl`, `json`, `mysql`, `pdo-sqlite`, `sqlite3`, `gd`, `intl`, `mysqli`, `pgsql`, `ssh2`, `gmp`, `mcrypt`, `pdo-mysql`, `readline`, `twig`, `imagick`, `memcache`, `pdo-pgsql`, `redis`, `xml`, `bz2`, `mbstring`. For details about the supported PHP versions, see [Supported Versions of PHP](/docs/scos/user/intro-to-spryker/whats-new/supported-versions-of-php.html). | -| SSL | For production systems, a valid security certificate is required for HTTPS. | -| Redis | Version >=3.2, >=5.0 | -| Elasticsearch | Version 6.*x* or 7.*x* | -| RabbitMQ | Version 3.6+ | -| Jenkins (for cronjob management) | Version 1.6.*x* or 2.*x* | -| Graphviz (for statemachine visualization) | 2.*x* | -| Symfony | Version >= 4.0 | -| Node.js | Version >= 16.0.0 | -| Intranet | Back Office application (Zed) must be secured in an Intranet (using VPN, Basic Auth, IP Allowlist, and DMZ) | -| Spryker Commerce OS | Version >= {{page.version}} | diff --git a/docs/marketplace/dev/setup/202304.0/system-requirements.md b/docs/marketplace/dev/setup/202304.0/system-requirements.md deleted file mode 100644 index 3ec35dbc958..00000000000 --- a/docs/marketplace/dev/setup/202304.0/system-requirements.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: System requirements -last_updated: May 15, 2023 -Descriptions: System infrastructure requirements for the Spryker Marketplace with Merchant Portal -template: howto-guide-template -redirect_from: - - /docs/marketplace/dev/setup/system-requirements.html -related: - - title: Infrastructure requirements - link: docs/marketplace/dev/setup/page.version/infrastructure-requirements.html ---- - - -| OPERATING SYSTEM | NATIVE: LINUXONLY tHROUGH VM: MACOS AND MS WINDOWS | -|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Web Server | NginX—preferred. But any webserver which supports PHP will work such as lighttpd, Apache, Cherokee. | -| Databases | Depending on the project, one of the databases: MariaDB >= 10.4—preferred, PostgreSQL >=9.6, or MySQL >=5.7. | -| PHP | Spryker supports PHP `>=8.0` with the following extensions: `curl`, `json`, `mysql`, `pdo-sqlite`, `sqlite3`, `gd`, `intl`, `mysqli`, `pgsql`, `ssh2`, `gmp`, `mcrypt`, `pdo-mysql`, `readline`, `twig`, `imagick`, `memcache`, `pdo-pgsql`, `redis`, `xml`, `bz2`, `mbstring`. For details about the supported PHP versions, see [Supported Versions of PHP](/docs/scos/user/intro-to-spryker/whats-new/supported-versions-of-php.html). | -| SSL | For production systems, a valid security certificate is required for HTTPS. | -| Redis | Version >=3.2, >=5.0 | -| Elasticsearch | Version 6.*x* or 7.*x* | -| RabbitMQ | Version 3.6+ | -| Jenkins (for cronjob management) | Version 1.6.*x* or 2.*x* | -| Graphviz (for statemachine visualization) | 2.*x* | -| Symfony | Version >= 4.0 | -| Node.js | Version >= 18.0.0 | -| Intranet | Back Office application (Zed) must be secured in an Intranet (using VPN, Basic Auth, IP Allowlist, and DMZ) | -| Spryker Commerce OS | Version >= {{page.version}} | diff --git a/docs/marketplace/dev/technical-enhancement/202212.0/technical-enhancement.md b/docs/marketplace/dev/technical-enhancement/202212.0/technical-enhancement.md deleted file mode 100644 index e79926bf763..00000000000 --- a/docs/marketplace/dev/technical-enhancement/202212.0/technical-enhancement.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Technical enhancement guides -description: Describes how to upgrade to Angluar v12 -last_updated: Jan 12, 2023 -template: concept-topic-template ---- - -This section contains the following article: -* [Migration guide – Upgrade to Angular v12](/docs/marketplace/dev/technical-enhancement/{{page.version}}/migration-guide-upgrade-to-angular-v12.html) diff --git a/docs/marketplace/user/features/202108.0/marketplace-promotions-and-discounts-feature-overview.md b/docs/marketplace/user/features/202108.0/marketplace-promotions-and-discounts-feature-overview.md index e20eb16ecc0..6bb13f6416f 100644 --- a/docs/marketplace/user/features/202108.0/marketplace-promotions-and-discounts-feature-overview.md +++ b/docs/marketplace/user/features/202108.0/marketplace-promotions-and-discounts-feature-overview.md @@ -2,6 +2,7 @@ title: Marketplace Promotions and Discounts feature overview description: This document contains concept information for the Marketplace Promotions and Discounts feature. template: concept-topic-template +lust_udpated: Jul 17, 2023 related: - title: Discount link: docs/marketplace/dev/feature-walkthroughs/page.version/marketplace-promotions-and-discounts-feature-walkthrough.html @@ -63,7 +64,7 @@ A decision rule is a condition assigned to a discount that should be fulfilled f A discount can have one or more decision rules. Find an exemplary combination below: -| Parameter | RELATION OPERATOR | Value | +| Parameter | RELATION OPERATOR | VALUE | | --- | --- | --- | | total-quantity | equal | 3 | | day-of-week| equal | 5 | @@ -139,7 +140,9 @@ The Marketplace discounts are applied based on the query string. The *query string* is a discount application type that uses [decision rules](#decision-rule) to dynamically define what products a discount applies to. The discount in the following example applies to white products. + ![Query collection](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+&+Discounts/Discount/Discount+Feature+Overview/collection-query.png) + The product selection based on the query string is dynamic: * If at some point, the color attribute of a product changes from white to anything else, the product is no longer eligible to be discounted. * If at some point, a product receives the white color attribute, it becomes eligible for the discount. @@ -158,9 +161,9 @@ With the calculator fixed type, the currency of the respective shop is used for {% endinfo_block %} - See examples in the following table. -| Product price | Calculation type | Amount | Discount applied | Price to pay | + +| PRODUCT PRICE | CALCULATION TYPE | AMOUNT | DISCOUNT APPLIED | PRICE TO PAY | | --- | --- | --- | --- | --- | | €50 | Calculator percentage | 10 | €5 | €45 | | €50 | Calculator fixed | 10 | €10 | €40 | @@ -181,7 +184,7 @@ An exclusive discount is a discount that, when applied to a cart, discards all t In the following example, a cart with the order total amount of €100 contains the following discounts. -| Discount name | Discount amount | Discount type | Exclusiveness | Discounted amount | +| DISCOUNT NAME | DISCOUNT AMOUNT | DISCOUNT TYPE | EXCLUSIVENESS | DISCOUNTED AMOUNT | | --- | --- | --- | --- | --- | | D1 | 15 | Calculator percentage | Exclusive | €15 | |D2|5| Calculator fixed | Exclusive | €5 | @@ -199,7 +202,7 @@ A non-exclusive discount is a discount that can be combined with other non-exclu In the following example, a cart with the order total amount of €30 contains the following discounts. -| Discount name | Discount amount | Discount type | Exclusiveness | Discounted amount | +| DISCOUNT NAME | DISCOUNT AMOUNT | DISCOUNT TYPE | EXCLUSIVENESS | DISCOUNTED AMOUNT | | --- | --- | --- | --- | --- | | D1 | 15 | Calculator percentage | Non-exclusive | €15 | | D2 | 5 | Calculator fixed | Non-exclusive | €5 | diff --git a/docs/marketplace/user/features/202204.0/marketplace-inventory-management-feature-overview.md b/docs/marketplace/user/features/202204.0/marketplace-inventory-management-feature-overview.md index 8daf5081ea3..21caa723992 100644 --- a/docs/marketplace/user/features/202204.0/marketplace-inventory-management-feature-overview.md +++ b/docs/marketplace/user/features/202204.0/marketplace-inventory-management-feature-overview.md @@ -32,7 +32,7 @@ Also, you can do the following using the data import: * Manage stock of product offers for a merchant by importing the product offer and stock data separately: [File details: product_offer_stock.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-product-offer-stock.csv.html). * Define stock when importing the product offer data: [File details: combined_merchant_product_offer.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-combined-merchant-product-offer.csv.html). * Import merchant stock data: [File details: merchant_stock.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant-stock.csv.html). -* Import stock of merchant products: [File details: product_stock.csv](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/import-data/file-details-product-stock.csv.html). +* Import stock of merchant products: [File details: product_stock.csv](/docs/pbc/all/warehouse-management-system/{{site.version}}/base-shop/import-and-export-data/file-details-product-stock.csv.html). ## Marketplace availability management diff --git a/docs/marketplace/user/features/202204.0/marketplace-promotions-and-discounts-feature-overview.md b/docs/marketplace/user/features/202204.0/marketplace-promotions-and-discounts-feature-overview.md index fd05db183b8..c6084b8b840 100644 --- a/docs/marketplace/user/features/202204.0/marketplace-promotions-and-discounts-feature-overview.md +++ b/docs/marketplace/user/features/202204.0/marketplace-promotions-and-discounts-feature-overview.md @@ -2,6 +2,7 @@ title: Marketplace Promotions and Discounts feature overview description: This document contains concept information for the Marketplace Promotions and Discounts feature. template: concept-topic-template +last_udpated: Jul 17, 2023 related: - title: Discount link: docs/marketplace/dev/feature-walkthroughs/page.version/marketplace-promotions-and-discounts-feature-walkthrough.html @@ -14,11 +15,11 @@ There are two discount types: * Voucher * Cart rule -A product catalog manager selects a discount type when [creating a discount](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-in-the-back-office/create-discounts.html). +A product catalog manager selects a discount type when [creating a discount](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html). {% info_block warningBox "Warning" %} -In current implementation, it is impossible to create cart rules or vouchers based on any merchant parameters, such as merchant or product offer. However, it is still possible to create cart rules and vouchers for the marketplace products. See [Create discounts](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-in-the-back-office/create-discounts.html) for more details. +In current implementation, it is impossible to create cart rules or vouchers based on any merchant parameters, such as merchant or product offer. However, it is still possible to create cart rules and vouchers for the marketplace products. See [Create discounts](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html) for more details. {% endinfo_block %} @@ -36,34 +37,38 @@ Based on the business logic, discounts can be applied in the following ways: ## Voucher A *Voucher* is a discount that applies when a customer enters an active voucher code on the *Cart* page. + ![Cart voucher](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Features/Marketplace+Promotions+and+Discounts+feature+overview/voucher-storefront.png) Once the customer clicks **Redeem code**, the page refreshes to show the discount name, discount value, and available actions: **Remove** and **Clear all**. The **Clear all** action disables all the applied discounts. The **Remove** action disables a single discount. + ![Cart voucher applied](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Features/Marketplace+Promotions+and+Discounts+feature+overview/voucher-cart.png) Multiple voucher codes can be generated for a single voucher. The code has a **Max number of uses** value which defines how many times the code can be redeemed. You can enter codes manually or use the code generator in the Back Office. + ![Generate codes](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+&+Discounts/Discount/Discount+Feature+Overview/generate_codes.png) To learn how a product catalog manager can create a voucher in the Back Office, see [Creating a voucher](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html). ## Cart Rule -A *cart rule* is a discount that applies to cart once all the [decision rules](#decision-rule) linked to the cart rule are fulfilled. +A *cart rule* is a discount that applies to the cart once all the [decision rules](#decision-rule) linked to the cart rule are fulfilled. The cart rule is applied automatically. If the decision rules of a discount are fulfilled, the customer can see the discount upon entering the cart. Unlike with [vouchers](#voucher), the **Clear all** and **Remove** actions are not displayed. + ![Cart rule](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Features/Marketplace+Promotions+and+Discounts+feature+overview/cart-rule-storefront.png) -To learn how a product catalog manager can create a cart rule in the Back Office, see [Create discounts](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-in-the-back-office/create-discounts.html). +To learn how a product catalog manager can create a cart rule in the Back Office, see [Create discounts](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html). ### Decision rule A decision rule is a condition assigned to a discount that should be fulfilled for the discount to be applied. A discount can have one or more decision rules. Find an exemplary combination below: -| Parameter | RELATION OPERATOR | Value | +| PARAMETER | RELATION OPERATOR | VALUE | | --- | --- | --- | | total-quantity | equal | 3 | | day-of-week| equal | 5 | @@ -98,9 +103,11 @@ Decision rules are combined with *AND* and *OR* combination operators. With the In the following example, for the discount to be applied, a cart should contain three items, and the purchase should be made on Wednesday. + ![AND operator](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+&+Discounts/Discount/Discount+Feature+Overview/and-operator.png) In the following example, for the discount to be applied, a cart should contain three items, or the purchase should be made on Wednesday. + ![OR operator](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+&+Discounts/Discount/Discount+Feature+Overview/or-operator.png) {% info_block infoBox "Info" %} @@ -116,15 +123,15 @@ A rule group is a separate set of rules with its own combination operator. ![Decision rule group](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+%26+Discounts/Discount/Discount+Feature+Overview/decision-rule-group.png) -With the rule groups, you can build multiple levels of rule hierarchy. When a cart is evaluated against the rules, it is evaluated on all the levels of the hierarchy. On each level, there can be both rules and rule groups. +With the rule groups, you can build multiple levels of rule hierarchy. When a cart is evaluated against the rules, it is evaluated on all levels of the hierarchy. On each level, there can be both rules and rule groups. ![Decision rule hierarchy](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+%26+Discounts/Discount/Discount+Feature+Overview/decision-rule-hierarchy.png) -When a cart is evaluated on a level that has a rule and a rule group, the rule group is treated as a single rule. The following diagram shows how a cart is evaluated against the rules on the previous screenshot. +When a cart is evaluated on a level that has a rule and a rule group, the rule group is treated as a single rule. The following diagram shows how a cart is evaluated against the rules in the previous screenshot. ### Discount threshold A *threshold* is a minimum number of items in the cart that should fulfill all the specified decision rules for the discount to be applied. -The default value is *1* . It means that a discount is applied if at least one item fulfills the discount's decision rules. +The default value is *1*. It means that a discount is applied if at least one item fulfills the discount's decision rules. In the following example, the discount is applied if there are four items with the Intel Core processor in the cart. ![Threshold](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+&+Discounts/Discount/Discount+Feature+Overview/threshold.png) @@ -139,7 +146,9 @@ The Marketplace discounts are applied based on the query string. The *query string* is a discount application type that uses [decision rules](#decision-rule) to dynamically define what products a discount applies to. The discount in the following example applies to white products. + ![Query collection](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+&+Discounts/Discount/Discount+Feature+Overview/collection-query.png) + The product selection based on the query string is dynamic: * If at some point, the color attribute of a product changes from white to anything else, the product is no longer eligible to be discounted. * If at some point, a product receives the white color attribute, it becomes eligible for the discount. @@ -160,19 +169,20 @@ With the calculator fixed type, the currency of the respective shop is used for See examples in the following table. -| Product price | Calculation type | Amount | Discount applied | Price to pay | + +| PRODUCT PRICE | CALCULATION TYPE | AMOUNT | DISCOUNT APPLIED | PRICE TO PAY | | --- | --- | --- | --- | --- | | €50 | Calculator percentage | 10 | €5 | €45 | | €50 | Calculator fixed | 10 | €10 | €40 | -A product catalog manager defines calculation when [creating a voucher](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html) or [Create discounts](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-in-the-back-office/create-discounts.html). +A product catalog manager defines calculation when [creating a voucher](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html) or [Create discounts](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html). ![Discount calculation](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+&+Discounts/Discount/Discount+Feature+Overview/discount_calculation.png) ## Discount exclusiveness Discount exclusiveness defines if a discount value of a discount can be combined with the discount value of other discounts in a single order. -A product catalog manager defines calculation when [creating a voucher](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html) or [Create discounts](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-in-the-back-office/create-discounts.html). +A product catalog manager defines calculation when [creating a voucher](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html) or [Create discounts](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html). ![Exclusive discount](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+&+Discounts/Discount/Discount+Feature+Overview/exclusivity.png) ### Exclusive discount @@ -181,7 +191,7 @@ An exclusive discount is a discount that, when applied to a cart, discards all t In the following example, a cart with the order total amount of €100 contains the following discounts. -| Discount name | Discount amount | Discount type | Exclusiveness | Discounted amount | +| DISCOUNT NAME | DISCOUNT AMOUNT | DISCOUNT TYPE | EXCLUSIVENESS | DISCOUNTED AMOUNT | | --- | --- | --- | --- | --- | | D1 | 15 | Calculator percentage | Exclusive | €15 | |D2|5| Calculator fixed | Exclusive | €5 | @@ -199,7 +209,7 @@ A non-exclusive discount is a discount that can be combined with other non-exclu In the following example, a cart with the order total amount of €30 contains the following discounts. -| Discount name | Discount amount | Discount type | Exclusiveness | Discounted amount | +| DISCOUNT NAME | DISCOUNT AMOUNT | DISCOUNT TYPE | EXCLUSIVENESS | DISCOUNTED AMOUNT | | --- | --- | --- | --- | --- | | D1 | 15 | Calculator percentage | Non-exclusive | €15 | | D2 | 5 | Calculator fixed | Non-exclusive | €5 | @@ -215,7 +225,7 @@ A *validity interval* is a time period during which a discount is active and can If a cart is eligible for a discount outside of its validity interval, the cart rule is not applied. If a customer enters a voucher code outside of its validity interval, they get a "Your voucher code is invalid." message. -A product catalog manager defines calculation when [creating a discount](/docs/pbc/all/discount-management/{{site.version}}/base-shop/manage-in-the-back-office/create-discounts.html). +A product catalog manager defines the calculation when [creating a discount](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html). ![Validity interval](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+&+Discounts/Discount/Discount+Feature+Overview/validity-interval.png) {% info_block warningBox "Developer guides" %} diff --git a/docs/marketplace/user/merchant-portal-user-guides/202212.0/logging-in-to-the-merchant-portal.md b/docs/marketplace/user/merchant-portal-user-guides/202212.0/logging-in-to-the-merchant-portal.md index 91fe254c49c..2413e0bd195 100644 --- a/docs/marketplace/user/merchant-portal-user-guides/202212.0/logging-in-to-the-merchant-portal.md +++ b/docs/marketplace/user/merchant-portal-user-guides/202212.0/logging-in-to-the-merchant-portal.md @@ -69,16 +69,7 @@ The **Reset Password** page opens. Your password is now updated. To log in, enter the new password in the login form. - - - -**What’s Next?** +## Next steps To have a quick overview of Merchant performance, see [Managing merchant's performance data](/docs/marketplace/user/merchant-portal-user-guides/{{page.version}}/dashboard/managing-merchants-performance-data.html). diff --git a/docs/pbc/all/back-office/202304.0/install-spryker-core-back-office-warehouse-user-management-feature.md b/docs/pbc/all/back-office/202400.0/unified-commerce/install-and-upgrade/install-the-spryker-core-back-office-warehouse-user-management-feature.md similarity index 82% rename from docs/pbc/all/back-office/202304.0/install-spryker-core-back-office-warehouse-user-management-feature.md rename to docs/pbc/all/back-office/202400.0/unified-commerce/install-and-upgrade/install-the-spryker-core-back-office-warehouse-user-management-feature.md index 02645f32cd1..e638802e5fc 100644 --- a/docs/pbc/all/back-office/202304.0/install-spryker-core-back-office-warehouse-user-management-feature.md +++ b/docs/pbc/all/back-office/202400.0/unified-commerce/install-and-upgrade/install-the-spryker-core-back-office-warehouse-user-management-feature.md @@ -4,6 +4,7 @@ description: Learn how to integrate the Spryker Core Back Office + Warehouse Use last_updated: Jan 25, 2023 template: feature-integration-guide-template redirect_from: + - /docs/pbc/all/back-office/202400.0/unified-commerce/fulfillment-app/install-the-spryker-core-back-office-warehouse-user-management-feature.html - /docs/scos/dev/feature-integration-guides/202304.0/spryker-core-back-office-warehouse-user-management-feature-integration.html --- diff --git a/docs/pbc/all/carrier-management/202212.0/base-shop/manage-via-glue-api/retrieve-shipments-in-orders.md b/docs/pbc/all/carrier-management/202212.0/base-shop/manage-via-glue-api/retrieve-shipments-in-orders.md index a9f5633d173..2496a882255 100644 --- a/docs/pbc/all/carrier-management/202212.0/base-shop/manage-via-glue-api/retrieve-shipments-in-orders.md +++ b/docs/pbc/all/carrier-management/202212.0/base-shop/manage-via-glue-api/retrieve-shipments-in-orders.md @@ -352,4 +352,4 @@ To retrieve detailed information about an order, send the following request: |002| Access token is missing. | |801| Order with the given order reference is not found. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/carrier-management/202304.0/base-shop/import-and-export-data/file-details-shipment-method-shipment-type.csv.md b/docs/pbc/all/carrier-management/202400.0/unified-commerce/import-and-export-data/file-details-shipment-method-shipment-type.csv.md similarity index 92% rename from docs/pbc/all/carrier-management/202304.0/base-shop/import-and-export-data/file-details-shipment-method-shipment-type.csv.md rename to docs/pbc/all/carrier-management/202400.0/unified-commerce/import-and-export-data/file-details-shipment-method-shipment-type.csv.md index 0f518704682..681cc7145c1 100644 --- a/docs/pbc/all/carrier-management/202304.0/base-shop/import-and-export-data/file-details-shipment-method-shipment-type.csv.md +++ b/docs/pbc/all/carrier-management/202400.0/unified-commerce/import-and-export-data/file-details-shipment-method-shipment-type.csv.md @@ -3,6 +3,8 @@ title: File details - shipment_method_shipment_type.csv description: This document describes the shipment_method_shipment_type.csv file to configure the shipment information in your Spryker Demo Shop. template: data-import-template last_updated: May 23, 2023 +redirect_from: + - /docs/pbc/all/carrier-management/202304.0/base-shop/import-and-export-data/file-details-shipment-method-shipment-type.csv.html --- This document describes the `shipment_method_shipment_type.csv` file to configure the [shipment method](/docs/pbc/all/carrier-management/base-shop/shipment-feature-overview.html) and store information in your Spryker Demo Shop. diff --git a/docs/pbc/all/carrier-management/202304.0/base-shop/import-and-export-data/file-details-shipment-type-store.csv.md b/docs/pbc/all/carrier-management/202400.0/unified-commerce/import-and-export-data/file-details-shipment-type-store.csv.md similarity index 92% rename from docs/pbc/all/carrier-management/202304.0/base-shop/import-and-export-data/file-details-shipment-type-store.csv.md rename to docs/pbc/all/carrier-management/202400.0/unified-commerce/import-and-export-data/file-details-shipment-type-store.csv.md index 6871eea732d..7b9d619b6e9 100644 --- a/docs/pbc/all/carrier-management/202304.0/base-shop/import-and-export-data/file-details-shipment-type-store.csv.md +++ b/docs/pbc/all/carrier-management/202400.0/unified-commerce/import-and-export-data/file-details-shipment-type-store.csv.md @@ -3,6 +3,8 @@ title: File details - shipment_type_store.csv description: This document describes the shipment_type_store.csv file to configure the shipment information in your Spryker Demo Shop. template: data-import-template last_updated: May 23, 2023 +redirect_From: + - /docs/pbc/all/carrier-management/202304.0/base-shop/import-and-export-data/file-details-shipment-type-store.csv.html --- This document describes the `shipment_type_store.csv` file to configure the [shipment method](/docs/pbc/all/carrier-management/base-shop/shipment-feature-overview.html) and store information in your Spryker Demo Shop. diff --git a/docs/pbc/all/carrier-management/202304.0/base-shop/import-and-export-data/file-details-shipment-type.csv.md b/docs/pbc/all/carrier-management/202400.0/unified-commerce/import-and-export-data/file-details-shipment-type.csv.md similarity index 91% rename from docs/pbc/all/carrier-management/202304.0/base-shop/import-and-export-data/file-details-shipment-type.csv.md rename to docs/pbc/all/carrier-management/202400.0/unified-commerce/import-and-export-data/file-details-shipment-type.csv.md index 995f50dd1ca..7d36eb56f27 100644 --- a/docs/pbc/all/carrier-management/202304.0/base-shop/import-and-export-data/file-details-shipment-type.csv.md +++ b/docs/pbc/all/carrier-management/202400.0/unified-commerce/import-and-export-data/file-details-shipment-type.csv.md @@ -3,6 +3,8 @@ title: File details - shipment_type.csv description: This document describes the shipment_type.csv file to configure the shipment information in your Spryker Demo Shop. template: data-import-template last_updated: May 23, 2023 +redirect_from: + - /docs/pbc/all/carrier-management/202304.0/base-shop/import-and-export-data/file-details-shipment-type.csv.html --- This document describes the `shipment_type.csv` file to configure the [shipment method](/docs/pbc/all/carrier-management/base-shop/shipment-feature-overview.html) and store information in your Spryker Demo Shop. diff --git a/docs/pbc/all/carrier-management/202304.0/base-shop/install-and-upgrade/install-the-shipment-feature.md b/docs/pbc/all/carrier-management/202400.0/unified-commerce/install-and-upgrade/install-the-shipment-feature.md similarity index 97% rename from docs/pbc/all/carrier-management/202304.0/base-shop/install-and-upgrade/install-the-shipment-feature.md rename to docs/pbc/all/carrier-management/202400.0/unified-commerce/install-and-upgrade/install-the-shipment-feature.md index 06e838c8cee..c96a00b5f03 100644 --- a/docs/pbc/all/carrier-management/202304.0/base-shop/install-and-upgrade/install-the-shipment-feature.md +++ b/docs/pbc/all/carrier-management/202400.0/unified-commerce/install-and-upgrade/install-the-shipment-feature.md @@ -1,7 +1,7 @@ --- title: Install the Shipment feature description: Use the guide to install the Shipment Back Office UI, Delivery method per store, and Shipment data import functionalities in your project. -last_updated: Apr 26, 2023 +last_updated: Jul 24, 2023 template: feature-integration-guide-template originalLink: https://documentation.spryker.com/2021080/docs/shipment-feature-integration originalArticleId: 593f9273-8a34-4a11-afdf-a21e7e74a57b diff --git a/docs/pbc/all/carrier-management/202400.0/unified-commerce/install-and-upgrade/install-the-shipment-service-points-feature.md b/docs/pbc/all/carrier-management/202400.0/unified-commerce/install-and-upgrade/install-the-shipment-service-points-feature.md new file mode 100644 index 00000000000..8cb45ecc6e2 --- /dev/null +++ b/docs/pbc/all/carrier-management/202400.0/unified-commerce/install-and-upgrade/install-the-shipment-service-points-feature.md @@ -0,0 +1,10 @@ +--- +title: Install the Shipment + Service Points feature +description: Learn how to integrate the Shipment + Service Points feature into your project +last_updated: May 30, 2023 +template: feature-integration-guide-template +redirect_from: + - /docs/scos/dev/feature-integration-guides/202304.0/install-the-shipment-service-points-feature.html +--- + +{% include pbc/all/install-features/202400.0/install-the-shipment-service-points-feature.md %} diff --git a/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/check-out/update-payment-data.md b/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/check-out/update-payment-data.md index afbc84cb154..3eafffec7fe 100644 --- a/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/check-out/update-payment-data.md +++ b/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/check-out/update-payment-data.md @@ -29,7 +29,7 @@ When [checking out purchases](/docs/pbc/all/cart-and-checkout/{{site.version}}/b It is the responsibility of the API Client to redirect the customer to the page and capture the response. For information on how to process it, see the payment service provider's API reference. -The formats of the payloads used in the request and response to the third-party page are defined by the Eco layer module that implements the interaction with the payment provider. See [3. Implement Payload Processor Plugin](/docs/pbc/all/payment-service-provider/{{site.version}}/interact-with-third-party-payment-providers-using-glue-api.html#implement-payload-processor-plugin) to learn more. +The formats of the payloads used in the request and response to the third-party page are defined by the Eco layer module that implements the interaction with the payment provider. See [3. Implement Payload Processor Plugin](/docs/pbc/all/payment-service-provider/{{site.version}}/spryker-pay/base-shop/interact-with-third-party-payment-providers-using-glue-api.html#implement-payload-processor-plugin) to learn more. **Interaction Diagram** @@ -87,7 +87,7 @@ To update payment with a payload from a third-party payment provider, send the r | ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | | --- | --- | --- | --- | -| paymentIdentifier | String | | The Unique payment ID. To get it, [place. an order](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/manage-using-glue-api/check-out/check-out-purchases.html#place-an-order). The value depends on the payment services provider plugin used to process the payment. For details, see [3. Implement Payload Processor Plugin](/docs/pbc/all/payment-service-provider/{{site.version}}/interact-with-third-party-payment-providers-using-glue-api.html#implement-payload-processor-plugin). | +| paymentIdentifier | String | | The Unique payment ID. To get it, [place. an order](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/manage-using-glue-api/check-out/check-out-purchases.html#place-an-order). The value depends on the payment services provider plugin used to process the payment. For details, see [3. Implement Payload Processor Plugin](/docs/pbc/all/payment-service-provider/{{site.version}}/spryker-pay/base-shop/interact-with-third-party-payment-providers-using-glue-api.html#implement-payload-processor-plugin). | | dataPayload | Array | v | Payload from the payment service provider. The attributes of the payload depend on the selected payment service provider. | diff --git a/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/manage-carts-of-registered-users.md b/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/manage-carts-of-registered-users.md index 47869272768..a9901744233 100644 --- a/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/manage-carts-of-registered-users.md +++ b/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/manage-carts-of-registered-users.md @@ -3076,4 +3076,4 @@ If the cart is deleted successfully, the endpoint returns the `204 No Content` s | 118 | Price mode is missing. | | 119 | Price mode is incorrect. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/manage-items-in-carts-of-registered-users.md b/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/manage-items-in-carts-of-registered-users.md index a7bd6b84cc9..dd0ac6c3a58 100644 --- a/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/manage-items-in-carts-of-registered-users.md +++ b/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/manage-items-in-carts-of-registered-users.md @@ -3245,4 +3245,4 @@ If the item is deleted successfully, the endpoint returns the “204 No Content | 4006 | The configured bundle cannot be updated. | | 4007 | The configured bundle cannot be removed. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/manage-guest-carts/manage-guest-cart-items.md b/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/manage-guest-carts/manage-guest-cart-items.md index f53ecb244e3..2d93da16c23 100644 --- a/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/manage-guest-carts/manage-guest-cart-items.md +++ b/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/manage-guest-carts/manage-guest-cart-items.md @@ -3314,4 +3314,4 @@ If the item is deleted successfully, the endpoint returns the “204 No Content | 4006 | The configured bundle cannot be updated. | | 4007 | The configured bundle cannot be removed. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/manage-guest-carts/manage-guest-carts.md b/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/manage-guest-carts/manage-guest-carts.md index 7102092ac97..bda6f8a4091 100644 --- a/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/manage-guest-carts/manage-guest-carts.md +++ b/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/manage-guest-carts/manage-guest-carts.md @@ -1193,4 +1193,4 @@ In a **single cart** environment, items from the guest cart have been added to | 118 | Price mode is missing. | | 119 | Price mode is incorrect. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/retrieve-customer-carts.md b/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/retrieve-customer-carts.md index 237aa0777de..d27b92360e5 100644 --- a/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/retrieve-customer-carts.md +++ b/docs/pbc/all/cart-and-checkout/202204.0/base-shop/manage-using-glue-api/retrieve-customer-carts.md @@ -1625,4 +1625,4 @@ For the attributes of the included resources, see: | 402 | Customer with the specified ID was not found. | | 802 | Request is unauthorized. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/cart-and-checkout/202212.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkoutrestapi-module.md b/docs/pbc/all/cart-and-checkout/202212.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkoutrestapi-module.md index 93de8bb84a4..fa6dcc91660 100644 --- a/docs/pbc/all/cart-and-checkout/202212.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkoutrestapi-module.md +++ b/docs/pbc/all/cart-and-checkout/202212.0/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-checkoutrestapi-module.md @@ -23,7 +23,7 @@ redirect_from: - /docs/pbc/all/cart-and-checkout/202212.0/install-and-upgrade/upgrade-modules/upgrade-the-checkoutrestapi-module.html related: - title: Migration guide - Payment - link: docs/pbc/all/payment-service-provider/page.version/install-and-upgrade/upgrade-the-payment-module.html + link: docs/pbc/all/payment-service-provider/page.version/spryker-pay/base-shop/install-and-upgrade/upgrade-the-payment-module.html --- {% include pbc/all/upgrade-modules/upgrade-glue-api-modules/upgrade-the-checkoutrestapi-module.md %} diff --git a/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/check-out/update-payment-data.md b/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/check-out/update-payment-data.md index d502ed6e79c..7e21ed6ca0f 100644 --- a/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/check-out/update-payment-data.md +++ b/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/check-out/update-payment-data.md @@ -29,7 +29,7 @@ When [checking out purchases](/docs/pbc/all/cart-and-checkout/{{site.version}}/b It is the responsibility of the API Client to redirect the customer to the page and capture the response. For information on how to process it, see the payment service provider's API reference. -The formats of the payloads used in the request and response to the third-party page are defined by the Eco layer module that implements the interaction with the payment provider. See [3. Implement Payload Processor Plugin](/docs/pbc/all/payment-service-provider/{{page.version}}/interact-with-third-party-payment-providers-using-glue-api.html#implement-payload-processor-plugin) to learn more. +The formats of the payloads used in the request and response to the third-party page are defined by the Eco layer module that implements the interaction with the payment provider. See [3. Implement Payload Processor Plugin](/docs/pbc/all/payment-service-provider/{{page.version}}/spryker-pay/base-shop/interact-with-third-party-payment-providers-using-glue-api.html#implement-payload-processor-plugin) to learn more. **Interaction Diagram** @@ -87,7 +87,7 @@ To update payment with a payload from a third-party payment provider, send the r | ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | | --- | --- | --- | --- | -| paymentIdentifier | String | | The Unique payment ID. To get it, [place. an order](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/manage-using-glue-api/check-out/check-out-purchases.html#place-an-order). The value depends on the payment services provider plugin used to process the payment. For details, see [3. Implement Payload Processor Plugin](/docs/pbc/all/payment-service-provider/{{page.version}}/interact-with-third-party-payment-providers-using-glue-api.html#implement-payload-processor-plugin). | +| paymentIdentifier | String | | The Unique payment ID. To get it, [place. an order](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/manage-using-glue-api/check-out/check-out-purchases.html#place-an-order). The value depends on the payment services provider plugin used to process the payment. For details, see [3. Implement Payload Processor Plugin](/docs/pbc/all/payment-service-provider/{{page.version}}/spryker-pay/base-shop/interact-with-third-party-payment-providers-using-glue-api.html#implement-payload-processor-plugin). | | dataPayload | Array | v | Payload from the payment service provider. The attributes of the payload depend on the selected payment service provider. | diff --git a/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/manage-carts-of-registered-users.md b/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/manage-carts-of-registered-users.md index a3a4a7d08df..4c756330ffb 100644 --- a/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/manage-carts-of-registered-users.md +++ b/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/manage-carts-of-registered-users.md @@ -3077,4 +3077,4 @@ If the cart is deleted successfully, the endpoint returns the `204 No Content` s | 118 | Price mode is missing. | | 119 | Price mode is incorrect. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/manage-items-in-carts-of-registered-users.md b/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/manage-items-in-carts-of-registered-users.md index 0b2936366b3..7542649b43d 100644 --- a/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/manage-items-in-carts-of-registered-users.md +++ b/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-carts-of-registered-users/manage-items-in-carts-of-registered-users.md @@ -3245,4 +3245,4 @@ If the item is deleted successfully, the endpoint returns the “204 No Content | 4006 | The configured bundle cannot be updated. | | 4007 | The configured bundle cannot be removed. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-guest-carts/manage-guest-cart-items.md b/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-guest-carts/manage-guest-cart-items.md index 1d87eeb6a16..2192d353f6c 100644 --- a/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-guest-carts/manage-guest-cart-items.md +++ b/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-guest-carts/manage-guest-cart-items.md @@ -3314,4 +3314,4 @@ If the item is deleted successfully, the endpoint returns the “204 No Content | 4006 | The configured bundle cannot be updated. | | 4007 | The configured bundle cannot be removed. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-guest-carts/manage-guest-carts.md b/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-guest-carts/manage-guest-carts.md index 550cf8baeff..cf7949ba9ba 100644 --- a/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-guest-carts/manage-guest-carts.md +++ b/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/manage-guest-carts/manage-guest-carts.md @@ -1210,4 +1210,4 @@ In a *single cart* environment, items from the guest cart have been added to t | 118 | Price mode is missing. | | 119 | Price mode is incorrect. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/retrieve-customer-carts.md b/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/retrieve-customer-carts.md index 44e2d12cd11..68a25badad1 100644 --- a/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/retrieve-customer-carts.md +++ b/docs/pbc/all/cart-and-checkout/202212.0/base-shop/manage-using-glue-api/retrieve-customer-carts.md @@ -1625,4 +1625,4 @@ For the attributes of the included resources, see: | 402 | Customer with the specified ID was not found. | | 802 | Request is unauthorized. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/cart-and-checkout/202212.0/marketplace/install/install-features/install-the-cart-marketplace-product-feature.md b/docs/pbc/all/cart-and-checkout/202212.0/marketplace/install/install-features/install-the-cart-marketplace-product-feature.md new file mode 100644 index 00000000000..78b3cb29233 --- /dev/null +++ b/docs/pbc/all/cart-and-checkout/202212.0/marketplace/install/install-features/install-the-cart-marketplace-product-feature.md @@ -0,0 +1,8 @@ +--- +title: Install the Cart + Marketplace Product feature +last_updated: Dec 16, 2020 +description: This document describes the process how to integrate the Cart + Marketplace Product feature into a Spryker project. +template: feature-integration-guide-template +--- + +{% include pbc/all/install-features/202212.0/marketplace/install-the-marketplace-product-cart-feature.md %} diff --git a/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.md b/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.md index ffd0ddf8683..23a7edf9cb5 100644 --- a/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.md +++ b/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-carts-of-registered-users.md @@ -4494,4 +4494,4 @@ If the cart is deleted successfully, the endpoint returns the `204 No Content` s | 118 | Price mode is missing. | | 119 | Price mode is incorrect. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.md b/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.md index 0b9b132ac34..f4b4bdd9814 100644 --- a/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.md +++ b/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/carts-of-registered-users/manage-items-in-carts-of-registered-users.md @@ -1822,4 +1822,4 @@ If the item is deleted successfully, the endpoint returns the `204 No Content` | 118 | Price mode is missing. | | 119 | Price mode is incorrect. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-cart-items.md b/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-cart-items.md index a543ce443b6..f5c2b7f81ed 100644 --- a/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-cart-items.md +++ b/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-cart-items.md @@ -1859,4 +1859,4 @@ If the item is deleted successfully, the endpoint returns the "204 No Content" | 118 | Price mode is missing. | | 119 | Price mode is incorrect. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.md b/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.md index 396fd231f6a..4f83725bcc8 100644 --- a/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.md +++ b/docs/pbc/all/cart-and-checkout/202212.0/marketplace/manage-using-glue-api/guest-carts/manage-guest-carts.md @@ -2135,4 +2135,4 @@ In a *single cart* environment, items from the guest cart have been added to t | 118 | Price mode is missing. | | 119 | Price mode is incorrect. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/content-management-system/202212.0/base-shop/import-and-export-data/import-content-management-system-data.md b/docs/pbc/all/content-management-system/202212.0/base-shop/import-and-export-data/import-content-management-system-data.md index 2e74d7e4c0e..a2d268b8a6d 100644 --- a/docs/pbc/all/content-management-system/202212.0/base-shop/import-and-export-data/import-content-management-system-data.md +++ b/docs/pbc/all/content-management-system/202212.0/base-shop/import-and-export-data/import-content-management-system-data.md @@ -15,7 +15,7 @@ redirect_from: - /docs/pbc/all/content-management-system/202212.0/import-and-export-data/import-content-management-system-data.html --- -To learn how data import works and about different ways of importing data, see [Data import](/docs/scos/dev/data-import/{{page.version}}/data-import.html). This section describes the data import files that are used to import data related to the Cart and Checkout PBC. +To learn how data import works and about different ways of importing data, see [Data import](/docs/scos/dev/data-import/{{page.version}}/data-import.html). This section describes the data import files that are used to import data related to the Content Management System PBC. The CMS data import category contains data required to create and manage content elements like CMS pages or blocks. diff --git a/docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-abstract-product-list-content-items.md b/docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-abstract-product-list-content-items.md index dd162875496..b3a21eb9bbf 100644 --- a/docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-abstract-product-list-content-items.md +++ b/docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-abstract-product-list-content-items.md @@ -366,4 +366,4 @@ Request sample: retrieve Abstract Product List with its abstract products | 2202 | Content key is missing. | | 2203 | Content type is invalid. | -For generic Glue Application errors that can also occur, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +For generic Glue Application errors that can also occur, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-banner-content-items.md b/docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-banner-content-items.md index e9741e6d3f1..38e69ff98e0 100644 --- a/docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-banner-content-items.md +++ b/docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-banner-content-items.md @@ -89,4 +89,4 @@ Response sample: retrieve a banner content item | 2202 | Content key is missing. | | 2203 | Content type is invalid. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-navigation-trees.md b/docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-navigation-trees.md index 7061e8f446d..5c26b55d5a6 100644 --- a/docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-navigation-trees.md +++ b/docs/pbc/all/content-management-system/202212.0/base-shop/manage-using-glue-api/retrieve-navigation-trees.md @@ -1134,4 +1134,4 @@ If a navigation tree has a category child node, include the `category-nodes` res | 1601 | Navigation is not found. | | 1602 | Navigation ID is not specified. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/customer-relationship-management/202212.0/customer-account-management-feature-overview/password-management-overview.md b/docs/pbc/all/customer-relationship-management/202212.0/customer-account-management-feature-overview/password-management-overview.md index fa272514bee..d2fdf71ef1b 100644 --- a/docs/pbc/all/customer-relationship-management/202212.0/customer-account-management-feature-overview/password-management-overview.md +++ b/docs/pbc/all/customer-relationship-management/202212.0/customer-account-management-feature-overview/password-management-overview.md @@ -20,7 +20,7 @@ When you create a customer account in the Back Office, you do not enter the pass You can create customer accounts by [importing](/docs/scos/dev/data-import/{{page.version}}/importing-data-with-a-configuration-file.html#console-commands-to-run-import) a [`customerCSV file`](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/commerce-setup/file-details-customer.csv.html). In this case, you can specify the passwords of the customer accounts to import, but it’s not mandatory. If you do not specify the passwords, you can send password reset emails to the customers without passwords by running `console customer:password:set`. Also, you can send password reset emails to all customers by running console `customer:password:reset`. To learn how a developer can import customer data, see [Importing Data with a Configuration File](/docs/scos/dev/data-import/{{page.version}}/importing-data-with-a-configuration-file.html). -With the help of [Glue API](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-rest-api.html), you can change and reset customer account passwords. This can be useful when you want to use a single authentication in all the apps connected to your shop. To learn how a developer can do it, see [Change a customer’s password](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-manage-customer-passwords.html#change-a-customers-password) and [Reset a customer’s password](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-manage-customer-passwords.html#reset-a-customers-password). +With the help of [Glue API](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/glue-rest-api.html), you can change and reset customer account passwords. This can be useful when you want to use a single authentication in all the apps connected to your shop. To learn how a developer can do it, see [Change a customer’s password](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-manage-customer-passwords.html#change-a-customers-password) and [Reset a customer’s password](/docs/pbc/all/identity-access-management/{{page.version}}/manage-using-glue-api/glue-api-manage-customer-passwords.html#reset-a-customers-password). On the Storefront, it is mandatory to enter a password when creating a customer account. After the account is created, you can update the password in the customer account or request a password reset using email. diff --git a/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/company-account/glue-api-retrieve-business-unit-addresses.md b/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/company-account/glue-api-retrieve-business-unit-addresses.md index 75addfe858a..f876d7a9bd1 100644 --- a/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/company-account/glue-api-retrieve-business-unit-addresses.md +++ b/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/company-account/glue-api-retrieve-business-unit-addresses.md @@ -114,7 +114,7 @@ If your current company account is not set, you may get the `404` status code. {% endinfo_block %} -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). ## Next steps diff --git a/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/company-account/glue-api-retrieve-business-units.md b/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/company-account/glue-api-retrieve-business-units.md index b4b6b551063..2392073409a 100644 --- a/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/company-account/glue-api-retrieve-business-units.md +++ b/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/company-account/glue-api-retrieve-business-units.md @@ -247,7 +247,7 @@ To retrieve a business unit, send the request: | 1903 | Current company account is not set. Select the current company user with `/company-user-access-tokens` to access the resource collection. | | 1901 | Specified business unit is not found or the user does not have access to it. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). ## Next steps diff --git a/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/company-account/glue-api-retrieve-companies.md b/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/company-account/glue-api-retrieve-companies.md index 4d15b5d723d..ce8d5dce629 100644 --- a/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/company-account/glue-api-retrieve-companies.md +++ b/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/company-account/glue-api-retrieve-companies.md @@ -110,7 +110,7 @@ To retrieve information about a company, send the request: | 1801 | Specified company is not found, or the current authenticated company user does not have access to it. | | 1803 | Current company account is not set. Select the current company user with `/company-user-access-tokens` to access the resource collection. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). ## Next steps diff --git a/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/company-account/glue-api-retrieve-company-roles.md b/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/company-account/glue-api-retrieve-company-roles.md index 9258c2a2401..2e48a79d9bc 100644 --- a/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/company-account/glue-api-retrieve-company-roles.md +++ b/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/company-account/glue-api-retrieve-company-roles.md @@ -176,7 +176,7 @@ To retrieve a company role, send the request: | 2101 | Company role is not found. | | 2103 | Current company user is not set. Select the current company user with `/company-user-access-tokens` to access the resource collection. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). ## Next steps diff --git a/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/company-account/glue-api-retrieve-company-users.md b/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/company-account/glue-api-retrieve-company-users.md index ce337b9b301..9dc479c182a 100644 --- a/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/company-account/glue-api-retrieve-company-users.md +++ b/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/company-account/glue-api-retrieve-company-users.md @@ -370,7 +370,7 @@ To retrieve information about a company user, send the request: | 1403 | Current company account is not set. Select the current company user with `/company-user-access-tokens` to access the resource collection. | | 1404 | Specified company user is not found or does not have permissions to view the account. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). ## Next steps diff --git a/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/company-account/glue-api-search-by-company-users.md b/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/company-account/glue-api-search-by-company-users.md index ec48bfc1ee7..2d1c1352713 100644 --- a/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/company-account/glue-api-search-by-company-users.md +++ b/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/company-account/glue-api-search-by-company-users.md @@ -314,7 +314,7 @@ To retrieve company users of the current authenticated customer, send the reques | 001 | The access token is invalid. | | 002 | The access token is missing. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). ## Next steps diff --git a/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/customers/glue-api-manage-customer-addresses.md b/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/customers/glue-api-manage-customer-addresses.md index bb4e4408593..7cb96278798 100644 --- a/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/customers/glue-api-manage-customer-addresses.md +++ b/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/customers/glue-api-manage-customer-addresses.md @@ -427,7 +427,7 @@ If the address is deleted successfully, the endpoint returns the `204 No Content | 412 | No address ID provided. | | 901 | One of the following fields is not specified: `salutaion`, `firstName`, `lastName`, `city`, `address1`, `address2`, `zipCode`, `country`, `iso2Code`, `isDefaultShipping`, `isDefaultBilling` | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). ## Next steps diff --git a/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/customers/glue-api-manage-customers.md b/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/customers/glue-api-manage-customers.md index ef7eefd2203..7a40193835d 100644 --- a/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/customers/glue-api-manage-customers.md +++ b/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/customers/glue-api-manage-customers.md @@ -342,7 +342,7 @@ There is an alternative way to retrieve existing subscriptions, for details see | 4606 | Request is unauthorized.| -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). ## Next steps diff --git a/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.md b/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.md index 6d2dbe88388..27d290f0278 100644 --- a/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.md +++ b/docs/pbc/all/customer-relationship-management/202212.0/manage-using-glue-api/customers/glue-api-retrieve-customer-orders.md @@ -136,4 +136,4 @@ Alternatively, you can retrieve all orders made by a customer through the **/ord | 402 | Customer with the specified ID was not found. | | 802 | Request is unauthorized. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-carts-of-registered-users.md b/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-carts-of-registered-users.md index 09168e88235..bfe2b6b9a36 100644 --- a/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-carts-of-registered-users.md +++ b/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-carts-of-registered-users.md @@ -719,4 +719,4 @@ For the attributes of the other included resources, see the docs: | 118 | Price mode is missing. | | 119 | Price mode is incorrect. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-guest-carts.md b/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-guest-carts.md index a084c3f0015..472e8231e60 100644 --- a/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-guest-carts.md +++ b/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-guest-carts.md @@ -702,4 +702,4 @@ For the attributes of guest carts, see [Retrieve discounts in guest cart](/docs/ | 119 | Price mode is incorrect. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-carts-of-registered-users.md b/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-carts-of-registered-users.md index e4a4041235b..8f5796ba32f 100644 --- a/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-carts-of-registered-users.md +++ b/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-carts-of-registered-users.md @@ -236,4 +236,4 @@ If the voucher is deleted successfully, the endpoints returns the `204 No Data` | 3302 | Incorrect voucher code or the voucher cannot be applied. | | 3303 | Cart code can't be removed. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-guest-carts.md b/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-guest-carts.md index e83506662fc..75529395755 100644 --- a/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-guest-carts.md +++ b/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-guest-carts.md @@ -250,4 +250,4 @@ If the voucher is deleted successfully, the endpoints returns the `204 No Data` | 3302 | Incorrect voucher code or the voucher cannot be applied.| | 3303| Cart code can't be removed. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/retrieve-discounts-in-carts-of-registered-users.md b/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/retrieve-discounts-in-carts-of-registered-users.md index 5fb8176fecd..b543288dc41 100644 --- a/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/retrieve-discounts-in-carts-of-registered-users.md +++ b/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/retrieve-discounts-in-carts-of-registered-users.md @@ -604,4 +604,4 @@ For the attributes of carts of registered users and included resources, see [Ret | 115 | Unauthorized cart action. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/retrieve-discounts-in-customer-carts.md b/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/retrieve-discounts-in-customer-carts.md index 653190cfda5..72cd939b936 100644 --- a/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/retrieve-discounts-in-customer-carts.md +++ b/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/retrieve-discounts-in-customer-carts.md @@ -346,4 +346,4 @@ Alternatively, you can retrieve all carts belonging to a customer through the ** | 402 | Customer with the specified ID was not found. | | 802 | Request is unauthorized. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/retrieve-discounts-in-guest-carts.md b/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/retrieve-discounts-in-guest-carts.md index eda41fba818..35669591c46 100644 --- a/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/retrieve-discounts-in-guest-carts.md +++ b/docs/pbc/all/discount-management/202204.0/base-shop/manage-via-glue-api/retrieve-discounts-in-guest-carts.md @@ -228,4 +228,4 @@ When retrieving the cart with `guestCartId`, the response includes a single obje | 104 | Cart uuid is missing. | | 109 | Anonymous customer unique ID is empty. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-carts-of-registered-users.md b/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-carts-of-registered-users.md index c812f99be83..cb0446d3c40 100644 --- a/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-carts-of-registered-users.md +++ b/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-carts-of-registered-users.md @@ -721,4 +721,4 @@ For the attributes of the other included resources, see the docs: | 118 | Price mode is missing. | | 119 | Price mode is incorrect. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-guest-carts.md b/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-guest-carts.md index a86f966783b..400a25245ac 100644 --- a/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-guest-carts.md +++ b/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/add-items-with-discounts-to-guest-carts.md @@ -706,4 +706,4 @@ For the attributes of guest carts, see [Retrieve discounts in guest cart](/docs/ | 119 | Price mode is incorrect. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-carts-of-registered-users.md b/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-carts-of-registered-users.md index 6597db2df4d..8624a67d631 100644 --- a/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-carts-of-registered-users.md +++ b/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-carts-of-registered-users.md @@ -237,4 +237,4 @@ If the voucher is deleted successfully, the endpoints returns the `204 No Data` | 3302 | Incorrect voucher code or the voucher cannot be applied. | | 3303 | Cart code can't be removed. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-guest-carts.md b/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-guest-carts.md index 43581abf2b5..7fbd7ead8bd 100644 --- a/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-guest-carts.md +++ b/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/manage-discount-vouchers-in-guest-carts.md @@ -249,4 +249,4 @@ If the voucher is deleted successfully, the endpoints returns the `204 No Data` | 3302 | Incorrect voucher code or the voucher cannot be applied.| | 3303| Cart code can't be removed. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/retrieve-discounts-in-carts-of-registered-users.md b/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/retrieve-discounts-in-carts-of-registered-users.md index 3c893be420e..25a9329e622 100644 --- a/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/retrieve-discounts-in-carts-of-registered-users.md +++ b/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/retrieve-discounts-in-carts-of-registered-users.md @@ -606,4 +606,4 @@ For the attributes of carts of registered users and included resources, see [Ret | 115 | Unauthorized cart action. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/retrieve-discounts-in-customer-carts.md b/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/retrieve-discounts-in-customer-carts.md index 6ad0ff9a491..9ab3b74eca6 100644 --- a/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/retrieve-discounts-in-customer-carts.md +++ b/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/retrieve-discounts-in-customer-carts.md @@ -348,4 +348,4 @@ Alternatively, you can retrieve all carts belonging to a customer through the ** | 402 | Customer with the specified ID was not found. | | 802 | Request is unauthorized. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/retrieve-discounts-in-guest-carts.md b/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/retrieve-discounts-in-guest-carts.md index 36d4792494c..659acdb1077 100644 --- a/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/retrieve-discounts-in-guest-carts.md +++ b/docs/pbc/all/discount-management/202212.0/base-shop/manage-via-glue-api/retrieve-discounts-in-guest-carts.md @@ -229,4 +229,4 @@ When retrieving the cart with `guestCartId`, the response includes a single obje | 104 | Cart uuid is missing. | | 109 | Anonymous customer unique ID is empty. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/discount-management/202212.0/marketplace/marketplace-promotions-discounts-feature-overview.md b/docs/pbc/all/discount-management/202212.0/marketplace/marketplace-promotions-discounts-feature-overview.md index 97432c712f2..10f23ef73c7 100644 --- a/docs/pbc/all/discount-management/202212.0/marketplace/marketplace-promotions-discounts-feature-overview.md +++ b/docs/pbc/all/discount-management/202212.0/marketplace/marketplace-promotions-discounts-feature-overview.md @@ -2,6 +2,7 @@ title: Marketplace Promotions & Discounts feature overview description: This document contains concept information for the Marketplace Promotions and Discounts feature. template: concept-topic-template +last_updated: Jul 17, 2023 redirect_from: - /docs/marketplace/user/features/202212.0/marketplace-promotions-and-discounts-feature-overview.html - /docs/marketplace/dev/feature-walkthroughs/202212.0/marketplace-promotions-and-discounts-feature-walkthrough.html @@ -39,6 +40,7 @@ Based on the business logic, discounts can be applied in the following ways: ## Voucher A *Voucher* is a discount that applies when a customer enters an active voucher code on the *Cart* page. + ![Cart voucher](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Features/Marketplace+Promotions+and+Discounts+feature+overview/voucher-storefront.png) Once the customer clicks **Redeem code**, the page refreshes to show the discount name, discount value, and available actions: **Remove** and **Clear all**. The **Clear all** action disables all the applied discounts. The **Remove** action disables a single discount. @@ -47,14 +49,14 @@ Once the customer clicks **Redeem code**, the page refreshes to show the discoun Multiple voucher codes can be generated for a single voucher. The code has a **Max number of uses** value which defines how many times the code can be redeemed. You can enter codes manually or use the code generator in the Back Office. + ![Generate codes](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+&+Discounts/Discount/Discount+Feature+Overview/generate_codes.png) To learn how a product catalog manager can create a voucher in the Back Office, see [Creating a voucher](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html). ## Cart Rule -A *cart rule* is a discount that applies to cart once all the [decision rules](#decision-rule) linked to the cart rule are fulfilled. - +A *cart rule* is a discount that applies to the cart once all the [decision rules](#decision-rule) linked to the cart rule are fulfilled. The cart rule is applied automatically. If the decision rules of a discount are fulfilled, the customer can see the discount upon entering the cart. Unlike with [vouchers](#voucher), the **Clear all** and **Remove** actions are not displayed. ![Cart rule](https://spryker.s3.eu-central-1.amazonaws.com/docs/Marketplace/user+guides/Features/Marketplace+Promotions+and+Discounts+feature+overview/cart-rule-storefront.png) @@ -66,7 +68,7 @@ A decision rule is a condition assigned to a discount that should be fulfilled f A discount can have one or more decision rules. Find an exemplary combination below: -| Parameter | RELATION OPERATOR | Value | +| PARAMETER | RELATION OPERATOR | VALUE | | --- | --- | --- | | total-quantity | equal | 3 | | day-of-week| equal | 5 | @@ -101,9 +103,11 @@ Decision rules are combined with *AND* and *OR* combination operators. With the In the following example, for the discount to be applied, a cart should contain three items, and the purchase should be made on Wednesday. + ![AND operator](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+&+Discounts/Discount/Discount+Feature+Overview/and-operator.png) In the following example, for the discount to be applied, a cart should contain three items, or the purchase should be made on Wednesday. + ![OR operator](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+&+Discounts/Discount/Discount+Feature+Overview/or-operator.png) {% info_block infoBox "Info" %} @@ -119,15 +123,15 @@ A rule group is a separate set of rules with its own combination operator. ![Decision rule group](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+%26+Discounts/Discount/Discount+Feature+Overview/decision-rule-group.png) -With the rule groups, you can build multiple levels of rule hierarchy. When a cart is evaluated against the rules, it is evaluated on all the levels of the hierarchy. On each level, there can be both rules and rule groups. +With the rule groups, you can build multiple levels of rule hierarchy. When a cart is evaluated against the rules, it is evaluated on all levels of the hierarchy. On each level, there can be both rules and rule groups. ![Decision rule hierarchy](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+%26+Discounts/Discount/Discount+Feature+Overview/decision-rule-hierarchy.png) -When a cart is evaluated on a level that has a rule and a rule group, the rule group is treated as a single rule. The following diagram shows how a cart is evaluated against the rules on the previous screenshot. +When a cart is evaluated on a level that has a rule and a rule group, the rule group is treated as a single rule. The following diagram shows how a cart is evaluated against the rules in the previous screenshot. ### Discount threshold A *threshold* is a minimum number of items in the cart that should fulfill all the specified decision rules for the discount to be applied. -The default value is *1* . It means that a discount is applied if at least one item fulfills the discount's decision rules. +The default value is *1*. It means that a discount is applied if at least one item fulfills the discount's decision rules. In the following example, the discount is applied if there are four items with the Intel Core processor in the cart. ![Threshold](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+&+Discounts/Discount/Discount+Feature+Overview/threshold.png) @@ -142,12 +146,13 @@ The Marketplace discounts are applied based on the query string. The *query string* is a discount application type that uses [decision rules](#decision-rule) to dynamically define what products a discount applies to. The discount in the following example applies to white products. + ![Query collection](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+&+Discounts/Discount/Discount+Feature+Overview/collection-query.png) + The product selection based on the query string is dynamic: * If at some point, the color attribute of a product changes from white to anything else, the product is no longer eligible to be discounted. * If at some point, a product receives the white color attribute, it becomes eligible for the discount. - ## Discount calculation Calculation defines the value to be deducted from a product's original price. There are two types of discount calculation: @@ -163,7 +168,8 @@ With the calculator fixed type, the currency of the respective shop is used for See examples in the following table. -| Product price | Calculation type | Amount | Discount applied | Price to pay | + +| PRODUCT PRICE | CALCULATION TYPE | AMOUNT | DISCOUNT APPLIED | PRICE TO PAY | | --- | --- | --- | --- | --- | | €50 | Calculator percentage | 10 | €5 | €45 | | €50 | Calculator fixed | 10 | €10 | €40 | @@ -184,7 +190,7 @@ An exclusive discount is a discount that, when applied to a cart, discards all t In the following example, a cart with the order total amount of €100 contains the following discounts. -| Discount name | Discount amount | Discount type | Exclusiveness | Discounted amount | +| DISCOUNT NAME | DISCOUNT AMOUNT | DISCOUNT TYPE | EXCLUSIVENESS | DISCOUNTED AMOUNT | | --- | --- | --- | --- | --- | | D1 | 15 | Calculator percentage | Exclusive | €15 | |D2|5| Calculator fixed | Exclusive | €5 | @@ -202,7 +208,7 @@ A non-exclusive discount is a discount that can be combined with other non-exclu In the following example, a cart with the order total amount of €30 contains the following discounts. -| Discount name | Discount amount | Discount type | Exclusiveness | Discounted amount | +| DISCOUNT NAME | DISCOUNT AMOUNT | DISCOUNT TYPE | EXCLUSIVENESS | DISCOUNTED AMOUNT | | --- | --- | --- | --- | --- | | D1 | 15 | Calculator percentage | Non-exclusive | €15 | | D2 | 5 | Calculator fixed | Non-exclusive | €5 | @@ -214,11 +220,9 @@ As all the discounts are non-exclusive, they are applied together. A *validity interval* is a time period during which a discount is active and can be applied. - If a cart is eligible for a discount outside of its validity interval, the cart rule is not applied. If a customer enters a voucher code outside of its validity interval, they get a "Your voucher code is invalid." message. - -A product catalog manager defines calculation when [creating a discount](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html). +A product catalog manager defines the calculation when [creating a discount](/docs/pbc/all/discount-management/{{page.version}}/base-shop/manage-in-the-back-office/create-discounts.html). ![Validity interval](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Promotions+&+Discounts/Discount/Discount+Feature+Overview/validity-interval.png) ## Related Developer articles diff --git a/docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/manage-gift-cards-of-guest-users.md b/docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/manage-gift-cards-of-guest-users.md index dbfe4d1f6e5..34c31c46283 100644 --- a/docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/manage-gift-cards-of-guest-users.md +++ b/docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/manage-gift-cards-of-guest-users.md @@ -197,4 +197,4 @@ If the item is deleted successfully, the endpoint will respond with a `204 No C | 3302| Cart code can't be added. | | 3303| Cart code can't be removed. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/manage-gift-cards-of-registered-users.md b/docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/manage-gift-cards-of-registered-users.md index 02b50c998de..69f183508bc 100644 --- a/docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/manage-gift-cards-of-registered-users.md +++ b/docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/manage-gift-cards-of-registered-users.md @@ -206,4 +206,4 @@ If the item is deleted successfully, the endpoint will respond with a `204 No Co | 3302 | Incorrect voucher code or the voucher cannot be applied. | | 3303| Cart code can't be removed. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/retrieve-gift-cards-in-carts-of-registered-users.md b/docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/retrieve-gift-cards-in-carts-of-registered-users.md index 16792d7cfb4..0e24fa192db 100644 --- a/docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/retrieve-gift-cards-in-carts-of-registered-users.md +++ b/docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/retrieve-gift-cards-in-carts-of-registered-users.md @@ -235,4 +235,4 @@ For the attributes of the gift cards included resource, see [Manage gift cards o | 115 | Unauthorized cart action. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/retrieve-gift-cards-in-guest-carts.md b/docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/retrieve-gift-cards-in-guest-carts.md index 0de759fe5ee..86d295e0aa5 100644 --- a/docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/retrieve-gift-cards-in-guest-carts.md +++ b/docs/pbc/all/gift-cards/202204.0/manage-using-glue-api/retrieve-gift-cards-in-guest-carts.md @@ -146,4 +146,4 @@ For the attributes of guest cart items, see [Managing gift cards of guest users] | 104 | Cart uuid is missing. | | 109 | Anonymous customer unique id is empty. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/manage-gift-cards-of-guest-users.md b/docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/manage-gift-cards-of-guest-users.md index 419528996f1..50a216ba6a7 100644 --- a/docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/manage-gift-cards-of-guest-users.md +++ b/docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/manage-gift-cards-of-guest-users.md @@ -197,4 +197,4 @@ If the item is deleted successfully, the endpoint will respond with a `204 No C | 3302| Cart code can't be added. | | 3303| Cart code can't be removed. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/manage-gift-cards-of-registered-users.md b/docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/manage-gift-cards-of-registered-users.md index e93e07891c2..71a5fd3f6cc 100644 --- a/docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/manage-gift-cards-of-registered-users.md +++ b/docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/manage-gift-cards-of-registered-users.md @@ -206,4 +206,4 @@ If the item is deleted successfully, the endpoint will respond with a `204 No Co | 3302 | Incorrect voucher code or the voucher cannot be applied. | | 3303| Cart code can't be removed. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/retrieve-gift-cards-in-carts-of-registered-users.md b/docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/retrieve-gift-cards-in-carts-of-registered-users.md index e489e6365fd..6d0722f3f10 100644 --- a/docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/retrieve-gift-cards-in-carts-of-registered-users.md +++ b/docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/retrieve-gift-cards-in-carts-of-registered-users.md @@ -235,4 +235,4 @@ For the attributes of the gift cards included resource, see [Manage gift cards o | 115 | Unauthorized cart action. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/retrieve-gift-cards-in-guest-carts.md b/docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/retrieve-gift-cards-in-guest-carts.md index aeab6ccabdc..4d085ff95ac 100644 --- a/docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/retrieve-gift-cards-in-guest-carts.md +++ b/docs/pbc/all/gift-cards/202212.0/manage-using-glue-api/retrieve-gift-cards-in-guest-carts.md @@ -146,4 +146,4 @@ For the attributes of guest cart items, see [Managing gift cards of guest users] | 104 | Cart uuid is missing. | | 109 | Anonymous customer unique id is empty. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/identity-access-management/202212.0/glue-api-security-and-authentication.md b/docs/pbc/all/identity-access-management/202212.0/glue-api-security-and-authentication.md index 5bcfafdd9f9..a67b94a8fff 100644 --- a/docs/pbc/all/identity-access-management/202212.0/glue-api-security-and-authentication.md +++ b/docs/pbc/all/identity-access-management/202212.0/glue-api-security-and-authentication.md @@ -21,7 +21,7 @@ related: - title: Authentication and Authorization link: docs/pbc/all/identity-access-management/page.version/glue-api-authentication-and-authorization.html - title: Glue Infrastructure - link: docs/scos/dev/glue-api-guides/page.version/glue-infrastructure.html + link: docs/scos/dev/glue-api-guides/page.version/old-glue-infrastructure/glue-infrastructure.html --- When exposing information via Spryker Glue API and integrating with third-party applications, it is essential to protect API endpoints from unauthorized access. For this purpose, Spryker provides an authorization mechanism, using which you can request users to authenticate themselves before accessing a resource. For this purpose, Spryker Glue is shipped with an implementation of the OAuth 2.0 protocol. It allows users to authenticate themselves with their username and password and receive an access token. The token can then be used to access protected resources. @@ -113,7 +113,7 @@ In addition to user scopes, each endpoint can be secured individually. For this {% info_block infoBox %} -For details, see [Resource Routing](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-infrastructure.html#resource-routing). +For details, see [Resource Routing](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/glue-infrastructure.html#resource-routing). {% endinfo_block %} diff --git a/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-authenticate-as-a-company-user.md b/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-authenticate-as-a-company-user.md index 57073035e76..7dcffe6ad3f 100644 --- a/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-authenticate-as-a-company-user.md +++ b/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-authenticate-as-a-company-user.md @@ -112,7 +112,7 @@ Request sample: authenticate as a company user | 002 | Authentication token is missing. | | 901 | The `idCompanyUser` attribute is not specified, invalid, or empty. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). ## Next steps diff --git a/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-authenticate-as-a-customer.md b/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-authenticate-as-a-customer.md index 2d1b2430972..143634f24c9 100644 --- a/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-authenticate-as-a-customer.md +++ b/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-authenticate-as-a-customer.md @@ -133,7 +133,7 @@ Note that depending on the Login feature configuration for your project, too man | 003 | Failed to log in the user. | | 901 | Unprocessable login data (incorrect email format; email or password is empty).| -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). ## Next steps diff --git a/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-authenticate-as-an-agent-assist.md b/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-authenticate-as-an-agent-assist.md index dcefb87bb53..c80dfbf6eb0 100644 --- a/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-authenticate-as-an-agent-assist.md +++ b/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-authenticate-as-an-agent-assist.md @@ -106,7 +106,7 @@ Note that depending on the Login feature configuration for your project, too man | --- | --- | |4101 | Failed to authenticate an agent. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). ## Next steps diff --git a/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-confirm-customer-registration.md b/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-confirm-customer-registration.md index 524e59aeac7..fb35a7df324 100644 --- a/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-confirm-customer-registration.md +++ b/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-confirm-customer-registration.md @@ -82,7 +82,7 @@ If the customer email is confirmed successfully, the endpoint returns the `204 N | --- | --- | | 423 | Confirmation code is invalid or has been already used. | | 901 | Confirmation code is empty. | -For generic Glue Application errors that can also occur, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +For generic Glue Application errors that can also occur, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). ## Next Steps diff --git a/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-manage-agent-assist-authentication-tokens.md b/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-manage-agent-assist-authentication-tokens.md index d9b9d29d06a..39002dffcc9 100644 --- a/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-manage-agent-assist-authentication-tokens.md +++ b/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-manage-agent-assist-authentication-tokens.md @@ -132,4 +132,4 @@ The tokens are marked as expired on the date and time of the request. You can co | 901 | The `refreshToken` attribute is not specified or empty. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-manage-company-user-authentication-tokens.md b/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-manage-company-user-authentication-tokens.md index b625eb4d1a9..2f42832b720 100644 --- a/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-manage-company-user-authentication-tokens.md +++ b/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-manage-company-user-authentication-tokens.md @@ -144,4 +144,4 @@ The tokens are marked as expired on the date and time of the request. You can co | 004 | Failed to refresh the token. | | 901 | Refresh token is not specified or empty. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-manage-customer-authentication-tokens-via-oauth-2.0.md b/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-manage-customer-authentication-tokens-via-oauth-2.0.md index ad0deb975b7..b6f1f72106e 100644 --- a/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-manage-customer-authentication-tokens-via-oauth-2.0.md +++ b/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-manage-customer-authentication-tokens-via-oauth-2.0.md @@ -152,4 +152,4 @@ To refresh an authentication token, send the request: | invalid_request | The refresh token is invalid. | | invalid_grant | The provided authorization grant or refresh token is invalid, expired, or revoked. The provided authorization grant or refresh token does not match the redirection URI used in the authorization request, or was issued to another client. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-manage-customer-authentication-tokens.md b/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-manage-customer-authentication-tokens.md index a880b9c4ecd..d381f234cf4 100644 --- a/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-manage-customer-authentication-tokens.md +++ b/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-manage-customer-authentication-tokens.md @@ -148,7 +148,7 @@ The tokens are marked as expired on the date and time of the request. You can co | --- | --- | | 004 | Failed to refresh the token. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). ## Next steps diff --git a/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-manage-customer-passwords.md b/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-manage-customer-passwords.md index d4a46d5fba6..4bc405f5625 100644 --- a/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-manage-customer-passwords.md +++ b/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-manage-customer-passwords.md @@ -190,7 +190,7 @@ If the password reset is successful, the endpoint returns the `204 No Content` s | 422 | `newPassword` and `confirmPassword` values are not identical. | | 901 | `newPassword` and `confirmPassword` are not specified; or the password length is invalid (it should be from 8 to 64 characters). | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). ## Next steps diff --git a/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-retrieve-protected-resources.md b/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-retrieve-protected-resources.md index 897f9de5eb6..937afcc24e7 100644 --- a/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-retrieve-protected-resources.md +++ b/docs/pbc/all/identity-access-management/202212.0/manage-using-glue-api/glue-api-retrieve-protected-resources.md @@ -77,4 +77,4 @@ Response sample: retrieve protected resources | --- | --- | --- | | resourceTypes | String | Contains a `string` array, where each element is a resource type that is protected from unauthorized access. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/merchant-management/202212.0/marketplace/import-data/file-details-merchant-stock.csv.md b/docs/pbc/all/merchant-management/202212.0/marketplace/import-data/file-details-merchant-stock.csv.md index b5634f57d3a..240b0ce24e5 100644 --- a/docs/pbc/all/merchant-management/202212.0/marketplace/import-data/file-details-merchant-stock.csv.md +++ b/docs/pbc/all/merchant-management/202212.0/marketplace/import-data/file-details-merchant-stock.csv.md @@ -18,7 +18,7 @@ This document describes the `merchant_stock.csv` file to configure [merchant sto ## Import file dependencies - [merchant.csv](/docs/pbc/all/merchant-management/{{site.version}}/marketplace/import-data/file-details-merchant.csv.html) -- [warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-data/file-details-warehouse.csv.html) +- [warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/file-details-warehouse.csv.html) ## Import file parameters diff --git a/docs/marketplace/dev/feature-integration-guides/202212.0/merchant-switcher-customer-account-management-feature-integration.md b/docs/pbc/all/merchant-management/202212.0/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-customer-account-management-feature.md similarity index 87% rename from docs/marketplace/dev/feature-integration-guides/202212.0/merchant-switcher-customer-account-management-feature-integration.md rename to docs/pbc/all/merchant-management/202212.0/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-customer-account-management-feature.md index 323adfc0fea..b0987741434 100644 --- a/docs/marketplace/dev/feature-integration-guides/202212.0/merchant-switcher-customer-account-management-feature-integration.md +++ b/docs/pbc/all/merchant-management/202212.0/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-customer-account-management-feature.md @@ -1,5 +1,5 @@ --- -title: Merchant Switcher + Customer Account Management feature integration +title: Install the Merchant Switcher + Customer Account Management feature last_updated: Jan 06, 2021 description: This document describes the process how to integrate the Merchant Switcher + Customer Account Management feature into a Spryker project. template: feature-integration-guide-template diff --git a/docs/marketplace/dev/feature-integration-guides/202212.0/merchant-switcher-feature-integration.md b/docs/pbc/all/merchant-management/202212.0/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-feature.md similarity index 90% rename from docs/marketplace/dev/feature-integration-guides/202212.0/merchant-switcher-feature-integration.md rename to docs/pbc/all/merchant-management/202212.0/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-feature.md index 4bd9cb04c47..33e76a1c27f 100644 --- a/docs/marketplace/dev/feature-integration-guides/202212.0/merchant-switcher-feature-integration.md +++ b/docs/pbc/all/merchant-management/202212.0/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-feature.md @@ -1,5 +1,5 @@ --- -title: Merchant Switcher feature integration +title: Install the Merchant Switcher feature last_updated: Jan 06, 2021 description: This integration guide provides steps on how to integrate the Merchant Switcher feature into a Spryker project. template: feature-integration-guide-template diff --git a/docs/marketplace/dev/feature-integration-guides/202212.0/merchant-switcher-wishlist-feature-integration.md b/docs/pbc/all/merchant-management/202212.0/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-wishlist-feature.md similarity index 88% rename from docs/marketplace/dev/feature-integration-guides/202212.0/merchant-switcher-wishlist-feature-integration.md rename to docs/pbc/all/merchant-management/202212.0/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-wishlist-feature.md index e1d75006a5f..2b9462f07ca 100644 --- a/docs/marketplace/dev/feature-integration-guides/202212.0/merchant-switcher-wishlist-feature-integration.md +++ b/docs/pbc/all/merchant-management/202212.0/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-wishlist-feature.md @@ -1,5 +1,5 @@ --- -title: Merchant Switcher + Wishlist feature integration +title: Install the Merchant Switcher + Wishlist feature last_updated: Oct 08, 2021 description: This document describes the process how to integrate the Merchant Switcher + Wishlist feature into a Spryker project. template: feature-integration-guide-template diff --git a/docs/pbc/all/merchant-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-addresses.md b/docs/pbc/all/merchant-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-addresses.md index 03513147d99..ea10e600fc5 100644 --- a/docs/pbc/all/merchant-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-addresses.md +++ b/docs/pbc/all/merchant-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-addresses.md @@ -106,4 +106,4 @@ Request sample: retrieve merchant addresses ## Possible errors -For statuses, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +For statuses, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/merchant-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-opening-hours.md b/docs/pbc/all/merchant-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-opening-hours.md index d34aa9ad25e..a8a0d146909 100644 --- a/docs/pbc/all/merchant-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-opening-hours.md +++ b/docs/pbc/all/merchant-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchant-opening-hours.md @@ -206,4 +206,4 @@ Request sample: retrieve merchant opening hours ## Possible errors -For statuses, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +For statuses, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/merchant-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.md b/docs/pbc/all/merchant-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.md index c728680db20..84e4c6ba14b 100644 --- a/docs/pbc/all/merchant-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.md +++ b/docs/pbc/all/merchant-management/202212.0/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.md @@ -656,4 +656,4 @@ Resolve a search engine friendly URL of a merchant page. For details, see [Resol ## Possible errors -For statuses, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +For statuses, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/marketplace/dev/howtos/how-to-add-new-guitable-column-type.md b/docs/pbc/all/merchant-management/202212.0/marketplace/tutorials-and-howtos/create-gui-table-column-types.md similarity index 93% rename from docs/marketplace/dev/howtos/how-to-add-new-guitable-column-type.md rename to docs/pbc/all/merchant-management/202212.0/marketplace/tutorials-and-howtos/create-gui-table-column-types.md index 71f469c027b..44b71ce2c4b 100644 --- a/docs/marketplace/dev/howtos/how-to-add-new-guitable-column-type.md +++ b/docs/pbc/all/merchant-management/202212.0/marketplace/tutorials-and-howtos/create-gui-table-column-types.md @@ -1,7 +1,9 @@ --- -title: "How-To: Create a new Gui table column type" +title: Create Gui table column types description: This articles provides details how to create a new Gui table column type template: howto-guide-template +redirect_from: + - /docs/marketplace/dev/howtos/how-to-add-new-guitable-column-type.html --- This document describes how to add new column types to a Gui table. diff --git a/docs/pbc/all/miscellaneous/202212.0/glue-api-retrieve-store-configuration.md b/docs/pbc/all/miscellaneous/202212.0/glue-api-retrieve-store-configuration.md index 4ace50e898f..bfbb3feb6ea 100644 --- a/docs/pbc/all/miscellaneous/202212.0/glue-api-retrieve-store-configuration.md +++ b/docs/pbc/all/miscellaneous/202212.0/glue-api-retrieve-store-configuration.md @@ -118,4 +118,4 @@ Request sample: retrieve stores | iso2Code | String | Iso 2 code for the region. | | name | String | Region name. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/offer-management/202212.0/marketplace/glue-api-retrieve-product-offers.md b/docs/pbc/all/offer-management/202212.0/marketplace/glue-api-retrieve-product-offers.md index 5d54c186ab9..880f594bad5 100644 --- a/docs/pbc/all/offer-management/202212.0/marketplace/glue-api-retrieve-product-offers.md +++ b/docs/pbc/all/offer-management/202212.0/marketplace/glue-api-retrieve-product-offers.md @@ -278,4 +278,4 @@ You can use the product offers resource as follows: | 3701 | Product offer was not found. | | 3702 | Product offer ID is not specified. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/offer-management/202304.0/marketplace/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.md b/docs/pbc/all/offer-management/202304.0/marketplace/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.md deleted file mode 100644 index 010a91b479b..00000000000 --- a/docs/pbc/all/offer-management/202304.0/marketplace/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: Install the Marketplace Product Offer + Product Offer Service Points feature -description: Follow the steps below to install the Marketplace Product Offer + Service Points feature core. -last_updated: July 05, 2023 -template: feature-integration-guide-template ---- - -{% include pbc/all/install-features/{{page.version}}/marketplace/install-the-marketplace-product-offer-service-points-feature.md %} diff --git a/docs/pbc/all/offer-management/202400.0/marketplace/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.md b/docs/pbc/all/offer-management/202400.0/marketplace/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.md new file mode 100644 index 00000000000..c51bfd67d0b --- /dev/null +++ b/docs/pbc/all/offer-management/202400.0/marketplace/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.md @@ -0,0 +1,10 @@ +--- +title: Install the Marketplace Product Offer + Service Points feature +description: Install the Marketplace Product Offer + Service Points feature +last_updated: July 05, 2023 +template: feature-integration-guide-template +redirect_from: + - /docs/pbc/all/offer-management/202304.0/marketplace/install-and-upgrade/install-the-marketplace-product-offer-service-points-feature.html +--- + +{% include pbc/all/install-features/202400.0/marketplace/install-the-marketplace-product-offer-service-points-feature.md %} diff --git a/docs/scos/dev/feature-integration-guides/202304.0/install-the-product-offer-service-points-feature.md b/docs/pbc/all/offer-management/202400.0/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-feature.md similarity index 51% rename from docs/scos/dev/feature-integration-guides/202304.0/install-the-product-offer-service-points-feature.md rename to docs/pbc/all/offer-management/202400.0/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-feature.md index 4c3625eef4a..75949e36e26 100644 --- a/docs/scos/dev/feature-integration-guides/202304.0/install-the-product-offer-service-points-feature.md +++ b/docs/pbc/all/offer-management/202400.0/unified-commerce/install-and-upgrade/install-the-product-offer-service-points-feature.md @@ -5,4 +5,4 @@ last_updated: July 04, 2023 template: feature-integration-guide-template --- -{% include pbc/all/install-features/{{page.version}}/install-the-product-offer-service-points-feature.md %} +{% include pbc/all/install-features/202400.0/install-the-product-offer-service-points-feature.md %} diff --git a/docs/pbc/all/offer-management/202400.0/unified-commerce/install-and-upgrade/install-the-product-offer-shipment-feature.md b/docs/pbc/all/offer-management/202400.0/unified-commerce/install-and-upgrade/install-the-product-offer-shipment-feature.md new file mode 100644 index 00000000000..4295c43c51e --- /dev/null +++ b/docs/pbc/all/offer-management/202400.0/unified-commerce/install-and-upgrade/install-the-product-offer-shipment-feature.md @@ -0,0 +1,10 @@ +--- +title: Install the Product offer shipment feature +description: Learn how to integrate the Product offer shipment feature into your project +last_updated: June 20, 2023 +template: feature-integration-guide-template +redirect_from: + - /docs/scos/dev/feature-integration-guides/202304.0/install-the-product-offer-shipment-feature.html +--- + +{% include pbc/all/install-features/202400.0/install-the-product-offer-shipment-feature.md %} diff --git a/docs/pbc/all/order-management-system/202212.0/base-shop/glue-api-retrieve-orders.md b/docs/pbc/all/order-management-system/202212.0/base-shop/glue-api-retrieve-orders.md index 33d4f7bb830..85ddd04eacc 100644 --- a/docs/pbc/all/order-management-system/202212.0/base-shop/glue-api-retrieve-orders.md +++ b/docs/pbc/all/order-management-system/202212.0/base-shop/glue-api-retrieve-orders.md @@ -1226,4 +1226,4 @@ To retrieve detailed information on an order, send the request: |002| Access token is missing. | |801| Order with the given order reference is not found. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/adyen/adyen.md b/docs/pbc/all/payment-service-provider/202212.0/adyen/adyen.md similarity index 65% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/adyen/adyen.md rename to docs/pbc/all/payment-service-provider/202212.0/adyen/adyen.md index 44c8266ff78..9f2c6917bfe 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/adyen/adyen.md +++ b/docs/pbc/all/payment-service-provider/202212.0/adyen/adyen.md @@ -6,22 +6,17 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/adyen originalArticleId: 0d0cbb43-1cdd-47b8-86a1-a963cef8a788 redirect_from: - - /2021080/docs/adyen - - /2021080/docs/en/adyen - - /docs/adyen - - /docs/en/adyen - - /docs/scos/user/technology-partners/202108.0/payment-partners/adyen/adyen-provided-payment-methods.html - - /docs/sdk/dev/conventions - /docs/scos/user/technology-partners/202212.0/payment-partners/adyen.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/adyen/adyen.html related: - title: Installing and configuring Adyen - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/adyen/installing-and-configuring-adyen.html + link: docs/pbc/all/payment-service-provider/page.version/adyen/installing-and-configuring-adyen.html - title: Integrating Adyen - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/adyen/integrate-adyen.html + link: docs/pbc/all/payment-service-provider/page.version/adyen/integrate-adyen.html - title: Integrating Adyen payment methods - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/adyen/integrate-adyen-payment-methods.html + link: docs/pbc/all/payment-service-provider/page.version/adyen/integrate-adyen-payment-methods.html - title: Enabling filtering of payment methods for Ayden - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/adyen/enable-filtering-of-payment-methods-for-adyen.html + link: docs/pbc/all/payment-service-provider/page.version/adyen/enable-filtering-of-payment-methods-for-adyen.html --- ## Partner Information @@ -32,10 +27,10 @@ Adyen is a global payment company that allows businesses to accept e-commerce, m ## Related Developer guides -* [Installing and configuring Adyen](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/adyen/installing-and-configuring-adyen.html) -* [Integrating Adyen](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/adyen/integrate-adyen.html) -* [Integrating Adyen payment methods](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/adyen/integrate-adyen-payment-methods.html) -* [Enabling filtering of payment methods for Ayden](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/adyen/enable-filtering-of-payment-methods-for-adyen.html) +* [Installing and configuring Adyen](/docs/pbc/all/payment-service-provider/{{page.version}}/adyen/installing-and-configuring-adyen.html) +* [Integrating Adyen](/docs/pbc/all/payment-service-provider/{{page.version}}/adyen/integrate-adyen.html) +* [Integrating Adyen payment methods](/docs/pbc/all/payment-service-provider/{{page.version}}/adyen/integrate-adyen-payment-methods.html) +* [Enabling filtering of payment methods for Ayden](/docs/pbc/all/payment-service-provider/{{page.version}}/adyen/enable-filtering-of-payment-methods-for-adyen.html) ## Copyright and Disclaimer diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/adyen/enable-filtering-of-payment-methods-for-adyen.md b/docs/pbc/all/payment-service-provider/202212.0/adyen/enable-filtering-of-payment-methods-for-adyen.md similarity index 70% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/adyen/enable-filtering-of-payment-methods-for-adyen.md rename to docs/pbc/all/payment-service-provider/202212.0/adyen/enable-filtering-of-payment-methods-for-adyen.md index 4e4eb9204d8..8f9ca1e2f6e 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/adyen/enable-filtering-of-payment-methods-for-adyen.md +++ b/docs/pbc/all/payment-service-provider/202212.0/adyen/enable-filtering-of-payment-methods-for-adyen.md @@ -6,19 +6,15 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/adyen-filter-payment-methods originalArticleId: 5e090a05-3c2f-43d4-9775-8d9c212f3923 redirect_from: - - /2021080/docs/adyen-filter-payment-methods - - /2021080/docs/en/adyen-filter-payment-methods - - /docs/adyen-filter-payment-methods - - /docs/en/adyen-filter-payment-methods - - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/adyen/enabling-filtering-of-payment-methods-for-adyen.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/adyen/enabling-filtering-of-payment-methods-for-adyen.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/adyen/enable-filtering-of-payment-methods-for-adyen.html related: - title: Installing and configuring Adyen - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/adyen/installing-and-configuring-adyen.html + link: docs/pbc/all/payment-service-provider/page.version/adyen/installing-and-configuring-adyen.html - title: Integrating Adyen - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/adyen/integrate-adyen.html + link: docs/pbc/all/payment-service-provider/page.version/adyen/integrate-adyen.html - title: Integrating Adyen payment methods - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/adyen/integrate-adyen-payment-methods.html + link: docs/pbc/all/payment-service-provider/page.version/adyen/integrate-adyen-payment-methods.html --- Adyen module provides filtering available payment methods depend on result of `/paymentMethods` API call. diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/adyen/install-and-configure-adyen.md b/docs/pbc/all/payment-service-provider/202212.0/adyen/install-and-configure-adyen.md similarity index 85% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/adyen/install-and-configure-adyen.md rename to docs/pbc/all/payment-service-provider/202212.0/adyen/install-and-configure-adyen.md index b2962975cef..dc38123ff85 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/adyen/install-and-configure-adyen.md +++ b/docs/pbc/all/payment-service-provider/202212.0/adyen/install-and-configure-adyen.md @@ -6,19 +6,15 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/adyen-configuration originalArticleId: 2966816e-71e5-4460-8366-ce775e0712a9 redirect_from: - - /2021080/docs/adyen-configuration - - /2021080/docs/en/adyen-configuration - - /docs/adyen-configuration - - /docs/en/adyen-configuration - - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/adyen/installing-and-configuring-adyen.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/adyen/installing-and-configuring-adyen.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/adyen/install-and-configure-adyen.html related: - title: Integrating Adyen - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/adyen/integrate-adyen.html + link: docs/pbc/all/payment-service-provider/page.version/adyen/integrate-adyen.html - title: Enabling filtering of payment methods for Ayden - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/adyen/enable-filtering-of-payment-methods-for-adyen.html + link: docs/pbc/all/payment-service-provider/page.version/adyen/enable-filtering-of-payment-methods-for-adyen.html - title: Integrating Adyen payment methods - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/adyen/integrate-adyen-payment-methods.html + link: docs/pbc/all/payment-service-provider/page.version/adyen/integrate-adyen-payment-methods.html --- This topic describes how to install and configure the Adyen module to integrate Adyen into your project. @@ -33,15 +29,15 @@ The `SprykerEco.Adyen` module includes integration with: * OMS (Order Management System) - state machines, all necessary commands for making modification requests and conditions for changing orders status accordingly. The `SprykerEco.Adyen` module provides the following payment methods: -* [Credit Card](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/adyen/integrate-adyen-payment-methods.html#credit-card) -* [Direct Debit](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/adyen/integrate-adyen-payment-methods.html#direct-debit-sepa-direct-debit) -* [Klarna Invoice](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/adyen/integrate-adyen-payment-methods.html#klarna-invoice) -* [Prepayment](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/adyen/integrate-adyen-payment-methods.html#prepayment-bank-transfer-iban) -* [Sofort](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/adyen/integrate-adyen-payment-methods.html#sofort) -* [PayPal](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/adyen/integrate-adyen-payment-methods.html#paypal) -* [iDeal](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/adyen/integrate-adyen-payment-methods.html#ideal) -* [AliPay](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/adyen/integrate-adyen-payment-methods.html#alipay) -* [WeChatPay](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/adyen/integrate-adyen-payment-methods.html#wechatpay) +* [Credit Card](/docs/pbc/all/payment-service-provider/{{page.version}}/adyen/integrate-adyen-payment-methods.html#credit-card) +* [Direct Debit](/docs/pbc/all/payment-service-provider/{{page.version}}/adyen/integrate-adyen-payment-methods.html#direct-debit-sepa-direct-debit) +* [Klarna Invoice](/docs/pbc/all/payment-service-provider/{{page.version}}/adyen/integrate-adyen-payment-methods.html#klarna-invoice) +* [Prepayment](/docs/pbc/all/payment-service-provider/{{page.version}}/adyen/integrate-adyen-payment-methods.html#prepayment-bank-transfer-iban) +* [Sofort](/docs/pbc/all/payment-service-provider/{{page.version}}/adyen/integrate-adyen-payment-methods.html#sofort) +* [PayPal](/docs/pbc/all/payment-service-provider/{{page.version}}/adyen/integrate-adyen-payment-methods.html#paypal) +* [iDeal](/docs/pbc/all/payment-service-provider/{{page.version}}/adyen/integrate-adyen-payment-methods.html#ideal) +* [AliPay](/docs/pbc/all/payment-service-provider/{{page.version}}/adyen/integrate-adyen-payment-methods.html#alipay) +* [WeChatPay](/docs/pbc/all/payment-service-provider/{{page.version}}/adyen/integrate-adyen-payment-methods.html#wechatpay) ## Installation diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/adyen/integrate-adyen-payment-methods.md b/docs/pbc/all/payment-service-provider/202212.0/adyen/integrate-adyen-payment-methods.md similarity index 96% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/adyen/integrate-adyen-payment-methods.md rename to docs/pbc/all/payment-service-provider/202212.0/adyen/integrate-adyen-payment-methods.md index 8a2c70a5252..8b291c89b74 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/adyen/integrate-adyen-payment-methods.md +++ b/docs/pbc/all/payment-service-provider/202212.0/adyen/integrate-adyen-payment-methods.md @@ -6,19 +6,15 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/adyen-provided-payment-methods originalArticleId: f1994f41-32fd-4af3-8e5a-b3a3ce75e39c redirect_from: - - /2021080/docs/adyen-provided-payment-methods - - /2021080/docs/en/adyen-provided-payment-methods - - /docs/adyen-provided-payment-methods - - /docs/en/adyen-provided-payment-methods - - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/adyen/integrating-adyen-payment-methods.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/adyen/integrating-adyen-payment-methods.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/adyen/integrate-adyen-payment-methods.html related: - title: Installing and configuring Adyen - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/adyen/installing-and-configuring-adyen.html + link: docs/pbc/all/payment-service-provider/page.version/adyen/installing-and-configuring-adyen.html - title: Integrating Adyen - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/adyen/integrate-adyen.html + link: docs/pbc/all/payment-service-provider/page.version/adyen/integrate-adyen.html - title: Enabling filtering of payment methods for Ayden - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/adyen/enable-filtering-of-payment-methods-for-adyen.html + link: docs/pbc/all/payment-service-provider/page.version/adyen/enable-filtering-of-payment-methods-for-adyen.html --- ## Credit card diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/adyen/integrate-adyen.md b/docs/pbc/all/payment-service-provider/202212.0/adyen/integrate-adyen.md similarity index 94% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/adyen/integrate-adyen.md rename to docs/pbc/all/payment-service-provider/202212.0/adyen/integrate-adyen.md index 7c770b82bf4..3e460da01f3 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/adyen/integrate-adyen.md +++ b/docs/pbc/all/payment-service-provider/202212.0/adyen/integrate-adyen.md @@ -6,20 +6,15 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/adyen-integration originalArticleId: 4b3bafa7-ec4b-40d7-b6aa-2f21bcf35c14 redirect_from: - - /2021080/docs/adyen-integration - - /2021080/docs/en/adyen-integration - - /docs/adyen-integration - - /docs/en/adyen-integration - - /docs/scos/user/technology-partners/202204.0/payment-partners/adyen/adyen-integration-into-a-project.html - - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/adyen/integrating-adyen.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/adyen/integrating-adyen.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/adyen/integrate-adyen.html related: - title: Installing and configuring Adyen - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/adyen/installing-and-configuring-adyen.html + link: docs/pbc/all/payment-service-provider/page.version/adyen/installing-and-configuring-adyen.html - title: Enabling filtering of payment methods for Ayden - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/adyen/enable-filtering-of-payment-methods-for-adyen.html + link: docs/pbc/all/payment-service-provider/page.version/adyen/enable-filtering-of-payment-methods-for-adyen.html - title: Integrating Adyen payment methods - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/adyen/integrate-adyen-payment-methods.html + link: docs/pbc/all/payment-service-provider/page.version/adyen/integrate-adyen-payment-methods.html --- {% info_block errorBox %} @@ -32,7 +27,7 @@ This article provides step-by-step instructions on integrating the Adyen module ## Prerequisites -Prior to integrating Adyen into your project, make sure you [installed and configured the Adyen module](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/adyen/installing-and-configuring-adyen.html). +Prior to integrating Adyen into your project, make sure you [installed and configured the Adyen module](/docs/pbc/all/payment-service-provider/{{page.version}}/adyen/installing-and-configuring-adyen.html). ## Project integration @@ -264,7 +259,7 @@ class RouterDependencyProvider extends SprykerRouterDependencyProvider {% info_block infoBox "Note" %} -If you provide the Credit Card payment method, you have to overwrite `CheckoutPageRouteProviderPlugin` with the one from the project level. For details, see [Adyen - Provided Payment Methods Credit Card (Step 7)](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/adyen/integrate-adyen-payment-methods.html#credit-card). +If you provide the Credit Card payment method, you have to overwrite `CheckoutPageRouteProviderPlugin` with the one from the project level. For details, see [Adyen - Provided Payment Methods Credit Card (Step 7)](/docs/pbc/all/payment-service-provider/{{page.version}}/adyen/integrate-adyen-payment-methods.html#credit-card). {% endinfo_block %} diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/afterpay/afterpay.md b/docs/pbc/all/payment-service-provider/202212.0/afterpay/afterpay.md similarity index 89% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/afterpay/afterpay.md rename to docs/pbc/all/payment-service-provider/202212.0/afterpay/afterpay.md index 3043b8ba22b..aafa6e269c2 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/afterpay/afterpay.md +++ b/docs/pbc/all/payment-service-provider/202212.0/afterpay/afterpay.md @@ -6,14 +6,11 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/afterpay originalArticleId: 3ed914a1-aa6a-472e-b213-f5e60058cbb1 redirect_from: - - /2021080/docs/afterpay - - /2021080/docs/en/afterpay - - /docs/afterpay - - /docs/en/afterpay - /docs/scos/user/technology-partners/202212.0/payment-partners/afterpay.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/afterpay/afterpay.html related: - title: Afterpay - Installation and Configuration - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/afterpay/install-and-configure-afterpay.html + link: docs/pbc/all/payment-service-provider/page.version/afterpay/install-and-configure-afterpay.html --- ## Partner Information @@ -44,8 +41,8 @@ Unlike other pay-after-delivery providers we keep you informed of your customers ## Related Developer guides -* [Installing and configuring Afterpay](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/afterpay/install-and-configure-afterpay.html) -* [Integrating Afterpay](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/afterpay/integrate-afterpay.html) +* [Installing and configuring Afterpay](/docs/pbc/all/payment-service-provider/{{page.version}}/afterpay/install-and-configure-afterpay.html) +* [Integrating Afterpay](/docs/pbc/all/payment-service-provider/{{page.version}}/afterpay/integrate-afterpay.html) --- diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/afterpay/install-and-configure-afterpay.md b/docs/pbc/all/payment-service-provider/202212.0/afterpay/install-and-configure-afterpay.md similarity index 95% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/afterpay/install-and-configure-afterpay.md rename to docs/pbc/all/payment-service-provider/202212.0/afterpay/install-and-configure-afterpay.md index da6d92cf23e..bf1aeafb2a6 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/afterpay/install-and-configure-afterpay.md +++ b/docs/pbc/all/payment-service-provider/202212.0/afterpay/install-and-configure-afterpay.md @@ -12,9 +12,10 @@ redirect_from: - /docs/en/afterpay-installation-and-configuration - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/afterpay/installing-and-configuring-afterpay.html - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/afterpay/install-and-configure-afterpay.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/afterpay/install-and-configure-afterpay.html related: - title: Afterpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/afterpay/afterpay.html + link: docs/pbc/all/payment-service-provider/page.version/afterpay/afterpay.html --- {% info_block errorBox %} diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/afterpay/integrate-afterpay.md b/docs/pbc/all/payment-service-provider/202212.0/afterpay/integrate-afterpay.md similarity index 96% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/afterpay/integrate-afterpay.md rename to docs/pbc/all/payment-service-provider/202212.0/afterpay/integrate-afterpay.md index 4037d8693fc..f7af2bdf8bb 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/afterpay/integrate-afterpay.md +++ b/docs/pbc/all/payment-service-provider/202212.0/afterpay/integrate-afterpay.md @@ -5,10 +5,11 @@ last_updated: Jun 16, 2021 template: howto-guide-template related: - title: Afterpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/afterpay/afterpay.html + link: docs/pbc/all/payment-service-provider/page.version/afterpay/afterpay.html redirect_from: - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/afterpay/integrating-afterpay.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/afterpay/integrating-afterpay.html +- /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/afterpay/integrate-afterpay.html --- To integrate AfterPay, do the following: diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/amazon-pay/amazon-pay-sandbox-simulations.md b/docs/pbc/all/payment-service-provider/202212.0/amazon-pay/amazon-pay-sandbox-simulations.md similarity index 88% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/amazon-pay/amazon-pay-sandbox-simulations.md rename to docs/pbc/all/payment-service-provider/202212.0/amazon-pay/amazon-pay-sandbox-simulations.md index 4733147b973..994a48ff095 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/amazon-pay/amazon-pay-sandbox-simulations.md +++ b/docs/pbc/all/payment-service-provider/202212.0/amazon-pay/amazon-pay-sandbox-simulations.md @@ -6,22 +6,17 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/amazon-sandbox-simulations originalArticleId: c664cbf9-33b1-409f-be65-5785f7299e35 redirect_from: - - /2021080/docs/amazon-sandbox-simulations - - /2021080/docs/en/amazon-sandbox-simulations - - /docs/amazon-sandbox-simulations - - /docs/en/amazon-sandbox-simulations - - /docs/scos/user/technology-partners/202204.0/payment-partners/amazon-pay/legacy-demoshop-integration/amazon-pay-sandbox-simulations.html - - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/amazon-pay/amazon-pay-sandbox-simulations.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/amazon-pay/amazon-pay-sandbox-simulations.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/amazon-pay/amazon-pay-sandbox-simulations.html related: - title: Handling orders with Amazon Pay API - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/amazon-pay/handling-orders-with-amazon-pay-api.html + link: docs/pbc/all/payment-service-provider/page.version/amazon-pay/handling-orders-with-amazon-pay-api.html - title: Configuring Amazon Pay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/amazon-pay/configure-amazon-pay.html + link: docs/pbc/all/payment-service-provider/page.version/amazon-pay/configure-amazon-pay.html - title: Amazon Pay - State Machine - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/amazon-pay/amazon-pay-state-machine.html + link: docs/pbc/all/payment-service-provider/page.version/amazon-pay/amazon-pay-state-machine.html - title: Obtaining an Amazon Order Reference and information about shipping addresses - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/amazon-pay/obtain-an-amazon-order-reference-and-information-about-shipping-addresses.html + link: docs/pbc/all/payment-service-provider/page.version/amazon-pay/obtain-an-amazon-order-reference-and-information-about-shipping-addresses.html --- In order to reproduce some edge cases like declined payment or pending capture Amazon provides two solutions. First is special methods marked with red star on payment widget. diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/amazon-pay/amazon-pay-state-machine.md b/docs/pbc/all/payment-service-provider/202212.0/amazon-pay/amazon-pay-state-machine.md similarity index 80% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/amazon-pay/amazon-pay-state-machine.md rename to docs/pbc/all/payment-service-provider/202212.0/amazon-pay/amazon-pay-state-machine.md index 202fdbc5ff2..fa104ec80f6 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/amazon-pay/amazon-pay-state-machine.md +++ b/docs/pbc/all/payment-service-provider/202212.0/amazon-pay/amazon-pay-state-machine.md @@ -6,22 +6,17 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/amazon-pay-state-machine originalArticleId: 95d68099-5bb5-4423-8945-b0cdbcc01384 redirect_from: - - /2021080/docs/amazon-pay-state-machine - - /2021080/docs/en/amazon-pay-state-machine - - /docs/amazon-pay-state-machine - - /docs/en/amazon-pay-state-machine - - /docs/scos/user/technology-partners/202204.0/payment-partners/amazon-pay/legacy-demoshop-integration/amazon-pay-state-machine.html - - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/amazon-pay/amazon-pay-state-machine.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/amazon-pay/amazon-pay-state-machine.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/amazon-pay/amazon-pay-state-machine.html related: - title: Handling orders with Amazon Pay API - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/amazon-pay/handling-orders-with-amazon-pay-api.html + link: docs/pbc/all/payment-service-provider/page.version/amazon-pay/handling-orders-with-amazon-pay-api.html - title: Configuring Amazon Pay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/amazon-pay/configure-amazon-pay.html + link: docs/pbc/all/payment-service-provider/page.version/amazon-pay/configure-amazon-pay.html - title: Amazon Pay - Sandbox Simulations - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/amazon-pay/amazon-pay-sandbox-simulations.html + link: docs/pbc/all/payment-service-provider/page.version/amazon-pay/amazon-pay-sandbox-simulations.html - title: Obtaining an Amazon Order Reference and information about shipping addresses - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/amazon-pay/obtain-an-amazon-order-reference-and-information-about-shipping-addresses.html + link: docs/pbc/all/payment-service-provider/page.version/amazon-pay/obtain-an-amazon-order-reference-and-information-about-shipping-addresses.html --- The state machine is different for synchronous and asynchronous flow. Although from status "capture completed" it is the same and in the state machine, it's presented as a sub-process. diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/amazon-pay/amazon-pay.md b/docs/pbc/all/payment-service-provider/202212.0/amazon-pay/amazon-pay.md similarity index 66% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/amazon-pay/amazon-pay.md rename to docs/pbc/all/payment-service-provider/202212.0/amazon-pay/amazon-pay.md index 86fc55dae85..f8ae3436723 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/amazon-pay/amazon-pay.md +++ b/docs/pbc/all/payment-service-provider/202212.0/amazon-pay/amazon-pay.md @@ -6,21 +6,18 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/amazon-pay originalArticleId: 0636967e-995e-4f57-b980-eac1b4bcda3e redirect_from: - - /2021080/docs/amazon-pay - - /2021080/docs/en/amazon-pay - - /docs/amazon-pay - - /docs/en/amazon-pay - /docs/scos/user/technology-partners/202212.0/payment-partners/amazon-pay.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/amazon-pay/amazon-pay.html related: - title: Obtaining an Amazon Order Reference and information about shipping addresses - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/amazon-pay/obtain-an-amazon-order-reference-and-information-about-shipping-addresses.html + link: docs/pbc/all/payment-service-provider/page.version/amazon-pay/obtain-an-amazon-order-reference-and-information-about-shipping-addresses.html - title: Amazon Pay - Rendering a “Pay with Amazon” Button on the Cart Page - title: Configuring Amazon Pay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/amazon-pay/configure-amazon-pay.html + link: docs/pbc/all/payment-service-provider/page.version/amazon-pay/configure-amazon-pay.html - title: Handling orders with Amazon Pay API - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/amazon-pay/handling-orders-with-amazon-pay-api.html + link: docs/pbc/all/payment-service-provider/page.version/amazon-pay/handling-orders-with-amazon-pay-api.html - title: Amazon Pay - Sandbox Simulations - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/amazon-pay/amazon-pay-sandbox-simulations.html + link: docs/pbc/all/payment-service-provider/page.version/amazon-pay/amazon-pay-sandbox-simulations.html --- ## Partner Information @@ -37,11 +34,11 @@ Subsequent all integration functionality is provided by Amazon Pay. ## Related Developer guides -* [Configuring Amazon Pay](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/amazon-pay/configure-amazon-pay.html) -* [Amazon Pay - Sandbox Simulations](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/amazon-pay/amazon-pay-sandbox-simulations.html) -* [Amazon Pay - State Machine](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/amazon-pay/amazon-pay-state-machine.html) -* [Handling orders with Amazon Pay API](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/amazon-pay/handling-orders-with-amazon-pay-api.html) -* [Obtaining an Amazon Order Reference and information about shipping addresses](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/amazon-pay/obtain-an-amazon-order-reference-and-information-about-shipping-addresses.html) +* [Configuring Amazon Pay](/docs/pbc/all/payment-service-provider/{{page.version}}/amazon-pay/configure-amazon-pay.html) +* [Amazon Pay - Sandbox Simulations](/docs/pbc/all/payment-service-provider/{{page.version}}/amazon-pay/amazon-pay-sandbox-simulations.html) +* [Amazon Pay - State Machine](/docs/pbc/all/payment-service-provider/{{page.version}}/amazon-pay/amazon-pay-state-machine.html) +* [Handling orders with Amazon Pay API](/docs/pbc/all/payment-service-provider/{{page.version}}/amazon-pay/handling-orders-with-amazon-pay-api.html) +* [Obtaining an Amazon Order Reference and information about shipping addresses](/docs/pbc/all/payment-service-provider/{{page.version}}/amazon-pay/obtain-an-amazon-order-reference-and-information-about-shipping-addresses.html) --- ## Copyright and Disclaimer diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/amazon-pay/configure-amazon-pay.md b/docs/pbc/all/payment-service-provider/202212.0/amazon-pay/configure-amazon-pay.md similarity index 94% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/amazon-pay/configure-amazon-pay.md rename to docs/pbc/all/payment-service-provider/202212.0/amazon-pay/configure-amazon-pay.md index 2b147406c92..bd89fc97fa2 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/amazon-pay/configure-amazon-pay.md +++ b/docs/pbc/all/payment-service-provider/202212.0/amazon-pay/configure-amazon-pay.md @@ -14,15 +14,16 @@ redirect_from: - /docs/scos/user/technology-partners/202204.0/payment-partners/amazon-pay/legacy-demoshop-integration/amazon-pay-support-of-bundled-products.html - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/amazon-pay/configuring-amazon-pay.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/amazon-pay/configuring-amazon-pay.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/amazon-pay/configure-amazon-pay.html related: - title: Handling orders with Amazon Pay API - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/amazon-pay/handling-orders-with-amazon-pay-api.html + link: docs/pbc/all/payment-service-provider/page.version/amazon-pay/handling-orders-with-amazon-pay-api.html - title: Amazon Pay - State Machine - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/amazon-pay/amazon-pay-state-machine.html + link: docs/pbc/all/payment-service-provider/page.version/amazon-pay/amazon-pay-state-machine.html - title: Amazon Pay - Sandbox Simulations - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/amazon-pay/amazon-pay-sandbox-simulations.html + link: docs/pbc/all/payment-service-provider/page.version/amazon-pay/amazon-pay-sandbox-simulations.html - title: Obtaining an Amazon Order Reference and information about shipping addresses - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/amazon-pay/obtain-an-amazon-order-reference-and-information-about-shipping-addresses.html + link: docs/pbc/all/payment-service-provider/page.version/amazon-pay/obtain-an-amazon-order-reference-and-information-about-shipping-addresses.html --- {% info_block errorBox %} diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/amazon-pay/handling-orders-with-amazon-pay-api.md b/docs/pbc/all/payment-service-provider/202212.0/amazon-pay/handling-orders-with-amazon-pay-api.md similarity index 95% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/amazon-pay/handling-orders-with-amazon-pay-api.md rename to docs/pbc/all/payment-service-provider/202212.0/amazon-pay/handling-orders-with-amazon-pay-api.md index d53b4777baa..4e92b136780 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/amazon-pay/handling-orders-with-amazon-pay-api.md +++ b/docs/pbc/all/payment-service-provider/202212.0/amazon-pay/handling-orders-with-amazon-pay-api.md @@ -13,15 +13,16 @@ redirect_from: - /docs/scos/user/technology-partners/202204.0/payment-partners/amazon-pay/scos-integration/amazon-pay-api.html - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/amazon-pay/handling-orders-with-amazon-pay-api.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/amazon-pay/handling-orders-with-amazon-pay-api.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/amazon-pay/handling-orders-with-amazon-pay-api.html related: - title: Configuring Amazon Pay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/amazon-pay/configure-amazon-pay.html + link: docs/pbc/all/payment-service-provider/page.version/amazon-pay/configure-amazon-pay.html - title: Amazon Pay - State Machine - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/amazon-pay/amazon-pay-state-machine.html + link: docs/pbc/all/payment-service-provider/page.version/amazon-pay/amazon-pay-state-machine.html - title: Amazon Pay - Sandbox Simulations - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/amazon-pay/amazon-pay-sandbox-simulations.html + link: docs/pbc/all/payment-service-provider/page.version/amazon-pay/amazon-pay-sandbox-simulations.html - title: Obtaining an Amazon Order Reference and information about shipping addresses - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/amazon-pay/obtain-an-amazon-order-reference-and-information-about-shipping-addresses.html + link: docs/pbc/all/payment-service-provider/page.version/amazon-pay/obtain-an-amazon-order-reference-and-information-about-shipping-addresses.html --- So far we discussed the client-side implementation provided by Amazon Pay. On the Spryker side, the bundle provides the tools for rendering Amazon Pay widgets. diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/amazon-pay/obtain-an-amazon-order-reference-and-information-about-shipping-addresses.md b/docs/pbc/all/payment-service-provider/202212.0/amazon-pay/obtain-an-amazon-order-reference-and-information-about-shipping-addresses.md similarity index 90% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/amazon-pay/obtain-an-amazon-order-reference-and-information-about-shipping-addresses.md rename to docs/pbc/all/payment-service-provider/202212.0/amazon-pay/obtain-an-amazon-order-reference-and-information-about-shipping-addresses.md index ea7e4ff402f..19d3431bcac 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/amazon-pay/obtain-an-amazon-order-reference-and-information-about-shipping-addresses.md +++ b/docs/pbc/all/payment-service-provider/202212.0/amazon-pay/obtain-an-amazon-order-reference-and-information-about-shipping-addresses.md @@ -12,15 +12,16 @@ redirect_from: - /docs/en/amazon-order-reference-information - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/amazon-pay/obtaining-an-amazon-order-reference-and-information-about-shipping-addresses.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/amazon-pay/obtaining-an-amazon-order-reference-and-information-about-shipping-addresses.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/amazon-pay/obtain-an-amazon-order-reference-and-information-about-shipping-addresses.html related: - title: Handling orders with Amazon Pay API - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/amazon-pay/handling-orders-with-amazon-pay-api.html + link: docs/pbc/all/payment-service-provider/page.version/amazon-pay/handling-orders-with-amazon-pay-api.html - title: Configuring Amazon Pay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/amazon-pay/configure-amazon-pay.html + link: docs/pbc/all/payment-service-provider/page.version/amazon-pay/configure-amazon-pay.html - title: Amazon Pay - State Machine - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/amazon-pay/amazon-pay-state-machine.html + link: docs/pbc/all/payment-service-provider/page.version/amazon-pay/amazon-pay-state-machine.html - title: Amazon Pay - Sandbox Simulations - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/amazon-pay/amazon-pay-sandbox-simulations.html + link: docs/pbc/all/payment-service-provider/page.version/amazon-pay/amazon-pay-sandbox-simulations.html --- After successful authorization, a buyer will be redirected to an order detils page to enter all the information necessary for placing an order: address of shipment, payment method, delivery method and some calculations about taxes, possible discounts, delivery cost, etc. diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/arvato/arvato-risk-check.md b/docs/pbc/all/payment-service-provider/202212.0/arvato/arvato-risk-check.md similarity index 90% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/arvato/arvato-risk-check.md rename to docs/pbc/all/payment-service-provider/202212.0/arvato/arvato-risk-check.md index 82d6e453459..c6ae362b48f 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/arvato/arvato-risk-check.md +++ b/docs/pbc/all/payment-service-provider/202212.0/arvato/arvato-risk-check.md @@ -6,16 +6,13 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/arvato-risk-check originalArticleId: 41dea1fe-a5d6-4641-b29a-7dc2091129fe redirect_from: - - /2021080/docs/arvato-risk-check - - /2021080/docs/en/arvato-risk-check - - /docs/arvato-risk-check - - /docs/en/arvato-risk-check - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/arvato/arvato-risk-check.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/arvato/arvato-risk-check.html related: - title: Arvato - Store Order 2.0 - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/arvato/arvato-store-order.html + link: docs/pbc/all/payment-service-provider/page.version/arvato/arvato-store-order.html - title: Arvato - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/arvato/arvato.html + link: docs/pbc/all/payment-service-provider/page.version/arvato/arvato.html --- Accounted for by external credit agency data and internal existing customer- and order-details the `RiskCheck` evaluates the probability of payment default for the customer orders. diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/arvato/arvato-store-order.md b/docs/pbc/all/payment-service-provider/202212.0/arvato/arvato-store-order.md similarity index 91% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/arvato/arvato-store-order.md rename to docs/pbc/all/payment-service-provider/202212.0/arvato/arvato-store-order.md index cebe9c26d63..e4e07325722 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/arvato/arvato-store-order.md +++ b/docs/pbc/all/payment-service-provider/202212.0/arvato/arvato-store-order.md @@ -6,15 +6,13 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/arvato-store-order-2-0 originalArticleId: 24cf640b-da52-4d4e-a912-ceacb443f1cd redirect_from: - - /2021080/docs/arvato-store-order-2-0 - - /2021080/docs/en/arvato-store-order-2-0 - - /docs/arvato-store-order-2-0 - - /docs/en/arvato-store-order-2-0 - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/arvato/arvato-store-order.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/arvato/arvato-store-order.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/arvato/arvato-store-order.html +related: related: - title: Arvato - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/arvato/arvato.html + link: docs/pbc/all/payment-service-provider/page.version/arvato/arvato.html --- As soon as the order is activated in the eShop it has to be directly delivered by the service call StoreOrder in risk solution services. Based on the transmitted data a limit check is processed again. The result and action codes returned by `StoreOrder` should be analyzed and the order process should be stopped if applicable. diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/arvato/arvato.md b/docs/pbc/all/payment-service-provider/202212.0/arvato/arvato.md similarity index 79% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/arvato/arvato.md rename to docs/pbc/all/payment-service-provider/202212.0/arvato/arvato.md index dd703eb2df3..8e2a1ee160d 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/arvato/arvato.md +++ b/docs/pbc/all/payment-service-provider/202212.0/arvato/arvato.md @@ -6,14 +6,11 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/arvato originalArticleId: baf8a048-9b5c-4c45-aaab-c3093f42bc36 redirect_from: - - /2021080/docs/arvato - - /2021080/docs/en/arvato - - /docs/arvato - - /docs/en/arvato - /docs/scos/user/technology-partners/202212.0/payment-partners/arvato.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/arvato/arvato.html related: - title: Arvato - Store Order 2.0 - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/arvato/arvato-store-order.html + link: docs/pbc/all/payment-service-provider/page.version/arvato/arvato-store-order.html --- ## Partner Information @@ -24,9 +21,9 @@ related: ## Related Developer guides - * [Installing and configuring Arvato](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/arvato/install-and-configure-arvato.html) - * [Arvato - Risk Check](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/arvato/arvato-risk-check.html) - * [Arvato - Store Order](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/arvato/arvato-store-order.html) + * [Installing and configuring Arvato](/docs/pbc/all/payment-service-provider/{{page.version}}/arvato/install-and-configure-arvato.html) + * [Arvato - Risk Check](/docs/pbc/all/payment-service-provider/{{page.version}}/arvato/arvato-risk-check.html) + * [Arvato - Store Order](/docs/pbc/all/payment-service-provider/{{page.version}}/arvato/arvato-store-order.html) --- diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/arvato/install-and-configure-arvato.md b/docs/pbc/all/payment-service-provider/202212.0/arvato/install-and-configure-arvato.md similarity index 85% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/arvato/install-and-configure-arvato.md rename to docs/pbc/all/payment-service-provider/202212.0/arvato/install-and-configure-arvato.md index 048f3d31c59..45d68616d11 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/arvato/install-and-configure-arvato.md +++ b/docs/pbc/all/payment-service-provider/202212.0/arvato/install-and-configure-arvato.md @@ -6,16 +6,14 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/arvato-installation-configuration originalArticleId: 01e4a638-f2ea-4974-8f55-ee85d8745298 redirect_from: - - /2021080/docs/arvato-installation-configuration - - /2021080/docs/en/arvato-installation-configuration - - /docs/arvato-installation-configuration - - /docs/en/arvato-installation-configuration - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/arvato/installing-and-configuring-arvato.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/arvato/install-and-configure-arvato.html +related: related: - title: Arvato - Store Order 2.0 - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/arvato/arvato-store-order.html + link: docs/pbc/all/payment-service-provider/page.version/arvato/arvato-store-order.html - title: Arvato - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/arvato/arvato.html + link: docs/pbc/all/payment-service-provider/page.version/arvato/arvato.html --- {% info_block errorBox %} @@ -62,8 +60,8 @@ API URLs: | Sandbox URL | `https://integration.risk-solution-services.de/rss-services/risk-solution-services.v2.1` | Services: -* [Risk Check](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/arvato/arvato-risk-check.html) -* [Store Order](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/arvato/arvato-store-order.html) +* [Risk Check](/docs/pbc/all/payment-service-provider/{{page.version}}/arvato/arvato-risk-check.html) +* [Store Order](/docs/pbc/all/payment-service-provider/{{page.version}}/arvato/arvato-store-order.html) To implement Arvato RSS you should be familiar with concept of extending the Spryker Commerce OS. See [Extending Spryker](/docs/scos/dev/back-end-development/extend-spryker/spryker-os-module-customisation/extend-a-core-module-that-is-used-by-another.html) for more details. diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/billie.md b/docs/pbc/all/payment-service-provider/202212.0/billie.md similarity index 96% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/billie.md rename to docs/pbc/all/payment-service-provider/202212.0/billie.md index b56c2bf138c..14781a3b881 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/billie.md +++ b/docs/pbc/all/payment-service-provider/202212.0/billie.md @@ -11,6 +11,7 @@ redirect_from: - /docs/billie - /docs/en/billie - /docs/scos/user/technology-partners/202212.0/payment-partners/billie.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/billie.html --- ## Partner Information diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/billpay/billpay-switch-invoice-payments-to-a-preauthorize-mode.md b/docs/pbc/all/payment-service-provider/202212.0/billpay/billpay-switch-invoice-payments-to-a-preauthorize-mode.md similarity index 98% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/billpay/billpay-switch-invoice-payments-to-a-preauthorize-mode.md rename to docs/pbc/all/payment-service-provider/202212.0/billpay/billpay-switch-invoice-payments-to-a-preauthorize-mode.md index 7c9b44eadd6..7c83a1d5e5c 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/billpay/billpay-switch-invoice-payments-to-a-preauthorize-mode.md +++ b/docs/pbc/all/payment-service-provider/202212.0/billpay/billpay-switch-invoice-payments-to-a-preauthorize-mode.md @@ -5,15 +5,12 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/billpay-payment-methods originalArticleId: 139410c0-8709-4f24-8016-b5b8afa7b435 redirect_from: - - /2021080/docs/billpay-payment-methods - - /2021080/docs/en/billpay-payment-methods - - /docs/billpay-payment-methods - - /docs/en/billpay-payment-methods - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/billpay/billpay-switching-invoice-payments-to-a-preauthorize-mode.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/billpay/billpay-switching-invoice-payments-to-a-preauthorize-mode.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/billpay/billpay.html related: - title: Billpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/billpay/billpay.html + link: docs/pbc/all/payment-service-provider/page.version/billpay/billpay.html --- Refer to [Billpay payment information](https://www.billpay.de/en/klarna-group-for-business/) for information about payment methods. diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/billpay/billpay.md b/docs/pbc/all/payment-service-provider/202212.0/billpay/billpay.md similarity index 89% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/billpay/billpay.md rename to docs/pbc/all/payment-service-provider/202212.0/billpay/billpay.md index 31583301dfa..fbcd563a783 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/billpay/billpay.md +++ b/docs/pbc/all/payment-service-provider/202212.0/billpay/billpay.md @@ -6,11 +6,8 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/billpay originalArticleId: 1aba685d-52bb-4060-bed0-62178fa04d71 redirect_from: - - /2021080/docs/billpay - - /2021080/docs/en/billpay - - /docs/billpay - - /docs/en/billpay - /docs/scos/user/technology-partners/202212.0/payment-partners/billpay.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/billpay/billpay.html --- ## Partner Information @@ -22,8 +19,8 @@ BillPay is the DACH market leader for the preferred, local payment methods Invoi ## Related Developer guides -* [Billpay - Switching invoice payments to a preauthorize mode](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/billpay/billpay-switch-invoice-payments-to-a-preauthorize-mode.html) -* [Integrating Billpay](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/billpay/integrate-billpay.html) +* [Billpay - Switching invoice payments to a preauthorize mode](/docs/pbc/all/payment-service-provider/{{page.version}}/billpay/billpay-switch-invoice-payments-to-a-preauthorize-mode.html) +* [Integrating Billpay](/docs/pbc/all/payment-service-provider/{{page.version}}/billpay/integrate-billpay.html) --- diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/billpay/integrate-billpay.md b/docs/pbc/all/payment-service-provider/202212.0/billpay/integrate-billpay.md similarity index 93% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/billpay/integrate-billpay.md rename to docs/pbc/all/payment-service-provider/202212.0/billpay/integrate-billpay.md index 50e96f37d82..a3e19685961 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/billpay/integrate-billpay.md +++ b/docs/pbc/all/payment-service-provider/202212.0/billpay/integrate-billpay.md @@ -5,15 +5,12 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/billpay-integration originalArticleId: 3d4bf922-652c-45c7-b130-951015ff3b65 redirect_from: - - /2021080/docs/billpay-integration - - /2021080/docs/en/billpay-integration - - /docs/billpay-integration - - /docs/en/billpay-integration - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/billpay/integrating-billpay.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/billpay/integrating-billpay.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/billpay/billpay.html related: - title: Billpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/billpay/billpay.html + link: docs/pbc/all/payment-service-provider/page.version/billpay/billpay.html --- Billpay offers multiple payment methods (Invoice, Direct Debit, PayLater, Instalment). Availability of payment methods differs from country to country. Please contact Billpay directly or visit the [Billpay website](https://www.billpay.de/en/)e for details. diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/braintree/braintree-performing-requests.md b/docs/pbc/all/payment-service-provider/202212.0/braintree/braintree-performing-requests.md similarity index 88% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/braintree/braintree-performing-requests.md rename to docs/pbc/all/payment-service-provider/202212.0/braintree/braintree-performing-requests.md index 1e57a2d7fc6..67f27e38615 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/braintree/braintree-performing-requests.md +++ b/docs/pbc/all/payment-service-provider/202212.0/braintree/braintree-performing-requests.md @@ -6,19 +6,16 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/braintree-performing-requests originalArticleId: 866b7c18-891a-45db-bc3d-8ac04b89ee80 redirect_from: - - /2021080/docs/braintree-performing-requests - - /2021080/docs/en/braintree-performing-requests - - /docs/braintree-performing-requests - - /docs/en/braintree-performing-requests - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/braintree/braintree-performing-requests.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/braintree/braintree-performing-requests.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/braintree/braintree-performing-requests.html related: - title: Installing and configuring Braintree - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/braintree/install-and-configure-braintree.html + link: docs/pbc/all/payment-service-provider/page.version/braintree/install-and-configure-braintree.html - title: Integrating Braintree - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/braintree/integrate-braintree.html + link: docs/pbc/all/payment-service-provider/page.version/braintree/integrate-braintree.html - title: Braintree - Request workflow - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/braintree/braintree-request-workflow.html + link: docs/pbc/all/payment-service-provider/page.version/braintree/braintree-request-workflow.html --- In order to perform the necessary requests in the project based on Spryker Commerce OS or SCOS, you can easily use the implemented state machine commands and conditions. The next section gives a summary of them. You can also use the facade methods directly which, however, are invoked by the state machine. diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/braintree/braintree-request-workflow.md b/docs/pbc/all/payment-service-provider/202212.0/braintree/braintree-request-workflow.md similarity index 71% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/braintree/braintree-request-workflow.md rename to docs/pbc/all/payment-service-provider/202212.0/braintree/braintree-request-workflow.md index c5d0255eb40..c5467d5c463 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/braintree/braintree-request-workflow.md +++ b/docs/pbc/all/payment-service-provider/202212.0/braintree/braintree-request-workflow.md @@ -6,19 +6,16 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/braintree-workflow originalArticleId: 9cfdb1b2-c552-40f0-9856-f39230b79e90 redirect_from: - - /2021080/docs/braintree-workflow - - /2021080/docs/en/braintree-workflow - - /docs/braintree-workflow - - /docs/en/braintree-workflow - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/braintree/braintree-request-workflow.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/braintree/braintree-request-workflow.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/braintree/braintree-request-workflow.html related: - title: Installing and configuring Braintree - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/braintree/install-and-configure-braintree.html + link: docs/pbc/all/payment-service-provider/page.version/braintree/install-and-configure-braintree.html - title: Integrating Braintree - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/braintree/integrate-braintree.html + link: docs/pbc/all/payment-service-provider/page.version/braintree/integrate-braintree.html - title: Braintree - Performing Requests - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/braintree/braintree-performing-requests.html + link: docs/pbc/all/payment-service-provider/page.version/braintree/braintree-performing-requests.html --- Both credit card and PayPal utilize the same request flow in: diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/braintree/braintree.md b/docs/pbc/all/payment-service-provider/202212.0/braintree/braintree.md similarity index 76% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/braintree/braintree.md rename to docs/pbc/all/payment-service-provider/202212.0/braintree/braintree.md index 9a83f064a21..32fd271fbdc 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/braintree/braintree.md +++ b/docs/pbc/all/payment-service-provider/202212.0/braintree/braintree.md @@ -6,20 +6,17 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/braintree originalArticleId: 940c4c06-b484-4eba-b262-14c9c8ba1a58 redirect_from: - - /2021080/docs/braintree - - /2021080/docs/en/braintree - - /docs/braintree - - /docs/en/braintree - /docs/scos/user/technology-partners/202212.0/payment-partners/braintree.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/braintree/braintree.html related: - title: Installing and configuring Braintree - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/braintree/install-and-configure-braintree.html + link: docs/pbc/all/payment-service-provider/page.version/braintree/install-and-configure-braintree.html - title: Integrating Braintree - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/braintree/integrate-braintree.html + link: docs/pbc/all/payment-service-provider/page.version/braintree/integrate-braintree.html - title: Braintree - Performing Requests - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/braintree/braintree-performing-requests.html + link: docs/pbc/all/payment-service-provider/page.version/braintree/braintree-performing-requests.html - title: Braintree - Request workflow - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/braintree/braintree-request-workflow.html + link: docs/pbc/all/payment-service-provider/page.version/braintree/braintree-request-workflow.html --- [ABOUT BRAINTREE](https://www.braintreepayments.com/) @@ -52,10 +49,10 @@ Because of PCI compliance reasons, credit card data is communicated to the third ## Related Developer guides -* [Installing and configuring Braintree](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/braintree/install-and-configure-braintree.html) -* [Integrating Braintree](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/braintree/integrate-braintree.html) -* [Braintree - Request workflow](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/braintree/braintree-request-workflow.html) -* [Braintree - Performing requests](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/braintree/braintree-performing-requests.html) +* [Installing and configuring Braintree](/docs/pbc/all/payment-service-provider/{{page.version}}/braintree/install-and-configure-braintree.html) +* [Integrating Braintree](/docs/pbc/all/payment-service-provider/{{page.version}}/braintree/integrate-braintree.html) +* [Braintree - Request workflow](/docs/pbc/all/payment-service-provider/{{page.version}}/braintree/braintree-request-workflow.html) +* [Braintree - Performing requests](/docs/pbc/all/payment-service-provider/{{page.version}}/braintree/braintree-performing-requests.html) --- diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/braintree/install-and-configure-braintree.md b/docs/pbc/all/payment-service-provider/202212.0/braintree/install-and-configure-braintree.md similarity index 93% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/braintree/install-and-configure-braintree.md rename to docs/pbc/all/payment-service-provider/202212.0/braintree/install-and-configure-braintree.md index 7a7381de963..d4eae57ee25 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/braintree/install-and-configure-braintree.md +++ b/docs/pbc/all/payment-service-provider/202212.0/braintree/install-and-configure-braintree.md @@ -6,19 +6,16 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/braintree-configuration originalArticleId: 50dfb6cf-d660-49f5-93cb-6bda88ca88f1 redirect_from: - - /2021080/docs/braintree-configuration - - /2021080/docs/en/braintree-configuration - - /docs/braintree-configuration - - /docs/en/braintree-configuration - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/braintree/installing-and-configuring-braintree.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/braintree/installing-and-configuring-braintree.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/braintree/install-and-configure-braintree.html related: - title: Integrating Braintree - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/braintree/integrate-braintree.html + link: docs/pbc/all/payment-service-provider/page.version/braintree/integrate-braintree.html - title: Braintree - Performing Requests - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/braintree/braintree-performing-requests.html + link: docs/pbc/all/payment-service-provider/page.version/braintree/braintree-performing-requests.html - title: Braintree - Request workflow - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/braintree/braintree-request-workflow.html + link: docs/pbc/all/payment-service-provider/page.version/braintree/braintree-request-workflow.html --- To configure Braintree module for Spryker Commerce OS (SCOS), do the following: diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/braintree/integrate-braintree.md b/docs/pbc/all/payment-service-provider/202212.0/braintree/integrate-braintree.md similarity index 90% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/braintree/integrate-braintree.md rename to docs/pbc/all/payment-service-provider/202212.0/braintree/integrate-braintree.md index 9154b669362..9e9234e3871 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/braintree/integrate-braintree.md +++ b/docs/pbc/all/payment-service-provider/202212.0/braintree/integrate-braintree.md @@ -6,18 +6,15 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/braintree-integration originalArticleId: bde8e23d-6b95-420a-aefd-151293c40786 redirect_from: - - /2021080/docs/braintree-integration - - /2021080/docs/en/braintree-integration - - /docs/braintree-integration - - /docs/en/braintree-integration - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/braintree/integrating-braintree.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/braintree/integrate-braintree.html related: - title: Installing and configuring Braintree - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/braintree/install-and-configure-braintree.html + link: docs/pbc/all/payment-service-provider/page.version/braintree/install-and-configure-braintree.html - title: Braintree - Performing Requests - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/braintree/braintree-performing-requests.html + link: docs/pbc/all/payment-service-provider/page.version/braintree/braintree-performing-requests.html - title: Braintree - Request workflow - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/braintree/braintree-request-workflow.html + link: docs/pbc/all/payment-service-provider/page.version/braintree/braintree-request-workflow.html --- {% info_block errorBox %} @@ -28,7 +25,7 @@ Gift cards are not compatible with Braintree. We are working on resolving this c ## Prerequisites -Before proceeding with the integration, make sure you have [installed and configured](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/braintree/install-and-configure-braintree.html) the Braintree module. +Before proceeding with the integration, make sure you have [installed and configured](/docs/pbc/all/payment-service-provider/{{page.version}}/braintree/install-and-configure-braintree.html) the Braintree module. ## Frontend integration diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/computop-api-calls.md b/docs/pbc/all/payment-service-provider/202212.0/computop/computop-api-calls.md similarity index 61% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/computop-api-calls.md rename to docs/pbc/all/payment-service-provider/202212.0/computop/computop-api-calls.md index 42307956372..6d2b2c5a924 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/computop-api-calls.md +++ b/docs/pbc/all/payment-service-provider/202212.0/computop/computop-api-calls.md @@ -6,31 +6,29 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/computop-api-details originalArticleId: 40f89caf-03ea-43b6-975d-364f30c29f52 redirect_from: - - /2021080/docs/computop-api-details - - /2021080/docs/en/computop-api-details - - /docs/computop-api-details - - /docs/en/computop-api-details + - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/computop/computop-api-calls.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/computop/computop-api-calls.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/computop-api-calls.html related: - title: Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/computop.html - title: Integrating the Sofort payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html - title: Integrating the PayPal payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html - title: Integrating the Direct Debit payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html - title: Integrating the iDeal payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html - title: Integrating the Credit Card payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html - title: Integrating the Easy Credit payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html - title: Integrating the Paydirekt payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html - title: Integrating the CRIF payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.html --- ## Authorization Call: diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/computop-oms-plugins.md b/docs/pbc/all/payment-service-provider/202212.0/computop/computop-oms-plugins.md similarity index 51% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/computop-oms-plugins.md rename to docs/pbc/all/payment-service-provider/202212.0/computop/computop-oms-plugins.md index b1409893440..f62f7fa4043 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/computop-oms-plugins.md +++ b/docs/pbc/all/payment-service-provider/202212.0/computop/computop-oms-plugins.md @@ -6,33 +6,30 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/computop-oms-details originalArticleId: 24fc01dc-bae5-4689-a6bb-c93a26e07dba redirect_from: - - /2021080/docs/computop-oms-details - - /2021080/docs/en/computop-oms-details - - /docs/computop-oms-details - - /docs/en/computop-oms-details - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/computop/computop-oms-plugins.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/computop/computop-oms-plugins.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/computop-oms-plugins.html related: - title: Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/computop.html - title: Integrating the Sofort payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html - title: Integrating the PayPal payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html - title: Integrating the PayNow payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html - title: Integrating the Easy Credit payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html - title: Computop API calls - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/computop-api-calls.html + link: docs/pbc/all/payment-service-provider/page.version/computop/computop-api-calls.html - title: Integrating the iDeal payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html - title: Integrating the Direct Debit payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html - title: Integrating the Credit Card payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html - title: Integrating the CRIF payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.html --- The following plugins are used for performing calls to Paygate during OMS operation. diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/computop.md b/docs/pbc/all/payment-service-provider/202212.0/computop/computop.md similarity index 72% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/computop.md rename to docs/pbc/all/payment-service-provider/202212.0/computop/computop.md index a92dee8329d..529cda846a1 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/computop.md +++ b/docs/pbc/all/payment-service-provider/202212.0/computop/computop.md @@ -6,32 +6,29 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/computop originalArticleId: afe86236-29c0-44e5-94ed-8df656c7a9de redirect_from: - - /2021080/docs/computop - - /2021080/docs/en/computop - - /docs/computop - - /docs/en/computop - /docs/scos/user/technology-partners/202212.0/payment-partners/computop.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/computop.html related: - title: Integrating the Sofort payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html - title: Integrating the PayPal payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html - title: Computop API calls - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/computop-api-calls.html + link: docs/pbc/all/payment-service-provider/page.version/computop/computop-api-calls.html - title: Integrating the PayNow payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html - title: Integrating the Direct Debit payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html - title: Integrating the iDeal payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html - title: Integrating the Сredit Сard payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html - title: Integrating the Easy Credit payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html - title: Integrating the Paydirekt payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html - title: Integrating the CRIF payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.html --- ## Partner Information @@ -67,10 +64,10 @@ Push notifications speed up order placement process for customers. They allow to ## Related Developer guides -* [Installing and configuring Computop](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/computop/install-and-configure-computop.html) -* [Integrating Computop](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/computop/integrate-computop.html) -* [Computop API calls](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/computop/computop-api-calls.html) -* [Computop - OMS plugins](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/computop/computop-oms-plugins.html) +* [Installing and configuring Computop](/docs/pbc/all/payment-service-provider/{{page.version}}/computop/install-and-configure-computop.html) +* [Integrating Computop](/docs/pbc/all/payment-service-provider/{{page.version}}/computop/integrate-computop.html) +* [Computop API calls](/docs/pbc/all/payment-service-provider/{{page.version}}/computop/computop-api-calls.html) +* [Computop - OMS plugins](/docs/pbc/all/payment-service-provider/{{page.version}}/computop/computop-oms-plugins.html) * [Integrating the Сredit Сard payment method for Computop](/docs/scos/dev/technology-partner-guides/202108.0/payment-partners/computop/integrating-payment-methods-for-computop/integrating-the-credit-card-payment-method-for-computop.html) * [Integrating the CRIF payment method for Computop](/docs/scos/dev/technology-partner-guides/202108.0/payment-partners/computop/integrating-payment-methods-for-computop/integrating-the-crif-payment-method-for-computop.html) * [Integrating the Direct Debit payment method for Computop](/docs/scos/dev/technology-partner-guides/202108.0/payment-partners/computop/integrating-payment-methods-for-computop/integrating-the-direct-debit-payment-method-for-computop.html) diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/install-and-configure-computop.md b/docs/pbc/all/payment-service-provider/202212.0/computop/install-and-configure-computop.md similarity index 90% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/install-and-configure-computop.md rename to docs/pbc/all/payment-service-provider/202212.0/computop/install-and-configure-computop.md index 36ee55f4239..e4bb83a04ca 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/install-and-configure-computop.md +++ b/docs/pbc/all/payment-service-provider/202212.0/computop/install-and-configure-computop.md @@ -5,12 +5,9 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/computop-installation-and-configuration originalArticleId: 7d6fd0b4-0e5e-41ac-9788-0361d3252a58 redirect_from: - - /2021080/docs/computop-installation-and-configuration - - /2021080/docs/en/computop-installation-and-configuration - - /docs/computop-installation-and-configuration - - /docs/en/computop-installation-and-configuration - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/computop/installing-and-configuring-computop.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/computop/installing-and-configuring-computop.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/install-and-configure-computop.html --- This topic describes how to integrate Computop into a Spryker project by installing and configuring the Computop module. @@ -23,14 +20,14 @@ The `SprykerEco.Computop` module includes the integrations: The `SprykerEco.Computop` module provides the following payment methods: -* [Credit Card](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html) -* [Direct Debit](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html) -* [EasyCredit](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html) -* [iDeal](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html) -* [Paydirekt](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html) -* [PayNow](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html) -* [PayPal](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html) -* [SofortÜberweisung](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html) +* [Credit Card](/docs/pbc/all/payment-service-provider/{{page.version}}/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html) +* [Direct Debit](/docs/pbc/all/payment-service-provider/{{page.version}}/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html) +* [EasyCredit](/docs/pbc/all/payment-service-provider/{{page.version}}/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html) +* [iDeal](/docs/pbc/all/payment-service-provider/{{page.version}}/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html) +* [Paydirekt](/docs/pbc/all/payment-service-provider/{{page.version}}/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html) +* [PayNow](/docs/pbc/all/payment-service-provider/{{page.version}}/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html) +* [PayPal](/docs/pbc/all/payment-service-provider/{{page.version}}/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html) +* [SofortÜberweisung](/docs/pbc/all/payment-service-provider/{{page.version}}/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html) * PayU CEE Single * PayPal Express diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/integrate-computop.md b/docs/pbc/all/payment-service-provider/202212.0/computop/integrate-computop.md similarity index 99% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/integrate-computop.md rename to docs/pbc/all/payment-service-provider/202212.0/computop/integrate-computop.md index c2875d1f425..aece05d7f82 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/integrate-computop.md +++ b/docs/pbc/all/payment-service-provider/202212.0/computop/integrate-computop.md @@ -5,11 +5,8 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/computop-integration-into-project originalArticleId: dee3b189-78b2-4dd2-ae97-45506831a9b8 redirect_from: - - /2021080/docs/computop-integration-into-project - - /2021080/docs/en/computop-integration-into-project - - /docs/computop-integration-into-project - - /docs/en/computop-integration-into-project - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/computop/integrating-computop.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/integrate-computop.html --- {% info_block errorBox %} @@ -22,7 +19,7 @@ This article provides step-by-step instructions on integrating the Computop modu ## Prerequisites -Prior to integrating Computop into your project, make sure you [installed and configured the Computop module](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/computop/install-and-configure-computop.html). +Prior to integrating Computop into your project, make sure you [installed and configured the Computop module](/docs/pbc/all/payment-service-provider/{{page.version}}/computop/install-and-configure-computop.html). ## Integrating Computop into your project @@ -1574,7 +1571,7 @@ namespace Pyz\Yves\ShopApplication; ### CRIF configuration -To configure [CRIF](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.html), do the following: +To configure [CRIF](/docs/pbc/all/payment-service-provider/{{page.version}}/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.html), do the following: 1. Adjust `PaymentDependencyProvider` to use `ComputopPaymentMethodFilterPlugin`: @@ -1776,7 +1773,7 @@ class CheckoutPageDependencyProvider extends SprykerShopCheckoutPageDependencyPr ## Integration into a project -To integrate the Computop module, make sure you [installed and configured it](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/computop/install-and-configure-computop.html). +To integrate the Computop module, make sure you [installed and configured it](/docs/pbc/all/payment-service-provider/{{page.version}}/computop/install-and-configure-computop.html). ## Test mode diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.md b/docs/pbc/all/payment-service-provider/202212.0/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.md similarity index 69% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.md rename to docs/pbc/all/payment-service-provider/202212.0/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.md index 7e966eeac26..79d7ea850b9 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.md +++ b/docs/pbc/all/payment-service-provider/202212.0/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.md @@ -6,36 +6,33 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/computop-credit-card originalArticleId: 682d66ae-585b-4de5-bfad-3ab51281697f redirect_from: - - /2021080/docs/computop-credit-card - - /2021080/docs/en/computop-credit-card - - /docs/computop-credit-card - - /docs/en/computop-credit-card - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/computop/integrating-payment-methods-for-computop/integrating-the-credit-card-payment-method-for-computop.html - /docs/scos/dev/technology-partner-guides/202204.0/payment-partners/computop/integrating-payment-methods-for-computop/integrating-the-credit-card-payment-method-for-computop.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/computop/integrating-payment-methods-for-computop/integrating-the-credit-card-payment-method-for-computop.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html related: - title: Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/computop.html - title: Integrating the Sofort payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html - title: Integrating the PayPal payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html - title: Integrating the PayNow payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html - title: Computop API calls - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/computop-api-calls.html + link: docs/pbc/all/payment-service-provider/page.version/computop/computop-api-calls.html - title: Integrating the Direct Debit payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html - title: Integrating the iDeal payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html - title: Integrating the Easy Credit payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html - title: Integrating the Paydirekt payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html - title: Integrating the CRIF payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.html - title: Computop - OMS plugins - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/computop-oms-plugins.html + link: docs/pbc/all/payment-service-provider/page.version/computop/computop-oms-plugins.html --- Example State Machine: diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.md b/docs/pbc/all/payment-service-provider/202212.0/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.md similarity index 82% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.md rename to docs/pbc/all/payment-service-provider/202212.0/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.md index 8bd00b0adb3..71acf533e11 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.md +++ b/docs/pbc/all/payment-service-provider/202212.0/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.md @@ -6,34 +6,31 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/computop-crif originalArticleId: 9e295864-bffd-4b37-b8a8-33c413bc46db redirect_from: - - /2021080/docs/computop-crif - - /2021080/docs/en/computop-crif - - /docs/computop-crif - - /docs/en/computop-crif - /docs/scos/dev/technology-partner-guides/202001.0/payment-partners/computop/integrating-payment-methods-for-computop/integrating-the-crif-payment-method-for-computop.html - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/computop/integrating-payment-methods-for-computop/integrating-the-crif-payment-method-for-computop.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/computop/integrating-payment-methods-for-computop/integrating-the-crif-payment-method-for-computop.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.html related: - title: Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/computop.html - title: Integrating the Sofort payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html - title: Integrating the PayPal payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html - title: Integrating the PayNow payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html - title: Computop API calls - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/computop-api-calls.html + link: docs/pbc/all/payment-service-provider/page.version/computop/computop-api-calls.html - title: Integrating the Direct Debit payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html - title: Integrating the iDeal payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html - title: Computop - Credit Card - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html - title: Integrating the Easy Credit payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html - title: Integrating the Paydirekt payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html --- ## General Information About CRIF diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.md b/docs/pbc/all/payment-service-provider/202212.0/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.md similarity index 64% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.md rename to docs/pbc/all/payment-service-provider/202212.0/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.md index 06180ed22f3..2db92f45fa5 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.md +++ b/docs/pbc/all/payment-service-provider/202212.0/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.md @@ -6,33 +6,30 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/computop-direct-debit originalArticleId: 4fc82f9b-f9fb-4608-9f1c-59f42cf54619 redirect_from: - - /2021080/docs/computop-direct-debit - - /2021080/docs/en/computop-direct-debit - - /docs/computop-direct-debit - - /docs/en/computop-direct-debit - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/computop/integrating-payment-methods-for-computop/integrating-the-direct-debit-payment-method-for-computop.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/computop/integrating-payment-methods-for-computop/integrating-the-direct-debit-payment-method-for-computop.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html related: - title: Integrating the Sofort payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html - title: Integrating the PayPal payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html - title: Integrating the PayNow payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html - title: Integrating the Easy Credit payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html - title: Computop API calls - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/computop-api-calls.html + link: docs/pbc/all/payment-service-provider/page.version/computop/computop-api-calls.html - title: Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/computop.html - title: Integrating the iDeal payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html - title: Computop - Credit Card - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html - title: Integrating the CRIF payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.html - title: Integrating the Paydirekt payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html --- Example State Machine: diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.md b/docs/pbc/all/payment-service-provider/202212.0/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.md similarity index 66% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.md rename to docs/pbc/all/payment-service-provider/202212.0/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.md index a0f32b9bc82..4077c1d10fb 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.md +++ b/docs/pbc/all/payment-service-provider/202212.0/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.md @@ -12,27 +12,28 @@ redirect_from: - /docs/en/computop-easy-credit - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/computop/integrating-payment-methods-for-computop/integrating-the-easy-credit-payment-method-for-computop.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/computop/integrating-payment-methods-for-computop/integrating-the-easy-credit-payment-method-for-computop.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html related: - title: Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/computop.html - title: Integrating the Sofort payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html - title: Integrating the PayPal payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html - title: Integrating the PayNow payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html - title: Computop API calls - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/computop-api-calls.html + link: docs/pbc/all/payment-service-provider/page.version/computop/computop-api-calls.html - title: Integrating the iDeal payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html - title: Integrating the Direct Debit payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html - title: Computop - Credit Card - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html - title: Integrating the CRIF payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.html - title: Integrating the Paydirekt payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html --- Example State Machine diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.md b/docs/pbc/all/payment-service-provider/202212.0/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.md similarity index 66% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.md rename to docs/pbc/all/payment-service-provider/202212.0/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.md index 77c282bc565..9f64c063dec 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.md +++ b/docs/pbc/all/payment-service-provider/202212.0/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.md @@ -12,23 +12,24 @@ redirect_from: - /docs/en/computop-ideal - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/computop/integrating-payment-methods-for-computop/integrating-the-ideal-payment-method-for-computop.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/computop/integrating-payment-methods-for-computop/integrating-the-ideal-payment-method-for-computop.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html related: - title: Integrating the Sofort payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html - title: Integrating the PayPal payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html - title: Integrating the PayNow payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html - title: Integrating the Easy Credit payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html - title: Integrating the Direct Debit payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html - title: Computop - Credit Card - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html - title: Integrating the CRIF payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.html - title: Integrating the Paydirekt payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html --- Example State Machine: diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.md b/docs/pbc/all/payment-service-provider/202212.0/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.md similarity index 63% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.md rename to docs/pbc/all/payment-service-provider/202212.0/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.md index eb643923737..9f934ee183c 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.md +++ b/docs/pbc/all/payment-service-provider/202212.0/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.md @@ -6,33 +6,30 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/computop-paydirekt originalArticleId: a4c9059f-8244-4c34-b7e9-9bf7d5998f2e redirect_from: - - /2021080/docs/computop-paydirekt - - /2021080/docs/en/computop-paydirekt - - /docs/computop-paydirekt - - /docs/en/computop-paydirekt - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/computop/integrating-payment-methods-for-computop/integrating-the-paydirekt-payment-method-for-computop.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/computop/integrating-payment-methods-for-computop/integrating-the-paydirekt-payment-method-for-computop.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html related: - title: Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/computop.html - title: Integrating the Sofort payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html - title: Integrating the PayPal payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html - title: Integrating the PayNow payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html - title: Integrating the Easy Credit payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html - title: Computop API calls - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/computop-api-calls.html + link: docs/pbc/all/payment-service-provider/page.version/computop/computop-api-calls.html - title: Integrating the iDeal payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html - title: Computop - OMS plugins - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/computop-oms-plugins.html + link: docs/pbc/all/payment-service-provider/page.version/computop/computop-oms-plugins.html - title: Integrating the Direct Debit payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html - title: Computop - Credit Card - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html --- Example State Machine: diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.md b/docs/pbc/all/payment-service-provider/202212.0/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.md similarity index 86% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.md rename to docs/pbc/all/payment-service-provider/202212.0/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.md index 62f229d93ff..b612e3d7c59 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.md +++ b/docs/pbc/all/payment-service-provider/202212.0/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.md @@ -6,33 +6,30 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/computop-paynow originalArticleId: 5b27c38c-8d44-4a1d-9bdf-fb542362df8d redirect_from: - - /2021080/docs/computop-paynow - - /2021080/docs/en/computop-paynow - - /docs/computop-paynow - - /docs/en/computop-paynow - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/computop/integrating-payment-methods-for-computop/integrating-the-paynow-payment-method-for-computop.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/computop/integrating-payment-methods-for-computop/integrating-the-paynow-payment-method-for-computop.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html related: - title: Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/computop.html - title: Integrating the Sofort payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html - title: Integrating the PayPal payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html - title: Integrating the Easy Credit payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html - title: Computop API calls - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/computop-api-calls.html + link: docs/pbc/all/payment-service-provider/page.version/computop/computop-api-calls.html - title: Integrating the iDeal payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html - title: Integrating the Paydirekt payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html - title: Computop - OMS plugins - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/computop-oms-plugins.html + link: docs/pbc/all/payment-service-provider/page.version/computop/computop-oms-plugins.html - title: Integrating the Direct Debit payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html - title: Computop - Credit Card - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html --- Example State Machine diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.md b/docs/pbc/all/payment-service-provider/202212.0/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.md similarity index 60% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.md rename to docs/pbc/all/payment-service-provider/202212.0/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.md index fca088c4ff2..3efe27192ac 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.md +++ b/docs/pbc/all/payment-service-provider/202212.0/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.md @@ -6,33 +6,30 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/computop-paypal originalArticleId: 199b0408-9355-41f0-bdc9-78cb050afe0c redirect_from: - - /2021080/docs/computop-paypal - - /2021080/docs/en/computop-paypal - - /docs/computop-paypal - - /docs/en/computop-paypal - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/computop/integrating-payment-methods-for-computop/integrating-the-paypal-payment-method-for-computop.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/computop/integrating-payment-methods-for-computop/integrating-the-paypal-payment-method-for-computop.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paypal-payment-method-for-computop.html related: - title: Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/computop.html - title: Integrating the Sofort payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html - title: Integrating the PayNow payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html - title: Integrating the Easy Credit payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html - title: Computop API calls - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/computop-api-calls.html + link: docs/pbc/all/payment-service-provider/page.version/computop/computop-api-calls.html - title: Integrating the iDeal payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html - title: Integrating the Paydirekt payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html - title: Computop - OMS plugins - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/computop-oms-plugins.html + link: docs/pbc/all/payment-service-provider/page.version/computop/computop-oms-plugins.html - title: Integrating the Direct Debit payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html - title: Computop - Credit Card - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html --- Example State Machine diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.md b/docs/pbc/all/payment-service-provider/202212.0/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.md similarity index 66% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.md rename to docs/pbc/all/payment-service-provider/202212.0/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.md index 28e64285c9e..b89f600a9cd 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.md +++ b/docs/pbc/all/payment-service-provider/202212.0/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.md @@ -6,35 +6,32 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/computop-sofort originalArticleId: 0d22997c-4a0c-4a8d-8031-e705869d05b8 redirect_from: - - /2021080/docs/computop-sofort - - /2021080/docs/en/computop-sofort - - /docs/computop-sofort - - /docs/en/computop-sofort - /docs/scos/dev/technology-partner-guides/202001.0/payment-partners/computop/integrating-payment-methods-for-computop/integrating-the-sofort-payment-method-for-computop.html - /docs/scos/dev/technology-partner-guides/202005.0/payment-partners/computop/integrating-payment-methods-for-computop/integrating-the-sofort-payment-method-for-computop.html - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/computop/integrating-payment-methods-for-computop/integrating-the-sofort-payment-method-for-computop.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/computop/integrating-payment-methods-for-computop/integrating-the-sofort-payment-method-for-computop.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-sofort-payment-method-for-computop.html related: - title: Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/computop.html - title: Integrating the PayNow payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-paynow-payment-method-for-computop.html - title: Integrating the Easy Credit payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-easy-credit-payment-method-for-computop.html - title: Computop API calls - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/computop-api-calls.html + link: docs/pbc/all/payment-service-provider/page.version/computop/computop-api-calls.html - title: Integrating the iDeal payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-ideal-payment-method-for-computop.html - title: Integrating the Paydirekt payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-paydirekt-payment-method-for-computop.html - title: Computop - OMS plugins - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/computop-oms-plugins.html + link: docs/pbc/all/payment-service-provider/page.version/computop/computop-oms-plugins.html - title: Integrating the Direct Debit payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-direct-debit-payment-method-for-computop.html - title: Computop - Credit Card - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-credit-card-payment-method-for-computop.html - title: Integrating the CRIF payment method for Computop - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.html + link: docs/pbc/all/payment-service-provider/page.version/computop/integrate-payment-methods-for-computop/integrate-the-crif-payment-method-for-computop.html --- Example State Machine: diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/crefopay/crefopay-callbacks.md b/docs/pbc/all/payment-service-provider/202212.0/crefopay/crefopay-callbacks.md similarity index 61% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/crefopay/crefopay-callbacks.md rename to docs/pbc/all/payment-service-provider/202212.0/crefopay/crefopay-callbacks.md index 715ff92d78d..19da061505c 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/crefopay/crefopay-callbacks.md +++ b/docs/pbc/all/payment-service-provider/202212.0/crefopay/crefopay-callbacks.md @@ -6,25 +6,22 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/crefopay-callback originalArticleId: 620ac3f8-81fc-4aa3-b8a4-cc489dad20b5 redirect_from: - - /2021080/docs/crefopay-callback - - /2021080/docs/en/crefopay-callback - - /docs/crefopay-callback - - /docs/en/crefopay-callback - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/crefopay/crefopay-callbacks.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/crefopay/crefopay-callbacks.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/crefopay/crefopay-callbacks.html related: - title: Integrating CrefoPay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/crefopay/integrate-crefopay.html + link: docs/pbc/all/payment-service-provider/page.version/crefopay/integrate-crefopay.html - title: Installing and configuring CrefoPay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/crefopay/install-and-configure-crefopay.html + link: docs/pbc/all/payment-service-provider/page.version/crefopay/install-and-configure-crefopay.html - title: CrefoPay—Enabling B2B payments - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/crefopay/crefopay-enable-b2b-payments.html + link: docs/pbc/all/payment-service-provider/page.version/crefopay/crefopay-enable-b2b-payments.html - title: CrefoPay payment methods - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/crefopay/crefopay-payment-methods.html + link: docs/pbc/all/payment-service-provider/page.version/crefopay/crefopay-payment-methods.html - title: CrefoPay capture and refund Processes - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/crefopay/crefopay-capture-and-refund-processes.html + link: docs/pbc/all/payment-service-provider/page.version/crefopay/crefopay-capture-and-refund-processes.html - title: CrefoPay notifications - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/crefopay/crefopay-notifications.html + link: docs/pbc/all/payment-service-provider/page.version/crefopay/crefopay-notifications.html --- Callbacks are redirects performed by the CrefoPay system. The CrefoPay system redirects customers back to the URLs configured for the merchants shop. For each shop, you can define a single URL of each of the following types: confirmation, success and error. diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/crefopay/crefopay-capture-and-refund-processes.md b/docs/pbc/all/payment-service-provider/202212.0/crefopay/crefopay-capture-and-refund-processes.md similarity index 73% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/crefopay/crefopay-capture-and-refund-processes.md rename to docs/pbc/all/payment-service-provider/202212.0/crefopay/crefopay-capture-and-refund-processes.md index 41dbe4bc011..38a89dcbaa7 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/crefopay/crefopay-capture-and-refund-processes.md +++ b/docs/pbc/all/payment-service-provider/202212.0/crefopay/crefopay-capture-and-refund-processes.md @@ -12,21 +12,22 @@ redirect_from: - /docs/en/crefopay-capture-refund-processes - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/crefopay/crefopay-capture-and-refund-processes.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/crefopay/crefopay-capture-and-refund-processes.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/crefopay/crefopay-capture-and-refund-processes.html related: - title: Integrating CrefoPay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/crefopay/integrate-crefopay.html + link: docs/pbc/all/payment-service-provider/page.version/crefopay/integrate-crefopay.html - title: CrefoPay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/crefopay/crefopay.html + link: docs/pbc/all/payment-service-provider/page.version/crefopay/crefopay.html - title: Installing and configuring CrefoPay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/crefopay/install-and-configure-crefopay.html + link: docs/pbc/all/payment-service-provider/page.version/crefopay/install-and-configure-crefopay.html - title: CrefoPay callbacks - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/crefopay/crefopay-callbacks.html + link: docs/pbc/all/payment-service-provider/page.version/crefopay/crefopay-callbacks.html - title: CrefoPay—Enabling B2B payments - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/crefopay/crefopay-enable-b2b-payments.html + link: docs/pbc/all/payment-service-provider/page.version/crefopay/crefopay-enable-b2b-payments.html - title: CrefoPay payment methods - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/crefopay/crefopay-payment-methods.html + link: docs/pbc/all/payment-service-provider/page.version/crefopay/crefopay-payment-methods.html - title: CrefoPay notifications - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/crefopay/crefopay-notifications.html + link: docs/pbc/all/payment-service-provider/page.version/crefopay/crefopay-notifications.html --- CrefoPay module can have different capture and refund processes: diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/crefopay/crefopay-enable-b2b-payments.md b/docs/pbc/all/payment-service-provider/202212.0/crefopay/crefopay-enable-b2b-payments.md similarity index 66% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/crefopay/crefopay-enable-b2b-payments.md rename to docs/pbc/all/payment-service-provider/202212.0/crefopay/crefopay-enable-b2b-payments.md index 7a518d759ee..1afd1e297ea 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/crefopay/crefopay-enable-b2b-payments.md +++ b/docs/pbc/all/payment-service-provider/202212.0/crefopay/crefopay-enable-b2b-payments.md @@ -12,21 +12,22 @@ redirect_from: - /docs/en/crefopay-business-to-business-model - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/crefopay/crefopay-enabling-b2b-payments.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/crefopay/crefopay-enabling-b2b-payments.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/crefopay/crefopay-enable-b2b-payments.html related: - title: Integrating CrefoPay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/crefopay/integrate-crefopay.html + link: docs/pbc/all/payment-service-provider/page.version/crefopay/integrate-crefopay.html - title: CrefoPay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/crefopay/crefopay.html + link: docs/pbc/all/payment-service-provider/page.version/crefopay/crefopay.html - title: Installing and configuring CrefoPay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/crefopay/install-and-configure-crefopay.html + link: docs/pbc/all/payment-service-provider/page.version/crefopay/install-and-configure-crefopay.html - title: CrefoPay payment methods - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/crefopay/crefopay-payment-methods.html + link: docs/pbc/all/payment-service-provider/page.version/crefopay/crefopay-payment-methods.html - title: CrefoPay capture and refund Processes - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/crefopay/crefopay-capture-and-refund-processes.html + link: docs/pbc/all/payment-service-provider/page.version/crefopay/crefopay-capture-and-refund-processes.html - title: CrefoPay callbacks - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/crefopay/crefopay-callbacks.html + link: docs/pbc/all/payment-service-provider/page.version/crefopay/crefopay-callbacks.html - title: CrefoPay notifications - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/crefopay/crefopay-notifications.html + link: docs/pbc/all/payment-service-provider/page.version/crefopay/crefopay-notifications.html --- CrefoPay module enables B2B strategy in payments. diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/crefopay/crefopay-notifications.md b/docs/pbc/all/payment-service-provider/202212.0/crefopay/crefopay-notifications.md similarity index 92% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/crefopay/crefopay-notifications.md rename to docs/pbc/all/payment-service-provider/202212.0/crefopay/crefopay-notifications.md index f0740708c29..1d62b21196c 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/crefopay/crefopay-notifications.md +++ b/docs/pbc/all/payment-service-provider/202212.0/crefopay/crefopay-notifications.md @@ -12,6 +12,7 @@ redirect_from: - /docs/en/crefopay-notifications - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/crefopay/crefopay-notifications.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/crefopay/crefopay-notifications.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/crefopay/crefopay-notifications.html --- Merchant Notification System (MNS) is a push notification service for merchants. The MNS allows merchants to receive a multitude of notifications asynchronously in order to decouple the merchant system from CrefoPay’s payment systems. Also, with the MNS, merchants can react to any kind of change in the payment status of processed transactions. diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/crefopay/crefopay-payment-methods.md b/docs/pbc/all/payment-service-provider/202212.0/crefopay/crefopay-payment-methods.md similarity index 85% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/crefopay/crefopay-payment-methods.md rename to docs/pbc/all/payment-service-provider/202212.0/crefopay/crefopay-payment-methods.md index 7ced6f12567..678910232db 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/crefopay/crefopay-payment-methods.md +++ b/docs/pbc/all/payment-service-provider/202212.0/crefopay/crefopay-payment-methods.md @@ -12,21 +12,22 @@ redirect_from: - /docs/en/crefopay-provided-payment-methods - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/crefopay/crefopay-payment-methods.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/crefopay/crefopay-payment-methods.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/crefopay/crefopay-payment-methods.html related: - title: Integrating CrefoPay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/crefopay/integrate-crefopay.html + link: docs/pbc/all/payment-service-provider/page.version/crefopay/integrate-crefopay.html - title: CrefoPay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/crefopay/crefopay.html + link: docs/pbc/all/payment-service-provider/page.version/crefopay/crefopay.html - title: Installing and configuring CrefoPay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/crefopay/install-and-configure-crefopay.html + link: docs/pbc/all/payment-service-provider/page.version/crefopay/install-and-configure-crefopay.html - title: CrefoPay capture and refund Processes - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/crefopay/crefopay-capture-and-refund-processes.html + link: docs/pbc/all/payment-service-provider/page.version/crefopay/crefopay-capture-and-refund-processes.html - title: CrefoPay—Enabling B2B payments - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/crefopay/crefopay-enable-b2b-payments.html + link: docs/pbc/all/payment-service-provider/page.version/crefopay/crefopay-enable-b2b-payments.html - title: CrefoPay callbacks - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/crefopay/crefopay-callbacks.html + link: docs/pbc/all/payment-service-provider/page.version/crefopay/crefopay-callbacks.html - title: CrefoPay notifications - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/crefopay/crefopay-notifications.html + link: docs/pbc/all/payment-service-provider/page.version/crefopay/crefopay-notifications.html --- CrefoPay supports key payment methods across different regions, channels, and verticals. This article gives overview of these payment methods. diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/crefopay/crefopay.md b/docs/pbc/all/payment-service-provider/202212.0/crefopay/crefopay.md similarity index 70% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/crefopay/crefopay.md rename to docs/pbc/all/payment-service-provider/202212.0/crefopay/crefopay.md index 24e0563a422..d594ff0d2db 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/crefopay/crefopay.md +++ b/docs/pbc/all/payment-service-provider/202212.0/crefopay/crefopay.md @@ -4,6 +4,7 @@ template: concept-topic-template redirect_from: - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/crefopay/crefopay.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/crefopay/crefopay.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/crefopay/crefopay.html --- `SprykerEco.CrefoPay` [spryker-eco/crefo-pay](https://github.com/spryker-eco/crefo-pay) module provides integration of Spryker e-commerce system with the CrefoPay technology partner. It requires `SprykerEco.CrefoPayApi` [spryker-eco/crefo-pay-api](https://github.com/spryker-eco/crefo-pay-api) module that provides the REST Client for making API calls to CrefoPay Payment Provider. @@ -15,21 +16,21 @@ The `SprykerEco.CrefoPay` module includes integration with: The `SprykerEco.CrefoPay` module provides the following payment methods: -* [Bill](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/crefopay/crefopay-payment-methods.html#bill) -* [Cash on Delivery](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/crefopay/crefopay-payment-methods.html#cash-on-delivery) -* [Credit Card](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/crefopay/crefopay-payment-methods.html#credit-card) -* [Card with 3D secure](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/crefopay/crefopay-payment-methods.html#credit-card-with-3d-secure) -* [Direct Debit](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/crefopay/crefopay-payment-methods.html#direct-debit) -* [PayPal](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/crefopay/crefopay-payment-methods.html#paypal) -* [Cash in advance](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/crefopay/crefopay-payment-methods.html#cash-in-advance) -* [SofortÜberweisung](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/crefopay/crefopay-payment-methods.html#sofortberweisung) +* [Bill](/docs/pbc/all/payment-service-provider/{{page.version}}/crefopay/crefopay-payment-methods.html#bill) +* [Cash on Delivery](/docs/pbc/all/payment-service-provider/{{page.version}}/crefopay/crefopay-payment-methods.html#cash-on-delivery) +* [Credit Card](/docs/pbc/all/payment-service-provider/{{page.version}}/crefopay/crefopay-payment-methods.html#credit-card) +* [Card with 3D secure](/docs/pbc/all/payment-service-provider/{{page.version}}/crefopay/crefopay-payment-methods.html#credit-card-with-3d-secure) +* [Direct Debit](/docs/pbc/all/payment-service-provider/{{page.version}}/crefopay/crefopay-payment-methods.html#direct-debit) +* [PayPal](/docs/pbc/all/payment-service-provider/{{page.version}}/crefopay/crefopay-payment-methods.html#paypal) +* [Cash in advance](/docs/pbc/all/payment-service-provider/{{page.version}}/crefopay/crefopay-payment-methods.html#cash-in-advance) +* [SofortÜberweisung](/docs/pbc/all/payment-service-provider/{{page.version}}/crefopay/crefopay-payment-methods.html#sofortberweisung) ## Related Developer guides To integrate CrefoPay into your system the see following articles: -* [Installing and configuring CrefoPay](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/crefopay/install-and-configure-crefopay.html) -* [Integrating CrefoPay](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/crefopay/integrate-crefopay.html) +* [Installing and configuring CrefoPay](/docs/pbc/all/payment-service-provider/{{page.version}}/crefopay/install-and-configure-crefopay.html) +* [Integrating CrefoPay](/docs/pbc/all/payment-service-provider/{{page.version}}/crefopay/integrate-crefopay.html) --- diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/crefopay/install-and-configure-crefopay.md b/docs/pbc/all/payment-service-provider/202212.0/crefopay/install-and-configure-crefopay.md similarity index 81% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/crefopay/install-and-configure-crefopay.md rename to docs/pbc/all/payment-service-provider/202212.0/crefopay/install-and-configure-crefopay.md index 5e559d3e5c8..3e2e74926c4 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/crefopay/install-and-configure-crefopay.md +++ b/docs/pbc/all/payment-service-provider/202212.0/crefopay/install-and-configure-crefopay.md @@ -13,21 +13,22 @@ redirect_from: - /docs/scos/user/technology-partners/201907.0/payment-partners/crefopay/installing-and-configuring-crefopay.html - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/crefopay/installing-and-configuring-crefopay.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/crefopay/installing-and-configuring-crefopay.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/crefopay/install-and-configure-crefopay.html related: - title: Integrating CrefoPay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/crefopay/integrate-crefopay.html + link: docs/pbc/all/payment-service-provider/page.version/crefopay/integrate-crefopay.html - title: CrefoPay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/crefopay/crefopay.html + link: docs/pbc/all/payment-service-provider/page.version/crefopay/crefopay.html - title: CrefoPay payment methods - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/crefopay/crefopay-payment-methods.html + link: docs/pbc/all/payment-service-provider/page.version/crefopay/crefopay-payment-methods.html - title: CrefoPay capture and refund Processes - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/crefopay/crefopay-capture-and-refund-processes.html + link: docs/pbc/all/payment-service-provider/page.version/crefopay/crefopay-capture-and-refund-processes.html - title: CrefoPay—Enabling B2B payments - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/crefopay/crefopay-enable-b2b-payments.html + link: docs/pbc/all/payment-service-provider/page.version/crefopay/crefopay-enable-b2b-payments.html - title: CrefoPay callbacks - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/crefopay/crefopay-callbacks.html + link: docs/pbc/all/payment-service-provider/page.version/crefopay/crefopay-callbacks.html - title: CrefoPay notifications - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/crefopay/crefopay-notifications.html + link: docs/pbc/all/payment-service-provider/page.version/crefopay/crefopay-notifications.html --- This document describes how to install and configure CrefoPay. @@ -98,8 +99,8 @@ CrefoPayConfig::CREFO_PAY_PAYMENT_METHOD_BILL => 'CrefoPayBill01', ]; ``` -See [CrefoPay payment methods](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/crefopay/crefopay-payment-methods.html) for more information on the payment methods provided by CrefoPay. +See [CrefoPay payment methods](/docs/pbc/all/payment-service-provider/{{page.version}}/crefopay/crefopay-payment-methods.html) for more information on the payment methods provided by CrefoPay. ## Next steps -Once you are done with the installation and configuration of the CrefoPay module, [integrate CrefoPay into your project](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/crefopay/integrate-crefopay.html). +Once you are done with the installation and configuration of the CrefoPay module, [integrate CrefoPay into your project](/docs/pbc/all/payment-service-provider/{{page.version}}/crefopay/integrate-crefopay.html). diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/crefopay/integrate-crefopay.md b/docs/pbc/all/payment-service-provider/202212.0/crefopay/integrate-crefopay.md similarity index 97% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/crefopay/integrate-crefopay.md rename to docs/pbc/all/payment-service-provider/202212.0/crefopay/integrate-crefopay.md index 6cce9dc0462..99a07146f6b 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/crefopay/integrate-crefopay.md +++ b/docs/pbc/all/payment-service-provider/202212.0/crefopay/integrate-crefopay.md @@ -12,28 +12,29 @@ redirect_from: - /docs/en/crefopay-integration - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/crefopay/integrating-crefopay.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/crefopay/integrating-crefopay.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/crefopay/integrate-crefopay.html related: - title: CrefoPay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/crefopay/crefopay.html + link: docs/pbc/all/payment-service-provider/page.version/crefopay/crefopay.html - title: Installing and configuring CrefoPay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/crefopay/install-and-configure-crefopay.html + link: docs/pbc/all/payment-service-provider/page.version/crefopay/install-and-configure-crefopay.html - title: CrefoPay payment methods - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/crefopay/crefopay-payment-methods.html + link: docs/pbc/all/payment-service-provider/page.version/crefopay/crefopay-payment-methods.html - title: CrefoPay capture and refund Processes - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/crefopay/crefopay-capture-and-refund-processes.html + link: docs/pbc/all/payment-service-provider/page.version/crefopay/crefopay-capture-and-refund-processes.html - title: CrefoPay—Enabling B2B payments - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/crefopay/crefopay-enable-b2b-payments.html + link: docs/pbc/all/payment-service-provider/page.version/crefopay/crefopay-enable-b2b-payments.html - title: CrefoPay callbacks - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/crefopay/crefopay-callbacks.html + link: docs/pbc/all/payment-service-provider/page.version/crefopay/crefopay-callbacks.html - title: CrefoPay notifications - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/crefopay/crefopay-notifications.html + link: docs/pbc/all/payment-service-provider/page.version/crefopay/crefopay-notifications.html --- This document shows how to integrate the CrefoPay system into your project. ## Prerequisites -Before integrating CrefoPay into your project, make sure you [installed and configured the CrefoPay module](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/crefopay/install-and-configure-crefopay.html). +Before integrating CrefoPay into your project, make sure you [installed and configured the CrefoPay module](/docs/pbc/all/payment-service-provider/{{page.version}}/crefopay/install-and-configure-crefopay.html). ## Integrating CrefoPay into your project diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/configure-heidelpay.md b/docs/pbc/all/payment-service-provider/202212.0/heidelpay/configure-heidelpay.md similarity index 78% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/configure-heidelpay.md rename to docs/pbc/all/payment-service-provider/202212.0/heidelpay/configure-heidelpay.md index 66301dcb28d..217af2085db 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/configure-heidelpay.md +++ b/docs/pbc/all/payment-service-provider/202212.0/heidelpay/configure-heidelpay.md @@ -12,25 +12,26 @@ redirect_from: - /docs/en/heidelpay-configuration-scos - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/heidelpay/configuring-heidelpay.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/heidelpay/configuring-heidelpay.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/configure-heidelpay.html related: - title: Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/heidelpay.html - title: Integrating Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-heidelpay.html - title: Integrating the Credit Card Secure payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html - title: Integrating the Direct Debit payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html - title: Integrating the Paypal Authorize payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html - title: Installing Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/install-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/install-heidelpay.html - title: Heidelpay workflow for errors - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/heidelpay-workflow-for-errors.html - title: Integrating the Split-payment Marketplace payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.html - title: Integrating the Easy Credit payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html --- Base settings are located in `config/Shared/config_default.php` diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/heidelpay-oms-workflow.md b/docs/pbc/all/payment-service-provider/202212.0/heidelpay/heidelpay-oms-workflow.md similarity index 92% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/heidelpay-oms-workflow.md rename to docs/pbc/all/payment-service-provider/202212.0/heidelpay/heidelpay-oms-workflow.md index cb919106cbc..1308396fb19 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/heidelpay-oms-workflow.md +++ b/docs/pbc/all/payment-service-provider/202212.0/heidelpay/heidelpay-oms-workflow.md @@ -11,6 +11,7 @@ redirect_from: - /docs/en/heidelpay-oms-workflow - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/heidelpay/heidelpay-oms-workflow.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/heidelpay/heidelpay-oms-workflow.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/heidelpay-oms-workflow.html --- We use state machines for handling and managing orders and payments. diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.md b/docs/pbc/all/payment-service-provider/202212.0/heidelpay/heidelpay-workflow-for-errors.md similarity index 62% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.md rename to docs/pbc/all/payment-service-provider/202212.0/heidelpay/heidelpay-workflow-for-errors.md index 7fffef06a0f..49c06281379 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.md +++ b/docs/pbc/all/payment-service-provider/202212.0/heidelpay/heidelpay-workflow-for-errors.md @@ -12,25 +12,26 @@ redirect_from: - /docs/en/heidelpay-error-workflow - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/heidelpay/heidelpay-workflow-for-errors.html - /docs/scos/user/technology-partners/202212.0/payment-partners/heidelpay/technical-details-and-howtos/heidelpay-workflow-for-errors.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.html related: - title: Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/heidelpay.html - title: Integrating the Credit Card Secure payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html - title: Configuring Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/configure-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/configure-heidelpay.html - title: Integrating the Paypal Authorize payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html - title: Integrating Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-heidelpay.html - title: Integrating the Direct Debit payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html - title: Installing Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/install-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/install-heidelpay.html - title: Integrating the Easy Credit payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html - title: Integrating the Invoice Secured B2C payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-invoice-secured-b2c-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-invoice-secured-b2c-payment-method-for-heidelpay.html --- diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/heidelpay.md b/docs/pbc/all/payment-service-provider/202212.0/heidelpay/heidelpay.md similarity index 50% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/heidelpay.md rename to docs/pbc/all/payment-service-provider/202212.0/heidelpay/heidelpay.md index 59e33aa31de..c4e9ed26a02 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/heidelpay.md +++ b/docs/pbc/all/payment-service-provider/202212.0/heidelpay/heidelpay.md @@ -6,12 +6,8 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/heidelpay originalArticleId: 92607b28-3e51-4b0a-a41f-12bc9852b1cb redirect_from: - - /2021080/docs/heidelpay - - /2021080/docs/en/heidelpay - - /docs/heidelpay - - /docs/en/heidelpay - - /industry_partners/payment/heidelpay/heidelpay.htm - /docs/scos/user/technology-partners/202212.0/payment-partners/heidelpay.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/heidelpay.html --- ## Partner Information @@ -22,20 +18,20 @@ Heidelpay is an internationally operating payment institution, authorized and re ## Related Developer guides -* [Installing Heidelpay](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/heidelpay/install-heidelpay.html) -* [Integrating Heidelpay](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/heidelpay/integrate-heidelpay.html) -* [Configuring Heidelpay](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/heidelpay/configure-heidelpay.html) -* [Heidelpay OMS workflow](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/heidelpay/heidelpay-oms-workflow.html) -* [Heidelpay workflow for errors](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.html) -* [Integrating the Credit Card Secure payment method for Heidelpay](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html) -* [Integrating the Direct Debit payment method for Heidelpay](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html) -* [Integrating the Easy Credit payment method for Heidelpay](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html) -* [Integrating the iDeal payment method for Heidelpay](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-ideal-payment-method-for-heidelpay.html) -* [Integrating the Invoice Secured B2C payment method for Heidelpay](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-invoice-secured-b2c-payment-method-for-heidelpay.html) -* [Integrating the Paypal Authorize payment method for Heidelpay](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html) -* [Integrating the Paypal Debit payment method for Heidelpay](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-debit-payment-method-for-heidelpay.html) -* [Integrating the Sofort payment method for Heidelpay](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-sofort-payment-method-for-heidelpay.html) -* [Integrating the Split-payment Marketplace payment method for Heidelpay](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.html) +* [Installing Heidelpay](/docs/pbc/all/payment-service-provider/{{page.version}}/heidelpay/install-heidelpay.html) +* [Integrating Heidelpay](/docs/pbc/all/payment-service-provider/{{page.version}}/heidelpay/integrate-heidelpay.html) +* [Configuring Heidelpay](/docs/pbc/all/payment-service-provider/{{page.version}}/heidelpay/configure-heidelpay.html) +* [Heidelpay OMS workflow](/docs/pbc/all/payment-service-provider/{{page.version}}/heidelpay/heidelpay-oms-workflow.html) +* [Heidelpay workflow for errors](/docs/pbc/all/payment-service-provider/{{page.version}}/heidelpay/heidelpay-workflow-for-errors.html) +* [Integrating the Credit Card Secure payment method for Heidelpay](/docs/pbc/all/payment-service-provider/{{page.version}}/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html) +* [Integrating the Direct Debit payment method for Heidelpay](/docs/pbc/all/payment-service-provider/{{page.version}}/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html) +* [Integrating the Easy Credit payment method for Heidelpay](/docs/pbc/all/payment-service-provider/{{page.version}}/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html) +* [Integrating the iDeal payment method for Heidelpay](/docs/pbc/all/payment-service-provider/{{page.version}}/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-ideal-payment-method-for-heidelpay.html) +* [Integrating the Invoice Secured B2C payment method for Heidelpay](/docs/pbc/all/payment-service-provider/{{page.version}}/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-invoice-secured-b2c-payment-method-for-heidelpay.html) +* [Integrating the Paypal Authorize payment method for Heidelpay](/docs/pbc/all/payment-service-provider/{{page.version}}/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html) +* [Integrating the Paypal Debit payment method for Heidelpay](/docs/pbc/all/payment-service-provider/{{page.version}}/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-debit-payment-method-for-heidelpay.html) +* [Integrating the Sofort payment method for Heidelpay](/docs/pbc/all/payment-service-provider/{{page.version}}/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-sofort-payment-method-for-heidelpay.html) +* [Integrating the Split-payment Marketplace payment method for Heidelpay](/docs/pbc/all/payment-service-provider/{{page.version}}/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.html) --- ## Copyright and Disclaimer diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/install-heidelpay.md b/docs/pbc/all/payment-service-provider/202212.0/heidelpay/install-heidelpay.md similarity index 51% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/install-heidelpay.md rename to docs/pbc/all/payment-service-provider/202212.0/heidelpay/install-heidelpay.md index 8b548da0536..20f7eb3d99d 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/install-heidelpay.md +++ b/docs/pbc/all/payment-service-provider/202212.0/heidelpay/install-heidelpay.md @@ -12,25 +12,26 @@ redirect_from: - /docs/en/heidelpay-installation - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/heidelpay/installing-heidelpay.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/heidelpay/installing-heidelpay.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/install-heidelpay.html related: - title: Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/heidelpay.html - title: Integrating Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-heidelpay.html - title: Integrating the Credit Card Secure payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html - title: Configuring Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/configure-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/configure-heidelpay.html - title: Integrating the Direct Debit payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html - title: Integrating the Paypal Authorize payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html - title: Heidelpay workflow for errors - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/heidelpay-workflow-for-errors.html - title: Integrating the Split-payment Marketplace payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.html - title: Integrating the Easy Credit payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html --- To install Heidelpay, if necessary, add the Heidelpay repo to your repositories in composer.json: diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/integrate-heidelpay.md b/docs/pbc/all/payment-service-provider/202212.0/heidelpay/integrate-heidelpay.md similarity index 88% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/integrate-heidelpay.md rename to docs/pbc/all/payment-service-provider/202212.0/heidelpay/integrate-heidelpay.md index f3591544eda..f0d66afbad8 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/integrate-heidelpay.md +++ b/docs/pbc/all/payment-service-provider/202212.0/heidelpay/integrate-heidelpay.md @@ -12,25 +12,26 @@ redirect_from: - /docs/en/heidelpay-integration-scos - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/heidelpay/integrating-heidelpay.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/heidelpay/integrating-heidelpay.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/integrate-heidelpay.html related: - title: Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/heidelpay.html - title: Integrating the Credit Card Secure payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html - title: Configuring Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/configure-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/configure-heidelpay.html - title: Integrating the Direct Debit payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html - title: Integrating the Paypal Authorize payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html - title: Installing Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/install-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/install-heidelpay.html - title: Heidelpay workflow for errors - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/heidelpay-workflow-for-errors.html - title: Integrating the Split-payment Marketplace payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.html - title: Integrating the Easy Credit payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html --- {% info_block errorBox %} diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.md b/docs/pbc/all/payment-service-provider/202212.0/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.md similarity index 83% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.md rename to docs/pbc/all/payment-service-provider/202212.0/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.md index d15a9b75eea..a9906e7094c 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.md +++ b/docs/pbc/all/payment-service-provider/202212.0/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.md @@ -12,30 +12,31 @@ redirect_from: - /docs/en/heidelpay-credit-card - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/heidelpay/integrating-payment-methods-for-heidelpay/integrating-the-credit-card-secure-payment-method-for-heidelpay.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/heidelpay/integrating-payment-methods-for-heidelpay/integrating-the-credit-card-secure-payment-method-for-heidelpay.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html related: - title: Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/heidelpay.html - title: Configuring Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/configure-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/configure-heidelpay.html - title: Integrating the Direct Debit payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html - title: Integrating the Paypal Authorize payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html - title: Integrating Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-heidelpay.html - title: Installing Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/install-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/install-heidelpay.html - title: Heidelpay workflow for errors - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/heidelpay-workflow-for-errors.html - title: Integrating the Split-payment Marketplace payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.html - title: Integrating the Easy Credit payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html --- ## Setup -The following configuration should be made after Heidelpay has been [installed](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/heidelpay/install-heidelpay.html) and [integrated](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/heidelpay/configure-heidelpay.html). +The following configuration should be made after Heidelpay has been [installed](/docs/pbc/all/payment-service-provider/{{page.version}}/heidelpay/install-heidelpay.html) and [integrated](/docs/pbc/all/payment-service-provider/{{page.version}}/heidelpay/configure-heidelpay.html). ## Configuration @@ -113,6 +114,6 @@ class HeidelpayPostSavePlugin extends BaseAbstractPlugin implements CheckoutPost The most important data here - is the payment reference ID which can be used for further transactions like capture/cancel/etc.  -In the response Heidelpay expects an URL string which defines where customer has to be redirected. In case if customer successfully confirmed payment, it should be a link to checkout order success step, in case of failure - checkout payment failed action with error code (See See `HeidelpayController::paymentFailedAction()` and [Heidelpay workflow for errors](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.html) section). Heidelpay redirects customer to the given URL and payment process is finished.  +In the response Heidelpay expects an URL string which defines where customer has to be redirected. In case if customer successfully confirmed payment, it should be a link to checkout order success step, in case of failure - checkout payment failed action with error code (See See `HeidelpayController::paymentFailedAction()` and [Heidelpay workflow for errors](/docs/pbc/all/payment-service-provider/{{page.version}}/heidelpay/heidelpay-workflow-for-errors.html) section). Heidelpay redirects customer to the given URL and payment process is finished.  **Capture the money** - later on, when the item is shipped to the customer, it is time to call "capture" command of the state machine to capture money from the customer's account. It is done in CapturePlugin of the OMS command. In the provided basic order state machine for `CreditCardSecureAuthorize` method, command will be executed automatically, when order is manually moved into the "shipped" state. Now order can be considered as "paid". diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.md b/docs/pbc/all/payment-service-provider/202212.0/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.md similarity index 90% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.md rename to docs/pbc/all/payment-service-provider/202212.0/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.md index 01a8d2988f5..9ff59d0f9e2 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.md +++ b/docs/pbc/all/payment-service-provider/202212.0/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.md @@ -12,30 +12,31 @@ redirect_from: - /docs/en/integrating-the-direct-debit-payment-method-for-heidelpay.html - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/heidelpay/integrating-payment-methods-for-heidelpay/integrating-the-direct-debit-payment-method-for-heidelpay.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/heidelpay/integrating-payment-methods-for-heidelpay/integrating-the-direct-debit-payment-method-for-heidelpay.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html related: - title: Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/heidelpay.html - title: Integrating the Credit Card Secure payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html - title: Configuring Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/configure-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/configure-heidelpay.html - title: Integrating the Paypal Authorize payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html - title: Integrating Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-heidelpay.html - title: Installing Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/install-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/install-heidelpay.html - title: Heidelpay workflow for errors - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/heidelpay-workflow-for-errors.html - title: Integrating the Easy Credit payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html - title: Integrating the Invoice Secured B2C payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-invoice-secured-b2c-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-invoice-secured-b2c-payment-method-for-heidelpay.html --- ## Setup -The following configuration should be made after Heidelpay has been [installed](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/heidelpay/install-heidelpay.html) and [integrated](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/heidelpay/integrate-heidelpay.html). +The following configuration should be made after Heidelpay has been [installed](/docs/pbc/all/payment-service-provider/{{page.version}}/heidelpay/install-heidelpay.html) and [integrated](/docs/pbc/all/payment-service-provider/{{page.version}}/heidelpay/integrate-heidelpay.html). ## Configuration diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.md b/docs/pbc/all/payment-service-provider/202212.0/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.md similarity index 92% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.md rename to docs/pbc/all/payment-service-provider/202212.0/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.md index 7f6a5f6cb0e..665f6187333 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.md +++ b/docs/pbc/all/payment-service-provider/202212.0/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.md @@ -12,30 +12,31 @@ redirect_from: - /docs/en/heidelpay-easy-credit - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/heidelpay/integrating-payment-methods-for-heidelpay/integrating-the-easy-credit-payment-method-for-heidelpay.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/heidelpay/integrating-payment-methods-for-heidelpay/integrating-the-easy-credit-payment-method-for-heidelpay.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html related: - title: Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/heidelpay.html - title: Integrating the Credit Card Secure payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html - title: Configuring Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/configure-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/configure-heidelpay.html - title: Integrating the Paypal Authorize payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html - title: Integrating Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-heidelpay.html - title: Integrating the Direct Debit payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html - title: Installing Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/install-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/install-heidelpay.html - title: Heidelpay workflow for errors - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/heidelpay-workflow-for-errors.html - title: Integrating the Invoice Secured B2C payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-invoice-secured-b2c-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-invoice-secured-b2c-payment-method-for-heidelpay.html --- ## Setup -The following configuration should be implemented after Heidelpay has been [installed](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/heidelpay/install-heidelpay.html) and [integrated](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/heidelpay/integrate-heidelpay.html). +The following configuration should be implemented after Heidelpay has been [installed](/docs/pbc/all/payment-service-provider/{{page.version}}/heidelpay/install-heidelpay.html) and [integrated](/docs/pbc/all/payment-service-provider/{{page.version}}/heidelpay/integrate-heidelpay.html). ## Configuration diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-ideal-payment-method-for-heidelpay.md b/docs/pbc/all/payment-service-provider/202212.0/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-ideal-payment-method-for-heidelpay.md similarity index 69% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-ideal-payment-method-for-heidelpay.md rename to docs/pbc/all/payment-service-provider/202212.0/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-ideal-payment-method-for-heidelpay.md index 2907db30b50..76773e0373f 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-ideal-payment-method-for-heidelpay.md +++ b/docs/pbc/all/payment-service-provider/202212.0/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-ideal-payment-method-for-heidelpay.md @@ -12,30 +12,31 @@ redirect_from: - /docs/en/heidelpay-ideal - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/heidelpay/integrating-payment-methods-for-heidelpay/integrating-the-ideal-payment-method-for-heidelpay.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/heidelpay/integrating-payment-methods-for-heidelpay/integrating-the-ideal-payment-method-for-heidelpay.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-ideal-payment-method-for-heidelpay.html related: - title: Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/heidelpay.html - title: Integrating the Easy Credit payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html - title: Integrating Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-heidelpay.html - title: Integrating the Paypal Debit payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-debit-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-debit-payment-method-for-heidelpay.html - title: Integrating the Split-payment Marketplace payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.html - title: Configuring Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/configure-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/configure-heidelpay.html - title: Integrating the Invoice Secured B2C payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-invoice-secured-b2c-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-invoice-secured-b2c-payment-method-for-heidelpay.html - title: Integrating the Direct Debit payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html - title: Installing Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/install-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/install-heidelpay.html --- ### Setup -The following configuration should be made after Heidelpay has been [installed](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/heidelpay/install-heidelpay.html) and [integrated](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/heidelpay/integrate-heidelpay.html). +The following configuration should be made after Heidelpay has been [installed](/docs/pbc/all/payment-service-provider/{{page.version}}/heidelpay/install-heidelpay.html) and [integrated](/docs/pbc/all/payment-service-provider/{{page.version}}/heidelpay/integrate-heidelpay.html). #### Configuration @@ -68,6 +69,6 @@ No extra actions needed, quote being filled with payment method selection as def The most important data here - is the payment reference ID which can be used for further transactions like capture/cancel/etc.  -In the response Heidelpay expects an URL string which defines where customer has to be redirected. In case if customer successfully confirmed payment, it should be a link to the checkout order success step, in case of the failure - checkout payment failed action with the error code (see `HeidelpayController::paymentFailedAction()` and [Heidelpay workflow for errors](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.html) section). Heidelpay redirects customer to the given URL and the payment process is finished.  +In the response Heidelpay expects an URL string which defines where customer has to be redirected. In case if customer successfully confirmed payment, it should be a link to the checkout order success step, in case of the failure - checkout payment failed action with the error code (see `HeidelpayController::paymentFailedAction()` and [Heidelpay workflow for errors](/docs/pbc/all/payment-service-provider/{{page.version}}/heidelpay/heidelpay-workflow-for-errors.html) section). Heidelpay redirects customer to the given URL and the payment process is finished.  **Capture the money** - later on, when the item is shipped to the customer, it is time to call "capture" command of the state machine to capture the money from the customer's account. This is done in CapturePlugin of the OMS command. In the provided basic order state machine for iDeal authorize method, command will be executed automatically, when order is manually moved into the "shipped" state. Now order can be considered as "paid". diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-invoice-secured-b2c-payment-method-for-heidelpay.md b/docs/pbc/all/payment-service-provider/202212.0/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-invoice-secured-b2c-payment-method-for-heidelpay.md similarity index 86% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-invoice-secured-b2c-payment-method-for-heidelpay.md rename to docs/pbc/all/payment-service-provider/202212.0/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-invoice-secured-b2c-payment-method-for-heidelpay.md index dbec3569d29..87a79f6c024 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-invoice-secured-b2c-payment-method-for-heidelpay.md +++ b/docs/pbc/all/payment-service-provider/202212.0/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-invoice-secured-b2c-payment-method-for-heidelpay.md @@ -12,30 +12,31 @@ redirect_from: - /docs/en/heidelpay-invoice-secured-b2c - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/heidelpay/integrating-payment-methods-for-heidelpay/integrating-the-invoice-secured-b2c-payment-method-for-heidelpay.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/heidelpay/integrating-payment-methods-for-heidelpay/integrating-the-invoice-secured-b2c-payment-method-for-heidelpay.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-invoice-secured-b2c-payment-method-for-heidelpay.html related: - title: Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/heidelpay.html - title: Integrating the Credit Card Secure payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html - title: Configuring Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/configure-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/configure-heidelpay.html - title: Integrating the Paypal Authorize payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html - title: Integrating Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-heidelpay.html - title: Integrating the Direct Debit payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html - title: Installing Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/install-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/install-heidelpay.html - title: Heidelpay workflow for errors - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/heidelpay-workflow-for-errors.html - title: Integrating the Easy Credit payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html --- ## Setup -The following configuration should be made after Heidelpay has been [installed](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/heidelpay/install-heidelpay.html) and [integrated](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/heidelpay/integrate-heidelpay.html). +The following configuration should be made after Heidelpay has been [installed](/docs/pbc/all/payment-service-provider/{{page.version}}/heidelpay/install-heidelpay.html) and [integrated](/docs/pbc/all/payment-service-provider/{{page.version}}/heidelpay/integrate-heidelpay.html). ## Configuration diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.md b/docs/pbc/all/payment-service-provider/202212.0/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.md similarity index 72% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.md rename to docs/pbc/all/payment-service-provider/202212.0/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.md index 8b1fed283af..28176380951 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.md +++ b/docs/pbc/all/payment-service-provider/202212.0/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.md @@ -12,30 +12,31 @@ redirect_from: - /docs/en/heidelpay-authorize - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/heidelpay/integrating-payment-methods-for-heidelpay/integrating-the-paypal-authorize-payment-method-for-heidelpay.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/heidelpay/integrating-payment-methods-for-heidelpay/integrating-the-paypal-authorize-payment-method-for-heidelpay.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html related: - title: Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/heidelpay.html - title: Integrating the Credit Card Secure payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html - title: Configuring Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/configure-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/configure-heidelpay.html - title: Integrating the Direct Debit payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html - title: Integrating Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-heidelpay.html - title: Heidelay - Sofort (Online Transfer) - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-sofort-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-sofort-payment-method-for-heidelpay.html - title: Installing Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/install-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/install-heidelpay.html - title: Heidelpay workflow for errors - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/heidelpay-workflow-for-errors.html - title: Integrating the Split-payment Marketplace payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.html --- ### Setup -The following configuration should be made after Heidelpay has been [installed](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/heidelpay/install-heidelpay.html) and [integrated](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/heidelpay/configure-heidelpay.html). +The following configuration should be made after Heidelpay has been [installed](/docs/pbc/all/payment-service-provider/{{page.version}}/heidelpay/install-heidelpay.html) and [integrated](/docs/pbc/all/payment-service-provider/{{page.version}}/heidelpay/configure-heidelpay.html). #### Configuration @@ -87,6 +88,6 @@ class HeidelpayPostSavePlugin extends BaseAbstractPlugin implements CheckoutPost The most important data here is the payment reference ID which can be used for further transactions like `capture/cancel/etc`. -In the response Heidelpay expects an URL string which defines where customer has to be redirected. In case if customer successfully confirmed payment, it should be a link to checkout order success step, in case of failure - checkout payment failed action with error code (see `HeidelpayController::paymentFailedAction()` and [Heidelpay workflow for errors](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.html) section). Heidelpay redirects customer to the given URL and the payment process is finished.  +In the response Heidelpay expects an URL string which defines where customer has to be redirected. In case if customer successfully confirmed payment, it should be a link to checkout order success step, in case of failure - checkout payment failed action with error code (see `HeidelpayController::paymentFailedAction()` and [Heidelpay workflow for errors](/docs/pbc/all/payment-service-provider/{{page.version}}/heidelpay/heidelpay-workflow-for-errors.html) section). Heidelpay redirects customer to the given URL and the payment process is finished.  **Capture the money** - later on, when the item is shipped to the customer, it is time to call "capture" command of the state machine to capture the money from the customer's account. It is done in CapturePlugin of the OMS command. In the provided basic order of state machine for Paypal authorize method, the command will be executed automatically, when order is manually moved into the "shipped" state. Now the order can be considered as "paid". diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-debit-payment-method-for-heidelpay.md b/docs/pbc/all/payment-service-provider/202212.0/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-debit-payment-method-for-heidelpay.md similarity index 70% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-debit-payment-method-for-heidelpay.md rename to docs/pbc/all/payment-service-provider/202212.0/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-debit-payment-method-for-heidelpay.md index a5cb8135ec9..575dc5f5db8 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-debit-payment-method-for-heidelpay.md +++ b/docs/pbc/all/payment-service-provider/202212.0/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-debit-payment-method-for-heidelpay.md @@ -12,30 +12,31 @@ redirect_from: - /docs/en/heidelpay-paypal-debit - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/heidelpay/integrating-payment-methods-for-heidelpay/integrating-the-paypal-debit-payment-method-for-heidelpay.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/heidelpay/integrating-payment-methods-for-heidelpay/integrating-the-paypal-debit-payment-method-for-heidelpay.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-debit-payment-method-for-heidelpay.html related: - title: Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/heidelpay.html - title: Integrating the Credit Card Secure payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html - title: Configuring Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/configure-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/configure-heidelpay.html - title: Integrating the Paypal Authorize payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html - title: Integrating Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-heidelpay.html - title: Heidelay - Sofort (Online Transfer) - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-sofort-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-sofort-payment-method-for-heidelpay.html - title: Integrating the Direct Debit payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html - title: Installing Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/install-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/install-heidelpay.html - title: Heidelpay workflow for errors - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/heidelpay-workflow-for-errors.html --- ### Setup -The following configuration should be made after Heidelpay has been [installed](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/heidelpay/install-heidelpay.html) and [integrated](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/heidelpay/integrate-heidelpay.html). +The following configuration should be made after Heidelpay has been [installed](/docs/pbc/all/payment-service-provider/{{page.version}}/heidelpay/install-heidelpay.html) and [integrated](/docs/pbc/all/payment-service-provider/{{page.version}}/heidelpay/integrate-heidelpay.html). #### Configuration @@ -89,6 +90,6 @@ class HeidelpayPostSavePlugin extends BaseAbstractPlugin implements CheckoutPost The most important data here is the payment reference ID which can be used for further transactions like capture/cancel/etc.  -In the response Heidelpay expects an URL string which shows where customer has to be redirected. In case if customer successfully confirmed payment, there should be a link to checkout order success step, in case of failure - checkout payment failed action with error code (see`HeidelpayController::paymentFailedAction()` and [Heidelpay workflow for errors](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.html) section). Heidelpay redirects customer to the given URL and payment process is finished.  +In the response Heidelpay expects an URL string which shows where customer has to be redirected. In case if customer successfully confirmed payment, there should be a link to checkout order success step, in case of failure - checkout payment failed action with error code (see`HeidelpayController::paymentFailedAction()` and [Heidelpay workflow for errors](/docs/pbc/all/payment-service-provider/{{page.version}}/heidelpay/heidelpay-workflow-for-errors.html) section). Heidelpay redirects customer to the given URL and payment process is finished.  Now the order can be considered as "paid". diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-sofort-payment-method-for-heidelpay.md b/docs/pbc/all/payment-service-provider/202212.0/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-sofort-payment-method-for-heidelpay.md similarity index 70% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-sofort-payment-method-for-heidelpay.md rename to docs/pbc/all/payment-service-provider/202212.0/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-sofort-payment-method-for-heidelpay.md index 8ad7866e081..4fcef0fa75b 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-sofort-payment-method-for-heidelpay.md +++ b/docs/pbc/all/payment-service-provider/202212.0/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-sofort-payment-method-for-heidelpay.md @@ -12,30 +12,31 @@ redirect_from: - /docs/en/heidelpay-sofort - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/heidelpay/integrating-payment-methods-for-heidelpay/integrating-the-sofort-payment-method-for-heidelpay.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/heidelpay/integrating-payment-methods-for-heidelpay/integrating-the-sofort-payment-method-for-heidelpay.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-sofort-payment-method-for-heidelpay.html related: - title: Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/heidelpay.html - title: Integrating the Credit Card Secure payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html - title: Configuring Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/configure-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/configure-heidelpay.html - title: Integrating the Paypal Authorize payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html - title: Integrating Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-heidelpay.html - title: Integrating the Direct Debit payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html - title: Installing Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/install-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/install-heidelpay.html - title: Heidelpay workflow for errors - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/heidelpay-workflow-for-errors.html - title: Integrating the Easy Credit payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html --- ## Setup -The following configuration should be made after Heidelpay has been [installed](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/heidelpay/install-heidelpay.html) and [integrated](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/heidelpay/integrate-heidelpay.html). +The following configuration should be made after Heidelpay has been [installed](/docs/pbc/all/payment-service-provider/{{page.version}}/heidelpay/install-heidelpay.html) and [integrated](/docs/pbc/all/payment-service-provider/{{page.version}}/heidelpay/integrate-heidelpay.html). ## Configuration @@ -85,6 +86,6 @@ class HeidelpayPostSavePlugin extends BaseAbstractPlugin implements CheckoutPost The most important data here - is the payment reference ID which can be used for further transactions like capture/cancel/etc.  -In the response Heidelpay expects an URL string which defines where customer has to be redirected. In case if customer successfully confirmed payment, it should be link to checkout order success step, in case of failure - checkout payment failed action with error code (see `HeidelpayController::paymentFailedAction()` and [Heidelpay workflow for errors](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.html) section). Heidelpay redirects customer to the given URL and payment process is finished.  +In the response Heidelpay expects an URL string which defines where customer has to be redirected. In case if customer successfully confirmed payment, it should be link to checkout order success step, in case of failure - checkout payment failed action with error code (see `HeidelpayController::paymentFailedAction()` and [Heidelpay workflow for errors](/docs/pbc/all/payment-service-provider/{{page.version}}/heidelpay/heidelpay-workflow-for-errors.html) section). Heidelpay redirects customer to the given URL and payment process is finished.  Now order can be considered as "paid", no further capture is needed. diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.md b/docs/pbc/all/payment-service-provider/202212.0/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.md similarity index 57% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.md rename to docs/pbc/all/payment-service-provider/202212.0/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.md index f0b7a2d65fa..f38b893718c 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.md +++ b/docs/pbc/all/payment-service-provider/202212.0/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.md @@ -12,30 +12,31 @@ redirect_from: - /docs/en/heidelpay-split-payment-marketplace - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/heidelpay/integrating-payment-methods-for-heidelpay/integrating-the-split-payment-marketplace-payment-method-for-heidelpay.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/heidelpay/integrating-payment-methods-for-heidelpay/integrating-the-split-payment-marketplace-payment-method-for-heidelpay.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.html related: - title: Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/heidelpay.html - title: Integrating the Credit Card Secure payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-credit-card-secure-payment-method-for-heidelpay.html - title: Configuring Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/configure-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/configure-heidelpay.html - title: Integrating the Direct Debit payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-direct-debit-payment-method-for-heidelpay.html - title: Integrating the Paypal Authorize payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-paypal-authorize-payment-method-for-heidelpay.html - title: Integrating Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-heidelpay.html - title: Installing Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/install-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/install-heidelpay.html - title: Heidelpay workflow for errors - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/heidelpay-workflow-for-errors.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/heidelpay-workflow-for-errors.html - title: Integrating the Easy Credit payment method for Heidelpay - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html + link: docs/pbc/all/payment-service-provider/page.version/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html --- ## Setup -The following configuration should be made after Heidelpay has been [installed](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/heidelpay/install-heidelpay.html) and [integrated](/docs/scos/dev/technology-partner-guides/{{page.version}}/payment-partners/heidelpay/configuring-heidelpay.html). +The following configuration should be made after Heidelpay has been [installed](/docs/pbc/all/payment-service-provider/{{page.version}}/heidelpay/install-heidelpay.html) and [integrated](/docs/scos/dev/technology-partner-guides/{{page.version}}/payment-partners/heidelpay/configuring-heidelpay.html). ## Configuration diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/klarna/klarna-invoice-pay-in-14-days.md b/docs/pbc/all/payment-service-provider/202212.0/klarna/klarna-invoice-pay-in-14-days.md similarity index 74% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/klarna/klarna-invoice-pay-in-14-days.md rename to docs/pbc/all/payment-service-provider/202212.0/klarna/klarna-invoice-pay-in-14-days.md index c360fc273ee..a8e68cf52a7 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/klarna/klarna-invoice-pay-in-14-days.md +++ b/docs/pbc/all/payment-service-provider/202212.0/klarna/klarna-invoice-pay-in-14-days.md @@ -6,20 +6,17 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/klarna-invoice-pay-in-14-days originalArticleId: dcff76cb-ec18-41d9-bd2f-b0e1713e8508 redirect_from: - - /2021080/docs/klarna-invoice-pay-in-14-days - - /2021080/docs/en/klarna-invoice-pay-in-14-days - - /docs/klarna-invoice-pay-in-14-days - - /docs/en/klarna-invoice-pay-in-14-days - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/klarna/klarna-invoice-pay-in-14-days.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/klarna/klarna-invoice-pay-in-14-days.html related: - title: Klarna - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/klarna/klarna.html + link: docs/pbc/all/payment-service-provider/page.version/klarna/klarna.html - title: Klarna payment workflow - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/klarna/klarna-payment-workflow.html + link: docs/pbc/all/payment-service-provider/page.version/klarna/klarna-payment-workflow.html - title: Klarna - Part Payment Flexible - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/klarna/klarna-part-payment-flexible.html + link: docs/pbc/all/payment-service-provider/page.version/klarna/klarna-part-payment-flexible.html - title: Klarna state machine commands and conditions - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/klarna/klarna-state-machine-commands-and-conditions.html + link: docs/pbc/all/payment-service-provider/page.version/klarna/klarna-state-machine-commands-and-conditions.html --- ## Payment Workflow Scenarios @@ -70,4 +67,4 @@ You can copy over configuration to your config from the Klarna modules `config.d ## Perform Requests -In order to perform the needed requests, you can easily use the implemented [Klarna State Machine Commands and Conditions](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/klarna/klarna-state-machine-commands-and-conditions.html). The next section gives a summary of them. +In order to perform the needed requests, you can easily use the implemented [Klarna State Machine Commands and Conditions](/docs/pbc/all/payment-service-provider/{{page.version}}/klarna/klarna-state-machine-commands-and-conditions.html). The next section gives a summary of them. diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/klarna/klarna-part-payment-flexible.md b/docs/pbc/all/payment-service-provider/202212.0/klarna/klarna-part-payment-flexible.md similarity index 75% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/klarna/klarna-part-payment-flexible.md rename to docs/pbc/all/payment-service-provider/202212.0/klarna/klarna-part-payment-flexible.md index 5db7242015a..ef731f06561 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/klarna/klarna-part-payment-flexible.md +++ b/docs/pbc/all/payment-service-provider/202212.0/klarna/klarna-part-payment-flexible.md @@ -6,20 +6,17 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/klarna-part-payment-flexible originalArticleId: 78f05644-f9b7-4f56-9fc2-19f5d8d2a66e redirect_from: - - /2021080/docs/klarna-part-payment-flexible - - /2021080/docs/en/klarna-part-payment-flexible - - /docs/klarna-part-payment-flexible - - /docs/en/klarna-part-payment-flexible - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/klarna/klarna-part-payment-flexible.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/klarna/klarna-part-payment-flexible.html related: - title: Klarna - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/klarna/klarnaions/klarna/klarna.html + link: docs/pbc/all/payment-service-provider/page.version/klarna/klarnaions/klarna/klarna.html - title: Klarna payment workflow - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/klarna/klarna-payment-workflow.html + link: docs/pbc/all/payment-service-provider/page.version/klarna/klarna-payment-workflow.html - title: Klarna - Invoice Pay in 14 days - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/klarna/klarna-invoice-pay-in-14-days.html + link: docs/pbc/all/payment-service-provider/page.version/klarna/klarna-invoice-pay-in-14-days.html - title: Klarna state machine commands and conditions - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/klarna/klarna-state-machine-commands-and-conditions.html + link: docs/pbc/all/payment-service-provider/page.version/klarna/klarna-state-machine-commands-and-conditions.html --- ## Payment Workflow Scenarios @@ -53,4 +50,4 @@ The configuration to integrate `Part Payment` using Klarna is: You can copy over configuration to your config file from the Klarna bundles `config.dist.php` file. ## Perform Requests -In order to perform the needed requests, you can easily use the implemented [Klarna State Machine Commands and Conditions](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/klarna/klarna-state-machine-commands-and-conditions.html). The next section gives you a summary of them. +In order to perform the needed requests, you can easily use the implemented [Klarna State Machine Commands and Conditions](/docs/pbc/all/payment-service-provider/{{page.version}}/klarna/klarna-state-machine-commands-and-conditions.html). The next section gives you a summary of them. diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/klarna/klarna-payment-workflow.md b/docs/pbc/all/payment-service-provider/202212.0/klarna/klarna-payment-workflow.md similarity index 66% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/klarna/klarna-payment-workflow.md rename to docs/pbc/all/payment-service-provider/202212.0/klarna/klarna-payment-workflow.md index ea19f6fdf30..aeaa27af10e 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/klarna/klarna-payment-workflow.md +++ b/docs/pbc/all/payment-service-provider/202212.0/klarna/klarna-payment-workflow.md @@ -6,20 +6,17 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/klarna-payment-workflow originalArticleId: 3c541e8f-7983-4f74-acce-a34aebb26c36 redirect_from: - - /2021080/docs/klarna-payment-workflow - - /2021080/docs/en/klarna-payment-workflow - - /docs/klarna-payment-workflow - - /docs/en/klarna-payment-workflow - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/klarna/klarna-payment-workflow.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/klarna/klarna-payment-workflow.html related: - title: Klarna - Invoice Pay in 14 days - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/klarna/klarna-invoice-pay-in-14-days.html + link: docs/pbc/all/payment-service-provider/page.version/klarna/klarna-invoice-pay-in-14-days.html - title: Klarna - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/klarna/klarna.html + link: docs/pbc/all/payment-service-provider/page.version/klarna/klarna.html - title: Klarna - Part Payment Flexible - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/klarna/klarna-part-payment-flexible.html + link: docs/pbc/all/payment-service-provider/page.version/klarna/klarna-part-payment-flexible.html - title: Klarna state machine commands and conditions - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/klarna/klarna-state-machine-commands-and-conditions.html + link: docs/pbc/all/payment-service-provider/page.version/klarna/klarna-state-machine-commands-and-conditions.html --- Both `Part Payment` and `Invoice` payment methods have the same request flow. It basically consists of the following steps: diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/klarna/klarna-state-machine-commands-and-conditions.md b/docs/pbc/all/payment-service-provider/202212.0/klarna/klarna-state-machine-commands-and-conditions.md similarity index 84% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/klarna/klarna-state-machine-commands-and-conditions.md rename to docs/pbc/all/payment-service-provider/202212.0/klarna/klarna-state-machine-commands-and-conditions.md index 4cd36864821..75b116b82be 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/klarna/klarna-state-machine-commands-and-conditions.md +++ b/docs/pbc/all/payment-service-provider/202212.0/klarna/klarna-state-machine-commands-and-conditions.md @@ -6,20 +6,17 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/klarna-state-machine-commands-and-conditions originalArticleId: 38a8ca62-b931-49c9-8764-fbfa47add05b redirect_from: - - /2021080/docs/klarna-state-machine-commands-and-conditions - - /2021080/docs/en/klarna-state-machine-commands-and-conditions - - /docs/klarna-state-machine-commands-and-conditions - - /docs/en/klarna-state-machine-commands-and-conditions - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/klarna/klarna-state-machine-commands-and-conditions.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/klarna/klarna-state-machine-commands-and-conditions.html related: - title: Klarna - Invoice Pay in 14 days - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/klarna/klarna-invoice-pay-in-14-days.html + link: docs/pbc/all/payment-service-provider/page.version/klarna/klarna-invoice-pay-in-14-days.html - title: Klarna - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/klarna/klarna.html + link: docs/pbc/all/payment-service-provider/page.version/klarna/klarna.html - title: Klarna - Part Payment Flexible - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/klarna/klarna-part-payment-flexible.html + link: docs/pbc/all/payment-service-provider/page.version/klarna/klarna-part-payment-flexible.html - title: Klarna payment workflow - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/klarna/klarna-payment-workflow.html + link: docs/pbc/all/payment-service-provider/page.version/klarna/klarna-payment-workflow.html --- ## Commands diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/klarna/klarna.md b/docs/pbc/all/payment-service-provider/202212.0/klarna/klarna.md similarity index 81% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/klarna/klarna.md rename to docs/pbc/all/payment-service-provider/202212.0/klarna/klarna.md index a56144b9dde..a99f9101fd7 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/klarna/klarna.md +++ b/docs/pbc/all/payment-service-provider/202212.0/klarna/klarna.md @@ -6,20 +6,17 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/klarna originalArticleId: 19d4dba2-c122-4a37-8170-e8ad49b71821 redirect_from: - - /2021080/docs/klarna - - /2021080/docs/en/klarna - - /docs/klarna - - /docs/en/klarna - /docs/scos/user/technology-partners/202212.0/payment-partners/klarna.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/klarna/klarna.html related: - title: Klarna payment workflow - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/klarna/klarna-payment-workflow.html + link: docs/pbc/all/payment-service-provider/page.version/klarna/klarna-payment-workflow.html - title: Klarna - Invoice Pay in 14 days - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/klarna/klarna-invoice-pay-in-14-days.html + link: docs/pbc/all/payment-service-provider/page.version/klarna/klarna-invoice-pay-in-14-days.html - title: Klarna - Part Payment Flexible - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/klarna/klarna-part-payment-flexible.html + link: docs/pbc/all/payment-service-provider/page.version/klarna/klarna-part-payment-flexible.html - title: Klarna state machine commands and conditions - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/klarna/klarna-state-machine-commands-and-conditions.html + link: docs/pbc/all/payment-service-provider/page.version/klarna/klarna-state-machine-commands-and-conditions.html --- ## Partner Information @@ -63,10 +60,10 @@ The [Klarna State Machine Commands and Conditions](klarna-state-machine.htm) tri ## Related Developer guides -* [Klarna - Invoice Pay in 14 days](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/klarna/klarna-invoice-pay-in-14-days.html) -* [Klarna - Part Payment Flexible](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/klarna/klarna-part-payment-flexible.html) -* [Klarna payment workflow](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/klarna/klarna-payment-workflow.html) -* [Klarna state machine commands and conditions](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/klarna/klarna-state-machine-commands-and-conditions.html) +* [Klarna - Invoice Pay in 14 days](/docs/pbc/all/payment-service-provider/{{page.version}}/klarna/klarna-invoice-pay-in-14-days.html) +* [Klarna - Part Payment Flexible](/docs/pbc/all/payment-service-provider/{{page.version}}/klarna/klarna-part-payment-flexible.html) +* [Klarna payment workflow](/docs/pbc/all/payment-service-provider/{{page.version}}/klarna/klarna-payment-workflow.html) +* [Klarna state machine commands and conditions](/docs/pbc/all/payment-service-provider/{{page.version}}/klarna/klarna-state-machine-commands-and-conditions.html) --- diff --git a/docs/pbc/all/payment-service-provider/202212.0/payment-service-provider.md b/docs/pbc/all/payment-service-provider/202212.0/payment-service-provider.md index aeb57e8d85a..7fcab639ce4 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/payment-service-provider.md +++ b/docs/pbc/all/payment-service-provider/202212.0/payment-service-provider.md @@ -3,8 +3,27 @@ title: Payment Service Provider description: Different payment methods for your shop last_updated: Apr 23, 2023 template: concept-topic-template +redirect_from: + - /docs/pbc/all/payment-service-providers/psp.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payment-service-provider-integrations.html --- The *Payment Service Provider* PBC enables different kinds of payment methods, like credit cards of gift cards, to be used by customers. You can configure multiple payment methods to be available in your shop. The variety of third-party payment solutions let you find the best payment methods for your business requirements. -For more details, see [Payments feature overview](/docs/pbc/all/payment-service-provider/{{page.version}}/payments-feature-overview.html). +The capability consists of a base shop and the marketplace addon. The base shop features are needed for running a regular shop in which your company is the only entity fulfilling orders. To run a marketplace, the features from both the base shop and the marketplace addon are required. + +Spryker offers the following Payment Service Providers (PSP) integrations: + +| NAME | MARKETPLACE COMPATIBLE | AVAILABLE IN ACP | +| --- | --- | --- | +| Spryker Pay | Yes | No | +| Adyen | No | No | +| After Pay | No | No | +| Braintree | No | No | +| Crefo Pay | No | No | +| Computop | No | No | +| Easycredit | No | No | +| Optile | No | No | +| [Payone](/docs/pbc/all/payment-service-provider/{{page.version}}/payone/integration-in-the-back-office/payone-integration-in-the-back-office.html) | No | Yes | +| Ratepay | No | No | +| [Unzer](/docs/pbc/all/payment-service-provider/{{page.version}}/unzer/unzer.html) | Yes | No | diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payolution/install-and-configure-payolution.md b/docs/pbc/all/payment-service-provider/202212.0/payolution/install-and-configure-payolution.md similarity index 89% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payolution/install-and-configure-payolution.md rename to docs/pbc/all/payment-service-provider/202212.0/payolution/install-and-configure-payolution.md index 1f1ea780a0c..fcac9661ce6 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payolution/install-and-configure-payolution.md +++ b/docs/pbc/all/payment-service-provider/202212.0/payolution/install-and-configure-payolution.md @@ -12,17 +12,18 @@ redirect_from: - /docs/en/payolution-configuration - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/payolution/installing-and-configuring-payolution.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/payolution/installing-and-configuring-payolution.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payolution/install-and-configure-payolution.html related: - title: Integrating Payolution - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/payolution/integrate-payolution.html + link: docs/pbc/all/payment-service-provider/page.version/payolution/integrate-payolution.html - title: Payolution - Performing Requests - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/payolution/payolution-performing-requests.html + link: docs/pbc/all/payment-service-provider/page.version/payolution/payolution-performing-requests.html - title: Payolution request flow - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/payolution/payolution-request-flow.html + link: docs/pbc/all/payment-service-provider/page.version/payolution/payolution-request-flow.html - title: Integrating the installment payment method for Payolution - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/payolution/integrate-the-installment-payment-method-for-payolution.html + link: docs/pbc/all/payment-service-provider/page.version/payolution/integrate-the-installment-payment-method-for-payolution.html - title: Integrating the invoice paymnet method for Payolution - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/payolution/integrate-the-invoice-payment-method-for-payolution.html + link: docs/pbc/all/payment-service-provider/page.version/payolution/integrate-the-invoice-payment-method-for-payolution.html --- To integrate Payolution into your project, first you need to install and configure the Payolution module. This topic describes how to do that. diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payolution/integrate-payolution.md b/docs/pbc/all/payment-service-provider/202212.0/payolution/integrate-payolution.md similarity index 85% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payolution/integrate-payolution.md rename to docs/pbc/all/payment-service-provider/202212.0/payolution/integrate-payolution.md index 93195925b4e..31bcceda82d 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payolution/integrate-payolution.md +++ b/docs/pbc/all/payment-service-provider/202212.0/payolution/integrate-payolution.md @@ -5,22 +5,19 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/payolution-integration-into-project originalArticleId: d071cda2-3ca2-41b2-afbb-a9cdcdb09b5e redirect_from: - - /2021080/docs/payolution-integration-into-project - - /2021080/docs/en/payolution-integration-into-project - - /docs/payolution-integration-into-project - - /docs/en/payolution-integration-into-project - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/payolution/integrating-payolution.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payolution/integrate-payolution.html related: - title: Installing and configuring Payolution - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/payolution/install-and-configure-payolution.html + link: docs/pbc/all/payment-service-provider/page.version/payolution/install-and-configure-payolution.html - title: Payolution - Performing Requests - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/payolution/payolution-performing-requests.html + link: docs/pbc/all/payment-service-provider/page.version/payolution/payolution-performing-requests.html - title: Payolution request flow - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/payolution/payolution-request-flow.html + link: docs/pbc/all/payment-service-provider/page.version/payolution/payolution-request-flow.html - title: Integrating the installment payment method for Payolution - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/payolution/integrate-the-installment-payment-method-for-payolution.html + link: docs/pbc/all/payment-service-provider/page.version/payolution/integrate-the-installment-payment-method-for-payolution.html - title: Integrating the invoice paymnet method for Payolution - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/payolution/integrate-the-invoice-payment-method-for-payolution.html + link: docs/pbc/all/payment-service-provider/page.version/payolution/integrate-the-invoice-payment-method-for-payolution.html --- {% info_block errorBox %} @@ -31,7 +28,7 @@ There is currently an issue when using giftcards with Payolution. Our team is de ## Prerequisites -Before proceeding with the integration, make sure you have [installed and configured](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/payolution/install-and-configure-payolution.html) the Payolution module. +Before proceeding with the integration, make sure you have [installed and configured](/docs/pbc/all/payment-service-provider/{{page.version}}/payolution/install-and-configure-payolution.html) the Payolution module. ## Frontend Integration diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payolution/integrate-the-installment-payment-method-for-payolution.md b/docs/pbc/all/payment-service-provider/202212.0/payolution/integrate-the-installment-payment-method-for-payolution.md similarity index 81% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payolution/integrate-the-installment-payment-method-for-payolution.md rename to docs/pbc/all/payment-service-provider/202212.0/payolution/integrate-the-installment-payment-method-for-payolution.md index b6e2d2b82a7..3c1f62dcaeb 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payolution/integrate-the-installment-payment-method-for-payolution.md +++ b/docs/pbc/all/payment-service-provider/202212.0/payolution/integrate-the-installment-payment-method-for-payolution.md @@ -6,23 +6,20 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/payolution-installment originalArticleId: 8859c087-cad6-43e0-8365-caf51c3423cf redirect_from: - - /2021080/docs/payolution-installment - - /2021080/docs/en/payolution-installment - - /docs/payolution-installment - - /docs/en/payolution-installment - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/payolution/integrating-the-installment-payment-method-for-payolution.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/payolution/integrating-the-installment-payment-method-for-payolution.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payolution/integrate-the-installment-payment-method-for-payolution.html related: - title: Installing and configuring Payolution - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/payolution/install-and-configure-payolution.html + link: docs/pbc/all/payment-service-provider/page.version/payolution/install-and-configure-payolution.html - title: Integrating Payolution - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/payolution/integrate-payolution.html + link: docs/pbc/all/payment-service-provider/page.version/payolution/integrate-payolution.html - title: Payolution - Performing Requests - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/payolution/payolution-performing-requests.html + link: docs/pbc/all/payment-service-provider/page.version/payolution/payolution-performing-requests.html - title: Payolution request flow - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/payolution/payolution-request-flow.html + link: docs/pbc/all/payment-service-provider/page.version/payolution/payolution-request-flow.html - title: Integrating the invoice paymnet method for Payolution - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/payolution/integrate-the-invoice-payment-method-for-payolution.html + link: docs/pbc/all/payment-service-provider/page.version/payolution/integrate-the-invoice-payment-method-for-payolution.html --- ## Installment Scenarios diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payolution/integrate-the-invoice-payment-method-for-payolution.md b/docs/pbc/all/payment-service-provider/202212.0/payolution/integrate-the-invoice-payment-method-for-payolution.md similarity index 78% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payolution/integrate-the-invoice-payment-method-for-payolution.md rename to docs/pbc/all/payment-service-provider/202212.0/payolution/integrate-the-invoice-payment-method-for-payolution.md index db3e1ec2ccf..5ce119cb6d6 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payolution/integrate-the-invoice-payment-method-for-payolution.md +++ b/docs/pbc/all/payment-service-provider/202212.0/payolution/integrate-the-invoice-payment-method-for-payolution.md @@ -6,23 +6,20 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/payolution-invoice originalArticleId: 77f3e81c-18a1-46e0-b4f6-492681bf66da redirect_from: - - /2021080/docs/payolution-invoice - - /2021080/docs/en/payolution-invoice - - /docs/payolution-invoice - - /docs/en/payolution-invoice - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/payolution/integrating-the-invoice-payment-method-for-payolution.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/payolution/integrating-the-invoice-payment-method-for-payolution.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payolution/integrate-the-invoice-payment-method-for-payolution.html related: - title: Installing and configuring Payolution - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/payolution/install-and-configure-payolution.html + link: docs/pbc/all/payment-service-provider/page.version/payolution/install-and-configure-payolution.html - title: Integrating Payolution - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/payolution/integrate-payolution.html + link: docs/pbc/all/payment-service-provider/page.version/payolution/integrate-payolution.html - title: Payolution - Performing Requests - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/payolution/payolution-performing-requests.html + link: docs/pbc/all/payment-service-provider/page.version/payolution/payolution-performing-requests.html - title: Payolution request flow - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/payolution/payolution-request-flow.html + link: docs/pbc/all/payment-service-provider/page.version/payolution/payolution-request-flow.html - title: Integrating the installment payment method for Payolution - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/payolution/integrate-the-installment-payment-method-for-payolution.html + link: docs/pbc/all/payment-service-provider/page.version/payolution/integrate-the-installment-payment-method-for-payolution.html --- ## Workflow Scenarios @@ -99,4 +96,4 @@ The configuration to integrate invoice payments using Payolution is: ### Performing Requests -In order to perform the needed requests, you can easily use the implemented state machine commands and conditions. See [Payolution—Performing Requests](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/payolution/payolution-performing-requests.html) for a summary. You can also use the facade methods directly which, however, are invoked by the state machine. +In order to perform the needed requests, you can easily use the implemented state machine commands and conditions. See [Payolution—Performing Requests](/docs/pbc/all/payment-service-provider/{{page.version}}/payolution/payolution-performing-requests.html) for a summary. You can also use the facade methods directly which, however, are invoked by the state machine. diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payolution/payolution-performing-requests.md b/docs/pbc/all/payment-service-provider/202212.0/payolution/payolution-performing-requests.md similarity index 85% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payolution/payolution-performing-requests.md rename to docs/pbc/all/payment-service-provider/202212.0/payolution/payolution-performing-requests.md index f4945405738..909016eb5b8 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payolution/payolution-performing-requests.md +++ b/docs/pbc/all/payment-service-provider/202212.0/payolution/payolution-performing-requests.md @@ -6,21 +6,18 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/payolution-requests originalArticleId: d33f6bca-5f93-4761-ba90-2aeb9a5baa56 redirect_from: - - /2021080/docs/payolution-requests - - /2021080/docs/en/payolution-requests - - /docs/payolution-requests - - /docs/en/payolution-requests + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payolution/payolution-performing-requests.html related: - title: Integrating the invoice paymnet method for Payolution - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/payolution/integrate-the-invoice-payment-method-for-payolution.html + link: docs/pbc/all/payment-service-provider/page.version/payolution/integrate-the-invoice-payment-method-for-payolution.html - title: Payolution request flow - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/payolution/payolution-request-flow.html + link: docs/pbc/all/payment-service-provider/page.version/payolution/payolution-request-flow.html - title: Integrating the installment payment method for Payolution - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/payolution/integrate-the-installment-payment-method-for-payolution.html + link: docs/pbc/all/payment-service-provider/page.version/payolution/integrate-the-installment-payment-method-for-payolution.html - title: Payolution - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/payolution/payolution.html + link: docs/pbc/all/payment-service-provider/page.version/payolution/payolution.html - title: Installing and configuring Payolution - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/payolution/install-and-configure-payolution.html + link: docs/pbc/all/payment-service-provider/page.version/payolution/install-and-configure-payolution.html --- To perform the needed requests, you can easily use the implemented state machine commands and conditions. This article gives a summary of them. You can also use the facade methods directly, which, however, are invoked by the state machine. diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payolution/payolution-request-flow.md b/docs/pbc/all/payment-service-provider/202212.0/payolution/payolution-request-flow.md similarity index 55% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payolution/payolution-request-flow.md rename to docs/pbc/all/payment-service-provider/202212.0/payolution/payolution-request-flow.md index 45b2f453f56..cb920129aff 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payolution/payolution-request-flow.md +++ b/docs/pbc/all/payment-service-provider/202212.0/payolution/payolution-request-flow.md @@ -6,25 +6,22 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/payolution-workflow originalArticleId: 5b1cfc2a-7960-4d1c-96e5-1243473d3d50 redirect_from: - - /2021080/docs/payolution-workflow - - /2021080/docs/en/payolution-workflow - - /docs/payolution-workflow - - /docs/en/payolution-workflow - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/payolution/payolution-request-flow.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payolution/payolution-request-flow.html related: - title: Integrating the invoice paymnet method for Payolution - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/payolution/integrate-the-invoice-payment-method-for-payolution.html + link: docs/pbc/all/payment-service-provider/page.version/payolution/integrate-the-invoice-payment-method-for-payolution.html - title: Integrating the installment payment method for Payolution - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/payolution/integrate-the-installment-payment-method-for-payolution.html + link: docs/pbc/all/payment-service-provider/page.version/payolution/integrate-the-installment-payment-method-for-payolution.html - title: Payolution - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/payolution/payolution.html + link: docs/pbc/all/payment-service-provider/page.version/payolution/payolution.html - title: Installing and configuring Payolution - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/payolution/install-and-configure-payolution.html + link: docs/pbc/all/payment-service-provider/page.version/payolution/install-and-configure-payolution.html - title: Payolution - Performing Requests - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/payolution/payolution-performing-requests.html + link: docs/pbc/all/payment-service-provider/page.version/payolution/payolution-performing-requests.html --- -Both [invoice](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/payolution/integrate-the-invoice-payment-method-for-payolution.html) and [installment](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/payolution/integrate-the-installment-payment-method-for-payolution.html) payment methods utilize the same request flow. It basically consists of the following requests: +Both [invoice](/docs/pbc/all/payment-service-provider/{{page.version}}/payolution/integrate-the-invoice-payment-method-for-payolution.html) and [installment](/docs/pbc/all/payment-service-provider/{{page.version}}/payolution/integrate-the-installment-payment-method-for-payolution.html) payment methods utilize the same request flow. It basically consists of the following requests: * Calculation (for instalment only): to calculate the instalment amounts, dues, and durations. * Pre-check (optional): to check the user information in order to make sure that all the needed information is correct before doing the actual pre-authorization. * Pre-authorize: to perform a payment risk check which is a mandatory step before every payment. The payment is basically considered accepted when it is authorized. @@ -35,4 +32,4 @@ Both [invoice](/docs/pbc/all/payment-service-provider/{{page.version}}/third-par ![Click Me](https://spryker.s3.eu-central-1.amazonaws.com/docs/Technology+Partners/Payment+Partners/Payolution/payolution-workflow.png) -See Payolution - [Performing Requests](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/payolution/payolution-performing-requests.html) for detailed information on the requests. +See Payolution - [Performing Requests](/docs/pbc/all/payment-service-provider/{{page.version}}/payolution/payolution-performing-requests.html) for detailed information on the requests. diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payolution/payolution.md b/docs/pbc/all/payment-service-provider/202212.0/payolution/payolution.md similarity index 75% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payolution/payolution.md rename to docs/pbc/all/payment-service-provider/202212.0/payolution/payolution.md index 4ae6b1fbeb0..f9d8c7a4968 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payolution/payolution.md +++ b/docs/pbc/all/payment-service-provider/202212.0/payolution/payolution.md @@ -6,23 +6,20 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/payolution originalArticleId: 4d4f59ce-7e96-42af-a61d-c23df33d1205 redirect_from: - - /2021080/docs/payolution - - /2021080/docs/en/payolution - - /docs/payolution - - /docs/en/payolution + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payolution/payolution.html related: - title: Installing and configuring Payolution - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/payolution/install-and-configure-payolution.html + link: docs/pbc/all/payment-service-provider/page.version/payolution/install-and-configure-payolution.html - title: Integrating Payolution - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/payolution/integrate-payolution.html + link: docs/pbc/all/payment-service-provider/page.version/payolution/integrate-payolution.html - title: Payolution - Performing Requests - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/payolution/payolution-performing-requests.html + link: docs/pbc/all/payment-service-provider/page.version/payolution/payolution-performing-requests.html - title: Payolution request flow - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/payolution/payolution-request-flow.html + link: docs/pbc/all/payment-service-provider/page.version/payolution/payolution-request-flow.html - title: Integrating the installment payment method for Payolution - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/payolution/integrate-the-installment-payment-method-for-payolution.html + link: docs/pbc/all/payment-service-provider/page.version/payolution/integrate-the-installment-payment-method-for-payolution.html - title: Integrating the invoice paymnet method for Payolution - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/payolution/integrate-the-invoice-payment-method-for-payolution.html + link: docs/pbc/all/payment-service-provider/page.version/payolution/integrate-the-invoice-payment-method-for-payolution.html --- ## Partner Information diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payone/integration-in-the-back-office/disconnect-payone.md b/docs/pbc/all/payment-service-provider/202212.0/payone/integration-in-the-back-office/disconnect-payone.md similarity index 88% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payone/integration-in-the-back-office/disconnect-payone.md rename to docs/pbc/all/payment-service-provider/202212.0/payone/integration-in-the-back-office/disconnect-payone.md index a48a4f2b411..b73500447e8 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payone/integration-in-the-back-office/disconnect-payone.md +++ b/docs/pbc/all/payment-service-provider/202212.0/payone/integration-in-the-back-office/disconnect-payone.md @@ -4,6 +4,7 @@ description: Learn how you can disconnect the Payone app from your Spryker shop template: howto-guide-template redirect_from: - /docs/pbc/all/payment-service-providers/payone/disconnect-payone.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payone/integration-in-the-back-office/disconnect-payone.html --- Disconnecting Payone from your store removes its payment methods from the store configuration. However, you can disconnect Payone only if there are no open orders that still use the Payone payment methods. diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payone/integration-in-the-back-office/integrate-payone.md b/docs/pbc/all/payment-service-provider/202212.0/payone/integration-in-the-back-office/integrate-payone.md similarity index 96% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payone/integration-in-the-back-office/integrate-payone.md rename to docs/pbc/all/payment-service-provider/202212.0/payone/integration-in-the-back-office/integrate-payone.md index 4c6f391bfbb..f7650adaa5a 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payone/integration-in-the-back-office/integrate-payone.md +++ b/docs/pbc/all/payment-service-provider/202212.0/payone/integration-in-the-back-office/integrate-payone.md @@ -4,6 +4,7 @@ description: Learn how you can integrate the Payone app into your Spryker shop template: howto-guide-template redirect_from: - /docs/pbc/all/payment-service-providers/payone/integrate-payone.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payone/integration-in-the-back-office/integrate-payone.html --- To integrate Payone, follow these steps. diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payone/integration-in-the-back-office/payone-integration-in-the-back-office.md b/docs/pbc/all/payment-service-provider/202212.0/payone/integration-in-the-back-office/payone-integration-in-the-back-office.md similarity index 95% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payone/integration-in-the-back-office/payone-integration-in-the-back-office.md rename to docs/pbc/all/payment-service-provider/202212.0/payone/integration-in-the-back-office/payone-integration-in-the-back-office.md index b483636e91e..ba0628dc93b 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payone/integration-in-the-back-office/payone-integration-in-the-back-office.md +++ b/docs/pbc/all/payment-service-provider/202212.0/payone/integration-in-the-back-office/payone-integration-in-the-back-office.md @@ -6,6 +6,7 @@ redirect_from: - /docs/aop/user/apps/payone.html - /docs/acp/user/apps/payone.html - /docs/pbc/all/payment-service-providers/payone/payone.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payone/integration-in-the-back-office/payone-integration-in-the-back-office.html --- The [Payone](https://www.payone.com/DE-en?ref=spryker-documentation) app lets your customers make payments with common payment methods, such as credit card and PayPal. @@ -78,7 +79,4 @@ When customers pay with PayPal, a shop owner can do the following: ## Next steps -[Integrate Payone](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/payone/integration-in-the-back-office/integrate-payone.html) - - - +[Integrate Payone](/docs/pbc/all/payment-service-provider/{{page.version}}/payone/integration-in-the-back-office/integrate-payone.html) diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payone/manual-integration/integrate-payone.md b/docs/pbc/all/payment-service-provider/202212.0/payone/manual-integration/integrate-payone.md similarity index 89% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payone/manual-integration/integrate-payone.md rename to docs/pbc/all/payment-service-provider/202212.0/payone/manual-integration/integrate-payone.md index 6bf944e23f6..dd821ae8652 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payone/manual-integration/integrate-payone.md +++ b/docs/pbc/all/payment-service-provider/202212.0/payone/manual-integration/integrate-payone.md @@ -6,33 +6,30 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/payone-integration-with-project-scos originalArticleId: a86017aa-d5ce-44cf-b568-6cda73261766 redirect_from: - - /2021080/docs/payone-integration-with-project-scos - - /2021080/docs/en/payone-integration-with-project-scos - - /docs/payone-integration-with-project-scos - - /docs/en/payone-integration-with-project-scos - /docs/scos/user/technology-partners/202212.0/payment-partners/bs-payone/scos-integration/payone-integration-into-the-scos-project.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payone/manual-integration/integrate-payone.html related: - title: PayOne - Cash on Delivery - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/bs-payone/scos-integration/payone-cash-on-delivery.html + link: docs/pbc/all/payment-service-provider/page.version/bs-payone/scos-integration/payone-cash-on-delivery.html - title: PayOne - Authorization and Preauthorization Capture Flows - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/bs-payone/legacy-demoshop-integration/payone-authorization-and-preauthorization-capture-flows.html + link: docs/pbc/all/payment-service-provider/page.version/bs-payone/legacy-demoshop-integration/payone-authorization-and-preauthorization-capture-flows.html - title: PayOne - Invoice Payment - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/bs-payone/legacy-demoshop-integration/payone-payment-methods/payone-invoice-payment.html + link: docs/pbc/all/payment-service-provider/page.version/bs-payone/legacy-demoshop-integration/payone-payment-methods/payone-invoice-payment.html - title: PayOne - Prepayment - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/bs-payone/legacy-demoshop-integration/payone-payment-methods/payone-prepayment.html + link: docs/pbc/all/payment-service-provider/page.version/bs-payone/legacy-demoshop-integration/payone-payment-methods/payone-prepayment.html - title: PayOne - Direct Debit Payment - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/bs-payone/legacy-demoshop-integration/payone-payment-methods/payone-direct-debit-payment.html + link: docs/pbc/all/payment-service-provider/page.version/bs-payone/legacy-demoshop-integration/payone-payment-methods/payone-direct-debit-payment.html - title: PayOne - Security Invoice Payment - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/bs-payone/legacy-demoshop-integration/payone-payment-methods/payone-security-invoice-payment.html + link: docs/pbc/all/payment-service-provider/page.version/bs-payone/legacy-demoshop-integration/payone-payment-methods/payone-security-invoice-payment.html - title: PayOne - Online Transfer Payment - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/bs-payone/legacy-demoshop-integration/payone-payment-methods/payone-online-transfer-payment.html + link: docs/pbc/all/payment-service-provider/page.version/bs-payone/legacy-demoshop-integration/payone-payment-methods/payone-online-transfer-payment.html - title: PayOne - Paypal Payment - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/bs-payone/legacy-demoshop-integration/payone-payment-methods/payone-paypal-payment.html + link: docs/pbc/all/payment-service-provider/page.version/bs-payone/legacy-demoshop-integration/payone-payment-methods/payone-paypal-payment.html --- {% info_block errorBox %} -There is currently an issue when using giftcards with PayOne. Our team is developing a fix for it. +PayOne is not compatible with gift cards. We will update this document once the issue is resolved. {% endinfo_block %} diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payone/manual-integration/payone-cash-on-delivery.md b/docs/pbc/all/payment-service-provider/202212.0/payone/manual-integration/payone-cash-on-delivery.md similarity index 68% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payone/manual-integration/payone-cash-on-delivery.md rename to docs/pbc/all/payment-service-provider/202212.0/payone/manual-integration/payone-cash-on-delivery.md index 427890aa6f9..12d33c7e262 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payone/manual-integration/payone-cash-on-delivery.md +++ b/docs/pbc/all/payment-service-provider/202212.0/payone/manual-integration/payone-cash-on-delivery.md @@ -6,24 +6,21 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/payone-cash-on-delivery originalArticleId: e68a44fe-8cfe-4199-a3d0-537c04107688 redirect_from: - - /2021080/docs/payone-cash-on-delivery - - /2021080/docs/en/payone-cash-on-delivery - - /docs/payone-cash-on-delivery - - /docs/en/payone-cash-on-delivery - /docs/scos/user/technology-partners/202212.0/payment-partners/bs-payone/scos-integration/payone-cash-on-delivery.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payone/manual-integration/payone-cash-on-delivery.html related: - title: PayOne - Authorization and Preauthorization Capture Flows - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/bs-payone/legacy-demoshop-integration/payone-authorization-and-preauthorization-capture-flows.html + link: docs/pbc/all/payment-service-provider/page.version/bs-payone/legacy-demoshop-integration/payone-authorization-and-preauthorization-capture-flows.html - title: PayOne - Invoice Payment - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/bs-payone/legacy-demoshop-integration/payone-payment-methods/payone-invoice-payment.html + link: docs/pbc/all/payment-service-provider/page.version/bs-payone/legacy-demoshop-integration/payone-payment-methods/payone-invoice-payment.html - title: PayOne - Prepayment - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/bs-payone/legacy-demoshop-integration/payone-payment-methods/payone-prepayment.html + link: docs/pbc/all/payment-service-provider/page.version/bs-payone/legacy-demoshop-integration/payone-payment-methods/payone-prepayment.html - title: PayOne - Direct Debit Payment - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/bs-payone/legacy-demoshop-integration/payone-payment-methods/payone-direct-debit-payment.html + link: docs/pbc/all/payment-service-provider/page.version/bs-payone/legacy-demoshop-integration/payone-payment-methods/payone-direct-debit-payment.html - title: PayOne - Security Invoice Payment - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/bs-payone/legacy-demoshop-integration/payone-payment-methods/payone-security-invoice-payment.html + link: docs/pbc/all/payment-service-provider/page.version/bs-payone/legacy-demoshop-integration/payone-payment-methods/payone-security-invoice-payment.html - title: PayOne - Online Transfer Payment - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/bs-payone/legacy-demoshop-integration/payone-payment-methods/payone-online-transfer-payment.html + link: docs/pbc/all/payment-service-provider/page.version/bs-payone/legacy-demoshop-integration/payone-payment-methods/payone-online-transfer-payment.html --- ## Frontend Integration: Extending Checkout Page diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payone/manual-integration/payone-manual-integration.md b/docs/pbc/all/payment-service-provider/202212.0/payone/manual-integration/payone-manual-integration.md similarity index 92% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payone/manual-integration/payone-manual-integration.md rename to docs/pbc/all/payment-service-provider/202212.0/payone/manual-integration/payone-manual-integration.md index cf89690d994..ee50cf0bc33 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payone/manual-integration/payone-manual-integration.md +++ b/docs/pbc/all/payment-service-provider/202212.0/payone/manual-integration/payone-manual-integration.md @@ -6,28 +6,25 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/payone-v1-1 originalArticleId: ffd53037-46a0-410e-941c-eb9cd4c3ff22 redirect_from: - - /2021080/docs/payone-v1-1 - - /2021080/docs/en/payone-v1-1 - - /docs/payone-v1-1 - - /docs/en/payone-v1-1 - /docs/scos/user/technology-partners/202212.0/payment-partners/bs-payone/bs-payone.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payone/manual-integration/payone-manual-integration.html related: - title: PayOne - Integration into the SCOS Project - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/bs-payone/scos-integration/payone-integration-into-the-scos-project.html + link: docs/pbc/all/payment-service-provider/page.version/bs-payone/scos-integration/payone-integration-into-the-scos-project.html - title: PayOne - Risk Check and Address Check - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/bs-payone/scos-integration/payone-risk-check-and-address-check.html + link: docs/pbc/all/payment-service-provider/page.version/bs-payone/scos-integration/payone-risk-check-and-address-check.html - title: PayOne - Prepayment - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/bs-payone/legacy-demoshop-integration/payone-payment-methods/payone-prepayment.html + link: docs/pbc/all/payment-service-provider/page.version/bs-payone/legacy-demoshop-integration/payone-payment-methods/payone-prepayment.html - title: PayOne - Authorization and Preauthorization Capture Flows - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/bs-payone/legacy-demoshop-integration/payone-authorization-and-preauthorization-capture-flows.html + link: docs/pbc/all/payment-service-provider/page.version/bs-payone/legacy-demoshop-integration/payone-authorization-and-preauthorization-capture-flows.html - title: PayOne - Invoice Payment - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/bs-payone/legacy-demoshop-integration/payone-payment-methods/payone-invoice-payment.html + link: docs/pbc/all/payment-service-provider/page.version/bs-payone/legacy-demoshop-integration/payone-payment-methods/payone-invoice-payment.html - title: PayOne - Cash on Delivery - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/bs-payone/scos-integration/payone-cash-on-delivery.html + link: docs/pbc/all/payment-service-provider/page.version/bs-payone/scos-integration/payone-cash-on-delivery.html - title: PayOne - Credit Card Payment - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/bs-payone/legacy-demoshop-integration/payone-payment-methods/payone-credit-card-payment.html + link: docs/pbc/all/payment-service-provider/page.version/bs-payone/legacy-demoshop-integration/payone-payment-methods/payone-credit-card-payment.html - title: PayOne - Security Invoice Payment - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/bs-payone/legacy-demoshop-integration/payone-payment-methods/payone-security-invoice-payment.html + link: docs/pbc/all/payment-service-provider/page.version/bs-payone/legacy-demoshop-integration/payone-payment-methods/payone-security-invoice-payment.html --- ## Partner Information diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payone/manual-integration/payone-paypal-express-checkout-payment.md b/docs/pbc/all/payment-service-provider/202212.0/payone/manual-integration/payone-paypal-express-checkout-payment.md similarity index 96% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payone/manual-integration/payone-paypal-express-checkout-payment.md rename to docs/pbc/all/payment-service-provider/202212.0/payone/manual-integration/payone-paypal-express-checkout-payment.md index 830cf9f95f2..e2c0b3dd311 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payone/manual-integration/payone-paypal-express-checkout-payment.md +++ b/docs/pbc/all/payment-service-provider/202212.0/payone/manual-integration/payone-paypal-express-checkout-payment.md @@ -6,11 +6,8 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/payone-paypal-express-checkout-scos originalArticleId: 77d504fd-b731-4eb8-86a0-5435630900f8 redirect_from: - - /2021080/docs/payone-paypal-express-checkout-scos - - /2021080/docs/en/payone-paypal-express-checkout-scos - - /docs/payone-paypal-express-checkout-scos - - /docs/en/payone-paypal-express-checkout-scos - /docs/scos/user/technology-partners/202212.0/payment-partners/bs-payone/scos-integration/payone-paypal-express-checkout-payment.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payone/manual-integration/payone-paypal-express-checkout-payment.html --- The payment using PayPal requires a redirect to the PayPal website. When customers are redirected to PayPal's website, they have to authorize and after that either cancel or validate the transaction. diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payone/manual-integration/payone-risk-check-and-address-check.md b/docs/pbc/all/payment-service-provider/202212.0/payone/manual-integration/payone-risk-check-and-address-check.md similarity index 86% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payone/manual-integration/payone-risk-check-and-address-check.md rename to docs/pbc/all/payment-service-provider/202212.0/payone/manual-integration/payone-risk-check-and-address-check.md index 388fd39710f..926e5e01230 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payone/manual-integration/payone-risk-check-and-address-check.md +++ b/docs/pbc/all/payment-service-provider/202212.0/payone/manual-integration/payone-risk-check-and-address-check.md @@ -6,26 +6,23 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/payone-risk-check-address-check-scos originalArticleId: 38b985f4-811e-4e38-8f43-c7863cb5add2 redirect_from: - - /2021080/docs/payone-risk-check-address-check-scos - - /2021080/docs/en/payone-risk-check-address-check-scos - - /docs/payone-risk-check-address-check-scos - - /docs/en/payone-risk-check-address-check-scos - /docs/scos/user/technology-partners/202212.0/payment-partners/bs-payone/scos-integration/payone-risk-check-and-address-check.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/payone/manual-integration/payone-risk-check-and-address-check.html related: - title: PayOne - Cash on Delivery - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/bs-payone/scos-integration/payone-cash-on-delivery.html + link: docs/pbc/all/payment-service-provider/page.version/bs-payone/scos-integration/payone-cash-on-delivery.html - title: PayOne - Authorization and Preauthorization Capture Flows - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/bs-payone/legacy-demoshop-integration/payone-authorization-and-preauthorization-capture-flows.html + link: docs/pbc/all/payment-service-provider/page.version/bs-payone/legacy-demoshop-integration/payone-authorization-and-preauthorization-capture-flows.html - title: PayOne - Invoice Payment - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/bs-payone/legacy-demoshop-integration/payone-payment-methods/payone-invoice-payment.html + link: docs/pbc/all/payment-service-provider/page.version/bs-payone/legacy-demoshop-integration/payone-payment-methods/payone-invoice-payment.html - title: PayOne - Prepayment - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/bs-payone/legacy-demoshop-integration/payone-payment-methods/payone-prepayment.html + link: docs/pbc/all/payment-service-provider/page.version/bs-payone/legacy-demoshop-integration/payone-payment-methods/payone-prepayment.html - title: PayOne - Direct Debit Payment - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/bs-payone/legacy-demoshop-integration/payone-payment-methods/payone-direct-debit-payment.html + link: docs/pbc/all/payment-service-provider/page.version/bs-payone/legacy-demoshop-integration/payone-payment-methods/payone-direct-debit-payment.html - title: PayOne - Security Invoice Payment - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/bs-payone/legacy-demoshop-integration/payone-payment-methods/payone-security-invoice-payment.html + link: docs/pbc/all/payment-service-provider/page.version/bs-payone/legacy-demoshop-integration/payone-payment-methods/payone-security-invoice-payment.html - title: PayOne - Online Transfer Payment - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/bs-payone/legacy-demoshop-integration/payone-payment-methods/payone-online-transfer-payment.html + link: docs/pbc/all/payment-service-provider/page.version/bs-payone/legacy-demoshop-integration/payone-payment-methods/payone-online-transfer-payment.html --- On the project level, you should override execute and postCondition methods of `SprykerShop\Yves\CheckoutPage\Process\Steps\AddressStep`. diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/powerpay.md b/docs/pbc/all/payment-service-provider/202212.0/powerpay.md similarity index 96% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/powerpay.md rename to docs/pbc/all/payment-service-provider/202212.0/powerpay.md index 272c4921c74..30204947cf8 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/powerpay.md +++ b/docs/pbc/all/payment-service-provider/202212.0/powerpay.md @@ -11,6 +11,7 @@ redirect_from: - /docs/powerpay - /docs/en/powerpay - /docs/scos/user/technology-partners/202212.0/payment-partners/powerpay.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/powerpay.html related: - title: Technology Partner Integration link: docs/scos/user/technology-partners/page.version/technology-partners.html diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratenkauf-by-easycredit/install-and-configure-ratenkauf-by-easycredit.md b/docs/pbc/all/payment-service-provider/202212.0/ratenkauf-by-easycredit/install-and-configure-ratenkauf-by-easycredit.md similarity index 79% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratenkauf-by-easycredit/install-and-configure-ratenkauf-by-easycredit.md rename to docs/pbc/all/payment-service-provider/202212.0/ratenkauf-by-easycredit/install-and-configure-ratenkauf-by-easycredit.md index b4606f9844b..cfe2e3985a2 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratenkauf-by-easycredit/install-and-configure-ratenkauf-by-easycredit.md +++ b/docs/pbc/all/payment-service-provider/202212.0/ratenkauf-by-easycredit/install-and-configure-ratenkauf-by-easycredit.md @@ -6,17 +6,13 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/ratenkauf-by-easycredit-installation-and-configuration originalArticleId: fb3e79f2-a44a-464f-8b12-29f294b1adfd redirect_from: - - /2021080/docs/ratenkauf-by-easycredit-installation-and-configuration - - /2021080/docs/en/ratenkauf-by-easycredit-installation-and-configuration - - /docs/ratenkauf-by-easycredit-installation-and-configuration - - /docs/en/ratenkauf-by-easycredit-installation-and-configuration - - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/ratenkauf-by-easycredit/installing-and-configuring-ratenkauf-by-easycredit.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/ratenkauf-by-easycredit/installing-and-configuring-ratenkauf-by-easycredit.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratenkauf-by-easycredit/install-and-configure-ratenkauf-by-easycredit.html related: - title: ratenkauf by easyCredit - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/ratenkauf-by-easycredit/ratenkauf-by-easycredit.html + link: docs/pbc/all/payment-service-provider/page.version/ratenkauf-by-easycredit/ratenkauf-by-easycredit.html - title: Integrating ratenkauf by easyCredit - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/ratenkauf-by-easycredit/integrate-ratenkauf-by-easycredit.html + link: docs/pbc/all/payment-service-provider/page.version/ratenkauf-by-easycredit/integrate-ratenkauf-by-easycredit.html --- ## Installation diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratenkauf-by-easycredit/integrate-ratenkauf-by-easycredit.md b/docs/pbc/all/payment-service-provider/202212.0/ratenkauf-by-easycredit/integrate-ratenkauf-by-easycredit.md similarity index 98% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratenkauf-by-easycredit/integrate-ratenkauf-by-easycredit.md rename to docs/pbc/all/payment-service-provider/202212.0/ratenkauf-by-easycredit/integrate-ratenkauf-by-easycredit.md index fd50269766d..0acaa70ff4f 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratenkauf-by-easycredit/integrate-ratenkauf-by-easycredit.md +++ b/docs/pbc/all/payment-service-provider/202212.0/ratenkauf-by-easycredit/integrate-ratenkauf-by-easycredit.md @@ -6,16 +6,13 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/ratenkauf-integration-into-project originalArticleId: 8fa76fed-cfb3-4524-a570-79fa5d1e4859 redirect_from: - - /2021080/docs/ratenkauf-integration-into-project - - /2021080/docs/en/ratenkauf-integration-into-project - - /docs/ratenkauf-integration-into-project - - /docs/en/ratenkauf-integration-into-project - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/ratenkauf-by-easycredit/integrating-ratenkauf-by-easycredit.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratenkauf-by-easycredit/integrate-ratenkauf-by-easycredit.html related: - title: ratenkauf by easyCredit - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/ratenkauf-by-easycredit/ratenkauf-by-easycredit.html + link: docs/pbc/all/payment-service-provider/page.version/ratenkauf-by-easycredit/ratenkauf-by-easycredit.html - title: Installing and configuring ratenkauf by easyCredit - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/ratenkauf-by-easycredit/install-and-configure-ratenkauf-by-easycredit.html + link: docs/pbc/all/payment-service-provider/page.version/ratenkauf-by-easycredit/install-and-configure-ratenkauf-by-easycredit.html --- {% info_block errorBox %} diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratenkauf-by-easycredit/ratenkauf-by-easycredit.md b/docs/pbc/all/payment-service-provider/202212.0/ratenkauf-by-easycredit/ratenkauf-by-easycredit.md similarity index 81% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratenkauf-by-easycredit/ratenkauf-by-easycredit.md rename to docs/pbc/all/payment-service-provider/202212.0/ratenkauf-by-easycredit/ratenkauf-by-easycredit.md index ceb1bc60dc9..f76eb316bcf 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratenkauf-by-easycredit/ratenkauf-by-easycredit.md +++ b/docs/pbc/all/payment-service-provider/202212.0/ratenkauf-by-easycredit/ratenkauf-by-easycredit.md @@ -6,16 +6,13 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/ratenkauf-by-easycredit originalArticleId: 86cf0b54-43b8-4585-adef-0245c01e702a redirect_from: - - /2021080/docs/ratenkauf-by-easycredit - - /2021080/docs/en/ratenkauf-by-easycredit - - /docs/ratenkauf-by-easycredit - - /docs/en/ratenkauf-by-easycredit - /docs/scos/user/technology-partners/202212.0/payment-partners/ratenkauf-by-easycredit.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratenkauf-by-easycredit/ratenkauf-by-easycredit.html related: - title: Installing and configuring ratenkauf by easyCredit - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/ratenkauf-by-easycredit/install-and-configure-ratenkauf-by-easycredit.html + link: docs/pbc/all/payment-service-provider/page.version/ratenkauf-by-easycredit/install-and-configure-ratenkauf-by-easycredit.html - title: Integrating ratenkauf by easyCredit - link: docs/pbc/all/payment-service-provider/page.version/third-party-integrations/ratenkauf-by-easycredit/integrate-ratenkauf-by-easycredit.html + link: docs/pbc/all/payment-service-provider/page.version/ratenkauf-by-easycredit/integrate-ratenkauf-by-easycredit.html --- ## Partner Information diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratepay/disable-address-updates-from-the-backend-application-for-ratepay.md b/docs/pbc/all/payment-service-provider/202212.0/ratepay/disable-address-updates-from-the-backend-application-for-ratepay.md similarity index 93% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratepay/disable-address-updates-from-the-backend-application-for-ratepay.md rename to docs/pbc/all/payment-service-provider/202212.0/ratepay/disable-address-updates-from-the-backend-application-for-ratepay.md index a18c70e1c98..2e9b73528f1 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratepay/disable-address-updates-from-the-backend-application-for-ratepay.md +++ b/docs/pbc/all/payment-service-provider/202212.0/ratepay/disable-address-updates-from-the-backend-application-for-ratepay.md @@ -6,13 +6,10 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/ratepay-disable-address-updates originalArticleId: a9f1412a-e53b-4ff3-b0af-a79370c3db2e redirect_from: - - /2021080/docs/ratepay-disable-address-updates - - /2021080/docs/en/ratepay-disable-address-updates - - /docs/ratepay-disable-address-updates - - /docs/en/ratepay-disable-address-updates - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/ratepay/disabling-address-updates-from-the-backend-application-for-ratepay.html - /docs/scos/user/technology-partners/202204.0/payment-partners/ratepay/ratepay-how-to-disable-address-updates-from-the-backend-application.html - /docs/scos/user/technology-partners/202212.0/payment-partners/ratepay/ratepay-how-to-disable-address-updates-from-the-backend-application.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratepay/disable-address-updates-from-the-backend-application-for-ratepay.html related: - title: Integrating the Invoice payment method for RatePay link: docs/scos/dev/technology-partner-guides/page.version/payment-partners/ratepay/integrating-payment-methods-for-ratepay//integrating-the-invoice-payment-method-for-ratepay.html diff --git a/docs/pbc/all/payment-service-provider/202212.0/ratepay/integrate-payment-methods-for-ratepay/integrate-payment-methods-for-ratepay.md b/docs/pbc/all/payment-service-provider/202212.0/ratepay/integrate-payment-methods-for-ratepay/integrate-payment-methods-for-ratepay.md new file mode 100644 index 00000000000..56113de8d4b --- /dev/null +++ b/docs/pbc/all/payment-service-provider/202212.0/ratepay/integrate-payment-methods-for-ratepay/integrate-payment-methods-for-ratepay.md @@ -0,0 +1,12 @@ +--- +title: Integrating payment methods for Ratepay +description: How to integrate RatePay payment methods +last_updated: Jan 12, 2023 +template: concept-topic-template +--- + +This section explains how to integrate the following payment methods with RatePay: +* [Direct debit](/docs/pbc/all/payment-service-provider/{{page.version}}/ratepay/integrate-payment-methods-for-ratepay/integrate-the-direct-debit-payment-method-for-ratepay.html) +* [Prepayment](/docs/pbc/all/payment-service-provider/{{page.version}}/ratepay/integrate-payment-methods-for-ratepay/integrate-the-prepayment-payment-method-for-ratepay.html) +* [Installment payment](/docs/pbc/all/payment-service-provider/{{page.version}}/ratepay/integrate-payment-methods-for-ratepay/integrate-the-installment-payment-method-for-ratepay.html) +* [Invoice](/docs/pbc/all/payment-service-provider/{{page.version}}/ratepay/integrate-payment-methods-for-ratepay/integrate-the-invoice-payment-method-for-ratepay.html) diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-direct-debit-payment-method-for-ratepay.md b/docs/pbc/all/payment-service-provider/202212.0/ratepay/integrate-payment-methods-for-ratepay/integrate-the-direct-debit-payment-method-for-ratepay.md similarity index 84% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-direct-debit-payment-method-for-ratepay.md rename to docs/pbc/all/payment-service-provider/202212.0/ratepay/integrate-payment-methods-for-ratepay/integrate-the-direct-debit-payment-method-for-ratepay.md index c2f977384fb..12c2f0e3692 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-direct-debit-payment-method-for-ratepay.md +++ b/docs/pbc/all/payment-service-provider/202212.0/ratepay/integrate-payment-methods-for-ratepay/integrate-the-direct-debit-payment-method-for-ratepay.md @@ -6,13 +6,8 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/ratepay-direct-debit originalArticleId: 5b1a8407-02f1-418e-9f69-98643224753c redirect_from: - - /2021080/docs/ratepay-direct-debit - - /2021080/docs/en/ratepay-direct-debit - - /docs/ratepay-direct-debit - - /docs/en/ratepay-direct-debit - - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/ratepay/integrating-payment-methods-for-ratepay/integrating-the-direct-debit-payment-method-for-ratepay.html - - /docs/scos/user/technology-partners/202204.0/payment-partners/ratepay/integrating-payment-methods-for-ratepay/integrating-the-direct-debit-payment-method-for-ratepay.html - /docs/scos/user/technology-partners/202212.0/payment-partners/ratepay/integrating-payment-methods-for-ratepay/integrating-the-direct-debit-payment-method-for-ratepay.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-direct-debit-payment-method-for-ratepay.html related: - title: RatePay link: docs/scos/user/technology-partners/page.version/payment-partners/ratepay.html @@ -75,4 +70,4 @@ The configuration to integrate Direct Debit payments using RatePAY is: ## Performing Requests -In order to perform the needed requests, you can easily use the implemented state machine commands and conditions. The [RatePAY State Machine Commands and Conditions](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/ratepay/ratepay-state-machine-commands-and-conditions.html) section gives a summary of them. You can also use the facade methods directly which, however, are invoked by the state machine. +In order to perform the needed requests, you can easily use the implemented state machine commands and conditions. The [RatePAY State Machine Commands and Conditions](/docs/pbc/all/payment-service-provider/{{page.version}}/ratepay/ratepay-state-machine-commands-and-conditions.html) section gives a summary of them. You can also use the facade methods directly which, however, are invoked by the state machine. diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-installment-payment-method-for-ratepay.md b/docs/pbc/all/payment-service-provider/202212.0/ratepay/integrate-payment-methods-for-ratepay/integrate-the-installment-payment-method-for-ratepay.md similarity index 87% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-installment-payment-method-for-ratepay.md rename to docs/pbc/all/payment-service-provider/202212.0/ratepay/integrate-payment-methods-for-ratepay/integrate-the-installment-payment-method-for-ratepay.md index abb763bf90c..36d79aa3b9d 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-installment-payment-method-for-ratepay.md +++ b/docs/pbc/all/payment-service-provider/202212.0/ratepay/integrate-payment-methods-for-ratepay/integrate-the-installment-payment-method-for-ratepay.md @@ -6,13 +6,8 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/ratepay-installment originalArticleId: 3fe65872-d5b3-4c95-8757-6ae7ee0b2d87 redirect_from: - - /2021080/docs/ratepay-installment - - /2021080/docs/en/ratepay-installment - - /docs/ratepay-installment - - /docs/en/ratepay-installment - - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/ratepay/integrating-payment-methods-for-ratepay/integrating-the-installment-payment-method-for-ratepay.html - - /docs/scos/user/technology-partners/202204.0/payment-partners/ratepay/integrating-payment-methods-for-ratepay/integrating-the-installment-payment-method-for-ratepay.html - /docs/scos/user/technology-partners/202212.0/payment-partners/ratepay/integrating-payment-methods-for-ratepay/integrating-the-installment-payment-method-for-ratepay.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-installment-payment-method-for-ratepay related: - title: RatePay link: docs/scos/user/technology-partners/page.version/payment-partners/ratepay.html @@ -85,4 +80,4 @@ You can copy over configs to your config from the RatePAY module's `config.dist. ### Perform Requests -In order to perform the needed requests, you can easily use the implemented state machine commands and conditions. The [RatePAY State Machine Commands and Conditions](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/ratepay/ratepay-state-machine-commands-and-conditions.html) section gives a summary of them. You can also use the facade methods directly which, however, are invoked by the state machine. +In order to perform the needed requests, you can easily use the implemented state machine commands and conditions. The [RatePAY State Machine Commands and Conditions](/docs/pbc/all/payment-service-provider/{{page.version}}/ratepay/ratepay-state-machine-commands-and-conditions.html) section gives a summary of them. You can also use the facade methods directly which, however, are invoked by the state machine. diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-invoice-payment-method-for-ratepay.md b/docs/pbc/all/payment-service-provider/202212.0/ratepay/integrate-payment-methods-for-ratepay/integrate-the-invoice-payment-method-for-ratepay.md similarity index 89% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-invoice-payment-method-for-ratepay.md rename to docs/pbc/all/payment-service-provider/202212.0/ratepay/integrate-payment-methods-for-ratepay/integrate-the-invoice-payment-method-for-ratepay.md index f89de874f25..1a4cab19d60 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-invoice-payment-method-for-ratepay.md +++ b/docs/pbc/all/payment-service-provider/202212.0/ratepay/integrate-payment-methods-for-ratepay/integrate-the-invoice-payment-method-for-ratepay.md @@ -6,13 +6,9 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/ratepay-invoice originalArticleId: a9b40611-e42e-4529-918d-3fab9774f420 redirect_from: - - /2021080/docs/ratepay-invoice - - /2021080/docs/en/ratepay-invoice - - /docs/ratepay-invoice - - /docs/en/ratepay-invoice - - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/ratepay/integrating-payment-methods-for-ratepay/integrating-the-invoice-payment-method-for-ratepay.html - /docs/scos/user/technology-partners/202212.0/payment-partners/ratepay/integrating-payment-methods-for-ratepay/integrating-the-invoice-payment-method-for-ratepay.html - /docs/scos/user/technology-partners/202212.0/payment-partners/ratepay/integrating-payment-methods-for-ratepay/integrating-the-invoice-payment-method-for-ratepay.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-invoice-payment-method-for-ratepay.html related: - title: RatePay facade methods link: docs/scos/dev/technology-partner-guides/page.version/payment-partners/ratepay/ratepay-facade-methods.html @@ -82,4 +78,4 @@ The configuration to integrate invoice payments using RatePAY is: ## Perform Requests -To perform the needed requests, use the [RatePAY State Machine Commands and Conditions](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/ratepay/ratepay-state-machine-commands-and-conditions.html) . You can also use the `facademethods`directly which, however, are invoked by the state machine. +To perform the needed requests, use the [RatePAY State Machine Commands and Conditions](/docs/pbc/all/payment-service-provider/{{page.version}}/ratepay/ratepay-state-machine-commands-and-conditions.html) . You can also use the `facademethods`directly which, however, are invoked by the state machine. diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-prepayment-payment-method-for-ratepay.md b/docs/pbc/all/payment-service-provider/202212.0/ratepay/integrate-payment-methods-for-ratepay/integrate-the-prepayment-payment-method-for-ratepay.md similarity index 89% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-prepayment-payment-method-for-ratepay.md rename to docs/pbc/all/payment-service-provider/202212.0/ratepay/integrate-payment-methods-for-ratepay/integrate-the-prepayment-payment-method-for-ratepay.md index 21be048ff90..203d9c1df0a 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-prepayment-payment-method-for-ratepay.md +++ b/docs/pbc/all/payment-service-provider/202212.0/ratepay/integrate-payment-methods-for-ratepay/integrate-the-prepayment-payment-method-for-ratepay.md @@ -6,13 +6,8 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/ratepay-prepayment originalArticleId: a4c45f04-f178-4d8f-aee3-79cc0a24106d redirect_from: - - /2021080/docs/ratepay-prepayment - - /2021080/docs/en/ratepay-prepayment - - /docs/ratepay-prepayment - - /docs/en/ratepay-prepayment - - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/ratepay/integrating-payment-methods-for-ratepay/integrating-the-prepayment-payment-method-for-ratepay.html - - /docs/scos/user/technology-partners/202204.0/payment-partners/ratepay/integrating-payment-methods-for-ratepay/integrating-the-prepayment-payment-method-for-ratepay.html - /docs/scos/user/technology-partners/202212.0/payment-partners/ratepay/integrating-payment-methods-for-ratepay/integrating-the-prepayment-payment-method-for-ratepay.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-prepayment-payment-method-for-ratepay.html related: - title: RatePay link: docs/scos/user/technology-partners/page.version/payment-partners/ratepay.html diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratepay/ratepay-core-module-structure-diagram.md b/docs/pbc/all/payment-service-provider/202212.0/ratepay/ratepay-core-module-structure-diagram.md similarity index 94% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratepay/ratepay-core-module-structure-diagram.md rename to docs/pbc/all/payment-service-provider/202212.0/ratepay/ratepay-core-module-structure-diagram.md index 97f8fa5bf66..44425484dea 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratepay/ratepay-core-module-structure-diagram.md +++ b/docs/pbc/all/payment-service-provider/202212.0/ratepay/ratepay-core-module-structure-diagram.md @@ -6,13 +6,10 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/ratepay-structure-diag originalArticleId: dfe4133a-18c0-447b-b932-14d3ff410480 redirect_from: - - /2021080/docs/ratepay-structure-diag - - /2021080/docs/en/ratepay-structure-diag - - /docs/ratepay-structure-diag - - /docs/en/ratepay-structure-diag - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/ratepay/ratepay-core-module-structure-diagram.html - /docs/scos/user/technology-partners/202204.0/payment-partners/ratepay/ratepay-core-module-structure-diagram.html - /docs/scos/user/technology-partners/202212.0/payment-partners/ratepay/ratepay-core-module-structure-diagram.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratepay/ratepay-core-module-structure-diagram.html related: - title: RatePay facade methods link: docs/scos/dev/technology-partner-guides/page.version/payment-partners/ratepay/ratepay-facade-methods.html diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratepay/ratepay-facade-methods.md b/docs/pbc/all/payment-service-provider/202212.0/ratepay/ratepay-facade-methods.md similarity index 93% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratepay/ratepay-facade-methods.md rename to docs/pbc/all/payment-service-provider/202212.0/ratepay/ratepay-facade-methods.md index ed4531bd5ed..b9c5adc1584 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratepay/ratepay-facade-methods.md +++ b/docs/pbc/all/payment-service-provider/202212.0/ratepay/ratepay-facade-methods.md @@ -6,13 +6,8 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/ratepay-facade originalArticleId: eabf3483-95ab-4ced-91e5-4dd2dd2211db redirect_from: - - /2021080/docs/ratepay-facade - - /2021080/docs/en/ratepay-facade - - /docs/ratepay-facade - - /docs/en/ratepay-facade - - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/ratepay/ratepay-facade-methods.html - - /docs/scos/user/technology-partners/202204.0/payment-partners/ratepay/ratepay-facade-methods.html - /docs/scos/user/technology-partners/202212.0/payment-partners/ratepay/ratepay-facade-methods.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratepay/ratepay-facade-methods.html related: - title: Integrating the Invoice payment method for RatePay link: docs/scos/dev/technology-partner-guides/page.version/payment-partners/ratepay/integrating-payment-methods-for-ratepay//integrating-the-invoice-payment-method-for-ratepay.html diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratepay/ratepay-payment-workflow.md b/docs/pbc/all/payment-service-provider/202212.0/ratepay/ratepay-payment-workflow.md similarity index 91% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratepay/ratepay-payment-workflow.md rename to docs/pbc/all/payment-service-provider/202212.0/ratepay/ratepay-payment-workflow.md index 5d6f0f1e466..4a6abb06f1e 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratepay/ratepay-payment-workflow.md +++ b/docs/pbc/all/payment-service-provider/202212.0/ratepay/ratepay-payment-workflow.md @@ -6,13 +6,8 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/ratepay-payment-workflow originalArticleId: 9e0777dc-e660-4a9c-b2e0-0b8cf7adabb2 redirect_from: - - /2021080/docs/ratepay-payment-workflow - - /2021080/docs/en/ratepay-payment-workflow - - /docs/ratepay-payment-workflow - - /docs/en/ratepay-payment-workflow - - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/ratepay/ratepay-payment-workflow.html - - /docs/scos/user/technology-partners/202204.0/payment-partners/ratepay/ratepay-payment-workflow.html - /docs/scos/user/technology-partners/202212.0/payment-partners/ratepay/ratepay-payment-workflow.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratepay/ratepay-payment-workflow.html related: - title: RatePay facade methods link: docs/scos/dev/technology-partner-guides/page.version/payment-partners/ratepay/ratepay-facade-methods.html diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratepay/ratepay-state-machine-commands-and-conditions.md b/docs/pbc/all/payment-service-provider/202212.0/ratepay/ratepay-state-machine-commands-and-conditions.md similarity index 85% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratepay/ratepay-state-machine-commands-and-conditions.md rename to docs/pbc/all/payment-service-provider/202212.0/ratepay/ratepay-state-machine-commands-and-conditions.md index 559ece34fad..e4dd43da1d3 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratepay/ratepay-state-machine-commands-and-conditions.md +++ b/docs/pbc/all/payment-service-provider/202212.0/ratepay/ratepay-state-machine-commands-and-conditions.md @@ -6,15 +6,8 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/ratepay-state-machine originalArticleId: 25cb68aa-9d2c-42d2-8ae3-bd8f3ea572f3 redirect_from: - - /2021080/docs/ratepay-state-machine - - /2021080/docs/en/ratepay-state-machine - - /docs/ratepay-state-machine - - /docs/en/ratepay-state-machine - - /docs/en/ratepay-state-machine.html - - /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/ratepay/ratepay-state-machine-commands-and-conditions.html - - /docs/scos/dev/technology-partner-guides/202204.0/payment-partners/ratepay/ratepay-state-machine-commands-and-conditions.html - - /docs/scos/dev/technology-partner-guides/202204.0/payment-partners/ratepay/technical-details-and-howtos/ratepay-state-machine-commands-and-conditions.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/ratepay/technical-details-and-howtos/ratepay-state-machine-commands-and-conditions.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratepay/ratepay-state-machine-commands-and-conditions.html related: - title: RatePay facade methods link: docs/scos/dev/technology-partner-guides/page.version/payment-partners/ratepay/ratepay-facade-methods.html diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratepay/ratepay-state-machines.md b/docs/pbc/all/payment-service-provider/202212.0/ratepay/ratepay-state-machines.md similarity index 87% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratepay/ratepay-state-machines.md rename to docs/pbc/all/payment-service-provider/202212.0/ratepay/ratepay-state-machines.md index 5d515c8fc68..5b5e1ab702b 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratepay/ratepay-state-machines.md +++ b/docs/pbc/all/payment-service-provider/202212.0/ratepay/ratepay-state-machines.md @@ -4,8 +4,8 @@ description: Managing RatePay with state machines last_updated: Jun 16, 2021 template: concept-topic-template redirect_from: -- /docs/scos/dev/technology-partner-guides/202200.0/payment-partners/ratepay/ratepay-state-machines.html - /docs/scos/dev/technology-partner-guides/202212.0/payment-partners/ratepay/ratepay-state-machines.html +- /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratepay/ratepay-state-machines.html --- We use state machines for handling and managing orders and payments. To integrate RatePAY payments, a state machine for RatePAY should be created. diff --git a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratepay/ratepay.md b/docs/pbc/all/payment-service-provider/202212.0/ratepay/ratepay.md similarity index 77% rename from docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratepay/ratepay.md rename to docs/pbc/all/payment-service-provider/202212.0/ratepay/ratepay.md index e091d1e76ee..eded52f8333 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratepay/ratepay.md +++ b/docs/pbc/all/payment-service-provider/202212.0/ratepay/ratepay.md @@ -6,11 +6,8 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/ratepay originalArticleId: 76f600d9-1b7f-4a0a-81e6-4c2dc466063c redirect_from: - - /2021080/docs/ratepay - - /2021080/docs/en/ratepay - - /docs/ratepay - - /docs/en/ratepay - /docs/scos/user/technology-partners/202212.0/payment-partners/ratepay.html + - /docs/pbc/all/payment-service-provider/202212.0/third-party-integrations/ratepay/ratepay.html related: - title: Integrating the Invoice payment method for RatePay link: docs/scos/dev/technology-partner-guides/page.version/payment-partners/ratepay/integrating-payment-methods-for-ratepay//integrating-the-invoice-payment-method-for-ratepay.html @@ -58,16 +55,16 @@ RatePAY provides four methods of payment ## Related Developer guides -* [RatePay Core module structure diagram](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/ratepay/ratepay-core-module-structure-diagram.html) -* [RatePay state machines](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/ratepay/ratepay-state-machines.html) -* [Integrating the Direct Debit payment method for RatePay](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-direct-debit-payment-method-for-ratepay.html) -* [Integrating the Installment payment method for RatePay](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-installment-payment-method-for-ratepay.html) -* [Integrating the Invoice payment method for RatePay](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-invoice-payment-method-for-ratepay.html) -* [Integrating the Prepayment payment method for RatePay](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/ratepay/integrate-payment-methods-for-ratepay/integrate-the-prepayment-payment-method-for-ratepay.html) -* [Disabling address updates from the backend application for RatePay](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/ratepay/disable-address-updates-from-the-backend-application-for-ratepay.html) -* [RatePay facade methods](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/ratepay/ratepay-facade-methods.html) -* [RatePay payment workflow](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/ratepay/ratepay-payment-workflow.html) -* [RatePay state machine commands and conditions](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/ratepay/ratepay-state-machine-commands-and-conditions.html) +* [RatePay Core module structure diagram](/docs/pbc/all/payment-service-provider/{{page.version}}/ratepay/ratepay-core-module-structure-diagram.html) +* [RatePay state machines](/docs/pbc/all/payment-service-provider/{{page.version}}/ratepay/ratepay-state-machines.html) +* [Integrating the Direct Debit payment method for RatePay](/docs/pbc/all/payment-service-provider/{{page.version}}/ratepay/integrate-payment-methods-for-ratepay/integrate-the-direct-debit-payment-method-for-ratepay.html) +* [Integrating the Installment payment method for RatePay](/docs/pbc/all/payment-service-provider/{{page.version}}/ratepay/integrate-payment-methods-for-ratepay/integrate-the-installment-payment-method-for-ratepay.html) +* [Integrating the Invoice payment method for RatePay](/docs/pbc/all/payment-service-provider/{{page.version}}/ratepay/integrate-payment-methods-for-ratepay/integrate-the-invoice-payment-method-for-ratepay.html) +* [Integrating the Prepayment payment method for RatePay](/docs/pbc/all/payment-service-provider/{{page.version}}/ratepay/integrate-payment-methods-for-ratepay/integrate-the-prepayment-payment-method-for-ratepay.html) +* [Disabling address updates from the backend application for RatePay](/docs/pbc/all/payment-service-provider/{{page.version}}/ratepay/disable-address-updates-from-the-backend-application-for-ratepay.html) +* [RatePay facade methods](/docs/pbc/all/payment-service-provider/{{page.version}}/ratepay/ratepay-facade-methods.html) +* [RatePay payment workflow](/docs/pbc/all/payment-service-provider/{{page.version}}/ratepay/ratepay-payment-workflow.html) +* [RatePay state machine commands and conditions](/docs/pbc/all/payment-service-provider/{{page.version}}/ratepay/ratepay-state-machine-commands-and-conditions.html) --- ## Copyright and Disclaimer diff --git a/docs/pbc/all/payment-service-provider/202212.0/hydrate-payment-methods-for-an-order.md b/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/hydrate-payment-methods-for-an-order.md similarity index 87% rename from docs/pbc/all/payment-service-provider/202212.0/hydrate-payment-methods-for-an-order.md rename to docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/hydrate-payment-methods-for-an-order.md index 7bdce6c5d74..f46f3d019e3 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/hydrate-payment-methods-for-an-order.md +++ b/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/hydrate-payment-methods-for-an-order.md @@ -6,17 +6,9 @@ template: howto-guide-template originalLink: https://documentation.spryker.com/2021080/docs/ht-hydrate-payment-methods-for-order originalArticleId: 4e35e87f-d4a5-4a06-8cf5-d830eec89b5d redirect_from: - - /2021080/docs/ht-hydrate-payment-methods-for-order - - /2021080/docs/en/ht-hydrate-payment-methods-for-order - - /docs/ht-hydrate-payment-methods-for-order - - /docs/en/ht-hydrate-payment-methods-for-order - - /v6/docs/ht-hydrate-payment-methods-for-order - - /v6/docs/en/ht-hydrate-payment-methods-for-order - - /v5/docs/ht-hydrate-payment-methods-for-order - - /v5/docs/en/ht-hydrate-payment-methods-for-order - - /v4/docs/ht-hydrate-payment-methods-for-order - - /v4/docs/en/ht-hydrate-payment-methods-for-order - /docs/scos/dev/tutorials-and-howtos/howtos/howto-hydrate-payment-methods-for-an-order.html + - /docs/pbc/all/payment-service-provider/202212.0/hydrate-payment-methods-for-an-order.html + - /docs/pbc/all/payment-service-provider/202212.0/hydrate-payment-methods-for-an-order.html --- {% info_block warningBox "Warning" %} diff --git a/docs/pbc/all/payment-service-provider/202212.0/import-and-export-data/file-details-payment-method-store.csv.md b/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/import-and-export-data/import-file-details-payment-method-store.csv.md similarity index 85% rename from docs/pbc/all/payment-service-provider/202212.0/import-and-export-data/file-details-payment-method-store.csv.md rename to docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/import-and-export-data/import-file-details-payment-method-store.csv.md index 05456719c65..d76b003c937 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/import-and-export-data/file-details-payment-method-store.csv.md +++ b/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/import-and-export-data/import-file-details-payment-method-store.csv.md @@ -1,5 +1,5 @@ --- -title: File details - payment_method_store.csv +title: "Import file details: payment_method_store.csv" last_updated: Jun 16, 2021 template: data-import-template originalLink: https://documentation.spryker.com/2021080/docs/file-details-payment-method-storecsv @@ -14,6 +14,7 @@ redirect_from: - /docs/scos/dev/data-import/201907.0/data-import-categories/commerce-setup/file-details-payment-method-store.csv.html - /docs/scos/dev/data-import/202212.0/data-import-categories/commerce-setup/file-details-payment-method-store.csv.html - /docs/pbc/all/payment-service-provider/202212.0/import-data/file-details-payment-method-store.csv.html + - /docs/pbc/all/payment-service-provider/202212.0/import-and-export-data/import-file-details-payment-method-store.csv.html related: - title: Execution order of data importers in Demo Shop link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html @@ -24,14 +25,14 @@ This document describes the `payment_method_store.csv` file to configure Payment ## Import file dependencies -* [payment_method.csv](/docs/pbc/all/payment-service-provider/{{page.version}}/import-and-export-data/file-details-payment-method.csv.html) +* [payment_method.csv](/docs/pbc/all/payment-service-provider/{{page.version}}/spryker-pay/base-shop/import-and-export-data/import-file-details-payment-method.csv.html) * *stores.php* configuration file of the demo shop PHP project ## Import file parameters | PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION | |-|-|-|-|-| -| payment_method_key | ✓ | String | Value should be imported from the [payment_method.csv](/docs/pbc/all/payment-service-provider/{{page.version}}/import-and-export-data/file-details-payment-method.csv.html) file. | Identifier of the payment method. | +| payment_method_key | ✓ | String | Value should be imported from the [payment_method.csv](/docs/pbc/all/payment-service-provider/{{page.version}}/spryker-pay/base-shop/import-and-export-data/import-file-details-payment-method.csv.html) file. | Identifier of the payment method. | | store | ✓ | String | Value must be within an existing store name, set in the *store.php* configuration file of the demo shop PHP project. | Name of the store. | diff --git a/docs/pbc/all/payment-service-provider/202212.0/import-and-export-data/file-details-payment-method.csv.md b/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/import-and-export-data/import-file-details-payment-method.csv.md similarity index 89% rename from docs/pbc/all/payment-service-provider/202212.0/import-and-export-data/file-details-payment-method.csv.md rename to docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/import-and-export-data/import-file-details-payment-method.csv.md index 11f4118aa57..d74be8a7cd6 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/import-and-export-data/file-details-payment-method.csv.md +++ b/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/import-and-export-data/import-file-details-payment-method.csv.md @@ -1,5 +1,5 @@ --- -title: File details - payment_method.csv +title: "Import file details: payment_method.csv" last_updated: Jun 16, 2021 template: data-import-template originalLink: https://documentation.spryker.com/2021080/docs/file-details-payment-methodcsv @@ -11,12 +11,13 @@ redirect_from: - /docs/en/file-details-payment-methodcsv - /docs/scos/dev/data-import/202212.0/data-import-categories/commerce-setup/file-details-payment-method.csv.html - /docs/pbc/all/payment-service-provider/202212.0/import-data/file-details-payment-method.csv.html + - /docs/pbc/all/payment-service-provider/202212.0/import-and-export-data/import-file-details-payment-method.csv.html related: - title: Execution order of data importers in Demo Shop link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html --- -This document describes the `payment_method.csv` file to configure the [Payment Method](/docs/pbc/all/payment-service-provider/{{page.version}}/payments-feature-overview.html) information in your Spryker Demo Shop. +This document describes the `payment_method.csv` file to configure the [Payment Method](/docs/pbc/all/payment-service-provider/{{page.version}}/spryker-pay/base-shop/payments-feature-overview.html) information in your Spryker Demo Shop. ## Import file parameters diff --git a/docs/pbc/all/payment-service-provider/202212.0/import-and-export-data/import-and-export-payment-service-provider-data.md b/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/import-and-export-data/payment-service-provider-data-import-and-export.md similarity index 93% rename from docs/pbc/all/payment-service-provider/202212.0/import-and-export-data/import-and-export-payment-service-provider-data.md rename to docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/import-and-export-data/payment-service-provider-data-import-and-export.md index ba674c29239..9e2b4366c85 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/import-and-export-data/import-and-export-payment-service-provider-data.md +++ b/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/import-and-export-data/payment-service-provider-data-import-and-export.md @@ -1,5 +1,5 @@ --- -title: Import Payment Service Provider data +title: Payment Service Provider data import and export description: Details about the data importers for Payment Service Provider last_updated: Jun 23, 2023 template: concept-topic-template diff --git a/docs/pbc/all/payment-service-provider/202212.0/install-and-upgrade/install-the-payments-feature.md b/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/install-and-upgrade/install-the-payments-feature.md similarity index 76% rename from docs/pbc/all/payment-service-provider/202212.0/install-and-upgrade/install-the-payments-feature.md rename to docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/install-and-upgrade/install-the-payments-feature.md index 06b2f17919d..370c14d04ef 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/install-and-upgrade/install-the-payments-feature.md +++ b/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/install-and-upgrade/install-the-payments-feature.md @@ -6,21 +6,18 @@ template: feature-integration-guide-template originalLink: https://documentation.spryker.com/2021080/docs/payments-feature-integration originalArticleId: 31957fa5-b32a-4227-b6d5-42b89c6e1855 redirect_from: - - /2021080/docs/payments-feature-integration - - /2021080/docs/en/payments-feature-integration - - /docs/payments-feature-integration - - /docs/en/payments-feature-integration - /docs/scos/dev/feature-integration-guides/201811.0/payments-feature-integration.html - /docs/scos/dev/feature-integration-guides/201903.0/payments-feature-integration.html - /docs/scos/dev/feature-integration-guides/201907.0/payments-feature-integration.html - /docs/scos/dev/feature-integration-guides/202212.0/payments-feature-integration.html + - /docs/pbc/all/payment-service-provider/202212.0/install-and-upgrade/install-the-payments-feature.html related: - title: Glue API - Payments feature integration link: docs/scos/dev/feature-integration-guides/page.version/glue-api/glue-api-payments-feature-integration.html - title: Payments feature walkthrough - link: docs/pbc/all/payment-service-provider/page.version/payments-feature-overview.html + link: docs/pbc/all/payment-service-provider/page.version/spryker-pay/base-shop/payments-feature-overview.html - title: Payments feature overview - link: docs/pbc/all/payment-service-provider/page.version/payments-feature-overview.html + link: docs/pbc/all/payment-service-provider/page.version/spryker-pay/base-shop/payments-feature-overview.html --- {% include pbc/all/install-features/202212.0/install-the-payments-feature.md %} diff --git a/docs/pbc/all/payment-service-provider/202212.0/install-and-upgrade/install-the-payments-glue-api.md b/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/install-and-upgrade/install-the-payments-glue-api.md similarity index 72% rename from docs/pbc/all/payment-service-provider/202212.0/install-and-upgrade/install-the-payments-glue-api.md rename to docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/install-and-upgrade/install-the-payments-glue-api.md index 849b9f5cd66..628a8829311 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/install-and-upgrade/install-the-payments-glue-api.md +++ b/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/install-and-upgrade/install-the-payments-glue-api.md @@ -5,17 +5,14 @@ template: feature-integration-guide-template originalLink: https://documentation.spryker.com/2021080/docs/glue-api-payments-feature-integration originalArticleId: 37aaeca3-9205-4ca3-8332-6a1ab7b31c80 redirect_from: - - /2021080/docs/glue-api-payments-feature-integration - - /2021080/docs/en/glue-api-payments-feature-integration - - /docs/glue-api-payments-feature-integration - - /docs/en/glue-api-payments-feature-integration - /docs/scos/dev/feature-integration-guides/202200.0/glue-api/glue-api-payments-feature-integration.html - /docs/scos/dev/feature-integration-guides/202212.0/glue-api/glue-api-payments-feature-integration.html + - /docs/pbc/all/payment-service-provider/202212.0/install-and-upgrade/install-the-payments-glue-api.html related: - title: Payments feature integration - link: docs/pbc/all/payment-service-provider/page.version/install-and-upgrade/install-the-payments-feature.html + link: docs/pbc/all/payment-service-provider/page.version/spryker-pay/base-shop/install-and-upgrade/install-the-payments-feature.html - title: Payments feature walkthrough - link: docs/pbc/all/payment-service-provider/page.version/payments-feature-overview.html + link: docs/pbc/all/payment-service-provider/page.version/spryker-pay/base-shop/payments-feature-overview.html - title: Check out purchases link: docs/scos/dev/glue-api-guides/page.version/checking-out/checking-out-purchases.html - title: Updating payment data diff --git a/docs/pbc/all/payment-service-provider/202212.0/install-and-upgrade/upgrade-the-payment-module.md b/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/install-and-upgrade/upgrade-the-payment-module.md similarity index 73% rename from docs/pbc/all/payment-service-provider/202212.0/install-and-upgrade/upgrade-the-payment-module.md rename to docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/install-and-upgrade/upgrade-the-payment-module.md index ac134f3fbc2..e21b5236fc4 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/install-and-upgrade/upgrade-the-payment-module.md +++ b/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/install-and-upgrade/upgrade-the-payment-module.md @@ -6,22 +6,6 @@ template: module-migration-guide-template originalLink: https://documentation.spryker.com/2021080/docs/mg-payment originalArticleId: fe27c0bc-2f52-42f0-8dbf-5a7ba050bc34 redirect_from: - - /2021080/docs/mg-payment - - /2021080/docs/en/mg-payment - - /docs/mg-payment - - /docs/en/mg-payment - - /v1/docs/mg-payment - - /v1/docs/en/mg-payment - - /v2/docs/mg-payment - - /v2/docs/en/mg-payment - - /v3/docs/mg-payment - - /v3/docs/en/mg-payment - - /v4/docs/mg-payment - - /v4/docs/en/mg-payment - - /v5/docs/mg-payment - - /v5/docs/en/mg-payment - - /v6/docs/mg-payment - - /v6/docs/en/mg-payment - /docs/scos/dev/module-migration-guides/201811.0/migration-guide-payment.html - /docs/scos/dev/module-migration-guides/201903.0/migration-guide-payment.html - /docs/scos/dev/module-migration-guides/201907.0/migration-guide-payment.html @@ -30,6 +14,7 @@ redirect_from: - /docs/scos/dev/module-migration-guides/202009.0/migration-guide-payment.html - /docs/scos/dev/module-migration-guides/202108.0/migration-guide-payment.html - /docs/scos/dev/module-migration-guides/migration-guide-payment.html + - /docs/pbc/all/payment-service-provider/202212.0/install-and-upgrade/upgrade-the-payment-module.html --- {% include pbc/all/upgrade-modules/upgrade-the-payment-module.md %} diff --git a/docs/pbc/all/payment-service-provider/202212.0/interact-with-third-party-payment-providers-using-glue-api.md b/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/interact-with-third-party-payment-providers-using-glue-api.md similarity index 91% rename from docs/pbc/all/payment-service-provider/202212.0/interact-with-third-party-payment-providers-using-glue-api.md rename to docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/interact-with-third-party-payment-providers-using-glue-api.md index 7a900bd2cbc..fd715859de1 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/interact-with-third-party-payment-providers-using-glue-api.md +++ b/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/interact-with-third-party-payment-providers-using-glue-api.md @@ -6,20 +6,10 @@ template: howto-guide-template originalLink: https://documentation.spryker.com/2021080/docs/t-interacting-with-third-party-payment-providers-via-glue-api originalArticleId: c9d486b4-ac75-46f5-917e-f3935043f018 redirect_from: - - /2021080/docs/t-interacting-with-third-party-payment-providers-via-glue-api - - /2021080/docs/en/t-interacting-with-third-party-payment-providers-via-glue-api - - /docs/t-interacting-with-third-party-payment-providers-via-glue-api - - /docs/en/t-interacting-with-third-party-payment-providers-via-glue-api - - /v6/docs/t-interacting-with-third-party-payment-providers-via-glue-api - - /v6/docs/en/t-interacting-with-third-party-payment-providers-via-glue-api - - /v5/docs/t-interacting-with-third-party-payment-providers-via-glue-api - - /v5/docs/en/t-interacting-with-third-party-payment-providers-via-glue-api - - /v4/docs/t-interacting-with-third-party-payment-providers-via-glue-api - - /v4/docs/en/t-interacting-with-third-party-payment-providers-via-glue-api - - /v3/docs/t-interacting-with-third-party-payment-providers-via-glue-api - - /v3/docs/en/t-interacting-with-third-party-payment-providers-via-glue-api - /docs/scos/dev/tutorials/201907.0/advanced/glue-api/tutorial-interacting-with-third-party-payment-providers-via-glue-api.html - /docs/scos/dev/tutorials-and-howtos/advanced-tutorials/glue-api/tutorial-interacting-with-third-party-payment-providers-via-glue-api.html + - /docs/pbc/all/payment-service-provider/202212.0/interact-with-third-party-payment-providers-using-glue-api.html + - /docs/pbc/all/payment-service-provider/202212.0/interact-with-third-party-payment-providers-using-glue-api.html related: - title: Technology Partner Integration link: docs/scos/user/technology-partners/page.version/technology-partners.html diff --git a/docs/pbc/all/payment-service-provider/202212.0/manage-in-the-back-office/edit-payment-methods.md b/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/manage-in-the-back-office/edit-payment-methods.md similarity index 89% rename from docs/pbc/all/payment-service-provider/202212.0/manage-in-the-back-office/edit-payment-methods.md rename to docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/manage-in-the-back-office/edit-payment-methods.md index 660ec8ce539..b590543a456 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/manage-in-the-back-office/edit-payment-methods.md +++ b/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/manage-in-the-back-office/edit-payment-methods.md @@ -6,18 +6,15 @@ template: back-office-user-guide-template originalLink: https://documentation.spryker.com/2021080/docs/managing-payment-methods originalArticleId: d0dc8732-295d-4072-8dc2-63f439feb324 redirect_from: - - /2021080/docs/managing-payment-methods - - /2021080/docs/en/managing-payment-methods - - /docs/managing-payment-methods - - /docs/en/managing-payment-methods - /docs/scos/user/back-office-user-guides/201811.0/administration/payment-methods/managing-payment-methods.html - /docs/scos/user/back-office-user-guides/201903.0/administration/payment-methods/managing-payment-methods.html - /docs/scos/user/back-office-user-guides/201907.0/administration/payment-methods/managing-payment-methods.html - /docs/scos/user/back-office-user-guides/202204.0/administration/payment-methods/managing-payment-methods.html - - /docs/scos/user/back-office-user-guides/202212.0/administration/payment-methods/edit-payment-methods.html + - /docs/scos/user/back-office-user-guides/202212.0/administration/payment-methods/edit-payment-methods.html + - /docs/pbc/all/payment-service-provider/202212.0/manage-in-the-back-office/edit-payment-methods.html related: - title: Payments feature overview - link: docs/pbc/all/payment-service-provider/page.version/payments-feature-overview.html + link: docs/pbc/all/payment-service-provider/page.version/spryker-pay/base-shop/payments-feature-overview.html --- To edit a payment method in the Back Office, follow the steps: diff --git a/docs/pbc/all/payment-service-provider/202212.0/manage-in-the-back-office/log-into-the-back-office.md b/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/manage-in-the-back-office/log-into-the-back-office.md similarity index 72% rename from docs/pbc/all/payment-service-provider/202212.0/manage-in-the-back-office/log-into-the-back-office.md rename to docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/manage-in-the-back-office/log-into-the-back-office.md index 2961c341733..15b1354b5a9 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/manage-in-the-back-office/log-into-the-back-office.md +++ b/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/manage-in-the-back-office/log-into-the-back-office.md @@ -9,5 +9,5 @@ template: back-office-user-guide-template ## Next steps -* [View payment methods](/docs/pbc/all/payment-service-provider/{{page.version}}/manage-in-the-back-office/view-payment-methods.html) -* [Edit payment methods](/docs/pbc/all/payment-service-provider/{{page.version}}/manage-in-the-back-office/edit-payment-methods.html) +* [View payment methods](/docs/pbc/all/payment-service-provider/{{page.version}}/spryker-pay/base-shop/manage-in-the-back-office/view-payment-methods.html) +* [Edit payment methods](/docs/pbc/all/payment-service-provider/{{page.version}}/spryker-pay/base-shop/manage-in-the-back-office/edit-payment-methods.html) diff --git a/docs/pbc/all/payment-service-provider/202212.0/manage-in-the-back-office/view-payment-methods.md b/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/manage-in-the-back-office/view-payment-methods.md similarity index 80% rename from docs/pbc/all/payment-service-provider/202212.0/manage-in-the-back-office/view-payment-methods.md rename to docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/manage-in-the-back-office/view-payment-methods.md index e4d488d0e14..e930ec880f9 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/manage-in-the-back-office/view-payment-methods.md +++ b/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/manage-in-the-back-office/view-payment-methods.md @@ -5,9 +5,10 @@ last_updated: June 2, 2022 template: back-office-user-guide-template redirect_from: - /docs/scos/user/back-office-user-guides/202212.0/administration/payment-methods/view-payment-methods.html + - /docs/pbc/all/payment-service-provider/202212.0/manage-in-the-back-office/view-payment-methods.html related: - title: Payments feature overview - link: docs/pbc/all/payment-service-provider/page.version/payments-feature-overview.html + link: docs/pbc/all/payment-service-provider/page.version/spryker-pay/base-shop/payments-feature-overview.html --- To view a payment methods in the Back Office, follow the steps: @@ -27,4 +28,4 @@ To view a payment methods in the Back Office, follow the steps: ## Next steps -[Edit payment methods](/docs/pbc/all/payment-service-provider/{{page.version}}/manage-in-the-back-office/edit-payment-methods.html) +[Edit payment methods](/docs/pbc/all/payment-service-provider/{{page.version}}/spryker-pay/base-shop/manage-in-the-back-office/edit-payment-methods.html) diff --git a/docs/pbc/all/payment-service-provider/202212.0/payments-feature-domain-model-and-relationships.md b/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/payments-feature-domain-model-and-relationships.md similarity index 80% rename from docs/pbc/all/payment-service-provider/202212.0/payments-feature-domain-model-and-relationships.md rename to docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/payments-feature-domain-model-and-relationships.md index 7ea249c9b5f..1c3bbfe3097 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/payments-feature-domain-model-and-relationships.md +++ b/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/payments-feature-domain-model-and-relationships.md @@ -6,6 +6,8 @@ template: concept-topic-template redirect_from: - /docs/scos/dev/feature-walkthroughs/202200.0/payments-feature-walkthrough.html - /docs/scos/dev/feature-walkthroughs/202212.0/payments-feature-walkthrough.html + - /docs/pbc/all/payment-service-provider/202212.0/payments-feature-domain-model-and-relationships.html + - /docs/pbc/all/payment-service-provider/202212.0/payments-feature-domain-model-and-relationships.html --- The _Payments_ feature lets customers pay for orders with none, one, or multiple payment methods during the checkout process. diff --git a/docs/pbc/all/payment-service-provider/202212.0/payments-feature-overview.md b/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/payments-feature-overview.md similarity index 69% rename from docs/pbc/all/payment-service-provider/202212.0/payments-feature-overview.md rename to docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/payments-feature-overview.md index facf57b45e1..caec2f131de 100644 --- a/docs/pbc/all/payment-service-provider/202212.0/payments-feature-overview.md +++ b/docs/pbc/all/payment-service-provider/202212.0/spryker-pay/base-shop/payments-feature-overview.md @@ -6,12 +6,10 @@ template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/payments-feature-overview originalArticleId: db728134-17d6-4023-8d7a-55177ee5af44 redirect_from: - - /2021080/docs/payments-feature-overview - - /2021080/docs/en/payments-feature-overview - - /docs/payments-feature-overview - - /docs/en/payments-feature-overview - /docs/scos/user/features/202200.0/payments-feature-overview.html - /docs/scos/user/features/202212.0/payments-feature-overview.html + - /docs/pbc/all/payment-service-provider/202212.0/payments-feature-overview.html + - /docs/pbc/all/payment-service-provider/202212.0/payments-feature-overview.html --- The *Payments* feature lets your customers pay for orders with none (for example, a [gift card](/docs/pbc/all/gift-cards/{{page.version}}/gift-cards.html)), one, or multiple payment methods during the checkout process. Most orders are paid with a single payment method, but in some cases, it may be useful to allow multiple payment methods. For example, the customer may want to use two credit cards or a gift card in addition to a traditional payment method. @@ -30,22 +28,22 @@ The Spryker Commerce OS offers integrations with several payment providers that The Spryker Commerce OS supports the integration of the following payment providers, which are our official partners: -* [Adyen](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/adyen/adyen.html) -* [AfterPay](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/afterpay/afterpay.html) -* [Amazon Pay](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/amazon-pay/amazon-pay.html) -* [Arvato](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/arvato/arvato.html) -* [Billie](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/billie.html) -* [Billpay](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/billpay/billpay.html) -* [Braintree](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/braintree/braintree.html) -* [BS Payone](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/bs-payone/bs-payone.html) -* [Computop](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/computop/computop.html) -* [CrefoPay](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/crefopay/crefopay.html) -* [Heidelpay](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/heidelpay/heidelpay.html) -* [Klarna](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/klarna/klarna.html) -* [Payolution](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/payolution/payolution.html) -* [Powerpay](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/powerpay.html) -* [ratenkauf by easyCredit](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/ratenkauf-by-easycredit/ratenkauf-by-easycredit.html) -* [RatePay](/docs/pbc/all/payment-service-provider/{{page.version}}/third-party-integrations/ratepay/ratepay.html) +* [Adyen](/docs/pbc/all/payment-service-provider/{{page.version}}/adyen/adyen.html) +* [AfterPay](/docs/pbc/all/payment-service-provider/{{page.version}}/afterpay/afterpay.html) +* [Amazon Pay](/docs/pbc/all/payment-service-provider/{{page.version}}/amazon-pay/amazon-pay.html) +* [Arvato](/docs/pbc/all/payment-service-provider/{{page.version}}/arvato/arvato.html) +* [Billie](/docs/pbc/all/payment-service-provider/{{page.version}}/billie.html) +* [Billpay](/docs/pbc/all/payment-service-provider/{{page.version}}/billpay/billpay.html) +* [Braintree](/docs/pbc/all/payment-service-provider/{{page.version}}/braintree/braintree.html) +* [BS Payone](/docs/pbc/all/payment-service-provider/{{page.version}}/bs-payone/bs-payone.html) +* [Computop](/docs/pbc/all/payment-service-provider/{{page.version}}/computop/computop.html) +* [CrefoPay](/docs/pbc/all/payment-service-provider/{{page.version}}/crefopay/crefopay.html) +* [Heidelpay](/docs/pbc/all/payment-service-provider/{{page.version}}/heidelpay/heidelpay.html) +* [Klarna](/docs/pbc/all/payment-service-provider/{{page.version}}/klarna/klarna.html) +* [Payolution](/docs/pbc/all/payment-service-provider/{{page.version}}/payolution/payolution.html) +* [Powerpay](/docs/pbc/all/payment-service-provider/{{page.version}}/powerpay.html) +* [ratenkauf by easyCredit](/docs/pbc/all/payment-service-provider/{{page.version}}/ratenkauf-by-easycredit/ratenkauf-by-easycredit.html) +* [RatePay](/docs/pbc/all/payment-service-provider/{{page.version}}/ratepay/ratepay.html) ## Dummy payment @@ -58,13 +56,13 @@ In the Back Office, you can view all payment methods available in the shop appli {% info_block warningBox "Note" %} -Before managing payment methods in the Back Office, you need to create them by [importing payment methods data using a .CSV file](/docs/pbc/all/payment-service-provider/{{page.version}}/import-and-export-data/file-details-payment-method.csv.html). +Before managing payment methods in the Back Office, you need to create them by [importing payment methods data using a .CSV file](/docs/pbc/all/payment-service-provider/{{page.version}}/spryker-pay/base-shop/import-and-export-data/import-file-details-payment-method.csv.html). {% endinfo_block %} ![List of payment methods](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/Payment/Payment+Methods+Overview/payment-methods-list.png) -To learn more on how to make a payment method available during the checkout and assign it to a different store, see [Edit payment methods](/docs/pbc/all/payment-service-provider/{{page.version}}/manage-in-the-back-office/edit-payment-methods.html). +To learn more on how to make a payment method available during the checkout and assign it to a different store, see [Edit payment methods](/docs/pbc/all/payment-service-provider/{{page.version}}/spryker-pay/base-shop/manage-in-the-back-office/edit-payment-methods.html). diff --git a/docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/retrieve-abstract-products.md b/docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/retrieve-abstract-products.md index f829808f405..2c253461e43 100644 --- a/docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/retrieve-abstract-products.md +++ b/docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/retrieve-abstract-products.md @@ -1497,4 +1497,4 @@ For the attributes of other included resources, see: | 301 | Abstract product is not found. | | 311 | Abstract product SKU is not specified. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/retrieve-concrete-products.md b/docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/retrieve-concrete-products.md index 3d83d0a67d6..f07b5c86e25 100644 --- a/docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/retrieve-concrete-products.md +++ b/docs/pbc/all/product-information-management/202212.0/marketplace/manage-using-glue-api/retrieve-concrete-products.md @@ -1145,4 +1145,4 @@ For attributes of the other included resources, see the following: | --- | --- | | 302 | Concrete product is not found. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/product-information-management/202212.0/marketplace/marketplace-merchant-portal-product-management-feature-overview.md b/docs/pbc/all/product-information-management/202212.0/marketplace/marketplace-merchant-portal-product-management-feature-overview.md new file mode 100644 index 00000000000..b8e67bb24d6 --- /dev/null +++ b/docs/pbc/all/product-information-management/202212.0/marketplace/marketplace-merchant-portal-product-management-feature-overview.md @@ -0,0 +1,16 @@ +--- +title: Marketplace Merchant Portal Product Management feature overview +description: Overview of the Marketplace Merchant Portal Product Management feature +last_updated: Nov 05, 2021 +template: feature-overview-template +redirect_from: + - /docs/marketplace/dev/feature-walkthroughs/202212.0/marketplace-merchant-portal-product-management-feature-walkthrough.html +--- + +The *Marketplace Merchant Portal Product Management* feature lets merchants manage products and their category, attributes, prices, tax sets, SEO settings, variants, stock and validity dates in the Merchant Portal. + +## Related Developer documents + +|INSTALLATION GUIDES | +|---------| +|[Marketplace Merchant Portal Product Management feature integration](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-merchant-portal-feature.html) | diff --git a/docs/pbc/all/product-information-management/202212.0/marketplace/marketplace-product-options-feature-overview.md b/docs/pbc/all/product-information-management/202212.0/marketplace/marketplace-product-options-feature-overview.md index 8dd59cc8b6a..978953957cf 100644 --- a/docs/pbc/all/product-information-management/202212.0/marketplace/marketplace-product-options-feature-overview.md +++ b/docs/pbc/all/product-information-management/202212.0/marketplace/marketplace-product-options-feature-overview.md @@ -78,7 +78,7 @@ Currently, the feature has the following functional constraints which are going * Product option values of a product option group can be only from one merchant. * Product options of a merchant can be used with all offers from all merchants. * There is no Back Office UI for approving or denying merchant product options. -* [Glue API](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-rest-api.html) does not support merchant product option groups and values. +* [Glue API](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/glue-rest-api.html) does not support merchant product option groups and values. * Merchants can not create and manage product option groups and values in the Merchant Portal. ## Related Business User documents diff --git a/docs/pbc/all/product-relationship-management/202212.0/glue-api-retrieve-related-products.md b/docs/pbc/all/product-relationship-management/202212.0/glue-api-retrieve-related-products.md index 3df94dcda81..985aa1ed33b 100644 --- a/docs/pbc/all/product-relationship-management/202212.0/glue-api-retrieve-related-products.md +++ b/docs/pbc/all/product-relationship-management/202212.0/glue-api-retrieve-related-products.md @@ -1320,4 +1320,4 @@ See [Retrieving Related Items of an Abstract Product](#related-product-attribute | 301 | Abstract product is not found. | | 311 | Abstract product ID is not specified. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/push-notification/202400.0/unified-commerce/install-and-upgrade/install-the-push-notification-feature.md b/docs/pbc/all/push-notification/202400.0/unified-commerce/install-and-upgrade/install-the-push-notification-feature.md new file mode 100644 index 00000000000..24fc3f35e40 --- /dev/null +++ b/docs/pbc/all/push-notification/202400.0/unified-commerce/install-and-upgrade/install-the-push-notification-feature.md @@ -0,0 +1,10 @@ +--- +title: Install the Push Notification feature +description: Learn how to integrate the Push notification feature into your project +last_updated: Jan 24, 2023 +template: feature-integration-guide-template +redirect_From: + - /docs/scos/dev/feature-integration-guides/202304.0/install-the-push-notification-feature.html +--- + +{% include pbc/all/install-features/202400.0/install-the-push-notification-feature.md %} \ No newline at end of file diff --git a/docs/scos/user/features/202304.0/push-notification-feature-overview.md b/docs/pbc/all/push-notification/202400.0/unified-commerce/push-notification-feature-overview.md similarity index 98% rename from docs/scos/user/features/202304.0/push-notification-feature-overview.md rename to docs/pbc/all/push-notification/202400.0/unified-commerce/push-notification-feature-overview.md index 66ca7f3269f..ab65aea1d02 100644 --- a/docs/scos/user/features/202304.0/push-notification-feature-overview.md +++ b/docs/pbc/all/push-notification/202400.0/unified-commerce/push-notification-feature-overview.md @@ -3,6 +3,8 @@ title: Push Notification feature overview description: The Push Notifications feature lets you receive push notifications last_updated: Feb 2, 2023 template: concept-topic-template +redirect_from: + - /docs/scos/user/features/202304.0/push-notification-feature-overview.html --- The *Push Notification* feature lets users subscribe to the web push notifications, which are sent from the server to all registered subscriptions. @@ -45,4 +47,5 @@ The following sequence diagram shows how sending and receiving push notification |INSTALLATION GUIDES | |---------| -| [Install the Push Notification feature](/docs/scos/dev/feature-integration-guides/{{page.version}}/install-the-push-notification-feature.html) | +| [Install the Push Notification feature](/docs/pbc/all/push-notification/{{page.version}}/unified-commerce/install-and-upgrade/install-the-push-notification-feature.html) | + \ No newline at end of file diff --git a/docs/pbc/all/ratings-reviews/202204.0/import-and-export-data/ratings-and-reviews-data-import.md b/docs/pbc/all/ratings-reviews/202204.0/import-and-export-data/ratings-and-reviews-data-import.md new file mode 100644 index 00000000000..7ae8f86fc45 --- /dev/null +++ b/docs/pbc/all/ratings-reviews/202204.0/import-and-export-data/ratings-and-reviews-data-import.md @@ -0,0 +1,9 @@ +--- +title: Ratings and Reviews data import +description: Details about data import files for the Ratings and Reviews PBC +template: concept-topic-template +last_updated: Jul 23, 2023 +--- + + +To learn how data import works and about different ways of importing data, see [Data import](/docs/scos/dev/data-import/{{page.version}}/data-import.html). This section describes the data import files that are used to import data related to the Ratings and Reviews PBC: [File details- product_review.csv](/docs/pbc/all/ratings-reviews/{{page.version}}/import-and-export-data/file-details-product-review.csv.html). diff --git a/docs/pbc/all/ratings-reviews/202204.0/manage-using-glue-api/manage-product-reviews-using-glue-api.md b/docs/pbc/all/ratings-reviews/202204.0/manage-using-glue-api/manage-product-reviews-using-glue-api.md index f15f3e7890f..af391512062 100644 --- a/docs/pbc/all/ratings-reviews/202204.0/manage-using-glue-api/manage-product-reviews-using-glue-api.md +++ b/docs/pbc/all/ratings-reviews/202204.0/manage-using-glue-api/manage-product-reviews-using-glue-api.md @@ -197,4 +197,4 @@ Also, all the endpoints that accept `abstract-products` and `concrete-products` | 311 | Abstract product ID is not specified. | | 901 | One or more of the following reasons:
  • The `nickname` attribute is empty or not specified.
  • The `rating` attribute is empty or not specified.
  • The `summary` attribute is empty or not specified.
| -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/ratings-reviews/202204.0/manage-using-glue-api/retrieve-product-reviews-when-retrieving-concrete-products.md b/docs/pbc/all/ratings-reviews/202204.0/manage-using-glue-api/retrieve-product-reviews-when-retrieving-concrete-products.md index 229d45b88ee..d36969a949f 100644 --- a/docs/pbc/all/ratings-reviews/202204.0/manage-using-glue-api/retrieve-product-reviews-when-retrieving-concrete-products.md +++ b/docs/pbc/all/ratings-reviews/202204.0/manage-using-glue-api/retrieve-product-reviews-when-retrieving-concrete-products.md @@ -162,4 +162,4 @@ For the attributes product reviews, see [Retrieve product reviews](/docs/pbc/all | 302 | Concrete product is not found. | | 312 | Concrete product is not specified. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/ratings-reviews/202212.0/import-and-export-data/ratings-and-reviews-data-import.md b/docs/pbc/all/ratings-reviews/202212.0/import-and-export-data/ratings-and-reviews-data-import.md new file mode 100644 index 00000000000..7ae8f86fc45 --- /dev/null +++ b/docs/pbc/all/ratings-reviews/202212.0/import-and-export-data/ratings-and-reviews-data-import.md @@ -0,0 +1,9 @@ +--- +title: Ratings and Reviews data import +description: Details about data import files for the Ratings and Reviews PBC +template: concept-topic-template +last_updated: Jul 23, 2023 +--- + + +To learn how data import works and about different ways of importing data, see [Data import](/docs/scos/dev/data-import/{{page.version}}/data-import.html). This section describes the data import files that are used to import data related to the Ratings and Reviews PBC: [File details- product_review.csv](/docs/pbc/all/ratings-reviews/{{page.version}}/import-and-export-data/file-details-product-review.csv.html). diff --git a/docs/pbc/all/ratings-reviews/202212.0/manage-using-glue-api/manage-product-reviews-using-glue-api.md b/docs/pbc/all/ratings-reviews/202212.0/manage-using-glue-api/manage-product-reviews-using-glue-api.md index 8201e86f766..a8bedb0d776 100644 --- a/docs/pbc/all/ratings-reviews/202212.0/manage-using-glue-api/manage-product-reviews-using-glue-api.md +++ b/docs/pbc/all/ratings-reviews/202212.0/manage-using-glue-api/manage-product-reviews-using-glue-api.md @@ -197,4 +197,4 @@ Also, all the endpoints that accept `abstract-products` and `concrete-products` | 311 | Abstract product ID is not specified. | | 901 | One or more of the following reasons:
  • The `nickname` attribute is empty or not specified.
  • The `rating` attribute is empty or not specified.
  • The `summary` attribute is empty or not specified.
| -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/ratings-reviews/202212.0/manage-using-glue-api/retrieve-product-reviews-when-retrieving-concrete-products.md b/docs/pbc/all/ratings-reviews/202212.0/manage-using-glue-api/retrieve-product-reviews-when-retrieving-concrete-products.md index 6c5b1848851..1f6ada9b04e 100644 --- a/docs/pbc/all/ratings-reviews/202212.0/manage-using-glue-api/retrieve-product-reviews-when-retrieving-concrete-products.md +++ b/docs/pbc/all/ratings-reviews/202212.0/manage-using-glue-api/retrieve-product-reviews-when-retrieving-concrete-products.md @@ -162,4 +162,4 @@ For the attributes product reviews, see [Retrieve product reviews](/docs/pbc/all | 302 | Concrete product is not found. | | 312 | Concrete product is not specified. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/ratings-reviews/202304.0/install-and-upgrade/install-the-product-rating-and-reviews-glue-api.md b/docs/pbc/all/ratings-reviews/202304.0/install-and-upgrade/install-the-product-rating-and-reviews-glue-api.md new file mode 100644 index 00000000000..6264ca7bd7d --- /dev/null +++ b/docs/pbc/all/ratings-reviews/202304.0/install-and-upgrade/install-the-product-rating-and-reviews-glue-api.md @@ -0,0 +1,29 @@ +--- +title: Install the Product Rating and Reviews Glue API +description: This guide contains step-by-step instructions on integrating Product Rating & Reviews API feature into a Spryker-based project. +last_updated: Jul 18, 2023 +template: feature-integration-guide-template +originalLink: https://documentation.spryker.com/2021080/docs/glue-api-product-rating-reviews-feature-integration +originalArticleId: 6634ada1-2f5a-454b-a5b3-9319b7e90cbf +redirect_from: + - /2021080/docs/glue-api-product-rating-reviews-feature-integration + - /2021080/docs/en/glue-api-product-rating-reviews-feature-integration + - /docs/glue-api-product-rating-reviews-feature-integration + - /docs/en/glue-api-product-rating-reviews-feature-integration + - /docs/scos/dev/feature-integration-guides/201811.0/glue-api/glue-api-product-rating-and-reviews-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201903.0/glue-api/glue-api-product-rating-and-reviews-feature-integration.html + - /docs/scos/dev/feature-integration-guides/201907.0/glue-api/glue-api-product-rating-and-reviews-feature-integration.html + - /docs/scos/dev/feature-integration-guides/202212.0/glue-api/glue-api-product-rating-and-reviews-feature-integration.html + +related: + - title: Product Rating and Reviews feature integration + link: docs/scos/dev/feature-integration-guides/page.version/product-rating-and-reviews-feature-integration.html + - title: Product Rating and Reviews feature walkthrough + link: docs/scos/dev/feature-walkthroughs/page.version/product-rating-reviews-feature-walkthrough.html + - title: Retrieving abstract products + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/abstract-products/glue-api-retrieve-abstract-products.html + - title: Retrieving concrete products + link: docs/pbc/all/product-information-management/page.version/base-shop/manage-using-glue-api/concrete-products/glue-api-retrieve-concrete-products.html +--- + +{% include pbc/all/install-features/202304.0/install-glue-api/install-the-product-rating-and-reviews-glue-api.md %} diff --git a/docs/pbc/all/return-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-return-reasons.md b/docs/pbc/all/return-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-return-reasons.md index b7dced653b8..47336d36fe7 100644 --- a/docs/pbc/all/return-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-return-reasons.md +++ b/docs/pbc/all/return-management/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-return-reasons.md @@ -89,4 +89,4 @@ Request sample: retrieve return reasons | --- | --- | --- | | reason | String | Predefined return reason. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/search/202212.0/base-shop/import-data/file-details-product-search-attribute-map.csv.md b/docs/pbc/all/search/202212.0/base-shop/import-and-export-data/file-details-product-search-attribute-map.csv.md similarity index 95% rename from docs/pbc/all/search/202212.0/base-shop/import-data/file-details-product-search-attribute-map.csv.md rename to docs/pbc/all/search/202212.0/base-shop/import-and-export-data/file-details-product-search-attribute-map.csv.md index f8d2864e7ac..fda753cd8e4 100644 --- a/docs/pbc/all/search/202212.0/base-shop/import-data/file-details-product-search-attribute-map.csv.md +++ b/docs/pbc/all/search/202212.0/base-shop/import-and-export-data/file-details-product-search-attribute-map.csv.md @@ -10,7 +10,7 @@ redirect_from: - /docs/file-details-product-search-attribute-mapcsv - /docs/en/file-details-product-search-attribute-mapcsv - /docs/scos/dev/data-import/202212.0/data-import-categories/merchandising-setup/product-merchandising/file-details-product-search-attribute-map.csv.html - - /docs/pbc/all/search/202212.0/import-data/file-details-product-search-attribute-map.csv.html + - /docs/pbc/all/search/202212.0/import-and-export-data/file-details-product-search-attribute-map.csv.html related: - title: Execution order of data importers in Demo Shop link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html diff --git a/docs/pbc/all/search/202212.0/base-shop/import-data/file-details-product-search-attribute.csv.md b/docs/pbc/all/search/202212.0/base-shop/import-and-export-data/file-details-product-search-attribute.csv.md similarity index 96% rename from docs/pbc/all/search/202212.0/base-shop/import-data/file-details-product-search-attribute.csv.md rename to docs/pbc/all/search/202212.0/base-shop/import-and-export-data/file-details-product-search-attribute.csv.md index 3ccaca2ff37..8ce085bd644 100644 --- a/docs/pbc/all/search/202212.0/base-shop/import-data/file-details-product-search-attribute.csv.md +++ b/docs/pbc/all/search/202212.0/base-shop/import-and-export-data/file-details-product-search-attribute.csv.md @@ -10,7 +10,7 @@ redirect_from: - /docs/file-details-product-search-attributecsv - /docs/en/file-details-product-search-attributecsv - /docs/scos/dev/data-import/202212.0/data-import-categories/merchandising-setup/product-merchandising/file-details-product-search-attribute.csv.html - - /docs/pbc/all/search/202212.0/import-data/file-details-product-search-attribute.csv.html + - /docs/pbc/all/search/202212.0/import-and-export-data/file-details-product-search-attribute.csv.html related: - title: Execution order of data importers in Demo Shop link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html diff --git a/docs/pbc/all/search/202212.0/base-shop/import-and-export-data/search-data-import.md b/docs/pbc/all/search/202212.0/base-shop/import-and-export-data/search-data-import.md new file mode 100644 index 00000000000..019bccbf6ea --- /dev/null +++ b/docs/pbc/all/search/202212.0/base-shop/import-and-export-data/search-data-import.md @@ -0,0 +1,12 @@ +--- +title: Search data import +description: Details about data import files for the Search PBC +template: concept-topic-template +last_updated: Jul 23, 2023 +--- + + +To learn how data import works and about different ways of importing data, see [Data import](/docs/scos/dev/data-import/{{page.version}}/data-import.html). This section describes the data import files that are used to import data related to the Search PBC: + +* [File details: product_search_attribute_map.csv](/docs/pbc/all/search/{{page.version}}/base-shop/import-and-export-data/file-details-product-search-attribute-map.csv.html) +* [File details: product_search_attribute.csv](/docs/pbc/all/search/{{page.version}}/base-shop/import-and-export-data/file-details-product-search-attribute.csv.html) diff --git a/docs/pbc/all/search/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-autocomplete-and-search-suggestions.md b/docs/pbc/all/search/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-autocomplete-and-search-suggestions.md index 76ca3de26cc..5e1812f3183 100644 --- a/docs/pbc/all/search/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-autocomplete-and-search-suggestions.md +++ b/docs/pbc/all/search/202212.0/base-shop/manage-using-glue-api/glue-api-retrieve-autocomplete-and-search-suggestions.md @@ -241,8 +241,8 @@ To retrieve a search suggestion, send the request: {% info_block infoBox "SEO-friendly URLs" %} -The `url` attribute of categories and abstract products exposes a SEO-friendly URL of the resource that represents the respective category or product. For information on how to resolve such a URL and retrieve the corresponding resource, see [Resolving search engine friendly URLs](/docs/scos/dev/glue-api-guides/{{page.version}}/resolving-search-engine-friendly-urls.html). +The `url` attribute of categories and abstract products exposes a SEO-friendly URL of the resource that represents the respective category or product. For information on how to resolve such a URL and retrieve the corresponding resource, see [Resolving search engine friendly URLs](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/resolving-search-engine-friendly-urls.html). {% endinfo_block %} -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/search/202212.0/base-shop/manage-using-glue-api/glue-api-search-the-product-catalog.md b/docs/pbc/all/search/202212.0/base-shop/manage-using-glue-api/glue-api-search-the-product-catalog.md index bb996aaa568..745a10e5b0f 100644 --- a/docs/pbc/all/search/202212.0/base-shop/manage-using-glue-api/glue-api-search-the-product-catalog.md +++ b/docs/pbc/all/search/202212.0/base-shop/manage-using-glue-api/glue-api-search-the-product-catalog.md @@ -6711,4 +6711,4 @@ For other abstract product attributes, see: | 314 | Price mode is invalid. | | 503 | Invalid type (non-integer) of one of the request parameters:
  • rating
  • rating.min
  • rating.max
  • page.limit
  • page.offset
  • category
| -For generic Glue Application errors that can also occur, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +For generic Glue Application errors that can also occur, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/search/202212.0/base-shop/search-feature-overview/search-feature-overview.md b/docs/pbc/all/search/202212.0/base-shop/search-feature-overview/search-feature-overview.md index 650155061d1..f62f5f61213 100644 --- a/docs/pbc/all/search/202212.0/base-shop/search-feature-overview/search-feature-overview.md +++ b/docs/pbc/all/search/202212.0/base-shop/search-feature-overview/search-feature-overview.md @@ -55,8 +55,8 @@ The feature has the following functional constraints which are going to be resol | INSTALLATION GUIDES | UPGRADE GUIDES | DATA IMPORT | GLUE API GUIDES | TUTORIALS AND HOWTOS | BEST PRACTICES | |---------|---------|-|-|-|-| -| [Install the Catalog Glue API](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-glue-api.html) | [Upgrade the Catalog module](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-catalog-module.html) | [File details: product_search_attribute_map.csv](/docs/pbc/all/search/{{page.version}}/base-shop/import-data/file-details-product-search-attribute-map.csv.html) | [Searching the product catalog](/docs/pbc/all/search/{{page.version}}/base-shop/manage-using-glue-api/glue-api-search-the-product-catalog.html) | [Tutorial: Content and search - attribute-cart-based catalog personalization](/docs/pbc/all/search/{{page.version}}/base-shop/tutorials-and-howtos/tutorial-content-and-search-attribute-cart-based-catalog-personalization/tutorial-content-and-search-attribute-cart-based-catalog-personalization.html) | [Data-driven ranking](/docs/pbc/all/search/{{page.version}}/base-shop/best-practices/data-driven-ranking.html) | -| [Install the Catalog + Category Management feature](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-catalog-category-management-feature.html) | [Upgrade the CatalogSearchRestApi module](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-catalogsearchrestapi–module.html) | [File details: product_search_attribute.csv](/docs/pbc/all/search/{{page.version}}/base-shop/import-data/file-details-product-search-attribute.csv.html) | [Retrieving autocomplete and search suggestions](/docs/pbc/all/search/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-autocomplete-and-search-suggestions.html) | [Tutorial: Boosting cart-based search](/docs/pbc/all/search/{{page.version}}/base-shop/tutorials-and-howtos/tutorial-content-and-search-attribute-cart-based-catalog-personalization/tutorial-boosting-cart-based-search.html) | [Full-text search](/docs/pbc/all/search/{{page.version}}/base-shop/best-practices/full-text-search.html) | +| [Install the Catalog Glue API](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-catalog-glue-api.html) | [Upgrade the Catalog module](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-catalog-module.html) | [File details: product_search_attribute_map.csv](/docs/pbc/all/search/{{page.version}}/base-shop/import-and-export-data/file-details-product-search-attribute-map.csv.html) | [Searching the product catalog](/docs/pbc/all/search/{{page.version}}/base-shop/manage-using-glue-api/glue-api-search-the-product-catalog.html) | [Tutorial: Content and search - attribute-cart-based catalog personalization](/docs/pbc/all/search/{{page.version}}/base-shop/tutorials-and-howtos/tutorial-content-and-search-attribute-cart-based-catalog-personalization/tutorial-content-and-search-attribute-cart-based-catalog-personalization.html) | [Data-driven ranking](/docs/pbc/all/search/{{page.version}}/base-shop/best-practices/data-driven-ranking.html) | +| [Install the Catalog + Category Management feature](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-catalog-category-management-feature.html) | [Upgrade the CatalogSearchRestApi module](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-catalogsearchrestapi–module.html) | [File details: product_search_attribute.csv](/docs/pbc/all/search/{{page.version}}/base-shop/import-and-export-data/file-details-product-search-attribute.csv.html) | [Retrieving autocomplete and search suggestions](/docs/pbc/all/search/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-autocomplete-and-search-suggestions.html) | [Tutorial: Boosting cart-based search](/docs/pbc/all/search/{{page.version}}/base-shop/tutorials-and-howtos/tutorial-content-and-search-attribute-cart-based-catalog-personalization/tutorial-boosting-cart-based-search.html) | [Full-text search](/docs/pbc/all/search/{{page.version}}/base-shop/best-practices/full-text-search.html) | | [Install the Catalog + Order Management feature](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-catalog-order-management-feature.html) | [Upgrade the CategoryPageSearch module](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-categorypagesearch–module.html) | | | [Configure a search query](/docs/pbc/all/search/{{page.version}}/base-shop/tutorials-and-howtos/configure-a-search-query.html) | [Generic faceted search](/docs/pbc/all/search/{{page.version}}/base-shop/best-practices/generic-faceted-search.html) | | [Install the Search Widget for Concrete Products feature](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/install-features-and-glue-api/install-the-search-widget-for-concrete-products.html) | [Upgrade the CmsPageSearch module](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-cmspagesearch–module.html) | | | [Configure Elasticsearch](/docs/pbc/all/search/{{page.version}}/base-shop/tutorials-and-howtos/configure-elasticsearch.html) | [Multi-term autocompletion](/docs/pbc/all/search/{{page.version}}/base-shop/best-practices/multi-term-auto-completion.html) | | | [Upgrade the ProductLabelSearch module](/docs/pbc/all/search/{{page.version}}/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productlabelsearch–module.html) | | | [Configure search features](/docs/pbc/all/search/{{page.version}}/base-shop/tutorials-and-howtos/configure-search-features.html) | [Naive product centric approach](/docs/pbc/all/search/{{page.version}}/base-shop/best-practices/naive-product-centric-approach.html) | diff --git a/docs/pbc/all/search/202212.0/base-shop/third-party-integrations/algolia.md b/docs/pbc/all/search/202212.0/base-shop/third-party-integrations/algolia.md index 47625e80567..f0c0a1afc43 100644 --- a/docs/pbc/all/search/202212.0/base-shop/third-party-integrations/algolia.md +++ b/docs/pbc/all/search/202212.0/base-shop/third-party-integrations/algolia.md @@ -64,12 +64,20 @@ Here is an example of product data stored in Algolia: { "sku": "017_21748906", "name": "Sony Cyber-shot DSC-W800", + "abstract_name": "Sony Cyber-shot DSC-W800", "description": "Styled for your pocket Precision photography meets the portability of a smartphone. The W800 is small enough to take great photos, look good while doing it, and slip in your pocket. Shooting great photos and videos is easy with the W800. Buttons are positioned for ease of use, while a dedicated movie button makes shooting movies simple. The vivid 2.7-type Clear Photo LCD display screen lets you view your stills and play back movies with minimal effort. Whip out the W800 to capture crisp, smooth footage in an instant. At the press of a button, you can record blur-free 720 HD images with digital sound. Breathe new life into a picture by using built-in Picture Effect technology. There’s a range of modes to choose from – you don’t even have to download image-editing software.", "url": "/en/sony-cyber-shot-dsc-w800-17", "product_abstract_sku": "017", "rating": 4.5, "keywords": "Sony,Entertainment Electronics", - "image": "https://images.icecat.biz/img/norm/high/21748906-Sony.jpg", + "images": { + "default": [ + { + "small": "https://images.icecat.biz/img/norm/medium/21748906-Sony.jpg", + "large": "https://images.icecat.biz/img/norm/high/21748906-Sony.jpg" + } + ] + }, "category": [ "Demoshop", "Cameras & Camcorders", @@ -90,18 +98,33 @@ Here is an example of product data stored in Algolia: "upcs": "0013803252897", "usb_version": "2" }, - "merchants": [ // Marketplace only - "Video King1", + "merchant_name": [ // Marketplace only + "Video King", "Budget Cameras" ], + "merchant_reference": [ // Marketplace only + "MER000002", + "MER000005" + ], + "search_metadata": [], // Put inside this list all your ranking attributes + "concrete_prices": { + "eur": { + "gross": 345699, + "net": 311129 + }, + "chf": { + "gross": 397554, + "net": 357798 + } + }, "prices": { "eur": { - "gross": 276559, - "net": 248903 + "gross": 345699, + "net": 311129 }, "chf": { - "gross": 318043, - "net": 286238 + "gross": 397554, + "net": 357798 } }, "objectID": "017_21748906" diff --git a/docs/pbc/all/search/202212.0/base-shop/third-party-integrations/integrate-algolia.md b/docs/pbc/all/search/202212.0/base-shop/third-party-integrations/integrate-algolia.md index aec34c28064..affae2a15ff 100644 --- a/docs/pbc/all/search/202212.0/base-shop/third-party-integrations/integrate-algolia.md +++ b/docs/pbc/all/search/202212.0/base-shop/third-party-integrations/integrate-algolia.md @@ -7,7 +7,7 @@ redirect_from: - /docs/pbc/all/search/202212.0/third-party-integrations/integrate-algolia.html --- -This document describes how to integrate [Algolia](docs/pbc/all/search/{{page.version}}/base-shop/third-party-integrations/algolia.html) into a Spryker shop. +This document describes how to integrate [Algolia](/docs/pbc/all/search/{{page.version}}/base-shop/third-party-integrations/algolia.html) into a Spryker shop. ## Prerequisites diff --git a/docs/pbc/all/search/202212.0/best-practices/precise-search-by-super-attributes.md b/docs/pbc/all/search/202212.0/best-practices/precise-search-by-super-attributes.md deleted file mode 100644 index 0db3035cd65..00000000000 --- a/docs/pbc/all/search/202212.0/best-practices/precise-search-by-super-attributes.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -title: Precise search by super attributes -description: This document describes precise search by super attributes -last_updated: Jun 16, 2021 -template: concept-topic-template -originalLink: https://documentation.spryker.com/2021080/docs/precise-search-by-super-attributes -originalArticleId: 0af5d38e-725f-44a1-9bfd-dd9f85cdf29b -redirect_from: - - /2021080/docs/precise-search-by-super-attributes - - /2021080/docs/en/precise-search-by-super-attributes - - /docs/scos/dev/best-practices/search-best-practices/precise-search-by-super-attributes.html - - /docs/precise-search-by-super-attributes - - /docs/en/precise-search-by-super-attributes - - /v6/docs/precise-search-by-super-attributes - - /v6/docs/en/precise-search-by-super-attributes -related: - - title: Data-driven ranking - link: docs/pbc/all/search/page.version/best-practices/data-driven-ranking.html - - title: Full-text search - link: docs/pbc/all/search/page.version/best-practices/full-text-search.html - - title: Generic faceted search - link: docs/pbc/all/search/page.version/best-practices/generic-faceted-search.html - - title: On-site search - link: docs/pbc/all/search/page.version/best-practices/on-site-search.html - - title: Other best practices - link: docs/pbc/all/search/page.version/best-practices/other-best-practices.html - - title: Multi-term autocompletion - link: docs/pbc/all/search/page.version/best-practices/multi-term-auto-completion.html - - title: Simple spelling suggestions - link: docs/pbc/all/search/page.version/best-practices/simple-spelling-suggestions.html - - title: Naive product centric approach - link: docs/pbc/all/search/page.version/best-practices/naive-product-centric-approach.html - - title: Personalization - dynamic pricing - link: docs/pbc/all/search/page.version/best-practices/personalization-dynamic-pricing.html - - title: Usage-driven schema and document structure - link: docs/pbc/all/search/page.version/best-practices/usage-driven-schema-and-document-structure.html ---- - -## Task to achieve - -Imagine a shop selling a laptop with 16/32Gb RAM and i5/i7 CPU options. One day there are only two models in stock: *16Gb + i5* and *32Gb + i7*. - -Selecting *RAM: 16Gb + CPU: i7* shows you this abstract product in the catalog/search, while none of its concretes match the requirements. - -As expected, only products with at least one concrete matching selected super-attribute values must be shown. In the previously mentioned example, the search result must be empty. - -## Possible solutions - -The following solutions require [Product Page Search 3.0.0](https://github.com/spryker/product-page-search/releases/tag/3.0.0) or newer. - -### Solution 1. Concrete products index as a support call -The solution consists of several steps: the idea, the implementation plan, and the possible downsides of the solution. - -#### Idea - -The Search is done in two steps: -1. In the **product concrete index**, search is performed by super attributes, and matching product abstract IDs are displayed. -2. Those from the main index for product abstracts are then retrieved. - -#### Implementation - -1. Extend `ProductConcretePageSearchTransfer` with the new field *attributes*, where the desired attributes are stored as an array of string values: - -``` - -``` - -2. Implement the Data expander with the interface `\Spryker\Zed\ProductPageSearchExtension\Dependency\Plugin\ProductConcretePageDataExpanderPluginInterface` to fill into `ProductConcretePageSearchTransfer` super attributes from the concrete. -3. Add this plugin in `ProductPageSearchDependencyProvider` into the plugins list `getProductConcretePageDataExpanderPlugins`. -3. Implement the query expander `ConcreteProductSearchQueryExpanderPlugin`, implementing the interface `QueryExpanderPluginInterface`. You have to add this plugin before `FacetQueryExpanderPlugin` in `CatalogDependencyProvider` into list `createCatalogSearchQueryExpanderPlugins`. - -This plugin does the following: -- Filters out from the request values for super attributes and doesn't include those in the query. -- Makes a sub-search request such as `CatalogClient::searchProductConcretesByFullText`, but searches by facets of super attributes from the request. -- Adds a list of unique abstract product IDs into the query. - -An example implementation looks as follows: - -``` -some code here -``` - -4. Extend `FacetQueryExpanderPlugin`, which doesn't take into account facets used in the plugin `ConcreteProductSearchQueryExpanderPlugin`. - -An example implementation looks as follows: - -``` -some code here -``` - -Make sure to use updated plugin in `CatalogDependencyProvider`. - -#### Downsides - -As you see from the implementation, the results of the last query abstract products index can't be actually paginated. You can't deal with smooth pagination since it's unknown how many concrete products to skip or query to get the next page with abstract products. - - -### Solution 2: Concrete products index is used as a main search index - -The solution consists of several steps: the idea, implementation plan, and possible downsides of the solution. - -#### Idea - -The search request is made on the concrete product index, which is extended with attributes, to allow filtering by those, and with abstract product data to fulfill the required abstract product information for catalog display. - -#### Implementation plan - -1. Update product concrete data loader. -2. Update `ProductConcretePageSearchPublisher` to load into `ProductConcreteTransfers` more data, needed to populate abstract product data. -3. Update `ProductConcreteSearchDataMapper` to use `productAbstractMapExpanderPlugins`. -4. Update the query plugin used to point to concrete index, using `ProductConcreteCatalogSearchQueryPlugin` in `CatalogDependencyProvider::createCatalogSearchQueryPlugin`. - -#### Downsides - -You get duplicate abstract products in the search results, accompanied by a single concrete product. - -Consider merging duplicated abstract products, if you don't want duplicates on the page. diff --git a/docs/pbc/all/service-points/202400.0/unified-commerce/install-the-service-points-feature.md b/docs/pbc/all/service-points/202400.0/unified-commerce/install-the-service-points-feature.md new file mode 100644 index 00000000000..7d49ea59622 --- /dev/null +++ b/docs/pbc/all/service-points/202400.0/unified-commerce/install-the-service-points-feature.md @@ -0,0 +1,10 @@ +--- +title: Install the Service Points feature +description: Learn how to integrate the Service Points feature into your project +last_updated: June 20, 2023 +template: feature-integration-guide-template +redirect_from: + - /docs/uc/all/enhanced-click-collect/202304.0/install-and-upgrade/install-features/install-the-service-points-feature.html +--- + +{% include pbc/all/install-features/202400.0/install-the-service-points-feature.md %} diff --git a/docs/pbc/all/shopping-list-and-wishlist/202212.0/base-shop/manage-using-glue-api/glue-api-manage-shopping-list-items.md b/docs/pbc/all/shopping-list-and-wishlist/202212.0/base-shop/manage-using-glue-api/glue-api-manage-shopping-list-items.md index af16678883d..de433bf995d 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202212.0/base-shop/manage-using-glue-api/glue-api-manage-shopping-list-items.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202212.0/base-shop/manage-using-glue-api/glue-api-manage-shopping-list-items.md @@ -672,4 +672,4 @@ If the item is removed successfully, the endpoint returns the `204 No Content` s | 1504 | Specified shopping list item is not found. | | 1508 | Concrete product is not found. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/shopping-list-and-wishlist/202212.0/base-shop/manage-using-glue-api/glue-api-manage-shopping-lists.md b/docs/pbc/all/shopping-list-and-wishlist/202212.0/base-shop/manage-using-glue-api/glue-api-manage-shopping-lists.md index 30730e4ed82..329c982d1d0 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202212.0/base-shop/manage-using-glue-api/glue-api-manage-shopping-lists.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202212.0/base-shop/manage-using-glue-api/glue-api-manage-shopping-lists.md @@ -856,4 +856,4 @@ If the shopping list is deleted successfully, the endpoint returns the `204 No C | 1503 | Specified shopping list is not found. | | 1506 | Shopping list with given name already exists. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/shopping-list-and-wishlist/202212.0/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.md b/docs/pbc/all/shopping-list-and-wishlist/202212.0/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.md index 66053a164f4..1eb8d1fd352 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202212.0/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202212.0/base-shop/manage-using-glue-api/glue-api-manage-wishlist-items.md @@ -437,4 +437,4 @@ If the item is removed successfully, the endpoint returns the `204 No Content` s | 207 | Cannot remove the item. | | 208 | An item with the provided SKU does not exist in the wishlist. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/shopping-list-and-wishlist/202212.0/base-shop/manage-using-glue-api/glue-api-manage-wishlists.md b/docs/pbc/all/shopping-list-and-wishlist/202212.0/base-shop/manage-using-glue-api/glue-api-manage-wishlists.md index 5fcb9cd778c..05208b8f751 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202212.0/base-shop/manage-using-glue-api/glue-api-manage-wishlists.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202212.0/base-shop/manage-using-glue-api/glue-api-manage-wishlists.md @@ -852,4 +852,4 @@ If the wishlist is deleted successfully, the endpoint returns the `204 No Conten | 210 | Please enter the name using only letters, numbers, underscores, spaces or dashes. | | 901 | `name` field is empty. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-list-items.md b/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-list-items.md index 6d97f84105e..5bfc9dcd364 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-list-items.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-list-items.md @@ -562,4 +562,4 @@ If the item is removed successfully, the endpoint returns the `204 No Content` s | 1518 | Product is not equal to the current Store. | | 1519 | Product offer is not equal to the current Store. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists.md b/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists.md index 085f49cc633..69dd1537d9f 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-shopping-lists.md @@ -1070,4 +1070,4 @@ If the shopping list is deleted successfully, the endpoint returns the `204 No C | 1518 | Product is not equal to the current Store. | | 1519 | Product offer is not equal to the current Store. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlist-items.md b/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlist-items.md index d4c02d377dc..d0b10837fdc 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlist-items.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlist-items.md @@ -253,4 +253,4 @@ If the item is removed successfully, the endpoint returns the `204 No Content` s | 207 | Cannot remove the item. | | 208 | An item with the provided SKU does not exist in the wishlist. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.md b/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.md index 005281d5061..7500ab1a977 100644 --- a/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.md +++ b/docs/pbc/all/shopping-list-and-wishlist/202212.0/marketplace/manage-using-glue-api/glue-api-manage-marketplace-wishlists.md @@ -2316,4 +2316,4 @@ If the wishlist is deleted successfully, the endpoint returns the `204 No Conten | 204 | Cannot update the wishlist. | | 205 | Cannot remove the wishlist. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/import-tax-sets-for-abstract-products.md b/docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/import-file-details-product-abstract.csv.md similarity index 95% rename from docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/import-tax-sets-for-abstract-products.md rename to docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/import-file-details-product-abstract.csv.md index a74d7bda4a5..d60a79c4d1a 100644 --- a/docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/import-tax-sets-for-abstract-products.md +++ b/docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/import-file-details-product-abstract.csv.md @@ -8,7 +8,7 @@ This document describes how to import taxes for abstract products via `product_ ## Import file dependencies -[tax.csv](/docs/pbc/all/tax-management/{{site.version}}/base-shop/import-and-export-data/import-tax-sets.html) +[tax.csv](/docs/pbc/all/tax-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-tax-sets.csv.html) ## Import file parameters diff --git a/docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/import-tax-sets-for-product-options.md b/docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/import-file-details-product-option.csv.md similarity index 96% rename from docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/import-tax-sets-for-product-options.md rename to docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/import-file-details-product-option.csv.md index 1e90877de73..63e8a16a1a6 100644 --- a/docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/import-tax-sets-for-product-options.md +++ b/docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/import-file-details-product-option.csv.md @@ -11,7 +11,7 @@ This document describes how to import taxes for product options via `product_op ## Dependencies * [product_abstract.csv](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/import-and-export-data/products-data-import/file-details-product-abstract.csv.html) -* [tax.csv](/docs/pbc/all/tax-management/{{site.version}}/base-shop/import-and-export-data/import-tax-sets.html) +* [tax.csv](/docs/pbc/all/tax-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-tax-sets.csv.html) ## Import file parameters diff --git a/docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/import-tax-sets-for-shipment-methods.md b/docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/import-file-details-shipment.csv.md similarity index 95% rename from docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/import-tax-sets-for-shipment-methods.md rename to docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/import-file-details-shipment.csv.md index 91501b718cf..79ae2485248 100644 --- a/docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/import-tax-sets-for-shipment-methods.md +++ b/docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/import-file-details-shipment.csv.md @@ -8,7 +8,7 @@ This document describes how to import taxes for shipment methods via `shipment. ## Import file dependencies -[tax.csv](/docs/pbc/all/tax-management/{{site.version}}/base-shop/import-and-export-data/import-tax-sets.html) +[tax.csv](/docs/pbc/all/tax-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-tax-sets.csv.html) ## Import file parameters diff --git a/docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/import-tax-sets.md b/docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/import-file-details-tax-sets.csv.md similarity index 100% rename from docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/import-tax-sets.md rename to docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/import-file-details-tax-sets.csv.md diff --git a/docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/tax-management-data-import.md b/docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/tax-management-data-import.md new file mode 100644 index 00000000000..8a9e0429724 --- /dev/null +++ b/docs/pbc/all/tax-management/202204.0/base-shop/import-and-export-data/tax-management-data-import.md @@ -0,0 +1,14 @@ +--- +title: Tax Management data import +description: Details about data import files for the Tax Management PBC +template: concept-topic-template +last_updated: Jul 23, 2023 +--- + + +To learn how data import works and about different ways of importing data, see [Data import](/docs/scos/dev/data-import/{{page.version}}/data-import.html). This section describes the data import files that are used to import data related to the Tax Management PBC: + +* [Import file details: tax_sets.csv](/docs/pbc/all/tax-management/{{page.version}}/base-shop/import-and-export-data/import-file-details-tax-sets.csv.html) +* [Import file details: product_abstract.csv](/docs/pbc/all/tax-management/{{page.version}}/base-shop/import-and-export-data/import-file-details-product-abstract.csv.html) +* [Import file details: product_option.csv](/docs/pbc/all/tax-management/{{page.version}}/base-shop/import-and-export-data/import-file-details-product-option.csv.html) +* [Import file details: shipment.csv](/docs/pbc/all/tax-management/{{page.version}}/base-shop/import-and-export-data/import-file-details-shipment.csv.html) diff --git a/docs/pbc/all/tax-management/202204.0/base-shop/manage-using-glue-api/retrieve-tax-sets.md b/docs/pbc/all/tax-management/202204.0/base-shop/manage-using-glue-api/retrieve-tax-sets.md index 671dbdbf86c..91a29967a24 100644 --- a/docs/pbc/all/tax-management/202204.0/base-shop/manage-using-glue-api/retrieve-tax-sets.md +++ b/docs/pbc/all/tax-management/202204.0/base-shop/manage-using-glue-api/retrieve-tax-sets.md @@ -170,4 +170,4 @@ Request sample: retrieve tax sets | 310 | Could not get tax set, product abstract with provided id not found. | | 311 | Abstract product SKU is not specified. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). diff --git a/docs/pbc/all/tax-management/202204.0/base-shop/tax-feature-overview.md b/docs/pbc/all/tax-management/202204.0/base-shop/tax-feature-overview.md index 6fe5d8d6e53..81dce84bf1c 100644 --- a/docs/pbc/all/tax-management/202204.0/base-shop/tax-feature-overview.md +++ b/docs/pbc/all/tax-management/202204.0/base-shop/tax-feature-overview.md @@ -26,7 +26,7 @@ The *Tax Management* capability lets you define taxes for the items you sell. Th The tax rate is the percentage of the sales price that buyer pays as a tax. In the default Spryker implementation, the tax rate is defined per country where the tax applies. For details about how to create tax rates for countries in the Back Office, see [Create tax rates](/docs/pbc/all/tax-management/{{site.version}}/base-shop/manage-in-the-back-office/create-tax-rates.html). -A tax set is a set of tax rates. You can [define tax sets in the Back office](/docs/pbc/all/tax-management/{{site.version}}/base-shop/manage-in-the-back-office/create-tax-sets.html) or[ import tax sets](/docs/pbc/all/tax-management/{{site.version}}/base-shop/import-and-export-data/import-tax-sets.html) into your project. +A tax set is a set of tax rates. You can [define tax sets in the Back office](/docs/pbc/all/tax-management/{{site.version}}/base-shop/manage-in-the-back-office/create-tax-sets.html) or[ import tax sets](/docs/pbc/all/tax-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-tax-sets.csv.html) into your project. Tax sets can be applied to an abstract product, product option, and shipment: @@ -116,10 +116,10 @@ The capability has the following functional constraints: | INSTALLATION GUIDES | UPGRADE GUIDES | GLUE API GUIDES | DATA IMPORT | |---|---|---|---| -| [Integrate the Tax Glue API](/docs/pbc/all/tax-management/{{site.version}}/base-shop/install-and-upgrade/install-the-tax-glue-api.html) | [Upgrade the Tax module](/docs/pbc/all/tax-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-tax-module.html) | [Retrieve tax sets](/docs/pbc/all/tax-management/{{site.version}}/base-shop/manage-using-glue-api/retrieve-tax-sets.html) | [Import tax sets](/docs/pbc/all/tax-management/{{site.version}}/base-shop/import-and-export-data/import-tax-sets.html) | -| [Integrate the Product Tax Sets Glue API](/docs/pbc/all/tax-management/{{site.version}}/base-shop/install-and-upgrade/install-the-product-tax-sets-glue-api.html) | [Upgrade the ProductTaxSetsRestApi module](/docs/pbc/all/tax-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-producttaxsetsrestapi-module.html) | [Retrieve tax sets of abstract products](/docs/pbc/all/tax-management/{{site.version}}/base-shop/manage-using-glue-api/retrieve-tax-sets-when-retrieving-abstract-products.html) | [Import tax sets for abstract products](/docs/pbc/all/tax-management/{{site.version}}/base-shop/import-and-export-data/import-tax-sets-for-abstract-products.html) | -| | | | [Import tax sets for shipment methods](/docs/pbc/all/tax-management/{{site.version}}/base-shop/import-and-export-data/import-tax-sets-for-shipment-methods.html) | -| | | | [Import tax sets for product options](/docs/pbc/all/tax-management/{{site.version}}/base-shop/import-and-export-data/import-tax-sets-for-product-options.html) | +| [Integrate the Tax Glue API](/docs/pbc/all/tax-management/{{site.version}}/base-shop/install-and-upgrade/install-the-tax-glue-api.html) | [Upgrade the Tax module](/docs/pbc/all/tax-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-tax-module.html) | [Retrieve tax sets](/docs/pbc/all/tax-management/{{site.version}}/base-shop/manage-using-glue-api/retrieve-tax-sets.html) | [Import tax sets](/docs/pbc/all/tax-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-tax-sets.csv.html) | +| [Integrate the Product Tax Sets Glue API](/docs/pbc/all/tax-management/{{site.version}}/base-shop/install-and-upgrade/install-the-product-tax-sets-glue-api.html) | [Upgrade the ProductTaxSetsRestApi module](/docs/pbc/all/tax-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-producttaxsetsrestapi-module.html) | [Retrieve tax sets of abstract products](/docs/pbc/all/tax-management/{{site.version}}/base-shop/manage-using-glue-api/retrieve-tax-sets-when-retrieving-abstract-products.html) | [Import tax sets for abstract products](/docs/pbc/all/tax-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-product-abstract.csv.html) | +| | | | [Import tax sets for shipment methods](/docs/pbc/all/tax-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-shipment.csv.html) | +| | | | [Import tax sets for product options](/docs/pbc/all/tax-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-product-option.csv.html) | \ No newline at end of file diff --git a/docs/pbc/all/warehouse-management-system/202304.0/base-shop/install-and-upgrade/install-the-warehouse-user-management-feature.md b/docs/pbc/all/warehouse-management-system/202304.0/base-shop/install-and-upgrade/install-the-warehouse-user-management-feature.md deleted file mode 100644 index 2ef51aa6892..00000000000 --- a/docs/pbc/all/warehouse-management-system/202304.0/base-shop/install-and-upgrade/install-the-warehouse-user-management-feature.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: Install the Warehouse User Management feature -description: Install the Warehouse User Management feature in your project -template: feature-integration-guide-template -last_updated: June 1, 2023 ---- - -{% include pbc/all/install-features/202304.0/install-the-warehouse-user-management-feature.md %} diff --git a/docs/pbc/all/warehouse-management-system/202304.0/base-shop/install-and-upgrade/install-features/install-the-inventory-management-feature.md b/docs/pbc/all/warehouse-management-system/202400.0/unified-commerce/install-and-upgrade/install-the-inventory-management-feature.md similarity index 60% rename from docs/pbc/all/warehouse-management-system/202304.0/base-shop/install-and-upgrade/install-features/install-the-inventory-management-feature.md rename to docs/pbc/all/warehouse-management-system/202400.0/unified-commerce/install-and-upgrade/install-the-inventory-management-feature.md index 44eb1fe1bb3..90dbc83b1f9 100644 --- a/docs/pbc/all/warehouse-management-system/202304.0/base-shop/install-and-upgrade/install-features/install-the-inventory-management-feature.md +++ b/docs/pbc/all/warehouse-management-system/202400.0/unified-commerce/install-and-upgrade/install-the-inventory-management-feature.md @@ -3,6 +3,8 @@ title: Install the Inventory Management feature description: Install the Inventory Management feature in your project template: feature-integration-guide-template last_updated: Feb 8, 2023 +redirect_from: + - /docs/pbc/all/warehouse-management-system/202304.0/base-shop/install-and-upgrade/install-features/install-the-inventory-management-feature.html --- -{% include pbc/all/install-features/{{page.version}}/install-the-inventory-management-feature.md %} \ No newline at end of file +{% include pbc/all/install-features/{{page.version}}/install-the-inventory-management-feature.md %} \ No newline at end of file diff --git a/docs/pbc/all/warehouse-management-system/202400.0/unified-commerce/install-and-upgrade/install-the-order-management-inventory-management-feature.md b/docs/pbc/all/warehouse-management-system/202400.0/unified-commerce/install-and-upgrade/install-the-order-management-inventory-management-feature.md new file mode 100644 index 00000000000..384c3a1d0d8 --- /dev/null +++ b/docs/pbc/all/warehouse-management-system/202400.0/unified-commerce/install-and-upgrade/install-the-order-management-inventory-management-feature.md @@ -0,0 +1,11 @@ +--- +title: Install the Order Management + Inventory Management feature +description: Install the Order Management + Inventory Management feature in your project +template: feature-integration-guide-template +last_updated: Feb 8, 2023 +redirect_from: + - /docs/pbc/all/warehouse-management-system/202304.0/base-shop/install-and-upgrade/install-features/install-the-order-management-inventory-management-feature.html + +--- + +{% include pbc/all/install-features/{{page.version}}/install-the-order-management-inventory-management-feature.md %} \ No newline at end of file diff --git a/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-user-management-feature.md b/docs/pbc/all/warehouse-management-system/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-user-management-feature.md similarity index 54% rename from docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-user-management-feature.md rename to docs/pbc/all/warehouse-management-system/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-user-management-feature.md index beff1f5c034..7b2aacae44e 100644 --- a/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-user-management-feature.md +++ b/docs/pbc/all/warehouse-management-system/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-user-management-feature.md @@ -1,8 +1,10 @@ --- title: Install the Warehouse User Management feature -description: Learn how to install the Warehouse User Management feature in your project -last_updated: Jan 25, 2023 +description: Install the Warehouse User Management feature in your project template: feature-integration-guide-template +last_updated: June 1, 2023 +redirect_from: + - /docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-user-management-feature.html --- -{% include pbc/all/install-features/{{page.version}}/install-the-warehouse-user-management-feature.md %} \ No newline at end of file +{% include pbc/all/install-features/{{page.version}}/install-the-warehouse-user-management-feature.md %} diff --git a/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-picker-user-login-feature.md b/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-picker-user-login-feature.md new file mode 100644 index 00000000000..0ab1c7ba05a --- /dev/null +++ b/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-picker-user-login-feature.md @@ -0,0 +1,10 @@ +--- +title: Install the Picker user login feature +description: Learn how to integrate the Picker user login feature into your project +last_updated: Mar 10, 2023 +template: feature-integration-guide-template +redirect_from: + - /docs/scos/dev/feature-integration-guides/202304.0/install-the-picker-user-login-feature.html +--- + +{% include pbc/all/install-features/202400.0/install-the-picker-user-login-feature.md %} diff --git a/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-feature.md b/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-feature.md new file mode 100644 index 00000000000..9458b07362a --- /dev/null +++ b/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-feature.md @@ -0,0 +1,10 @@ +--- +title: Install the Warehouse picking feature +description: Learn how to integrate the Warehouse picking feature into your project +last_updated: Feb 10, 2023 +template: feature-integration-guide-template +redirect_from: + - /docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-feature.html +--- + +{% include pbc/all/install-features/202400.0/install-the-warehouse-picking-feature.md %} diff --git a/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-inventory-management-feature.md b/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-inventory-management-feature.md new file mode 100644 index 00000000000..0b48eb657f5 --- /dev/null +++ b/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-inventory-management-feature.md @@ -0,0 +1,9 @@ +--- +title: Install the Warehouse picking + Inventory Management feature +description: Learn how to integrate the Warehouse picking + Inventory Management feature into your project +last_updated: Apr 10, 2023 +template: feature-integration-guide-template + - /docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-inventory-management-feature.html +--- + +{% include pbc/all/install-features/202400.0/install-the-warehouse-picking-inventory-management-feature.md %} diff --git a/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-order-management-feature.md b/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-order-management-feature.md new file mode 100644 index 00000000000..ae58ece0d1b --- /dev/null +++ b/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-order-management-feature.md @@ -0,0 +1,10 @@ +--- +title: Install the Warehouse picking + Order Management feature +description: Learn how to integrate the Warehouse picking + Order Management feature into your project +last_updated: Mar 30, 2023 +template: feature-integration-guide-template +redirect_from: + - /docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-order-management-feature.html +--- + +{% include pbc/all/install-features/202400.0/install-the-warehouse-picking-order-management-feature.md %} diff --git a/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-product-feature.md b/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-product-feature.md new file mode 100644 index 00000000000..41cc35b7bc0 --- /dev/null +++ b/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-product-feature.md @@ -0,0 +1,10 @@ +--- +title: Install the Warehouse picking + Product feature +description: Learn how to integrate the Warehouse picking + Product feature into your project +last_updated: Mar 30, 2023 +template: feature-integration-guide-template +redirect_from: + - /docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-product-feature.html +--- + +{% include pbc/all/install-features/202400.0/install-the-warehouse-picking-product-feature.md %} diff --git a/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-shipment-feature.md b/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-shipment-feature.md new file mode 100644 index 00000000000..ad60d737a5e --- /dev/null +++ b/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-shipment-feature.md @@ -0,0 +1,10 @@ +--- +title: Install the Warehouse picking + Shipment feature +description: Learn how to integrate the Warehouse picking + Shipment feature into your project +last_updated: Apr 10, 2023 +template: feature-integration-guide-template +redirect_from: + - /docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-shipment-feature.html +--- + +{% include pbc/all/install-features/202400.0/install-the-warehouse-picking-shipment-feature.md %} diff --git a/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-spryker-core-back-office-feature.md b/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-spryker-core-back-office-feature.md new file mode 100644 index 00000000000..3dd3e383d97 --- /dev/null +++ b/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-spryker-core-back-office-feature.md @@ -0,0 +1,10 @@ +--- +title: Install the Warehouse picking + Spryker Core Back Office feature +description: Learn how to integrate the Warehouse picking + Spryker Core Back Office feature into your project +last_updated: Apr 10, 2023 +template: feature-integration-guide-template +redirect_from: + - /docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-spryker-core-back-office-feature.html +--- + +{% include pbc/all/install-features/202400.0/install-the-warehouse-picking-spryker-core-back-office-feature.md %} diff --git a/docs/scos/dev/architecture/conceptual-overview.md b/docs/scos/dev/architecture/conceptual-overview.md index 092688fe701..6b3b4ee1385 100644 --- a/docs/scos/dev/architecture/conceptual-overview.md +++ b/docs/scos/dev/architecture/conceptual-overview.md @@ -57,7 +57,7 @@ The Spryker OS provides the following Application Layers: * [Yves](/docs/scos/dev/back-end-development/yves/yves.html)—provides frontend functionality with the light-weight data access. * [Zed](/docs/scos/dev/back-end-development/zed/zed.html)—provides back office/backend functionality with complicated calculations. -* [Glue](/docs/scos/dev/glue-api-guides/{{site.version}}/glue-infrastructure.html)—provides infrastructure for API with the mixed data access. +* [Glue](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/glue-infrastructure.html)—provides infrastructure for API with the mixed data access. * [Client](/docs/scos/dev/back-end-development/client/client.html)—provides data access infrastructure. * Shared—provides shared code abstractions to be used in other Application Layers of the same module. * Service—provides infrastructure for the stateless operations, usually utils. diff --git a/docs/scos/dev/back-end-development/data-manipulation/data-publishing/handle-data-with-publish-and-synchronization.md b/docs/scos/dev/back-end-development/data-manipulation/data-publishing/handle-data-with-publish-and-synchronization.md index dbaa15bdf61..54f14c7c693 100644 --- a/docs/scos/dev/back-end-development/data-manipulation/data-publishing/handle-data-with-publish-and-synchronization.md +++ b/docs/scos/dev/back-end-development/data-manipulation/data-publishing/handle-data-with-publish-and-synchronization.md @@ -1,7 +1,7 @@ --- title: Handle data with Publish and Synchronization description: Use the tutorial to understand how Publish and Synchronization work and how to export data using a particular example. -last_updated: April 22, 2022 +last_updated: July 14, 2023 template: howto-guide-template originalLink: https://documentation.spryker.com/2021080/docs/handling-data-with-publish-and-synchronization originalArticleId: 67658ab1-da03-4cec-a059-2cd5d41c48df @@ -36,11 +36,11 @@ related: link: docs/scos/dev/back-end-development/data-manipulation/data-publishing/synchronization-behavior-enabling-multiple-mappings.html --- -_Publish and Synchronization_ (P&S) lets you export data from Spryker backend (Zed) to external endpoints. The default external endpoints are Redis and Elasticsearch. The endpoints are usually used by the frontend (Yves) or API (Glue). +_Publish and Synchronization_ (P&S) lets you export data from Spryker backend (Zed) to external endpoints. The default external endpoints are Redis and Elasticsearch. The endpoints are usually used by the frontend (Yves) or API (Glue). -This document shows how P&S works and how to export data using a HelloWorld P&S module example. The module synchronizes the data stored in a Zed database table to Redis. When a record is changed, created, or deleted in the table, the module automatically makes changes in Redis. +This document shows how P&S works and how to export data using a HelloWorld P&S module example. The module synchronizes the data stored in a Zed database table to Redis. When a record is changed, created, or deleted in the table, the module automatically makes changes in Redis. -## 1. Module and table +## 1. Module and table Follow these steps to create the following: * Data source module @@ -50,7 +50,7 @@ Follow these steps to create the following: 1. Create the `HelloWorld` module by creating the `HelloWorld` folder in Zed. The module is the source of data for publishing. 2. Create `spy_hello_world_message` table in the database:
- a. In the `HelloWorld` module, define the table schema by creating `\Pyz\Zed\HelloWorld\Persistence\Propel\Schema\spy_hello_world.schema.xml`: + 1. In the `HelloWorld` module, define the table schema by creating `\Pyz\Zed\HelloWorld\Persistence\Propel\Schema\spy_hello_world.schema.xml`: ```xml {% raw %} @@ -66,25 +66,25 @@ Follow these steps to create the following: {% endraw %} ``` - b. Based on the schema, create the table in the database: + 2. Based on the schema, create the table in the database: ```bash console propel:install ``` - c. Create the `HelloWorldStorage` module by creating the `HelloWorldStorage` folder in Zed. The module is responsible for exporting data to Redis. + 3. Create the `HelloWorldStorage` module by creating the `HelloWorldStorage` folder in Zed. The module is responsible for exporting data to Redis. {% info_block infoBox "Naming conventions" %} The following P&S naming conventions are applied: -- All the modules related to Redis should have the `Storage` suffix. -- All the modules related to Elasticsearch should have the `Search` suffix. +- All the modules related to Redis should have the `Storage` suffix. +- All the modules related to Elasticsearch should have the `Search` suffix. {% endinfo_block %} ## 2. Data structure -The data for Yves is structured differently than the data for Zed. It's because the data model used in Redis and Elasticsearch is optimized to be used by the frontend. With P&S, data is always carried in the form of [transfer objects](/docs/scos/dev/back-end-development/data-manipulation/data-ingestion/structural-preparations/create-use-and-extend-the-transfer-objects.html) between Zed and Yves. +The data for Yves is structured differently than the data for Zed. It's because the data model used in Redis and Elasticsearch is optimized to be used by the frontend. With P&S, data is always carried in the form of [transfer objects](/docs/scos/dev/back-end-development/data-manipulation/data-ingestion/structural-preparations/create-use-and-extend-the-transfer-objects.html) between Zed and Yves. Follow these steps to create a transfer object that represents the target data structure of the frontend. @@ -110,7 +110,7 @@ To publish changes in the Zed database table automatically, you need to enable a To enable events, follow the steps: -1. Activate Event Propel Behavior in `spy_hello_world.schema.xml` you've created in step 1 [Module and table](#module-and-table). +1. Activate Event Propel Behavior in `spy_hello_world.schema.xml` you've created in step 1 [Module and table](#module-and-table). ```xml {% raw %} @@ -137,7 +137,7 @@ To track changes in all the table columns, the _*_ (asterisk) for the `column` a console propel:install ``` -The `SpyHelloWorldMessage` entity model has three events for creating, updating, and deleting a record. These events are referred to as *publish events*. +The `SpyHelloWorldMessage` entity model has three events for creating, updating, and deleting a record. These events are referred to as *publish events*. 3. To map the events to the constants, which you can use in code later, create the `\Pyz\Shared\HelloWorldStorage\HelloWorldStorageConfig` configuration file: @@ -167,7 +167,7 @@ class HelloWorldStorageConfig extends AbstractBundleConfig } ``` -You have enabled events for the `SpyHelloWorldMessage` entity. +You have enabled events for the `SpyHelloWorldMessage` entity. ## 4. Publishers @@ -413,7 +413,7 @@ class IndexController extends AbstractController Ensure that the event has been created: 1. Open the RabbitMQ management GUI at `http(s)://{host_name}:15672/#/queues`. -2. You should see the event in the `publish.hello_world` queue: +2. You should see the event in the `publish.hello_world` queue: ![rabbitmq-event](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Publishing/Handling+data+with+Publish+and+Synchronization/rabbitmq-event.png) Ensure that the triggered event has the correct structure: @@ -443,10 +443,10 @@ Ensure that the triggered event has the correct structure: 2. Verify the data required for the publisher to process it: -* Event name: `Entity.spy_hello_spryker_message.create` -* Listener: `HelloWorldWritePublisherPlugin` -* Table name: `spy_hello_spryker_message` -* Modified columns: `spy_hello_spryker_message.name` and `spy_hello_spryker_message.message` +* Event name: `Entity.spy_hello_spryker_message.create` +* Listener: `HelloWorldWritePublisherPlugin` +* Table name: `spy_hello_spryker_message` +* Modified columns: `spy_hello_spryker_message.name` and `spy_hello_spryker_message.message` * ID: the primary key of the record * ForeignKey: the key to backtrack the updated Propel entities @@ -501,7 +501,7 @@ Ensure that the event has been processed correctly: - The `publish.hello_world` queue is empty: ![empty-rabbitmq-queue](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Publishing/Handling+data+with+Publish+and+Synchronization/empty-rabbitmq-queue.png) -For debugging purposes, use the `-k` option to keep messages in the queue `queue:task:start publish.hello_world -k`. +For debugging purposes, use the `-k` option to keep messages in the queue `queue:task:start publish.hello_world -k`. {% endinfo_block %} @@ -511,7 +511,7 @@ To synchronize data with Redis, an intermediate Zed database table is required. Follow the steps to create the table: -1. Create the table schema `Pyz\Zed\HelloWorldStorage\Persistance\Propel\Schema\spy_hello_world_storage.schema.xml`: +1. Create the table schema file in `Pyz\Zed\HelloWorldStorage\Persistence\Propel\Schema\spy_hello_world_storage.schema.xml`. ```xml {% raw %} @@ -550,18 +550,18 @@ The schema file defines the table as follows: - `ID` is a primary key of the table (`id_hello_world_message_storage` in the example). - `ForeignKey` is a foreign key to the main resource that you want to export (`fk_hello_world_message` for `spy_hello_world_message`). - `SynchronizationBehaviour` modifies the table as follows: - - Adds the `Data` column that stores data in the format that can be sent directly to Redis. The database field type is `TEXT`. - - Adds the `Key` column that stores the Redis Key. The data type is `VARCHAR`. + - Adds the `Data` column that stores data in the format that can be sent directly to Redis. The database field type is `TEXT`. + - Adds the `Key` column that stores the Redis Key. The data type is `VARCHAR`. - Defines `Resource` name for key generation. - Defines `Store` value for store-specific data. - Defines `Locale` value for localizable data. - Defines `Key Suffix Column` value for key generation. - - Defines `queue_group` to send a copy of the `data` column. + - Defines `queue_group` to send a copy of the `data` column. - Timestamp behavior is added to keep timestamps and use an incremental sync strategy. {% info_block infoBox "Incremental sync" %} -An *incremental sync* is a sync that only processes the data records that have changed (created or modified) since the last time the integration ran as opposed to processing the entire data set every time. +An *incremental sync* is a sync that only processes the data records that have changed (created or modified) since the last time the integration ran as opposed to processing the entire data set every time. {% endinfo_block %} @@ -585,7 +585,7 @@ To create complex keys to use more than one column, do the following: At this point, you can complete the publishing part. Follow the standard conventions and let publishers delegate the execution process through the facade to the models behind. -To do this, create facade and model classes to handle the logic of the publish part as follows. +To do this, create facade and model classes to handle the logic of the publish part as follows. The Facade methods are: @@ -593,7 +593,7 @@ The Facade methods are: - `deleteCollectionByHelloWorldEvents(array $eventTransfers)` -1. Create the `HelloWorldStorageWriter` model and implement the following method: +1. Create the `HelloWorldStorageWriter` model and implement the following method: ```php getFactory() + ->createMessageStorageReader() + ->getMessageById($messageId); + } +} +``` + +3. Add the factory `Pyz/Client/HelloWorldStorage/HelloWorldStorageFactory.php` for `$this->getFactory()` method call within the `HelloWorldStorageClient` methods. + +```php +getSynchronizationService(), $this->getStorageClient()); + } + + /** + * @return \Spryker\Service\Synchronization\SynchronizationServiceInterface + */ + public function getSynchronizationService(): SynchronizationServiceInterface + { + return $this->getProvidedDependency(HelloWorldStorageDependencyProvider::SERVICE_SYNCHRONIZATION); + } + + /** + * @return \Spryker\Client\Storage\StorageClientInterface + */ + public function getStorageClient(): StorageClientInterface + { + return $this->getProvidedDependency(HelloWorldStorageDependencyProvider::CLIENT_STORAGE); + } +} +``` + +4. The HelloWorldFactory needs a dependency provider to handle dependencies required by the Redis and reader classes. Add the `Pyz/Client/HelloWorldStorage/HelloWorldStorageDependencyProvider.php` dependency provider. ```php addStorageClient($container); + $container = $this->addSynchronizationService($container); + + return $container; + } + + /** + * @param \Spryker\Client\Kernel\Container $container + * + * @return \Spryker\Client\Kernel\Container + */ + protected function addStorageClient(Container $container): Container + { + $container->set(static::CLIENT_STORAGE, function (Container $container) { + return $container->getLocator()->storage()->client(); + }); + + return $container; + } + + /** + * @param \Spryker\Client\Kernel\Container $container + * + * @return \Spryker\Client\Kernel\Container + */ + protected function addSynchronizationService(Container $container): Container + { + $container->set(static::SERVICE_SYNCHRONIZATION, function (Container $container) { + return $container->getLocator()->synchronization()->service(); + }); + + return $container; + } +} +``` + +5. To add an array of items that can be returned, update the transfer in `Pyz/Shared/HelloWorldStorage/Transfer/hello_world_storage.transfer.xml`: + +```xml + + + + + + + + + + +``` + +6. Run the following command: + +```bash + docker/sdk console transfer:generate +``` + +7. Add the `Pyz\Client\Reader\MessageStorageReaderInterface.php` interface. + +```php +synchronizationService = $synchronizationService; + $this->storageClient = $storageClient; + } + /** + * @param int $idMessage + * + * @return \Generated\Shared\Transfer\HelloWorldStorageTransfer + */ + public function getMessageById(int $idMessage): HelloWorldStorageTransfer { - $synchronizationDataTransfer = new SynchronizationDataTransfer(); - $synchronizationDataTransfer - ->setReference($idMessage); + $syncDataTransfer = new SynchronizationDataTransfer(); + $syncDataTransfer->setReference($idMessage); $key = $this->synchronizationService - ->getStorageKeyBuilder('message') // "message" is the resource name - ->generateKey($synchronizationDataTransfer); + ->getStorageKeyBuilder('message') + ->generateKey($syncDataTransfer); $data = $this->storageClient->get($key); @@ -1070,7 +1289,39 @@ class MessageStorageReader implements MessageStorageReaderInterface return $messageStorageTransfer; } - - ... } ``` + +9. Add thr endpoint to the controller in `Pyz/Zed/HelloWorld/Communication/Controller/IndexController.php`. + +```php + /** + * @param \Symfony\Component\HttpFoundation\Request $request + * + * @return \Symfony\Component\HttpFoundation\JsonResponse + */ + public function searchAction(Request $request): JsonResponse + { + $client = new HelloWorldStorageClient(); + $message = $client->getMessageById($request->get('id')); + + return $this->jsonResponse([ + 'status' => 'success', + 'message' => $message->toArray() + ]); + } +``` + +Update the routes for the Back Office using the following command: + +``` +docker/sdk console router:cache:warm-up:backoffice +``` + +You should now have another endpoint to get a message from the Redis storage via the newly created HelloWorldClient. + +Check the redis-commander to get ID of the message object that actually exists. Then access the message via the following endpoint: + +``` +http://[YOUR_BACKOFFICE_URL]/hello-world/index/search?id=[ID_IN_REDIS] +``` diff --git a/docs/scos/dev/back-end-development/extend-spryker/development-strategies.md b/docs/scos/dev/back-end-development/extend-spryker/development-strategies.md index ef1465910fa..c31cd295829 100644 --- a/docs/scos/dev/back-end-development/extend-spryker/development-strategies.md +++ b/docs/scos/dev/back-end-development/extend-spryker/development-strategies.md @@ -56,7 +56,7 @@ In your project, you don't store prices in Spryker OS, but in an external system {% endinfo_block %} -If an extension point is missing, register it in [Spryker Ideas](https://spryker.ideas.aha.io/), so we add it in future. +If an extension point is missing, you can send a request to your Spryker account manager, and we will add it in future. Spryker OS support: High, you can safely take minor and patch releases. @@ -80,7 +80,7 @@ When specific OOTB Spryker behavior doesn't fit Project requirements, you can en {% info_block infoBox "Let us know which extension point is missing, so we can add it in the core" %} -Register missing extension points in [Aha ideas](https://spryker.ideas.aha.io/). +If an extension point is missing, send a request to your Spryker account manager, and we will add it in future. {% endinfo_block %} diff --git a/docs/scos/dev/data-import/202204.0/data-import-categories/commerce-setup/commerce-setup.md b/docs/scos/dev/data-import/202204.0/data-import-categories/commerce-setup/commerce-setup.md index ac270bc13da..db2220a1e60 100644 --- a/docs/scos/dev/data-import/202204.0/data-import-categories/commerce-setup/commerce-setup.md +++ b/docs/scos/dev/data-import/202204.0/data-import-categories/commerce-setup/commerce-setup.md @@ -21,14 +21,14 @@ The following table provides details about Commerce Setup data importers, their | Currency | Imports information about currencies used in the store(s). The `currency.csv` file provides an easy way to load information about currencies used in Spryker Demo Shop. It allows to load information like: ISO code, currency symbol, and the name of the currency.|`data:import:currency` | [currency.csv](/docs/pbc/all/price-management/{{site.version}}/base-shop/import-and-export-data/file-details-currency.csv.html) | None| | Customer | Imports information about customers.|`data:import:customer` | [customer.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/commerce-setup/file-details-customer.csv.html) | None| | Glossary | Imports information relative to the several locales.|`data:import:glossary` | [glossary.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/commerce-setup/file-details-glossary.csv.html) | None| -| Tax |Imports information about taxes.|`data:import:tax` | [tax.csv](/docs/pbc/all/tax-management/{{site.version}}/base-shop/import-and-export-data/import-tax-sets.html) | None| +| Tax |Imports information about taxes.|`data:import:tax` | [tax.csv](/docs/pbc/all/tax-management/{{site.version}}/base-shop/import-and-export-data/import-file-details-tax-sets.csv.html) | None| | Shipment |Imports information about shipment methods.|`data:import:shipment` | [shipment.csv](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/import-and-export-data/file-details-shipment.csv.html) | None| | Shipment Price |Imports information about the price of each shipment method, applied in each store.|`data:import:shipment-price` | [shipment_price.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/commerce-setup/file-details-shipment-price.csv.html) |
  • [shipment.cs](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/import-and-export-data/file-details-shipment.csv.html)v
  • [currency.csv](/docs/pbc/all/price-management/{{site.version}}/base-shop/import-and-export-data/file-details-currency.csv.html)
  • `stores.php` configuration file of demo shop PHP project
| | Shipment Method Store | Links a *shipment method* to a specific *store*.|`data:import:shipment-method-store` | [shipment_method_store.csv](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/import-and-export-data/file-details-shipment-method-store.csv.html) |
  • [shipment.csv](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/import-and-export-data/file-details-shipment.csv.html)
  • `stores.php` configuration file of demo shop PHP project
| | Sales Order Threshold | Imports information about sales order thresholds. The CSV file content defines certain thresholds for specific stores and currencies.|`data:import:sales-order-threshold` | [sales_order_threshold.csv](/docs/pbc/all/cart-and-checkout/{{site.version}}/import-and-export-data/file-details-sales-order-threshold.csv.html) |
  • [currency.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/commerce-setup/file-details-currency.csv.html)
  • [glossary.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/commerce-setup/file-details-glossary.csv.html)
  • `stores.php` configuration file of demo shop PHP project
| -| Warehouse | Imports information about warehouses (for example, name of the warehouse, and if it is available or not).|`data:import:stock` | [warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-data/file-details-warehouse.csv.html) | None| -| Warehouse Store | Imports information about the Warehouse / Store relation configuration indicating which warehouse serves which store(s).|` data:import:stock-store`| [warehouse_store.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-data/file-details-warehouse-store.csv.html) |
  • [warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-data/file-details-warehouse.csv.html)
  • `stores.php` configuration file of demo shop PHP project
| +| Warehouse | Imports information about warehouses (for example, name of the warehouse, and if it is available or not).|`data:import:stock` | [warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/file-details-warehouse.csv.html) | None| +| Warehouse Store | Imports information about the Warehouse / Store relation configuration indicating which warehouse serves which store(s).|` data:import:stock-store`| [warehouse_store.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/file-details-warehouse-store.csv.html) |
  • [warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/file-details-warehouse.csv.html)
  • `stores.php` configuration file of demo shop PHP project
| | Payment Method | Imports information about *payment methods* as well as *payment providers*.|`data:import:payment-method` | [payment_method.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/commerce-setup/file-details-payment-method.csv.html) | None| | Payment Method Store |Imports information about payment methods per store. The CSV file links the *payment method* with each *store*.|`data:import:payment-method-store`| [payment_method_store.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/commerce-setup/file-details-payment-method-store.csv.html) |
  • [payment_method.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/commerce-setup/file-details-payment-method.csv.html)
  • `stores.php` configuration file of demo shop PHP project
| -| Warehouse address |Imports warehouse address information to be used as shipping origin address.|`data:import:stock-address`| [warehouse_address.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-data/file-details-warehouse-address.csv.html) |[warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-data/file-details-warehouse-store.csv.html)| +| Warehouse address |Imports warehouse address information to be used as shipping origin address.|`data:import:stock-address`| [warehouse_address.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/file-details-warehouse-address.csv.html) |[warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/file-details-warehouse-store.csv.html)| | Order |Updates the status of the order item.|`order-oms:status-import order-status`| [order-status.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/commerce-setup/file-details-order-status.csv.html) | | diff --git a/docs/scos/dev/data-import/202212.0/data-import-categories/commerce-setup/commerce-setup.md b/docs/scos/dev/data-import/202212.0/data-import-categories/commerce-setup/commerce-setup.md index e97fe3880a9..209b737cd6a 100644 --- a/docs/scos/dev/data-import/202212.0/data-import-categories/commerce-setup/commerce-setup.md +++ b/docs/scos/dev/data-import/202212.0/data-import-categories/commerce-setup/commerce-setup.md @@ -21,14 +21,14 @@ The table below provides details on Commerce Setup data importers, their purpose | Currency | Imports information about currencies used in the store(s). The `currency.csv` file provides an easy way to load information about currencies used in Spryker Demo Shop. It allows to load information like: ISO code, currency symbol, and the name of the currency.|`data:import:currency` | [currency.csv](/docs/pbc/all/price-management/{{page.version}}/base-shop/import-and-export-data/file-details-currency.csv.html) | None| | Customer | Imports information about customers.|`data:import:customer` | [customer.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/commerce-setup/file-details-customer.csv.html) | None| | Glossary | Imports information relative to the several locales.|`data:import:glossary` | [glossary.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/commerce-setup/file-details-glossary.csv.html) | None| -| Tax |Imports information about taxes.|`data:import:tax` | [tax.csv](/docs/pbc/all/tax-management/{{page.version}}/base-shop/import-and-export-data/import-tax-sets.html) | None| +| Tax |Imports information about taxes.|`data:import:tax` | [tax.csv](/docs/pbc/all/tax-management/{{page.version}}/base-shop/import-and-export-data/import-file-details-tax-sets.csv.html) | None| | Shipment |Imports information about shipment methods.|`data:import:shipment` | [shipment.csv](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/import-and-export-data/file-details-shipment.csv.html) | None| | Shipment Price |Imports information about the price of each shipment method, applied in each store.|`data:import:shipment-price` | [shipment_price.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/commerce-setup/file-details-shipment-price.csv.html) |
  • [shipment.cs](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/import-and-export-data/file-details-shipment.csv.html)v
  • [currency.csv](/docs/pbc/all/price-management/{{page.version}}/base-shop/import-and-export-data/file-details-currency.csv.html)
  • `stores.php` configuration file of demo shop PHP project
| | Shipment Method Store | Links a *shipment method* to a specific *store*.|`data:import:shipment-method-store` | [shipment_method_store.csv](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/import-and-export-data/file-details-shipment-method-store.csv.html) |
  • [shipment.csv](/docs/pbc/all/carrier-management/{{site.version}}/base-shop/import-and-export-data/file-details-shipment.csv.html)
  • `stores.php` configuration file of demo shop PHP project
| | Sales Order Threshold | Imports information about sales order thresholds. The CSV file content defines certain thresholds for specific stores and currencies.|`data:import:sales-order-threshold` | [sales_order_threshold.csv](/docs/pbc/all/cart-and-checkout/{{page.version}}/import-and-export-data/file-details-sales-order-threshold.csv.html) |
  • [currency.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/commerce-setup/file-details-currency.csv.html)
  • [glossary.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/commerce-setup/file-details-glossary.csv.html)
  • `stores.php` configuration file of demo shop PHP project
| -| Warehouse | Imports information about warehouses (for example, name of the warehouse, and if it is available or not).|`data:import:stock` | [warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-data/file-details-warehouse.csv.html) | None| -| Warehouse Store | Imports information about the Warehouse / Store relation configuration indicating which warehouse serves which store(s).|` data:import:stock-store`| [warehouse_store.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-data/file-details-warehouse-store.csv.html) |
  • [warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-data/file-details-warehouse.csv.html)
  • `stores.php` configuration file of demo shop PHP project
| -| Payment Method | Imports information about *payment methods* as well as *payment providers*.|`data:import:payment-method` | [payment_method.csv](/docs/pbc/all/payment-service-provider/{{page.version}}/import-and-export-data/file-details-payment-method.csv.html) | None| -| Payment Method Store |Imports information about payment methods per store. The CSV file links the *payment method* with each *store*.|`data:import:payment-method-store`| [payment_method_store.csv](/docs/pbc/all/payment-service-provider/{{page.version}}/import-and-export-data/file-details-payment-method-store.csv.html) |
  • [payment_method.csv](/docs/pbc/all/payment-service-provider/{{page.version}}/import-and-export-data/file-details-payment-method.csv.html)
  • `stores.php` configuration file of demo shop PHP project
| -| Warehouse address |Imports warehouse address information to be used as shipping origin address.|`data:import:stock-address`| [warehouse_address.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-data/file-details-warehouse-address.csv.html) |[warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-data/file-details-warehouse-store.csv.html)| +| Warehouse | Imports information about warehouses (for example, name of the warehouse, and if it is available or not).|`data:import:stock` | [warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/file-details-warehouse.csv.html) | None| +| Warehouse Store | Imports information about the Warehouse / Store relation configuration indicating which warehouse serves which store(s).|` data:import:stock-store`| [warehouse_store.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/file-details-warehouse-store.csv.html) |
  • [warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/file-details-warehouse.csv.html)
  • `stores.php` configuration file of demo shop PHP project
| +| Payment Method | Imports information about *payment methods* as well as *payment providers*.|`data:import:payment-method` | [payment_method.csv](/docs/pbc/all/payment-service-provider/{{page.version}}/spryker-pay/base-shop/import-and-export-data/import-file-details-payment-method.csv.html) | None| +| Payment Method Store |Imports information about payment methods per store. The CSV file links the *payment method* with each *store*.|`data:import:payment-method-store`| [payment_method_store.csv](/docs/pbc/all/payment-service-provider/{{page.version}}/spryker-pay/base-shop/import-and-export-data/import-file-details-payment-method-store.csv.html) |
  • [payment_method.csv](/docs/pbc/all/payment-service-provider/{{page.version}}/spryker-pay/base-shop/import-and-export-data/import-file-details-payment-method.csv.html)
  • `stores.php` configuration file of demo shop PHP project
| +| Warehouse address |Imports warehouse address information to be used as shipping origin address.|`data:import:stock-address`| [warehouse_address.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/file-details-warehouse-address.csv.html) |[warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/file-details-warehouse-store.csv.html)| | Order |Updates the status of the order item.|`order-oms:status-import order-status`| [order-status.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/commerce-setup/file-details-order-status.csv.html) | | diff --git a/docs/scos/dev/data-import/202212.0/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.md b/docs/scos/dev/data-import/202212.0/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.md index cd5fb5369c4..8fb90954afb 100644 --- a/docs/scos/dev/data-import/202212.0/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.md +++ b/docs/scos/dev/data-import/202212.0/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.md @@ -29,7 +29,7 @@ The following list illustrates the order followed to run the data importers and * [currency](/docs/pbc/all/price-management/{{page.version}}/base-shop/import-and-export-data/file-details-currency.csv.html) * [customer](/docs/pbc/all/customer-relationship-management/{{page.version}}/file-details-customer.csv.html) * [glossary](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/commerce-setup/file-details-glossary.csv.html) - * [tax](/docs/pbc/all/tax-management/{{page.version}}/base-shop/import-and-export-data/import-tax-sets.html) + * [tax](/docs/pbc/all/tax-management/{{page.version}}/base-shop/import-and-export-data/import-file-details-tax-sets.csv.html) * [shipment](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/import-and-export-data/file-details-shipment.csv.html) * [shipment-price](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/import-and-export-data/file-details-shipment-price.csv.html) * [shipment-method-store](/docs/pbc/all/carrier-management/{{page.version}}/base-shop/import-and-export-data/file-details-shipment-method-store.csv.html) @@ -49,7 +49,7 @@ The following list illustrates the order followed to run the data importers and * [product-image](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/file-details-product-image.csv.html) * [product-price](/docs/pbc/all/price-management/{{page.version}}/base-shop/import-and-export-data/file-details-product-price.csv.html) * [product-price-schedule](/docs/pbc/all/price-management/{{page.version}}/base-shop/import-and-export-data/file-details-product-price-schedule.csv.html) - * [product-stock](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-data/file-details-product-stock.csv.html) + * [product-stock](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/file-details-product-stock.csv.html) * Special Products: * [product-option](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/product-options/file-details-product-option.csv.html) * [product-option-price](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/product-options/file-details-product-option-price.csv.html) @@ -92,8 +92,8 @@ The following list illustrates the order followed to run the data importers and * [product-review](/docs/pbc/all/ratings-reviews/{{page.version}}/import-and-export-data/file-details-product-review.csv.html) * [product-label](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/file-details-product-label.csv.html) * [product-set](/docs/pbc/all/content-management-system/{{page.version}}/base-shop/import-and-export-data/file-details-product-set.csv.html) - * [product-search-attribute-map](/docs/pbc/all/search/{{page.version}}/base-shop/import-data/file-details-product-search-attribute-map.csv.html) - * [product-search-attribute](/docs/pbc/all/search/{{page.version}}/base-shop/import-data/file-details-product-search-attribute.csv.html) + * [product-search-attribute-map](/docs/pbc/all/search/{{page.version}}/base-shop/import-and-export-data/file-details-product-search-attribute-map.csv.html) + * [product-search-attribute](/docs/pbc/all/search/{{page.version}}/base-shop/import-and-export-data/file-details-product-search-attribute.csv.html) * [discount-amount](/docs/pbc/all/discount-management/{{page.version}}/base-shop/import-and-export-data/file-details-discount-amount.csv.html) * [product-discontinued](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/file-details-product-discontinued.csv.html) * [product-alternative](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/file-details-product-alternative.csv.html) diff --git a/docs/scos/dev/data-import/202212.0/importing-product-data-with-a-single-file.md b/docs/scos/dev/data-import/202212.0/importing-product-data-with-a-single-file.md index 9627185786e..74bb1febc5e 100644 --- a/docs/scos/dev/data-import/202212.0/importing-product-data-with-a-single-file.md +++ b/docs/scos/dev/data-import/202212.0/importing-product-data-with-a-single-file.md @@ -78,7 +78,7 @@ If you need to import other product data as well, for example, prices, images, e |
  • product_group.group_key
  • product_group.position
| [File details: product_group.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/merchandising-setup/product-merchandising/file-details-product-group.csv.html) | |
  • product_image.image_set_name
  • product_image.external_url_large
  • product_image.external_url_small
  • product_image.locale
  • product_image.sort_order
  • product_image.product_image_key
  • product_image.product_image_set_key
| [File details: product_image.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/catalog-setup/products/file-details-product-image.csv.html) | |
  • product_price.price_type
  • product_price.store
  • product_price.currency
  • product_price.value_net
  • product_price.value_gross
  • product_price.price_data.volume_prices
| [File details: product_price.csv](/docs/pbc/all/price-management/{{page.version}}/base-shop/import-and-export-data/file-details-product-price.csv.html) | -|
  • product_stock.name
  • product_stock.quantity
  • product_stock.is_never_out_of_stock
  • product_stock.is_bundle
| [File details: product_stock.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-data/file-details-product-stock.csv.html) | +|
  • product_stock.name
  • product_stock.quantity
  • product_stock.is_never_out_of_stock
  • product_stock.is_bundle
| [File details: product_stock.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/file-details-product-stock.csv.html) | diff --git a/docs/marketplace/dev/data-import/202212.0/marketplace-setup.md b/docs/scos/dev/data-import/202212.0/marketplace-data-import.md similarity index 97% rename from docs/marketplace/dev/data-import/202212.0/marketplace-setup.md rename to docs/scos/dev/data-import/202212.0/marketplace-data-import.md index 6ce37b40d42..3377449de57 100644 --- a/docs/marketplace/dev/data-import/202212.0/marketplace-setup.md +++ b/docs/scos/dev/data-import/202212.0/marketplace-data-import.md @@ -1,8 +1,10 @@ --- -title: "Marketplace setup" +title: "Marketplace data import" last_updated: May 28, 2021 description: The Marketplace setup category holds data required to set up the Marketplace environment. template: import-file-template +redirect_from: + - /docs/marketplace/dev/data-import/202212.0/marketplace-setup.html --- The Marketplace setup category contains data required to set up the Marketplace environment. @@ -19,11 +21,11 @@ The following table provides details about Marketplace setup data importers, the | Merchant category | Imports merchant categories. | `data:import merchant-category` | [merchant_category.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-data/file-details-merchant-category.csv.html) | [merchant.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-data/file-details-merchant.csv.html) | | Merchant users | Imports merchant users of the merchant. | `data:import merchant-user` | [merchant_user.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-data/file-details-merchant-user.csv.html) | [merchant.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-data/file-details-merchant.csv.html) | | Merchant stores | Imports merchant stores. | `data:import merchant-store` | [merchant_store.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-data/file-details-merchant-store.csv.html) |
  • [merchant.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-data/file-details-merchant.csv.html)
  • `stores.php` configuration file of Demo Shop
| -| Merchant stock | Imports merchant stock details. | `data:import merchant-stock` | [merchant_stock.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/import-data/file-details-merchant-stock.csv.html) |
  • [merchant.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant.csv.html)
  • [File details: warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-data/file-details-warehouse.csv.html)
| +| Merchant stock | Imports merchant stock details. | `data:import merchant-stock` | [merchant_stock.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/import-data/file-details-merchant-stock.csv.html) |
  • [merchant.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant.csv.html)
  • [File details: warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/file-details-warehouse.csv.html)
| | Merchant OMS processes | Imports Merchant OMS processes. | `data:import merchant-oms-process` | [merchant_oms_process.csv](/docs/pbc/all/order-management-system/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-oms-process.csv.html) |
  • [merchant.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-data/file-details-merchant.csv.html)
  • OMS configuration that can be found at:
    • `project/config/Zed/oms project/config/Zed/StateMachine`
    • `project/config/Zed/StateMachine`
| | Merchant product offer | Imports basic merchant product offer information. | `data:import merchant-product-offer` | [merchant_product_offer.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html) |
  • [merchant.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-data/file-details-merchant.csv.html)
  • [File details: product_concrete.csv](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/import-and-export-data/products-data-import/file-details-product-concrete.csv.html)
| | Merchant product offer price | Imports product offer prices. | `data:import price-product-offer` | [price-product-offer.csv](/docs/pbc/all/price-management/{{page.version}}/marketplace/import-and-export-data/file-details-price-product-offer.csv.html) |
  • [merchant_product_offer.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html)
  • [product_price.csv](/docs/pbc/all/price-management/{{page.version}}/base-shop/import-and-export-data/file-details-product-price.csv.html)
| -| Merchant product offer stock | Imports merchant product stock. | `data:import product-offer-stock` | [product_offer_stock.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/import-data/file-details-product-offer-stock.csv.html) |
  • [merchant_product_offer.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html)
  • [warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-data/file-details-warehouse.csv.html)
| +| Merchant product offer stock | Imports merchant product stock. | `data:import product-offer-stock` | [product_offer_stock.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/marketplace/import-data/file-details-product-offer-stock.csv.html) |
  • [merchant_product_offer.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html)
  • [warehouse.csv](/docs/pbc/all/warehouse-management-system/{{page.version}}/base-shop/import-and-export-data/file-details-warehouse.csv.html)
| | Merchant product offer stores | Imports merchant product offer stores. | `data:import merchant-product-offer-store` | [merchant_product_offer_store.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-offer-store.csv.html) |
  • [merchant_product_offer.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html)
  • `stores.php` configuration file of Demo Shop
| | Validity of the merchant product offers | Imports the validity of the merchant product offers. | `data:import product-offer-validity` | [product_offer_validity.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-product-offer-validity.csv.html) | [merchant_product_offer.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-merchant-product-offer.csv.html) | | Merchant product offers | Imports full product offer information via a single file. | `data:import --config data/import/common/combined_merchant_product_offer_import_config_{store}.yml` | [combined_merchant_product_offer.csv](/docs/pbc/all/offer-management/{{page.version}}/marketplace/import-and-export-data/import-file-details-combined-merchant-product-offer.csv.html) |
  • [merchant.csv](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/import-data/file-details-merchant.csv.html)
  • `stores.php` configuration file of Demo Shop
| diff --git a/docs/scos/dev/drafts-dev/roadmap.md b/docs/scos/dev/drafts-dev/roadmap.md index d6b16c8f12e..633e7b0f8ff 100644 --- a/docs/scos/dev/drafts-dev/roadmap.md +++ b/docs/scos/dev/drafts-dev/roadmap.md @@ -27,8 +27,6 @@ redirect_from: **Updated: April 2021** We at Spryker are happy to share our plans with you. The plans below are guidelines that give us direction to continuously evolve and improve our product. However, we are also flexible, and we constantly listen and adapt. Therefore, our plans could change. So although we are good at fulfilling our commitments, we reserve the right to change our priorities, remove or add new features from time to time. If you are planning anything strategic based on this list, you might want to talk to us first, either by contacting your Spryker representative or one of our [Solution Partners](https://spryker.com/solution-partners/). -If you see a feature that you like, [create an idea in our Aha](https://spryker.ideas.aha.io/ideas/) and let us know why the feature is important to you. - {% info_block warningBox %} The roadmap contains features and not architectural items, enhancements, technology updates, or any other strategic releases we are working on. We kindly ask you not to base any business decisions on these lists without consulting with us first. diff --git a/docs/scos/dev/feature-integration-guides/202304.0/glue-api/dynamic-data-api/dynamic-data-api-integration.md b/docs/scos/dev/feature-integration-guides/202304.0/glue-api/dynamic-data-api/dynamic-data-api-integration.md new file mode 100644 index 00000000000..c4d1d629ee3 --- /dev/null +++ b/docs/scos/dev/feature-integration-guides/202304.0/glue-api/dynamic-data-api/dynamic-data-api-integration.md @@ -0,0 +1,362 @@ +--- +title: Dynamic Data API integration +description: Integrate the Dynamic Data API into a Spryker project. +last_updated: June 22, 2023 +template: feature-integration-guide-template +--- + +This document describes how to integrate the Dynamic Data API into a Spryker project. + +--- + +The Dynamic Data API is a powerful tool that allows seamless interaction with your database. + +You can easily access your data by sending requests to the API endpoint. + +It enables you to retrieve, create, update, and manage data in a flexible and efficient manner. + +## Install feature core + +Follow the steps below to install the Dynamic Data API core. + +### Prerequisites + +To start feature integration, install the necessary features: + +| NAME | VERSION | INTEGRATION GUIDE | +| --- | --- | --- | +| Glue Backend Api Application | {{page.version}} | [Glue API - Glue Storefront and Backend API applications integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-glue-storefront-and-backend-api-applications-integration.html) | +| Glue Authentication | {{page.version}} | [Glue API - Authentication integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-authentication-integration.html) | + +### Install the required modules using Composer + +Install the required modules: + +```bash +composer require spryker/dynamic-entity-backend-api:"^0.1.0" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +| --- | --- | +| DynamicEntity | vendor/spryker/dynamic-entity | +| DynamicEntityBackendApi | vendor/spryker/dynamic-entity-backend-api | + +{% endinfo_block %} + +### Set up the configuration + +1. Move the following commands into `setup-glue` section after `demodata` step: + +**config/install/docker.yml** + +```yaml +setup-glue: + controller-cache-warmup: + command: 'vendor/bin/glue glue-api:controller:cache:warm-up' + + api-generate-documentation: + command: 'vendor/bin/glue api:generate:documentation' +``` + +2. By default, requests are sent to `/dynamic-entity/{entity-alias}`. + Adjust `DynamicEntityBackendApiConfig` in order to replace `dynamic-entity` part with another one: + +**src/Pyz/Glue/DynamicEntityBackendApi/DynamicEntityBackendApiConfig.php** + +```php + +src/Pyz/Glue/Console/ConsoleDependencyProvider.php + +```php + + */ + public function getApplicationPlugins(Container $container): array + { + $applicationPlugins = parent::getApplicationPlugins($container); + + $applicationPlugins[] = new PropelApplicationPlugin(); + + return $applicationPlugins; + } +} +``` +
+ +
+src/Pyz/Glue/DocumentationGeneratorApi/DocumentationGeneratorApiDependencyProvider.php + +```php +addExpander(new DynamicEntityApiSchemaContextExpanderPlugin(), [static::GLUE_BACKEND_API_APPLICATION_NAME]); + } +} +``` +
+ +
+src/Pyz/Glue/DocumentationGeneratorOpenApi/DocumentationGeneratorOpenApiDependencyProvider.php + +```php + + */ + protected function getOpenApiSchemaFormatterPlugins(): array + { + return [ + new DynamicEntityOpenApiSchemaFormatterPlugin(), + ]; + } +} +``` +
+ +
+src/Pyz/Glue/GlueBackendApiApplication/GlueBackendApiApplicationDependencyProvider.php + +```php + + */ + protected function getRouteProviderPlugins(): array + { + return [ + new DynamicEntityRouteProviderPlugin(), + ]; + } +} +``` +
+ +{% info_block warningBox "Verification" %} + +If everything is set up correctly, you can operate with the data. Follow this link to discover how to perform it:[How to send request in Dynamic Data API](/docs/scos/dev/glue-api-guides/{{page.version}}/dynamic-data-api/how-to-guides/how-to-send-request-in-dynamic-data-api.html) + +{% endinfo_block %} diff --git a/docs/scos/dev/feature-integration-guides/202304.0/install-the-picker-user-login-feature.md b/docs/scos/dev/feature-integration-guides/202304.0/install-the-picker-user-login-feature.md deleted file mode 100644 index 92867f5bea1..00000000000 --- a/docs/scos/dev/feature-integration-guides/202304.0/install-the-picker-user-login-feature.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: Install the Picker user login feature -description: Learn how to integrate the Picker user login feature into your project -last_updated: Mar 10, 2023 -template: feature-integration-guide-template ---- - -{% include pbc/all/install-features/{{page.version}}/install-the-picker-user-login-feature.md %} diff --git a/docs/scos/dev/feature-integration-guides/202304.0/install-the-product-offer-shipment-feature.md b/docs/scos/dev/feature-integration-guides/202304.0/install-the-product-offer-shipment-feature.md deleted file mode 100644 index 90f822c3b8f..00000000000 --- a/docs/scos/dev/feature-integration-guides/202304.0/install-the-product-offer-shipment-feature.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: Install the Product offer shipment feature -description: Learn how to integrate the Product offer shipment feature into your project -last_updated: June 20, 2023 -template: feature-integration-guide-template ---- - -{% include pbc/all/install-features/{{page.version}}/install-the-product-offer-shipment-feature.md %} diff --git a/docs/scos/dev/feature-integration-guides/202304.0/install-the-push-notification-feature.md b/docs/scos/dev/feature-integration-guides/202304.0/install-the-push-notification-feature.md deleted file mode 100644 index 77202c62872..00000000000 --- a/docs/scos/dev/feature-integration-guides/202304.0/install-the-push-notification-feature.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: Install the Push notification feature -description: Learn how to integrate the Push notification feature into your project -last_updated: Jan 24, 2023 -template: feature-integration-guide-template ---- - -{% include pbc/all/install-features/{{page.version}}/install-the-push-notification-feature.md %} \ No newline at end of file diff --git a/docs/scos/dev/feature-integration-guides/202304.0/install-the-service-points-feature.md b/docs/scos/dev/feature-integration-guides/202304.0/install-the-service-points-feature.md deleted file mode 100644 index 7fe136fc530..00000000000 --- a/docs/scos/dev/feature-integration-guides/202304.0/install-the-service-points-feature.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: Install the Service Points feature -description: Learn how to integrate the Service Points feature into your project -last_updated: July 05, 2023 -template: feature-integration-guide-template ---- - -{% include pbc/all/install-features/{{page.version}}/install-the-service-points-feature.md %} diff --git a/docs/scos/dev/feature-integration-guides/202304.0/install-the-shipment-service-points-feature.md b/docs/scos/dev/feature-integration-guides/202304.0/install-the-shipment-service-points-feature.md deleted file mode 100644 index 1e587d35a75..00000000000 --- a/docs/scos/dev/feature-integration-guides/202304.0/install-the-shipment-service-points-feature.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: Install the Shipment + Service Points feature -description: Learn how to integrate the Shipment + Service Points feature into your project -last_updated: May 30, 2023 -template: feature-integration-guide-template ---- - -{% include pbc/all/install-features/{{page.version}}/install-the-shipment-service-points-feature.md %} diff --git a/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-feature.md b/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-feature.md deleted file mode 100644 index 10b16e5fe7f..00000000000 --- a/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-feature.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: Install the Warehouse picking feature -description: Learn how to integrate the Warehouse picking feature into your project -last_updated: Feb 10, 2023 -template: feature-integration-guide-template ---- - -{% include pbc/all/install-features/{{page.version}}/install-the-warehouse-picking-feature.md %} diff --git a/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-inventory-management-feature.md b/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-inventory-management-feature.md deleted file mode 100644 index dd88e1cb4c1..00000000000 --- a/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-inventory-management-feature.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: Install the Warehouse picking + Inventory Management feature -description: Learn how to integrate the Warehouse picking + Inventory Management feature into your project -last_updated: Apr 10, 2023 -template: feature-integration-guide-template ---- - -{% include pbc/all/install-features/{{page.version}}/install-the-warehouse-picking-inventory-management-feature.md %} diff --git a/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-order-management-feature.md b/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-order-management-feature.md deleted file mode 100644 index 9d984c4558b..00000000000 --- a/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-order-management-feature.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: Install the Warehouse picking + Order Management feature -description: Learn how to integrate the Warehouse picking + Order Management feature into your project -last_updated: Mar 30, 2023 -template: feature-integration-guide-template ---- - -{% include pbc/all/install-features/{{page.version}}/install-the-warehouse-picking-order-management-feature.md %} diff --git a/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-product-feature.md b/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-product-feature.md deleted file mode 100644 index 776f6551392..00000000000 --- a/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-product-feature.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: Install the Warehouse picking + Product feature -description: Learn how to integrate the Warehouse picking + Product feature into your project -last_updated: Mar 30, 2023 -template: feature-integration-guide-template ---- - -{% include pbc/all/install-features/{{page.version}}/install-the-warehouse-picking-product-feature.md %} diff --git a/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-shipment-feature.md b/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-shipment-feature.md deleted file mode 100644 index f552144f3df..00000000000 --- a/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-shipment-feature.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: Install the Warehouse picking + Shipment feature -description: Learn how to integrate the Warehouse picking + Shipment feature into your project -last_updated: Apr 10, 2023 -template: feature-integration-guide-template ---- - -{% include pbc/all/install-features/{{page.version}}/install-the-warehouse-picking-shipment-feature.md %} diff --git a/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-spryker-core-back-office-feature.md b/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-spryker-core-back-office-feature.md deleted file mode 100644 index bb329291154..00000000000 --- a/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-spryker-core-back-office-feature.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: Install the Warehouse picking + Spryker Core Back Office feature -description: Learn how to integrate the Warehouse picking + Spryker Core Back Office feature into your project -last_updated: Apr 10, 2023 -template: feature-integration-guide-template ---- - -{% include pbc/all/install-features/{{page.version}}/install-the-warehouse-picking-spryker-core-back-office-feature.md %} diff --git a/docs/scos/dev/feature-integration-guides/202304.0/spryker-core-feature-integration.md b/docs/scos/dev/feature-integration-guides/202304.0/spryker-core-feature-integration.md index ee7b4a7093f..a947fb10ad1 100644 --- a/docs/scos/dev/feature-integration-guides/202304.0/spryker-core-feature-integration.md +++ b/docs/scos/dev/feature-integration-guides/202304.0/spryker-core-feature-integration.md @@ -1,7 +1,7 @@ --- title: Spryker Core feature integration description: The procedure to integrate Spryker Core feature into your project. -last_updated: Feb 8, 2023 +last_updated: Jul 18, 2023 template: feature-integration-guide-template originalLink: https://documentation.spryker.com/2021080/docs/spryker-core-feature-integration originalArticleId: f99d3cf9-e933-4a3b-888e-72cf8f4ea31b diff --git a/docs/scos/dev/feature-walkthroughs/202204.0/payments-feature-walkthrough.md b/docs/scos/dev/feature-walkthroughs/202204.0/payments-feature-walkthrough.md index 02380f3b40d..bf645f2ddde 100644 --- a/docs/scos/dev/feature-walkthroughs/202204.0/payments-feature-walkthrough.md +++ b/docs/scos/dev/feature-walkthroughs/202204.0/payments-feature-walkthrough.md @@ -30,4 +30,4 @@ The following schema illustrates relations between the _Payment_, _PaymentGui_, |---|---|---|---|---|---| | [Payments feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/payments-feature-integration.html) | [Payment migration guide](/docs/scos/dev/module-migration-guides/migration-guide-payment.html) | [Update payment data](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/manage-using-glue-api/check-out/update-payment-data.html) | [File details: payment_method.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/commerce-setup/file-details-payment-method-store.csv.html) | [HowTo: Hydrate payment methods for an order](/docs/scos/dev/tutorials-and-howtos/howtos/howto-hydrate-payment-methods-for-an-order.html) | [Payment partners](/docs/scos/user/technology-partners/{{page.version}}/payment-partners/adyen.html) | | | | | [File details: payment_method_store.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/commerce-setup/file-details-payment-method-store.csv.html) | [Implementing Direct Debit Payment](/docs/scos/dev/back-end-development/data-manipulation/payment-methods/direct-debit-example-implementation/implementing-direct-debit-payment.html) | | -| | | | | [Interact with third party payment providers using Glue API](/docs/pbc/all/payment-service-provider/{{site.version}}/interact-with-third-party-payment-providers-using-glue-api.html) | | +| | | | | [Interact with third party payment providers using Glue API](/docs/pbc/all/payment-service-provider/{{site.version}}/spryker-pay/base-shop/interact-with-third-party-payment-providers-using-glue-api.html) | | diff --git a/docs/scos/dev/front-end-development/202212.0/migration-guide-upgrade-nodejs-to-v18-and-npm-to-v9.md b/docs/scos/dev/front-end-development/202212.0/migration-guide-upgrade-nodejs-to-v18-and-npm-to-v9.md index 02d8ea88fe7..d565ba47f6a 100644 --- a/docs/scos/dev/front-end-development/202212.0/migration-guide-upgrade-nodejs-to-v18-and-npm-to-v9.md +++ b/docs/scos/dev/front-end-development/202212.0/migration-guide-upgrade-nodejs-to-v18-and-npm-to-v9.md @@ -163,7 +163,7 @@ If the project uses CI, adjust `.github/workflows/ci.yml`: uses: actions/cache@v3 with: path: ~/.npm - key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} + key: ${% raw %}{{{% endraw %} runner.os {% raw %}}}{% endraw %}-node-${% raw %}{{{% endraw %} hashFiles('**/package-lock.json') {% raw %}}}{% endraw %} restore-keys: | - ${{ runner.os }}-node- + ${% raw %}{{{% endraw %} runner.os {% raw %}}}{% endraw %}-node- ``` diff --git a/docs/scos/dev/glue-api-guides/202204.0/glue-api-tutorials/interact-with-third-party-payment-providers-using-glue-api.md b/docs/scos/dev/glue-api-guides/202204.0/glue-api-tutorials/interact-with-third-party-payment-providers-using-glue-api.md index bb279aa2ee9..996d40d9297 100644 --- a/docs/scos/dev/glue-api-guides/202204.0/glue-api-tutorials/interact-with-third-party-payment-providers-using-glue-api.md +++ b/docs/scos/dev/glue-api-guides/202204.0/glue-api-tutorials/interact-with-third-party-payment-providers-using-glue-api.md @@ -19,7 +19,7 @@ redirect_from: - /v3/docs/t-interacting-with-third-party-payment-providers-via-glue-api - /v3/docs/en/t-interacting-with-third-party-payment-providers-via-glue-api - /docs/scos/dev/tutorials/201907.0/advanced/glue-api/tutorial-interacting-with-third-party-payment-providers-via-glue-api.html - - /docs/scos/dev/glue-api-guides/202005.0/checking-out/docs/docs/pbc/all/payment-service-provider/{{site.version}}/interact-with-third-party-payment-providers-using-glue-api.html + - /docs/scos/dev/glue-api-guides/202005.0/checking-out/docs/docs/pbc/all/payment-service-provider/{{site.version}}/spryker-pay/base-shop/interact-with-third-party-payment-providers-using-glue-api.html - /docs/scos/dev/tutorials-and-howtos/advanced-tutorials/glue-api/tutorial-interacting-with-third-party-payment-providers-via-glue-api.html related: - title: Technology Partner Integration diff --git a/docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-infrastructure/authentication-and-authorization.md b/docs/scos/dev/glue-api-guides/202212.0/authentication-and-authorization.md similarity index 96% rename from docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-infrastructure/authentication-and-authorization.md rename to docs/scos/dev/glue-api-guides/202212.0/authentication-and-authorization.md index cd4b27024c0..4561526a2c9 100644 --- a/docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-infrastructure/authentication-and-authorization.md +++ b/docs/scos/dev/glue-api-guides/202212.0/authentication-and-authorization.md @@ -10,6 +10,7 @@ related: link: docs/scos/dev/glue-api-guides/page.version/use-authentication-servers-with-glue-api.html redirect_from: - /docs/scos/dev/glue-api-guides/202204.0/glue-backend-api/how-to-guides/authentication-and-authorization.html + - /docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-infrastructure/authentication-and-authorization.html --- For authentication, Spryker implements the OAuth 2.0 mechanism. On the REST API level, it is represented by the Login API. diff --git a/docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-infrastructure/backend-and-storefront-api-module-differences.md b/docs/scos/dev/glue-api-guides/202212.0/backend-and-storefront-api-module-differences.md similarity index 97% rename from docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-infrastructure/backend-and-storefront-api-module-differences.md rename to docs/scos/dev/glue-api-guides/202212.0/backend-and-storefront-api-module-differences.md index 75f064ff385..c9351d10319 100644 --- a/docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-infrastructure/backend-and-storefront-api-module-differences.md +++ b/docs/scos/dev/glue-api-guides/202212.0/backend-and-storefront-api-module-differences.md @@ -6,6 +6,7 @@ template: howto-guide-template redirect_from: - /docs/scos/dev/glue-api-guides/202204.0/glue-backend-api/how-to-guides/create-backend-vs-storefront-api-endpoint.html - /docs/scos/dev/glue-api-guides/202204.0/glue-backend-api/how-to-guides/backend-and-storefront-api-module-differences.html + - /docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-infrastructure/backend-and-storefront-api-module-differences.html --- This document describes differences between the backend and storefront code in API modules. diff --git a/docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-infrastructure/create-glue-api-applications.md b/docs/scos/dev/glue-api-guides/202212.0/create-glue-api-applications.md similarity index 99% rename from docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-infrastructure/create-glue-api-applications.md rename to docs/scos/dev/glue-api-guides/202212.0/create-glue-api-applications.md index c5f6342099a..546208c6f94 100644 --- a/docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-infrastructure/create-glue-api-applications.md +++ b/docs/scos/dev/glue-api-guides/202212.0/create-glue-api-applications.md @@ -6,6 +6,7 @@ template: howto-guide-template redirect_from: - /docs/scos/dev/glue-api-guides/202204.0/glue-backend-api/how-to-guides/create-api-application.html - /docs/scos/dev/glue-api-guides/202204.0/glue-backend-api/how-to-guides/how-to-create-api-applications.html + - /docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-infrastructure/create-glue-api-applications.html --- New Glue projects can create API applications. This is what you need to do in order to create one. diff --git a/docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-api.md b/docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-api.md new file mode 100644 index 00000000000..1fc0c5da4a6 --- /dev/null +++ b/docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-api.md @@ -0,0 +1,234 @@ +--- +title: Decoupled Glue API +description: Learn about the process of handling API requests through GlueStorefront and GlueBackoffice layers. +last_updated: Jul 11, 2023 +template: glue-api-storefront-guide-template +--- + +The Spryker Decoupled Glue API is a set of a few API applications like *Glue Storefront API (SAPI)* and *Glue Backend API (BAPI)* of the Spryker Commerce OS. Those applications are built to be used as a contract for accessing Storefront or Backoffice functionality through API. Those applications know how to read and interpret API resources and leverage feature modules that expose existing Spryker functionality. + +## Existing Glue Applications + +Out of the box, Spryker Commerce OS provides three API applications: +* Old Glue API application that can be used as a fallback. +* New Glue Storefront API (SAPI) that is a replacement for the old Glue and can be used for the same purpose. +* Glue Backend API (BAPI) that can be used to provide API access for the Backoffice functionality directly without any additional RPC calls. + +## Difference between Decoupled Glue Api and the old Glue API + +There are a few differences between the current Glue infrastructure (Decoupled Glue API) and the old [Glue API](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/glue-rest-api.html). + +### Possibility to create new API applications + +With the current infrastructure, projects can easily [create](/docs/scos/dev/glue-api-guides/{{page.version}}/create-glue-api-applications.html) their own API applications that would be completely separated from others. This means that resources can be added only to the new application, and users can't access them with existing ones. + +### Decoupling from conventions + +Old Glue API was tightly coupled with a JSON:API convention, and all resources have to follow it. With the current infrastructure, resources can use any implemented conventions, create new ones, or even not use any. In this case, the "no convention" approach is used, and a request and response are formatted as a plain JSON. For more details, see [Create and change Glue API conventions](/docs/scos/dev/glue-api-guides/{{page.version}}/create-and-change-glue-api-conventions.html). + +### New type of application: Glue Backend API application + +With the current setup out of the box, we have an additional Glue Backend API (BAPI) application that is meant to be an API application for our Back Office. This means that with this new application, infrastructure has direct access to Zed facades from BAPI resources. Also, out of the box, we have a separate `/token` resource specifically for BAPI that uses Back Office users' credentials to issue a token for a BAPI resource. + +For more details about the difference between SAPI and BAPI, refer to [Backend and storefront API module differences](/docs/scos/dev/glue-api-guides/{{page.version}}/backend-and-storefront-api-module-differences.html). + +### Authentication servers +Current infrastructure lets you switch between different authentication servers. For example, this can be useful if you want to use Auth0 or any other server in addition to implemented servers. + +For more details and examples, see [Use authentication servers with Glue API](/docs/scos/dev/glue-api-guides/{{page.version}}/use-authentication-servers-with-glue-api.html). + + +## Glue Storefront API + +![Glue Storefront API](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-api/glue-storefront-api.jpeg) + +## Glue Backend API + +![Glue Backend API](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-api/glue-backend-api.jpeg) + +## Infrastructure + +Decoupled Glue API infrastructure is implemented in the same layer of Spryker Commerce OS and called Glue, as the old one. It is responsible for providing API endpoints, processing requests, and communicating with other layers of the OS to retrieve the necessary information. Separate applications are implemented as separate modules—for example, `GlueStorefrontApiApplication`, and `GlueBackendApiApplication`. Each application has its own bootstrapping and a separate virtual host on the Spryker web server (Nginx by default). + +Logically, the Glue layer can be divided into separate parts: + +* **`GlueApplication` module**: The `GlueApplication` module provides a framework for constructing API resources and selecting a proper application. It intercepts all HTTP requests at resource URLs (for example, `http://mysprykershop.com/resource/1`), selects a proper application based on a bootstrap file, does content negotiation and selects applicable convention, and executes request flow. Also, this module is used for the fallback to the old Glue API. +* **GlueStorefrontApiApplication module**: The `GlueStorefrontApiApplication` module is used for wiring everything related to the Glue Storefront API resources and route processing. All resources, routes, application plugins, and the rest of the required plugin stacks are wired into this module. +* **GlueBackendApiApplication module**: The `GlueBackendApiApplication` module is used for wiring everything related to the Glue Backend API resources and route processing. All resources, routes, application plugins, and the rest of the required plugin stacks are wired into this module. +* **Convention module**: Each convention module represents some specific convention and should include all required functionality to format API requests according to this convention. Out of the box, Spryker provides a `GlueJsonApiConvention` module that represents JSON:API convention. +* **Resource modules**: A `Resource` module implements a separate resource or a set of resources for a specific application. The `Resource` module *must* be dedicated to a specific application but can use different conventions. Such a module handles requests to a particular resource and provides them with responses. In the process of doing so, the module can communicate with the Storage, Search, or Spryker Commerce OS (Zed through RPC call) for the Glue Storefront API application, or it can communicate with a Zed directly through Facades for the Glue Backend API application. The modules do not handle request semantics or rules. Their only task is to provide the necessary data in a `GlueResponseTransfer` object. All formatting and processing are done by the convention or selected application module. +* **Relationship modules**: Such modules represent relationships between two different resources. Their task is to extend the response of one of the resources with data from related resources. Out of the box, these modules are only applicable for resources that are using JSON:API convention. + +To be able to process API requests correctly, the `Resource` modules need to implement resource plugins that facilitate the routing of requests to the module. Such plugins need to be registered in the application they are related to. Also, plugins must implement a convention resource interface if must implement one. + +## Request flow + +Glue executes a few steps in order to execute a request: + +### Application bootstrapping and running + +Upon receiving an API request, an API context transfer is created where we set up basic request data like host, path, and method. It can be used to select a required application from the provided applications list. After that, `ApiApplicationProxy` is used to bootstrap and run the selected application. If the selected application plugin is the instance of `RequestFlowAgnosticApiApplication`, the direct flow is used, and no additional Glue logic is executed. It's useful if we need to create a simple API application that just returns the result of execution as is. If the application plugin is the instance of `RequestFlowAwareApiApplication`, we execute the whole request flow. + +### Request flow preparation + +First, we hydrate `GlueRequestTransfer` with data from the `Request` object. This includes request body, query params, headers, and attributes. + +Then, `ContentNegotiator` tries to resolve what convention the application must use for this request and updates `GlueRequestTransfer` with the request format. The convention is optional, so if it isn't found, the application uses the requested and accepted format to prepare request and response data. + +With hydrated `GlueRequestTransfer` and selected or not convention, the application executes `RequestFlowExecutor`. + +### Executing request builders, request validators, and response formatting based on selected convention + +At this stage, a bunch of plugin stacks are executed to prepare the request and response. If the convention is selected, the application merges plugins from three different places: default plugins from `GlueApplicationDependencyProvider`, plugins from the selected convention, and application-specific plugins. If the convention isn't found, instead of convention plugins, default flow classes are executed before common and application-specific plugins. + +### Routing + +Routing tries to find required resources in two plugin stacks in the selected application dependency provider—for example, `\Pyz\Glue\GlueBackendApiApplication\GlueBackendApiApplicationDependencyProvider::getResourcePlugins()` and `\Pyz\Glue\GlueBackendApiApplication\GlueBackendApiApplicationDependencyProvider::getRouteProviderPlugins()`. If no route is found, `MissingResource` is selected and executed. + +For more details about creating a resource, see these documents: +* [Create storefront resources](/docs/scos/dev/glue-api-guides/{{page.version}}/routing/create-storefront-resources.html) +* [Create backend resources](/docs/scos/dev/glue-api-guides/{{page.version}}/routing/create-backend-resources.html) +* [Create routes](/docs/scos/dev/glue-api-guides/{{page.version}}/routing/create-routes.html) + +## Resource modules + +A `Resource` module is a module that implements a single resource or a set of resources. It is responsible for accepting a request in the form of `GlueRequestTransfer` and providing responses in the form of `GlueResponseTransfers`. For this purpose, the SAPI `Resource` module can communicate with the Storage or Search, for which purpose it implements a [Client](/docs/scos/dev/back-end-development/client/client.html). It can also communicate with the Spryker Commerce OS (Zed) through RPC calls. + +BAPI resources can use direct facade access through the dependency provider and access the database directly. `Resource` modules must implement all logic related to processing a request. It is not recommended to have any of the Business Logic, or a part of it, in the GlueApplication or specific application Module. If you need to extend any of the built-in Glue functionality, extending the relevant `Resource` module is always safer than infrastructure. + +### Module naming + +Resource modules have their own naming pattern to follow: +- Storefront resources must use the simple `Api` suffix and resource name in plural—for example, `ProductsApi`. +- Backend resources must use the `BackendApi` suffix and resource name in plural—for example, `ProductsBackendApi`. +### Module structure + +Recommended module structure: + +| RESOURCESRESTAPI | DESCRIPTION | +|----------------------------------------------------------------|------------------------------------------------------------------------------------------------------| +| `Glue/Resources(Backend)Api/Controller` | Folder for resource controllers. Controllers are used to handle API requests and responses. | +| `Glue/Resources(Backend)Api/Dependency` | Bridges to clients/facades from other modules. | +| `Glue/Resources(Backend)Api/Plugin` | Resource plugins. | +| `Glue/Resources(Backend)Api/Processor` | Folder where all resource processing logic, data mapping code and calls to other clients are located. | +| `Glue/Resources(Backend)Api/Resources(Backend)ApiConfig.php` | Contains resource-related configuration. | +| `Glue/Resources(Backend)Api/Resources(Backend)ApiDependencyProvider.php` | Provides external dependencies. | +| `Glue/Resources(Backend)Api/Resources(Backend)ApiFactory.php` | Factory that creates instances. | + +Also, a module must contain the transfer definition in `src/Pyz/Shared/Resources(Backend)Api/Transfer`: + +| RESOURCESRESTAPI | DESCRIPTION | +|----------------------------------------| --- | +| `resources_(backend_)api.transfer.xml` | Contains API transfer definitions. | + +The resulting folder structure on the example of the ServicePointsBackendApi Resource module looks as follows: + +![Module structure](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-api/glue-api-module-structure.png) + +## Glue request structure + +| FIELD | DESCRIPTION | +|----------------------|-------------------------------------------------------------------------------------------------------| +| pagination | `PaginationTransfer` object with request pagination data. | +| sortings | Collection of `SortTransfer` objects. | +| queryFields | Assoc array of query parameters with values. | +| resource | `GlueResourceTransfer` object with resource-related data. | +| path | Returns the path being requested relative to the executed script. | +| content | Request body content. | +| filters | Collection of `GlueFilterTransfer` objects. | +| attributes | Array of attributes from the `Request` object. | +| meta | Array of metadata from the `Request` object. | +| locale | Current locale. | +| host | Current host. | +| convention | Selected convention that was selected in `ContentNegotiator`. | +| application | Selected application. | +| method | Request "intended" method. | +| parametersString | Normalized query string from the `Request` object. | +| requestedFormat | `content-type` header value. | +| acceptedFormat | `accept` header value that was processed in `ContentNegotiator` | +| httpRequestAttributes | Request parameters from the `Request` object. | +| requestUser | Backend user requesting the resource (valid only for Glue Backend API). | +| requestCustomer | Storefront customer requesting the resource (valid only for Glue Storefront API). | + +## Glue response structure + +| FIELD | DESCRIPTION | +|---------------------|-------------------------------------------------------------------------------------------------------| +| httpStatus | Response status code. | +| meta | Return headers. | +| content | Response body. If the resource sets any data into it, the response body uses it instead of the `resources` field. | +| requestValidation | `GlueRequestValidationTransfer` object. | +| errors | Collection of `GlueErrorTransfer` objects. | +| filters | Collection of `GlueFilterTransfer` objects. | +| sortings | Collection of `SortTransfer` objects. | +| pagination | `PaginationTransfer` object. | +| resources | Collection of `GlueResourceTransfer` objects that are used to prepare the response body. | +| format | Response format—for example, `application/vnd.api+json` for JSON:API resources. | + +## HTTP status codes + +This section provides a list of common HTTP statuses returned by Glue endpoints. + +### GET + +| CODE | REASON | +| --- | --- | +| 200 | An entity or entities corresponding to the requested resource is/are sent in the response | +| 400| Bad request | +| 401| Unauthenticated | +| 403 | Unauthorized| +|404 | Resource not found | + +### POST + +| CODE | REASON | +| --- | --- | +| 201 | Resource created successfully | +| 400| Bad request | +| 401| Unauthenticated | +| 403 | Unauthorized| +|404 | Resource not found | + +### PATCH + +| CODE | REASON | +| --- | --- | +| 200 | Resource updated successfully | +| 400| Bad request | +| 401| Unauthenticated | +| 403 | Unauthorized| +| 404 | Resource not found | + +### DELETE + +| CODE | REASON | +| --- | --- | +| 204 | No content (deleted successfully) | +| 400| Bad request | +| 401| Unauthenticated | +| 403 | Unauthorized| +| 404 | Resource not found | + + +## Dates + +For date formatting, [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date/time format is used. For requests, any time zone is accepted; however, dates are stored and returned in UTC. + +Example: +* request: `1985-07-01T01:22:11+02:00` +* in storage and responses: `1985-06-30T23:22:11+00:00` + +## Request header + +| HEADER | SAMPLE VALUE | USED FOR | WHEN NOT PRESENT | +| --- | --- | --- | --- | +| Accept | application/vnd.api+json |Indicates the data format of the expected API response. | 406 Not acceptable | +| Content-Type | application/vnd.api+json; version=1.1 | Indicates the request content-type and resource version. | 415 Unsupported | +| Accept-Language | de;, en;q=0.5 | Indicates the desired language in which the content should be returned. | | + +## Response header + +| HEADER | SAMPLE VALUE | USED FOR | +| --- | --- | --- | +| Content-Type |application/vnd.api+json; version=1.1 |Response format and resource version. | +|Content-Language|de_DE|Indicates the language in which the content is returned.| \ No newline at end of file diff --git a/docs/scos/dev/glue-api-guides/202212.0/glue-api-guides.md b/docs/scos/dev/glue-api-guides/202212.0/glue-api-guides.md index 8db37476b27..955b4117958 100644 --- a/docs/scos/dev/glue-api-guides/202212.0/glue-api-guides.md +++ b/docs/scos/dev/glue-api-guides/202212.0/glue-api-guides.md @@ -6,13 +6,22 @@ redirect_from: - /docs/scoc/dev/glue-api-guides/{{page.version}}/index.html --- +* [Decoupled Glue Api](/docs/scos/dev/glue-api-guides/{{page.version}}/decoupled-glue-api.html) +* [Create new Glue Application](/docs/scos/dev/glue-api-guides/{{page.version}}/create-glue-api-applications.html) +* [Differnece between Storefront and Backend application](/docs/scos/dev/glue-api-guides/{{page.version}}/backend-and-storefront-api-module-differences.html) -This section contains a collection of guides for working with the Spryker Glue API: -* [Glue REST API](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-rest-api.html) -* [Rest API B2C reference](/docs/scos/dev/glue-api-guides/{{page.version}}/rest-api-b2c-reference.html) -* [Rest API B2B Reference](/docs/scos/dev/glue-api-guides/{{page.version}}/rest-api-b2b-reference.html) -* [Handling concurrent REST requests and caching with entity tags](/docs/scos/dev/glue-api-guides/{{page.version}}/handling-concurrent-rest-requests-and-caching-with-entity-tags.html) -* [Reference information – GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html) +{% info_block warningBox %} + +This part of this document is related to the Old Glue infrastructure. For the new one, see [Decoupled Glue API](/docs/scos/dev/glue-api-guides/{{page.version}}/decoupled-glue-api.html) + +{% endinfo_block %} + +This section contains a collection of guides for working with the Old Spryker Glue API: +* [Glue REST API](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/glue-rest-api.html) +* [Rest API B2C reference](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/rest-api-b2c-reference.html) +* [Rest API B2B Reference](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/rest-api-b2b-reference.html) +* [Handling concurrent REST requests and caching with entity tags](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/handling-concurrent-rest-requests-and-caching-with-entity-tags.html) +* [Reference information – GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html) * [Glue Spryks](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-spryks.html) -* [Glue infrastructure](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-infrastructure.html) +* [Glue infrastructure](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/glue-infrastructure.html) * [Glue API tutorials](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-api-tutorials/glue-api-tutorials.html) diff --git a/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.md b/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.md index 81d92f55991..9b71d0dd05a 100644 --- a/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.md +++ b/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.md @@ -27,7 +27,7 @@ related: - title: Install B2C API React example link: docs/scos/dev/glue-api-guides/page.version/glue-api-tutorials/b2c-api-react-example/install-b2c-api-react-example.html - title: Glue REST API - link: docs/scos/dev/glue-api-guides/page.version/glue-rest-api.html + link: docs/scos/dev/glue-api-guides/page.version/old-glue-infrastructure/glue-rest-api.html --- As a part of documentation related to Spryker Glue REST API, we have also developed a B2C API React example. It is a [React](https://reactjs.org/) single-page application based on a [webpack](https://webpack.js.org/) dev server, Typescript, [Redux](https://redux.js.org/), and Material UI. diff --git a/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/document-glue-api-resources.md b/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/document-glue-api-resources.md index d0fdea0af4b..359378de7bb 100644 --- a/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/document-glue-api-resources.md +++ b/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/document-glue-api-resources.md @@ -23,7 +23,7 @@ redirect_from: - /docs/scos/dev/tutorials-and-howtos/introduction-tutorials/glue-api/documenting-glue-api-resources.html related: - title: Glue infrastructure - link: docs/scos/dev/glue-api-guides/page.version/glue-infrastructure.html + link: docs/scos/dev/glue-api-guides/page.version/old-glue-infrastructure/glue-infrastructure.html - title: Glue API installation and configuration link: docs/scos/dev/feature-integration-guides/page.version/glue-api/glue-api-installation-and-configuration.html --- @@ -35,8 +35,8 @@ The resulting document is a full description of your REST API following the [Ope {% info_block warningBox %} REST API endpoints shipped by Spryker are covered by documentation by default. A snapshot of the latest state of Spryker REST API can be found in Spryker Documentation. For more information, see Rest API references: -* [REST API B2B Demo Shop reference](/docs/scos/dev/glue-api-guides/{{site.version}}/rest-api-b2b-reference.html) -* [REST API B2C Demo Shop reference](/docs/scos/dev/glue-api-guides/{{site.version}}/rest-api-b2c-reference.html) +* [REST API B2B Demo Shop reference](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/rest-api-b2b-reference.html) +* [REST API B2C Demo Shop reference](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/rest-api-b2c-reference.html) {% endinfo_block %} @@ -113,7 +113,7 @@ vendor/bin/console transfer:generate ### Describe resource relationships -Many REST API resources are related to each other. For example, the cart items resource is related to the products resources describing the products included in a cart, and so on. On the API side, such relationships are expressed with the help of [resource relationships](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-infrastructure.html#resource-relationships). +Many REST API resources are related to each other. For example, the cart items resource is related to the products resources describing the products included in a cart, and so on. On the API side, such relationships are expressed with the help of [resource relationships](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/glue-infrastructure.html#resource-relationships). The already existing resource relationships are added to the documentation automatically. However, some resources are only available through relationships, so they do not have their own resource route. In these cases, to facilitate the implementation of clients based on the Glue REST API of your project, you can describe such relationships in the generated documentation. To describe how two resources are related, add an additional annotation to the `ResourceRelationshipPlugin`, which links the resources together. For example, in the following code sample, `ResourceRelationshipPlugin` allows including items while requesting a cart is expanded with the specification of the relationship attributes type: @@ -130,7 +130,7 @@ The already existing resource relationships are added to the documentation autom {% info_block infoBox "Info" %} -For more information about `ResourceRelationshipPlugins`, see [Resource relationships](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-infrastructure.html#resource-relationships). +For more information about `ResourceRelationshipPlugins`, see [Resource relationships](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/glue-infrastructure.html#resource-relationships). {% endinfo_block %} diff --git a/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/extend-a-rest-api-resource.md b/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/extend-a-rest-api-resource.md index 51113c9a6e7..97191e79682 100644 --- a/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/extend-a-rest-api-resource.md +++ b/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/extend-a-rest-api-resource.md @@ -25,14 +25,14 @@ related: - title: Glue API installation and configuration link: docs/scos/dev/feature-integration-guides/page.version/glue-api/glue-api-installation-and-configuration.html - title: Glue infrastructure - link: docs/scos/dev/glue-api-guides/page.version/glue-infrastructure.html + link: docs/scos/dev/glue-api-guides/page.version/old-glue-infrastructure/glue-infrastructure.html --- Spryker Glue REST API comes with a set of predefined APIs out of the box. You can extend and customize them to your own project needs by extending the Glue API modules that provide the relevant functionality on your project level. {% info_block infoBox %} -The following guide relies on your knowledge of the structure of the Glue REST API resource module and the behavior of its constituents. For more details, see the [Resource modules](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-infrastructure.html#resource-modules) section in *Glue Infrastructure*. +The following guide relies on your knowledge of the structure of the Glue REST API resource module and the behavior of its constituents. For more details, see the [Resource modules](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/glue-infrastructure.html#resource-modules) section in *Glue Infrastructure*. {% endinfo_block %} diff --git a/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/implement-versioning-for-rest-api-resources.md b/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/implement-versioning-for-rest-api-resources.md index ab2207824c9..fa26c1b9ce3 100644 --- a/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/implement-versioning-for-rest-api-resources.md +++ b/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/implement-versioning-for-rest-api-resources.md @@ -22,7 +22,7 @@ redirect_from: - /docs/scos/dev/tutorials-and-howtos/introduction-tutorials/glue-api/versioning-rest-api-resources.html related: - title: Glue infrastructure - link: docs/scos/dev/glue-api-guides/page.version/glue-infrastructure.html + link: docs/scos/dev/glue-api-guides/page.version/old-glue-infrastructure/glue-infrastructure.html --- In the course of the development of your REST APIs, you may need to change the data contracts of API resources. However, you can also have clients that rely on the existing contracts. To preserve backward compatibility for such clients, we recommend implementing a versioning system for REST API resources. In this case, each resource version has its own contract in terms of data, and various clients can request the exact resource versions they are designed for. @@ -42,7 +42,7 @@ To add versioning to a resource, the route plugin of the `resource` module needs {% info_block warningBox %} -For more information on route plugins, see the [Resource routing](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-infrastructure.html#resource-routing) section in *Glue Infrastructure*. +For more information on route plugins, see the [Resource routing](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/glue-infrastructure.html#resource-routing) section in *Glue Infrastructure*. {% endinfo_block %} diff --git a/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/validate-rest-request-format.md b/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/validate-rest-request-format.md index b82ac0cb42c..c3faca23efa 100644 --- a/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/validate-rest-request-format.md +++ b/docs/scos/dev/glue-api-guides/202212.0/glue-api-tutorials/validate-rest-request-format.md @@ -25,7 +25,7 @@ related: - title: Glue API installation and configuration link: docs/scos/dev/feature-integration-guides/page.version/glue-api/glue-api-installation-and-configuration.html - title: Glue infrastructure - link: docs/scos/dev/glue-api-guides/page.version/glue-infrastructure.html + link: docs/scos/dev/glue-api-guides/page.version/old-glue-infrastructure/glue-infrastructure.html --- Glue API lets you validate requests sent to REST endpoints. It lets you check whether all required fields are present and whether the type and format of the fields are correct. diff --git a/docs/scos/dev/glue-api-guides/202212.0/glue-spryks.md b/docs/scos/dev/glue-api-guides/202212.0/glue-spryks.md index 698b20c5d9e..96c351d8195 100644 --- a/docs/scos/dev/glue-api-guides/202212.0/glue-spryks.md +++ b/docs/scos/dev/glue-api-guides/202212.0/glue-spryks.md @@ -32,8 +32,8 @@ To perform the requested operations, besides the Spryks called by the user, oth {% endinfo_block %} To call a Spryk, you can use the following console commands: -* `vendor/bin/console spryk:run {SPRYK NAME}` - to call a _Spryk_ and input the arguments interactively, one-by-one. -* `vendor/bin/console spryk:run {SPRYK NAME} --{argument name}={argument value}` - to call a _Spryk_ and pass the named arguments in one pass. +* `vendor/bin/spryk-run {SPRYK NAME}`: to call a _Spryk_ and input the arguments interactively, one-by-one. +* `vendor/bin/spryk-run {SPRYK NAME} --{argument name}={argument value}`: to call a _Spryk_ and pass the named arguments in one pass. ## Glue module management diff --git a/docs/scos/dev/glue-api-guides/202212.0/glue-infrastructure.md b/docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/glue-infrastructure.md similarity index 98% rename from docs/scos/dev/glue-api-guides/202212.0/glue-infrastructure.md rename to docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/glue-infrastructure.md index d7a48b36173..63f122c5db7 100644 --- a/docs/scos/dev/glue-api-guides/202212.0/glue-infrastructure.md +++ b/docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/glue-infrastructure.md @@ -1,7 +1,7 @@ --- title: Glue infrastructure description: The guide will walk you through the process of handling API requests at the Glue layer, including GlueApplication, Resource, and Relationship modules. -last_updated: Jun 16, 2021 +last_updated: Jul 16, 2023 template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/glue-infrastructure originalArticleId: dd27e960-56f8-4be6-bc6b-b479c71c5e02 @@ -16,11 +16,18 @@ redirect_from: - /v5/docs/en/glue-infrastructure - /docs/scos/dev/concepts/glue-api/glue-infrastructure.html - /docs/scos/dev/glue-api-guides/202200.0/glue-infrastructure.html + - /docs/scos/dev/glue-api-guides/202212.0/glue-infrastructure.html related: - title: Authentication and authorization link: docs/pbc/all/identity-access-management/page.version/glue-api-authentication-and-authorization.html --- +{% info_block warningBox %} + +This is a document related to the Old Glue infrastructure. For the new one, see [Decoupled Glue API](/docs/scos/dev/glue-api-guides/{{page.version}}/decoupled-glue-api.html) + +{% endinfo_block %} + Spryker API infrastructure is implemented as a separate layer of Spryker Cloud Commerce OS, called Glue. It is responsible for providing API endpoints, processing requests, as well as for communication with other layers of the OS in order to retrieve the necessary information. The layer is implemented as a separate Spryker application, the same as Yves or Zed. It has its own bootstrapping and a separate virtual host on the Spryker web server (Nginx by default). In addition to that, Glue has a separate programming namespace within Spryker Commerce OS, also called Glue. {% info_block infoBox %} @@ -35,10 +42,8 @@ Consider studying the following documents before you begin: Logically, the Glue layer can be divided into 3 parts: * **GlueApplication module**
The `GlueApplication` module provides a framework for constructing API resources. It intercepts all HTTP requests at resource URLs (e.g. `http://mysprykershop.com/resource/1`), handles call semantics, verifies requests, and also provides several utility interfaces that can be used to construct API responses. - * **Resource modules**
Each `Resource` module implements a separate resource or a set of resources. Such a module handles requests to a particular resource and provides them with responses. In the process of doing so, the module can communicate with the Storage, Search or Spryker Commerce OS (Zed). The modules do not handle request semantics or rules. Their only task is to provide the necessary data in a format that can be converted by the `GlueApplication` module into an API response. - * **Relationship modules**
Such modules represent relationships between two different resources. Their task is to extend the response of one of the resources with data of related resources. @@ -68,7 +73,7 @@ The plugin should not map the _OPTIONS_ verb which is mapped automatically. The plugin must provide routing information for the following: -| --- | --- | +| RESOURCE | DESCRIPTION | | --- | --- | | Resource Type | Type of the resource implemented by the current `Resource` module. Resource types are extracted by Glue from the request URL. For example, if the URL is `/carts/1`, the resource type is `carts`. To be able to process calls to this URL, Glue will need a route plugin for the resource type _carts_. | | Controller Name | Name of the controller that handles a specific resource type. | @@ -119,7 +124,7 @@ By default, all Resource modules are located in `vendor/spryker/resources-rest-a Recommended module structure: -| ResourcesRestApi | DESCRIPTION | +| RESOURCESRESTAPI | DESCRIPTION | | --- | --- | | `Glue/ResourcesRestApi/Controller` | Folder for resource controllers. Controllers are used to handle API requests and responses. Typically, includes the following:
  • `FeatureResourcesController.php` - contains methods for handling HTTP verbs.
| | `Glue/ResourcesRestApi/Dependency` | Bridges to clients from other modules. | @@ -132,7 +137,7 @@ Recommended module structure: Also, a module should contain the transfer definition in `src/Pyz/Shared/ResourcesRestApi/Transfer`: -| ResourcesRestApi | DESCRIPTION | +| RESOURCESRESTAPI | DESCRIPTION | | --- | --- | | `resources_rest_api.transfer.xml` | Contains API transfer definitions. | @@ -427,6 +432,7 @@ In addition to HTTP Status codes, Glue can return additional error codes to dist | 1001-1099 | Guest Cart API | | 1101-1199 | Checkout API| | 1201-1299| Product Labels API | +| 1301-1399| Dynamic Data API | ### Data formatting diff --git a/docs/scos/dev/glue-api-guides/202212.0/glue-rest-api.md b/docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/glue-rest-api.md similarity index 72% rename from docs/scos/dev/glue-api-guides/202212.0/glue-rest-api.md rename to docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/glue-rest-api.md index 912f9839b3a..bb9d6bc5bc1 100644 --- a/docs/scos/dev/glue-api-guides/202212.0/glue-rest-api.md +++ b/docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/glue-rest-api.md @@ -1,6 +1,6 @@ --- title: Glue REST API -last_updated: Jun 16, 2021 +last_updated: Jul 13, 2023 template: glue-api-storefront-guide-template originalLink: https://documentation.spryker.com/2021080/docs/glue-rest-api originalArticleId: 0556fe67-9243-4b84-b81f-8e417ca3d270 @@ -10,13 +10,20 @@ redirect_from: - /docs/glue-rest-api - /docs/en/glue-rest-api - /docs/scos/dev/glue-api-guides/202200.0/glue-rest-api.html + - /docs/scos/dev/glue-api-guides/202212.0/glue-rest-api.html - /api/definition-api.htm related: - title: Reference information - GlueApplication errors - link: docs/scos/dev/glue-api-guides/page.version/reference-information-glueapplication-errors.html + link: docs/scos/dev/glue-api-guides/page.version/old-glue-infrastructure/reference-information-glueapplication-errors.html --- -The Spryker Glue REST API is a JSON REST API that is an application of the Spryker Cloud Commerce OS (SCCOS). It is build to be used as a contract between the SCCOS Backend and any possible touchpoint or integration with a third-party system. As an application, Glue knows how to read and interpret API resources and leverage feature modules that expose existing Spryker functionality. +{% info_block warningBox %} + +This document is related to the Old Glue infrastructure. For the new one, see [Decoupled Glue API](/docs/scos/dev/glue-api-guides/{{page.version}}/decoupled-glue-api.html) + +{% endinfo_block %} + +The *Spryker Glue REST API* is a JSON REST API that is an application of the Spryker Cloud Commerce OS (SCCOS). It is build to be used as a contract between the SCCOS backend and any possible touchpoint or integration with a third-party system. As an application, Glue knows how to read and interpret API resources and leverage feature modules that expose existing Spryker functionality. ![Glue REST API](https://spryker.s3.eu-central-1.amazonaws.com/docs/Glue+API/Glue+REST+API/glue-rest-api.jpg) @@ -24,7 +31,7 @@ The Spryker Glue REST API is a JSON REST API that is an application of the Spryk The Spryker API infrastructure, which is implemented as a separate layer of the SCCOS, is called Glue. Glue is responsible for providing API endpoints, processing requests, and for communicating with other layers of the OS. -For more details, see [Glue Infrastructure](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-infrastructure.html). +For more details, see [Glue Infrastructure](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/glue-infrastructure.html). ## REST API @@ -32,25 +39,25 @@ The Glue REST API comes with a set of predefined APIs, which you can extend or a For more details, see REST API reference: -* [REST API B2B Demo Shop reference](/docs/scos/dev/glue-api-guides/{{site.version}}/rest-api-b2b-reference.html) -* [REST API B2C Demo Shop reference](/docs/scos/dev/glue-api-guides/{{site.version}}/rest-api-b2c-reference.html) +* [REST API B2B Demo Shop reference](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/rest-api-b2b-reference.html) +* [REST API B2C Demo Shop reference](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/rest-api-b2c-reference.html) ## B2C API React example -To help you understand possible use cases, we provide a sample app as an exemplary implementation (which is not a starting point for development). It can coexist with a shop as a second touchpoint in the project. From a technology perspective, it is based on our customers' interests. The app is single-page application based on a React JS library. +To help you understand possible use cases, we provide a sample app as an exemplary implementation (which is not a starting point for development). It can coexist with a shop as a second touchpoint in the project. From a technological perspective, it is based on our customers' interests. The app is single-page application based on a React JS library. -It delivers a full customer experience from browsing the catalog to placing an order. The application helps you understand how you can use the predefined APIs to create a B2C user experience. As an example, the full power of Elasticsearch, which is already present in our [B2B](/docs/scos/user/intro-to-spryker/b2b-suite.html) and [B2C Demo Shops](/docs/scos/user/intro-to-spryker/b2c-suite.html), is leveraged via dedicated endpoints to deliver catalog search functionality with auto-completion, auto-suggestion, facets, sorting, and pagination. +It delivers a full customer experience from browsing the catalog to placing an order. The application helps you understand how you can use the predefined APIs to create a B2C user experience. As an example, the full power of Elasticsearch, which is already present in our [B2B](/docs/scos/user/intro-to-spryker/b2b-suite.html) and [B2C Demo Shops](/docs/scos/user/intro-to-spryker/b2c-suite.html), is leveraged through dedicated endpoints to deliver catalog search functionality with autocompletion, autosuggestion, facets, sorting, and pagination. {% info_block infoBox %} -[Install and run!](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.html) +For more deatails about installing and running, see [B2C API React example](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-api-tutorials/b2c-api-react-example/b2c-api-react-example.html). {% endinfo_block %} ### What can you use the REST API for? Glue API helps you to connect your Spryker Commerce OS with new or existing touch points. These touchpoints can be headless like voice commerce devices and chat bots, or they may come with a user interface like a mobile app. Alternative front ends also benefit from the APIs. Here are some examples: -* New front end: Build a new front end or use a front-end framework like Progressive Web Apps and power it by the Glue API. +* New frontend: Build a new frontend or use a frontend framework like Progressive Web Apps and power it by the Glue API. * Mobile app: a mobile app, no matter if it is native, hybrid or just a web-view, can support the same functionality as the existing demo shops do. * Voice commerce: Leverage the APIs for order history to inform your customers about the status of their delivery. * Chatbot: Use chatbots to identify the customer that are trying to reach out to you and help them answer basic questions about your products. diff --git a/docs/scos/dev/glue-api-guides/202212.0/handling-concurrent-rest-requests-and-caching-with-entity-tags.md b/docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/handling-concurrent-rest-requests-and-caching-with-entity-tags.md similarity index 89% rename from docs/scos/dev/glue-api-guides/202212.0/handling-concurrent-rest-requests-and-caching-with-entity-tags.md rename to docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/handling-concurrent-rest-requests-and-caching-with-entity-tags.md index 4cb0c41116a..fce7d0d5011 100644 --- a/docs/scos/dev/glue-api-guides/202212.0/handling-concurrent-rest-requests-and-caching-with-entity-tags.md +++ b/docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/handling-concurrent-rest-requests-and-caching-with-entity-tags.md @@ -10,13 +10,20 @@ redirect_from: - /2021080/docs/en/handling-concurrent-rest-requests-and-caching-with-entity-tags - /docs/handling-concurrent-rest-requests-and-caching-with-entity-tags - /docs/en/handling-concurrent-rest-requests-and-caching-with-entity-tags + - /docs/scos/dev/glue-api-guides/202212.0/handling-concurrent-rest-requests-and-caching-with-entity-tags.html related: - title: Glue Infrastructure - link: docs/scos/dev/glue-api-guides/page.version/glue-infrastructure.html + link: docs/scos/dev/glue-api-guides/page.version/old-glue-infrastructure/glue-infrastructure.html - title: Shared Cart Feature Overview link: docs/scos/user/features/page.version/shared-carts-feature-overview.html --- +{% info_block warningBox %} + +This document is related to the Old Glue infrastructure. For the new one, see [Decoupled Glue API](/docs/scos/dev/glue-api-guides/{{page.version}}/decoupled-glue-api.html) + +{% endinfo_block %} + Some Spryker Glue API resources allow concurrent changes from multiple sources. For example, a shared cart can be changed by multiple users that act independently. To ensure resource integrity and consistency, such resources implement *Entity Tags* (ETags). An ETag is a unique identifier of the state of a specific resource at a certain point in time. It allows a server to identify if the client initiating a change has received the last state of the resource known to the server prior to sending the change request. @@ -93,4 +100,4 @@ The following error responses can be returned by the server when a resource supp | 005 | Pre-condition required.
The `If-Match` header is missing. | | 006 | Pre-condition failed.
The `If-Match` header value is invalid or outdated.
Request the current state of the resource using a `GET` request to obtain a valid tag value. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/scos/dev/glue-api-guides/202212.0/reference-information-glueapplication-errors.md b/docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/reference-information-glueapplication-errors.md similarity index 70% rename from docs/scos/dev/glue-api-guides/202212.0/reference-information-glueapplication-errors.md rename to docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/reference-information-glueapplication-errors.md index f02c32c02b1..8756593201c 100644 --- a/docs/scos/dev/glue-api-guides/202212.0/reference-information-glueapplication-errors.md +++ b/docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/reference-information-glueapplication-errors.md @@ -1,5 +1,5 @@ --- -title: Reference information- GlueApplication errors +title: Reference information - GlueApplication errors description: Find out what common GlueAplication errors you can come across when sending and receiving data via the Glue API. last_updated: Jun 16, 2021 template: glue-api-storefront-guide-template @@ -11,11 +11,18 @@ redirect_from: - /docs/reference-information-glueapplication-errors - /docs/en/reference-information-glueapplication-errors - /docs/scos/dev/glue-api-guides/202200.0/reference-information-glueapplication-errors.html + - /docs/scos/dev/glue-api-guides/202212.0/reference-information-glueapplication-errors.html related: - title: Glue REST API - link: docs/scos/dev/glue-api-guides/page.version/glue-rest-api.html + link: docs/scos/dev/glue-api-guides/page.version/old-glue-infrastructure/glue-rest-api.html --- +{% info_block warningBox %} + +This is a document related to the Old Glue infrastructure. For the new one, see [Decoupled Glue API](/docs/scos/dev/glue-api-guides/{{page.version}}/decoupled-glue-api.html) + +{% endinfo_block %} + This page lists the generic errors that originate from the Glue Application. These errors can occur for any resource, and they are always the same for all the resources. | ERROR | DESCRIPTION | diff --git a/docs/scos/dev/glue-api-guides/202212.0/resolving-search-engine-friendly-urls.md b/docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/resolving-search-engine-friendly-urls.md similarity index 94% rename from docs/scos/dev/glue-api-guides/202212.0/resolving-search-engine-friendly-urls.md rename to docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/resolving-search-engine-friendly-urls.md index df4f4c8fe1b..2661b5841c7 100644 --- a/docs/scos/dev/glue-api-guides/202212.0/resolving-search-engine-friendly-urls.md +++ b/docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/resolving-search-engine-friendly-urls.md @@ -10,11 +10,18 @@ redirect_from: - /2021080/docs/en/resolving-search-engine-friendly-urls - /docs/resolving-search-engine-friendly-urls - /docs/en/resolving-search-engine-friendly-urls + - /docs/scos/dev/glue-api-guides/202212.0/resolving-search-engine-friendly-urls.html related: - title: Glue API - Spryker Core feature integration link: docs/pbc/all/miscellaneous/page.version/install-and-upgrade/install-glue-api/install-the-spryker-core-glue-api.html --- +{% info_block warningBox %} + +This is a document related to the Old Glue infrastructure. For the new one, see [Decoupled Glue API](/docs/scos/dev/glue-api-guides/{{page.version}}/decoupled-glue-api.html) + +{% endinfo_block %} + This endpoints allows resolving Search Engine Friendly (SEF) URLs into a resource URL in Glue API. For SEO purposes, Spryker automatically generates SEF URLs for products and categories. The URLs are returned as a `url` attribute in responses related to abstract products and product categories. For examples of such responses, see: @@ -152,4 +159,4 @@ Using the information from the response and the Glue server name, you can constr | 2801 | The `url` parameter is missing. | | 2802 | The provided URL does not exist. | -To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html). +To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html). diff --git a/docs/scos/dev/glue-api-guides/202212.0/rest-api-b2b-reference.md b/docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/rest-api-b2b-reference.md similarity index 78% rename from docs/scos/dev/glue-api-guides/202212.0/rest-api-b2b-reference.md rename to docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/rest-api-b2b-reference.md index b20bba61bf5..12fb9a3c6c2 100644 --- a/docs/scos/dev/glue-api-guides/202212.0/rest-api-b2b-reference.md +++ b/docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/rest-api-b2b-reference.md @@ -3,11 +3,19 @@ title: REST API B2B Demo Shop reference description: This page provides an exhaustive reference for the REST API endpoints present in the Spryker B2B demo Shop by default with the corresponding parameters and data formats. last_updated: May 10, 2022 template: glue-api-storefront-guide-template +redirect_from: + - /docs/scos/dev/glue-api-guides/202212.0/rest-api-b2b-reference.html related: - title: Reference information- GlueApplication errors - link: docs/scos/dev/glue-api-guides/page.version/reference-information-glueapplication-errors.html + link: docs/scos/dev/glue-api-guides/page.version/old-glue-infrastructure/reference-information-glueapplication-errors.html --- +{% info_block warningBox %} + +This is a document related to the Old Glue infrastructure. For the new one, see [Decoupled Glue API](/docs/scos/dev/glue-api-guides/{{page.version}}/decoupled-glue-api.html) + +{% endinfo_block %} + This document provides an overview of REST API endpoints provided by the Spryker B2B Demo Shop by default. For each endpoint, you will find its URL relative to the server, REST request parameters, as well as the appropriate request and response data formats.
diff --git a/docs/scos/dev/glue-api-guides/202212.0/rest-api-b2c-reference.md b/docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/rest-api-b2c-reference.md similarity index 82% rename from docs/scos/dev/glue-api-guides/202212.0/rest-api-b2c-reference.md rename to docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/rest-api-b2c-reference.md index 4542e40613d..48189b3351a 100644 --- a/docs/scos/dev/glue-api-guides/202212.0/rest-api-b2c-reference.md +++ b/docs/scos/dev/glue-api-guides/202212.0/old-glue-infrastructure/rest-api-b2c-reference.md @@ -12,11 +12,18 @@ redirect_from: - /docs/en/rest-api-reference - /docs/scos/dev/glue-api-guides/202204.0/rest-api-reference.html - /docs/scos/dev/glue-api-guides/202200.0/rest-api-reference.html + - /docs/scos/dev/glue-api-guides/202212.0/rest-api-b2c-reference.html related: - title: Reference information- GlueApplication errors - link: docs/scos/dev/glue-api-guides/page.version/reference-information-glueapplication-errors.html + link: docs/scos/dev/glue-api-guides/page.version/old-glue-infrastructure/reference-information-glueapplication-errors.html --- +{% info_block warningBox %} + +This is a document related to the Old Glue infrastructure. For the new one, see [Decoupled Glue API](/docs/scos/dev/glue-api-guides/{{page.version}}/decoupled-glue-api.html) + +{% endinfo_block %} + This document provides an overview of REST API endpoints provided by the Spryker B2C Demo Shop by default. For each endpoint, you will find its URL relative to the server, REST request parameters, as well as the appropriate request and response data formats.
diff --git a/docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-infrastructure/security-and-authentication.md b/docs/scos/dev/glue-api-guides/202212.0/security-and-authentication.md similarity index 100% rename from docs/scos/dev/glue-api-guides/202212.0/decoupled-glue-infrastructure/security-and-authentication.md rename to docs/scos/dev/glue-api-guides/202212.0/security-and-authentication.md diff --git a/docs/scos/dev/glue-api-guides/202304.0/dynamic-data-api/how-to-guides/how-to-configure-dynamic-data-api.md b/docs/scos/dev/glue-api-guides/202304.0/dynamic-data-api/how-to-guides/how-to-configure-dynamic-data-api.md new file mode 100644 index 00000000000..8b751ea3069 --- /dev/null +++ b/docs/scos/dev/glue-api-guides/202304.0/dynamic-data-api/how-to-guides/how-to-configure-dynamic-data-api.md @@ -0,0 +1,118 @@ +--- +title: How to configure Dynamic Data API endpoints. +description: This guide shows how to configure the Dynamic Data API endpoints. +last_updated: June 23, 2023 +template: howto-guide-template +--- + +This guide shows how to configure the Dynamic Data API endpoints. + +In order to incorporate a new endpoint for interacting with entities in the database, +it is necessary to add a corresponding row to the `spy_dynamic_entity_configuration` table. + +The `spy_dynamic_entity_configuration` table represents the configuration for dynamic entity endpoints in the system. It has the following columns: + +| COLUMN | SPECIFICATION | +| --- | --- | +| id_dynamic_entity_configuration | The unique ID for the configuration. | +| table_alias | An alias used in the request URL to refer to the endpoint. | +| table_name | The name of the corresponding table in the database to operate on. | +| is_active | Indicates whether the endpoint is enabled or disabled. | +| definition | A JSON-formatted string containing the configuration details for each field in the table. | +| created_at | Represents the date and time when the configuration was created. | +| updated_at | Represents the date and time when the configuration was last updated. | + +{% info_block infoBox %} + +Currently, the process entails manually executing SQL queries as there is no existing user interface (UI) feature in Spryker for it. +However, future releases are expected to introduce an UI solution for adding new rows to the `spy_dynamic_entity_configuration` table. + +{% endinfo_block %} + +Let's dive deeper into the configuration of the `spy_dynamic_entity_definition.definition` field. + +Below is an example snippet illustrating the structure of a possible definition value based on `spy_country` table: + +```json +{ + "identifier": "id_country", + "fields": [ + { + "fieldName": "id_country", + "fieldVisibleName": "id_country", + "isEditable": false, + "isCreatable": false, + "type": "integer", + "validation": { + "isRequired": false + } + }, + { + "fieldName": "iso2_code", + "fieldVisibleName": "iso2_code", + "type": "string", + "isEditable": true, + "isCreatable": true, + "validation": { + "isRequired": true, + "maxLength": 2, + "minLength": 2 + } + } + ] +} +``` + +And now, let's delve into the meaning of each field within the snippet. Here's a breakdown of the purpose of each field: + +| FIELD | SPECIFICATION | +| --- | --- | +| identifier | The name of the column in the table that serves as an identifier. It can be any chosen column from the table, typically used as a unique ID for each record. | +| fields | An array containing the descriptions of the columns from the table. It allows customization of which columns are included for interaction. By specifying the desired columns in the "fields" array, the API will only expose and operate on those specific columns. Any columns not included in the array will be inaccessible through API requests. | +| fieldName | The actual name of the column in the database table. | +| fieldVisibleName | The name used for interacting with the field through API requests. It provides a more user-friendly and descriptive name compared to the physical column name. | +| type | The data type of the field. It specifies the expected data format for the field, enabling proper validation and handling of values during API interactions. | +| isEditable | A flag indicating whether the field can be modified. When set to "true," the field is editable, allowing updates to its value. | +| isCreatable | A flag indicating whether the field can be set. If set to "true," the field can be included in requests to provide an initial value during record creation. | +| validation | Contains validation configurations. Proper validation ensures that the provided data meets the specified criteria. | +| required | A validation attribute that determines whether the field is required or optional. When set to "true," the field must be provided in API requests. | +| maxLength/minLength | An optional validation attribute that specifies the minimum/maximum length allowed for the field defined with a string type. It enforces a lower boundary, ensuring that the field's value meets or exceeds the defined minimum requirement. | +| max/min | An optional validation attribute that specifies the minimum/maximum value allowed for the field defined with an integer type. It enforces a lower boundary, ensuring that the field's value meets or exceeds the defined minimum requirement. | + +{% info_block infoBox %} + +It is recommended to set `isEditable` and `isCreatable` to `false` for fields that serve as identifiers or keys, ensuring their immutability and preserving the integrity of the data model. + +{% endinfo_block %} + +{% info_block infoBox %} + +When configuring the definition for the field responsible for the numerable values, keep in mind that an integer data type is a non-decimal number +between -2147483648 and 2147483647 in 32-bit systems, and between -9223372036854775808 and 9223372036854775807 in 64-bit systems. +However, if there is a need to use values outside this range or if the person providing the configuration anticipates +larger values, the field can be set as a string type instead. + +{% endinfo_block %} + +{% info_block infoBox %} + +So far the Dynamic Data API supports the following types for the configured fields: boolean, integer, string and decimal. + +{% endinfo_block %} + +Let's say you want to have a new endpoint `/dynamic-data/country` to operate with data in `spy_country` table in database. + +Based on the provided information, the SQL transaction for interacting with the `spy_country` table through the API request via `dynamic-entity/country` would be as follows: + +```sql +BEGIN; +INSERT INTO `spy_dynamic_entity_configuration` VALUES ('country', 'spy_country', 1, '{\"identifier\":\"id_country\",\"fields\":[{\"fieldName\":\"id_country\",\"fieldVisibleName\":\"id_country\",\"isEditable\":false,\"isCreatable\":false,\"type\":\"integer\",\"validation\":{\"isRequired\":false}},{\"fieldName\":\"iso2_code\",\"fieldVisibleName\":\"iso2_code\",\"type\":\"string\",\"isEditable\":true,\"isCreatable\":true,\"validation\":{\"isRequired\":true,\"maxLength\":2,\"minLength\":2}},{\"fieldName\":\"iso3_code\",\"fieldVisibleName\":\"iso3_code\",\"type\":\"string\",\"isEditable\":true,\"isCreatable\":true,\"validation\":{\"isRequired\":true,\"maxLength\":3,\"minLength\":3}},{\"fieldName\":\"name\",\"fieldVisibleName\":\"name\",\"type\":\"string\",\"isEditable\":true,\"isCreatable\":true,\"validation\":{\"isRequired\":true,\"maxLength\":255,\"minLength\":1}},{\"fieldName\":\"postal_code_mandatory\",\"fieldVisibleName\":\"postal_code_mandatory\",\"type\":\"boolean\",\"isEditable\":true,\"isCreatable\":true,\"validation\":{\"isRequired\":false}},{\"fieldName\":\"postal_code_regex\",\"isEditable\":\"false\",\"isCreatable\":\"false\",\"fieldVisibleName\":\"postal_code_regex\",\"type\":\"string\",\"validation\":{\"isRequired\":false,\"maxLength\":500,\"minLength\":1}}]}'); +COMMIT; +``` + +{% info_block warningBox "Verification" %} + +If everything is set up correctly, you can follow [How to send request in Dynamic Data API](/docs/scos/dev/glue-api-guides/{{page.version}}/dynamic-data-api/how-to-guides/how-to-send-request-in-dynamic-data-api.html) to discover how to request your API endpoint. +Or if you're in the middle of the integration process for the Dynamic Data API follow [Dynamic Data API integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/dynamic-data-api-integration.html) to proceed with it. + +{% endinfo_block %} diff --git a/docs/scos/dev/glue-api-guides/202304.0/dynamic-data-api/how-to-guides/how-to-send-request-in-dynamic-data-api.md b/docs/scos/dev/glue-api-guides/202304.0/dynamic-data-api/how-to-guides/how-to-send-request-in-dynamic-data-api.md new file mode 100644 index 00000000000..13bc30f9000 --- /dev/null +++ b/docs/scos/dev/glue-api-guides/202304.0/dynamic-data-api/how-to-guides/how-to-send-request-in-dynamic-data-api.md @@ -0,0 +1,473 @@ +--- +title: How send a request in Dynamic Data API +description: This guide shows how to send a request in Dynamic Data API. +last_updated: June 23, 2023 +template: howto-guide-template +--- + +This guide shows how to send a request in Dynamic Data API. + +{% info_block infoBox %} + +Ensure the Dynamic Data API is integrated (follow [Dynamic Data API integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/dynamic-data-api-integration.html)) +and configured (follow [How to configure Dynamic Data API](/docs/scos/dev/glue-api-guides/{{page.version}}/dynamic-data-api/how-to-guides/how-to-configure-dynamic-data-api.html)) +as described in the guides. + +{% endinfo_block %} + +Let's say you have an endpoint `/dynamic-data/country` to operate with data in `spy_country` table in database. + +The Dynamic Data API is a non-resource-based API and routes directly to a controller all specified endpoints. + +By default, all routes within the Dynamic Data API are protected to ensure data security. +To access the API, you need to obtain an access token by sending a POST request to the `/token/` endpoint with the appropriate credentials: + +```bash +POST /token/ HTTP/1.1 +Host: glue-backend.mysprykershop.com +Content-Type: application/x-www-form-urlencoded +Accept: application/json +Content-Length: 67 + +grant_type=password&username={username}&password={password} +``` + +### Sending a `GET` request + +To retrieve a collection of countries, a `GET` request should be sent to the `/dynamic-entity/country` endpoint. +This request needs to include the necessary headers, such as Content-Type, Accept, and Authorization, with the access token provided. + +The response body will contain all the columns from the `spy_country` table that have been configured in the `spy_dynamic_entity_definition.definition`. +Each column will be represented using the `fieldVisibleName` as the key, providing a comprehensive view of the table's data in the API response. + +Pagination allows for efficient data retrieval by specifying the desired range of results. +To implement pagination, include the desired page limit and offset in the request: + +```bash +GET /dynamic-entity/country?page[offset]=1&page[limit]=2 HTTP/1.1 +Host: glue-backend.mysprykershop.com +Content-Type: application/json +Accept: application/json +Authorization: Bearer {your_token} +``` + +{% info_block warningBox "Verification" %} + +If everything is set up correctly you will get the following response: + +```json +[ + { + "id_country": 2, + "iso2_code": "AD", + "iso3_code": "AND", + "name": "Andorra", + "postal_code_mandatory": true, + "postal_code_regex": "AD\\d{3}" + }, + { + "id_country": 3, + "iso2_code": "AE", + "iso3_code": "ARE", + "name": "United Arab Emirates", + "postal_code_mandatory": false, + "postal_code_regex": null + } +] +``` + +{% endinfo_block %} + +{% info_block infoBox %} + +Note, by default the API `GET` request returns up to 20 records. + +{% endinfo_block %} + +Filtering enables targeted data retrieval, refining the response to match the specified criteria. +To apply filtering to the results based on specific fields, include the appropriate filter parameter in the request: + +```bash +GET /dynamic-entity/country?filter[country.iso2_code]=AA HTTP/1.1 +Host: glue-backend.mysprykershop.com +Content-Type: application/json +Accept: application/json +Authorization: Bearer {your_token} +``` + +{% info_block warningBox "Verification" %} + +If everything is set up correctly you will get the following response: + +```json +[ + { + "id_country": 1, + "iso2_code": "AA", + "iso3_code": "UUD", + "name": "Create", + "postal_code_mandatory": false, + "postal_code_regex": null + } +] +``` + +{% endinfo_block %} + +{% info_block infoBox %} + +Note, so far when you combine multiple filters in a single request, the system applies an "AND" condition to the retrieved results. + +{% endinfo_block %} + +To retrieve a country by a specific ID, you can send a `GET` request with the following parameters: + +```bash +GET /dynamic-entity/country/3 HTTP/1.1 +Host: glue-backend.mysprykershop.com +Content-Type: application/json +Accept: application/json +Authorization: Bearer {your_token} +``` +{% info_block warningBox "Verification" %} + +If everything is set up correctly you will get the following response: + +```json +[ + { + "id_country": 3, + "iso2_code": "AE", + "iso3_code": "ARE", + "name": "United Arab Emirates", + "postal_code_mandatory": false, + "postal_code_regex": null + } +] +``` + +{% endinfo_block %} + +{% info_block infoBox %} + +Note if a current endpoint is not configured in `spy_dynamic_entity_configuration` and it's not found you'll get the following response: + +```json +[ + { + "message": "Not found", + "status": 404, + "code": "007" + } +] +``` + +{% endinfo_block %} + +### Sending `POST` request + +To create a collection of countries, submit the following HTTP request: + +```bash +POST /dynamic-entity/country HTTP/1.1 +Host: glue-backend.mysprykershop.com +Content-Type: application/json +Accept: application/json +Authorization: Bearer {your_token} +Content-Length: 154 + +{ + "data": [ + { + "iso2_code": "WA", + "iso3_code": "WWA", + "name": "FOO" + } + ] +} +``` + +{% info_block warningBox "Verification" %} + +If everything is set up correctly you will get the following response: + +```json +[ + { + "iso2_code": "WA", + "iso3_code": "WWA", + "name": "FOO", + "id_country": 257 + } +] +``` + +The response payload includes all the specified fields from the request body, along with the ID of the newly created entity. + +{% endinfo_block %} + +{% info_block infoBox %} + +Note that all fields included in the request payload are marked as `isCreatable: true` in the configuration. +Therefore, the API will create a new record with all the provided fields. +However, if any of the provided fields are configured as `isCreatable: false` it will result in an error. + +Let's configure `isCreatable: false` for `iso3_code` and send the same request. +You will receive the following error response because a non-creatable field `iso3_code` is provided: + +```json +[ + { + "message": "Modification of immutable field `iso3_code` is prohibited.", + "status": 400, + "code": "1304" + } +] +``` + +{% endinfo_block %} + +{% info_block infoBox %} + +It is important to consider that certain database-specific configurations may result in issues independent of entity configurations. + +For instance, in the case of MariaDB, it is not possible to set the ID value for an auto-incremented field. +Additionally, for the `iso2_code` field in the `spy_country` table, it must have a unique value. +Therefore, before creating a new record, it is necessary to verify that you do not pass a duplicated value for this field. +Otherwise, you will receive the following response: + +```json +[ + { + "message": "Failed to persist the data. Please verify the provided data and try again. Entry is duplicated.", + "status": 400, + "code": "1309" + } +] +``` + +This response is caused by a caught Propel exception, specifically an integrity constraint violation `(Integrity constraint violation: 1062 Duplicate entry 'WA' for key 'spy_country-iso2_code')`. + +{% endinfo_block %} + +### Sending `PATCH` request + +To update a collection of countries, submit the following HTTP request: + +```bash +PATCH /dynamic-entity/country HTTP/1.1 +Host: glue-backend.mysprykershop.com +Content-Type: application/json +Accept: application/json +Authorization: Bearer {your_token} +Content-Length: 174 +{ + "data": [ + { + "id_country": 1, + "iso2_code": "WB", + "iso3_code": "WWB", + "name": "FOO" + } + ] +} +``` + +{% info_block warningBox "Verification" %} + +If everything is set up correctly you will get the following response: + +```json +[ + { + "iso2_code": "WB", + "iso3_code": "WWB", + "name": "FOO", + "id_country": 1 + } +] +``` + +The response payload includes all the specified fields from the request body. + +{% endinfo_block %} + +{% info_block infoBox %} + +It is also possible to send a `PATCH` request for a specific ID instead of a collection, use the following request: + +```bash +PATCH /dynamic-entity/country/1 HTTP/1.1 +Host: glue-backend.mysprykershop.com +Content-Type: application/json +Accept: application/json +Authorization: Bearer {your_token} +Content-Length: 143 +{ + "data": { + "iso2_code": "WB", + "iso3_code": "WWB", + "name": "FOO" + } +} +``` + +{% endinfo_block %} + +{% info_block infoBox %} + +Note that all fields included in the request payload are marked as `isEditable: true` in the configuration. +Therefore, the API will update the found record with all the provided fields. +However, if any of the provided fields are configured as `isEditable: false` it will result in an error. + +Let's configure `isEditable: false` for `iso3_code` and send the same request. + +You will receive the following error response because a non-editable field `iso3_code` is provided: + +```json +[ + { + "message": "Modification of immutable field `iso3_code` is prohibited.", + "status": 400, + "code": "1304" + } +] +``` + +{% endinfo_block %} + +{% info_block infoBox %} + +If `id_country` is not provided you will get the following response: + +```json +[ + { + "message": "Incomplete Request - missing identifier.", + "status": 400, + "code": "1310" + } +] +``` + +If `id_country` is not found you will get the following response: + +```json +[ + { + "message": "The entity could not be found in the database.", + "status": 404, + "code": "1303" + } +] +``` + +{% endinfo_block %} + +{% info_block infoBox %} + +Similarly to the `POST` request, it is important to consider database-specific configurations when sending a `PATCH` request. + +{% endinfo_block %} + +### Sending `PUT` request + +When you send a PUT request, you provide the updated representation of the resource in the request +payload. The server then replaces the entire existing resource with the new representation provided. If the resource does not exist at the specified URL, a PUT request can also create a new resource. + +Let's send the following `PUT` request to update the existing entity: + +```bash +PUT /dynamic-entity/country HTTP/1.1 +Host: glue-backend.mysprykershop.com +Content-Type: application/json +Accept: application/json +Authorization: Bearer {your_token} +Content-Length: 263 +{ + "data": [ + { + "id_country": 1, + "iso2_code": "WB", + "iso3_code": "WWB", + "name": "FOO" + } + ] +} +``` + +{% info_block warningBox "Verification" %} + +If everything is set up correctly you will get the following response: + +```json +[ + { + "iso2_code": "WB", + "iso3_code": "WWB", + "name": "FOO", + "postal_code_mandatory": null, + "postal_code_regex": null, + "id_country": 1 + } +] +``` + +The response payload includes all touched fields for the provided resource. + +{% endinfo_block %} + +{% info_block infoBox %} + +It is also possible to send a `PUT` request for a specific ID instead of a collection using the following request: + +```bash +PUT /dynamic-entity/country/1 HTTP/1.1 +Host: glue-backend.mysprykershop.com +Content-Type: application/json +Accept: application/json +Authorization: Bearer {your_token} +Content-Length: 143 +{ + "data": { + "iso2_code": "WB", + "iso3_code": "WWB", + "name": "FOO" + } +} +``` + +{% endinfo_block %} + +{% info_block infoBox %} + +When using `PUT` requests, it's important to consider that the same rules and configurations apply +as with `PATCH` and `POST` requests. This means that the `isEditable` attribute determines whether existing +items can be modified during a `PUT` request. Additionally, the `isCreatable` attribute is used for non-existing +items that are created automatically according to the `PUT` request RFC. + +In technical terms, the `PUT` request follows the same guidelines as `PATCH` and `POST` requests in relation to +the definition and database-specific configurations. The `isEditable` attribute governs the update capability +of existing items during a `PUT` request, ensuring that only editable fields can be modified. Similarly, the `isCreatable` +attribute pertains to non-existing items and governs their automatic creation as part of the `PUT` request process, +adhering to the standards outlined in the `PUT` request RFC. It's crucial to adhere to these rules and configurations +to ensure accurate and consistent data manipulation during `PUT` operations. + +{% endinfo_block %} + +#### Error codes + +Bellow you can find a list of error codes that you can receive when sending `GET`, `POST`, `PATCH` or `PUT` requests. + +| Error code | Message | Description | +| --- | --- | --- | +| 1301 | Invalid or missing data format. Please ensure that the data is provided in the correct format. Example request body: `{'data':[{...},{...},..]}` | The request body is not valid. Please review the data format for validity. Ensure that the data is provided in the correct format. An example request body would be: `{'data':[{...data entity...},{...data entity...},...]}`. `data` If the data format is invalid or missing, an error message will be displayed. | +| 1302 | Failed to persist the data. Please verify the provided data and try again. | The data could not be persisted in the database. Please verify the provided data entities and try again. | +| 1303 | The entity could not be found in the database. | The requested entity could not be found in the database for retrieval or update. | +| 1304 | Modification of immutable field `field` is prohibited. | The field is prohibited from being modified. Please check the configuration for this field. | +| 1305 | Invalid data type for field: `field` | The specified field has an incorrect type. Please check the configuration for this field and correct the value. | +| 1306 | Invalid data value for field: `field`, row number: `row`. Field rules: `validation rules`. | The error indicates a data row and a field that does not comply with the validation rules in the configuration. Here is an example of the error: `Invalid data value for field: id, row number: 2. Field rules: min: 0, max: 127`. | +| 1307 | The required field must not be empty. Field: `field` | The specified field is required according to the configuration. The field was not provided. Please check the data you are sending and try again. | +| 1308 | Entity not found by identifier, and new identifier can not be persisted. Please update the request. | The entity could not be found using the provided identifier, and a new identifier cannot be persisted. Please update your request accordingly or check configuration for identifier field. | +| 1309 | Failed to persist the data. Please verify the provided data and try again. Entry is duplicated. | Failed to persist the data. Please verify the provided data and try again. This error may occur if a record with the same information already exists in the database. | +| 1310 | Incomplete Request - missing identifier. | The request is incomplete. The identifier is missing. Please check the request and try again. | \ No newline at end of file diff --git a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/additional-logic-in-dependency-provider.md b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/additional-logic-in-dependency-provider.md index 531f557345d..12613a17ce6 100644 --- a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/additional-logic-in-dependency-provider.md +++ b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/additional-logic-in-dependency-provider.md @@ -73,22 +73,19 @@ class ConsoleDependencyProvider extends SprykerConsoleDependencyProvider } ``` -## Example of an Evaluator error message +## Example of an evaluator error message ```bash ====================== MULTIDIMENSIONAL ARRAY ====================== -+---+------------------------------------------------------------------------------------+-------------------------------------------------------------------+ -| # | Message | Target | -+---+------------------------------------------------------------------------------------+-------------------------------------------------------------------+ -| 1 | The condition statement if ($alwaysTrue) {} is forbidden in the DependencyProvider | /Pyz/Zed/Checkout/CheckoutDependencyProvider.php | -+---+------------------------------------------------------------------------------------+-------------------------------------------------------------------+ +Message: The if ($alwaysTrue) {} condition statement is forbidden in DependencyProvider +Target: {PATH_TO_PROJECT}/Pyz/Zed/Checkout/CheckoutDependencyProvider.php ``` -## Example of code that causes an upgradability error +## Example of code that causes an evaluator error The method `getFormPlugins` in `FormDependencyProvider` contains unsupported expressions in the `if` construct `$alwaysAddPlugin`. diff --git a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/dead-code-checker.md b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/dead-code-checker.md index 82367175e45..df5fe6f2273 100644 --- a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/dead-code-checker.md +++ b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/dead-code-checker.md @@ -13,20 +13,19 @@ This results in unnecessary additional time investment from developers, as they This check examines potential obsolete classes, with a tendency to overlook important Spryker kernel classes like `Factory`, `Facade`, or `DependencyProvider`. If desired, you have the option to disable the dead code checker for a particular class using the `@evaluator-skip-dead-code` annotation. -## Example of an Evaluator error message +## Example of an evaluator error message ```bash ================= DEAD CODE CHECKER ================= -+---+---------------------------------------------------------------------------------+--------------------------------------------------+ -| # | Message | Target | -+---+---------------------------------------------------------------------------------+--------------------------------------------------+ -| 1 | Class "Pyz/Zed/Single/Communication/Plugin/SinglePlugin" is not used in project | Pyz/Zed/Single/Communication/Plugin/SinglePlugin | -+---+---------------------------------------------------------------------------------+--------------------------------------------------+ +Message: The class "Pyz/Zed/Single/Communication/Plugin/SinglePlugin" is not used in the project. +Target: Pyz/Zed/Single/Communication/Plugin/SinglePlugin ``` +## Example of code that causes an evaluator error + Unused class `Pyz/Zed/Single/Communication/Plugin/SinglePlugin` that produces an error: ```bash diff --git a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/minimum-allowed-shop-version.md b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/minimum-allowed-shop-version.md index ca6b3f97cfa..890a5fda464 100644 --- a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/minimum-allowed-shop-version.md +++ b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/minimum-allowed-shop-version.md @@ -12,7 +12,7 @@ To enable smooth upgradability of the project using the [Spryker Code Upgrader]( In case the project does not utilize the feature packages, it is necessary to ensure that the corresponding Spryker module versions are used. -## Example of an Evaluator error message +## Example of an evaluator error message Below is an example of when a used feature package version doesn't correspond to the minimum required version: @@ -28,18 +28,17 @@ MINIMUM ALLOWED SHOP VERSION +---+---------------------------------------------------------------------------------------------------------------------------+---------------------------------------+ ``` -Below is an example of when the used Spryker package version doesn't correspond to the minimum required version: +## Example of code that causes an evaluator error + +The following is an example of when the used Spryker package version doesn't correspond to the minimum required version: ```shell ============================ MINIMUM ALLOWED SHOP VERSION ============================ -+---+-----------------------------------------------------------------------------------------------------------------+--------------------------------+ -| # | Message | Target | -+---+-----------------------------------------------------------------------------------------------------------------+--------------------------------+ -| 1 | The package "spryker/availability-gui" version "6.5.9" is not supported. The minimum allowed version is "6.6.0" | spryker/availability-gui:6.5.9 | -+---+-----------------------------------------------------------------------------------------------------------------+--------------------------------+ +Message: The package "spryker/availability-gui" version 6.5.9 is not supported. The minimum allowed version is 6.6.0. +Target: spryker/availability-gui:6.5.9 ``` ### Resolving the error diff --git a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/multidimensional-array.md b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/multidimensional-array.md index 79435a3ea7d..1e608a40954 100644 --- a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/multidimensional-array.md +++ b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/multidimensional-array.md @@ -11,23 +11,19 @@ This check checks that project doesn't use the deeply nested multidimensional ar If a plugins stack is used on the project level, not all structures are necessarily required. Deeply nested multidimensional arrays make configuration hard to upgrade. This check verifies that multidimensional arrays have a maximum of two levels of nesting inside. -## Example of an Evaluator error message +## Example of an evaluator error message ```bash ====================== MULTIDIMENSIONAL ARRAY ====================== -+---+----------------------------------------------------------------------------------------------------------------------------+------------------------------------------+ -| # | Message | Target | -+---+----------------------------------------------------------------------------------------------------------------------------+------------------------------------------+ -| 1 | Reached max level of nesting for the plugin registration in the {FormDependencyProvider::getPlugins()}. | Pyz\Yves\Module\ModuleDependencyProvider | -| | The maximum allowed nesting level is 2. Please, refactor code, otherwise it will cause upgradability issues in the future. | | -+---+----------------------------------------------------------------------------------------------------------------------------+------------------------------------------+ - +Message: Reached max level of nesting for the plugin registration in the {FormDependencyProvider::getPlugins()}. + The maximum allowed nesting level is 2. Refactor the code; otherwise, it can cause upgradability issues in the future. +Target: Pyz\Yves\Module\ModuleDependencyProvider ``` -## Example of code that causes an upgradability error +## Example of code that causes an evaluator error The methods `ModuleDependencyProvider` contains unsupported multidimensional arrays, which have more than two nesting levels inside. diff --git a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/php-version.md b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/php-version.md index e4a16cf97dc..87f87b30d1d 100644 --- a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/php-version.md +++ b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/php-version.md @@ -47,7 +47,7 @@ image: ... ``` -## Example of an Evaluator error message +## Example of an evaluator error message Below is an example of an unsupported [Spryker SDK](https://docs.spryker.com/docs/sdk/dev/spryker-sdk.html) PHP version being used in the `composer.json` file: @@ -56,11 +56,8 @@ Below is an example of an unsupported [Spryker SDK](https://docs.spryker.com/doc PHP VERSION CHECKER =================== -+---+------------------------------------------------------------------------+---------------------------------+ -| # | Message | Target | -+---+------------------------------------------------------------------------+---------------------------------+ -| 1 | Composer json PHP constraint "7.2" does not match allowed PHP versions | /composer.json | -+---+------------------------------------------------------------------------+---------------------------------+ +Message: Composer json PHP constraint 7.2 does not match allowed PHP versions. +Target: `{PATH_TO_PROJECT}/composer.json` ``` A `composer.json` file that produces the error message: @@ -84,12 +81,9 @@ Below is an example of an unsupported [Spryker SDK](https://docs.spryker.com/doc PHP VERSION CHECKER =================== -+---+-----------------------------------------------------------------------------------+------------------------------+ -| # | Message | Target | -+---+-----------------------------------------------------------------------------------+------------------------------+ -| 1 | The deploy file uses a not allowed PHP image version "spryker/php:7.2-alpine3.12" | /deploy.yml | -| | The image tag must contain an allowed PHP version (image:abc-8.0) | | -+---+-----------------------------------------------------------------------------------+------------------------------+ +Message: The deploy file uses a not allowed PHP image version "spryker/php:7.2-alpine3.12". + The image tag must contain an allowed PHP version (image:abc-8.0) +Target: {PATH_TO_PROJECT}/deploy.yml ``` A `deploy.yml` file that produces the error message: @@ -112,14 +106,11 @@ Below is an example of inconsistent PHP versions being used in the `composer.jso PHP VERSION CHECKER =================== -+---+--------------------------------------------+--------------------------------------------------------+ -| # | Message | Target | -+---+--------------------------------------------+--------------------------------------------------------+ -| 1 | Not all the targets have the same PHP versions | Current php version $phpVersion: php7.2 | -| | | tests/Acceptance/_data/InvalidProject/composer.json: - | -| | | tests/Acceptance/_data/InvalidProject/deploy**.yml: - | -| | | SDK php versions: php7.2, php8.2 | -+---+--------------------------------------------+--------------------------------------------------------+ +Message: Not all the targets have the same PHP versions +Target: Current php version $phpVersion: php7.2 + tests/Acceptance/_data/InvalidProject/composer.json: - + tests/Acceptance/_data/InvalidProject/deploy**.yml: - + SDK php versions: php7.2, php8.2 ``` The `composer.json` file uses PHP version `7.2`: @@ -149,7 +140,7 @@ image: ... ``` -Inconsistent PHP versions produces the error message output. +Inconsistent PHP versions produce the error message output. ### Resolving the error diff --git a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/plugin-registration-with-restrintions.md b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/plugin-registration-with-restrintions.md index 7ab1887a127..bddff57f4ff 100644 --- a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/plugin-registration-with-restrintions.md +++ b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/plugin-registration-with-restrintions.md @@ -51,21 +51,18 @@ Below is an example of the annotation syntax needed to register a plugin only af new DefaultProductOfferReferenceStrategyPlugin(), ``` -## Example of an Evaluator error message +## Example of an evaluator error message ```shell ============================================== PLUGINS REGISTRATION WITH RESTRICTIONS CHECKER ============================================== -+---+------------------------------------------------------------------------------------------------------+--------------------------------+ -| # | Message | Target | -+---+------------------------------------------------------------------------------------------------------+--------------------------------+ -| 1 | Restriction rule does not match the pattern "/^\* - (before|after) \{@link (?.+)\}( .*\.|)$/" | CategoryDependencyProvider.php | -+---+------------------------------------------------------------------------------------------------------+--------------------------------+ +Message: Restriction rule does not match the pattern "/^\* - (before|after) \{@link (?.+)\}( .*\.|)$/". +Target: CategoryDependencyProvider.php ``` -## Example of code that causes an upgradability error +## Example of code that causes an evaluator error ```php namespace Pyz\Zed\Category; diff --git a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/security.md b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/security.md index e00fe2bb237..18fbe5f20fe 100644 --- a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/security.md +++ b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/security.md @@ -10,21 +10,18 @@ Security Checker is a tool that checks if your PHP application depends on PHP pa A project can sometimes use dependencies that contain known vulnerabilities.. To minimize the security risk for the project, such dependencies should be updated to the version that has the vulnerability fixed. -## Example of an Evaluator error message +## Example of an evaluator error message ```bash ================ SECURITY CHECKER ================ -+---+---------------------------------------------------------------------------------------------------------------------+-----------------------+ -| # | Message | Target | -+---+---------------------------------------------------------------------------------------------------------------------+-----------------------+ -| 1 | Improper header validation (CVE-2023-29197): https://github.com/guzzle/psr7/security/advisories/GHSA-wxmh-65f7-jcvw | guzzlehttp/psr7:2.4.1 | -+---+---------------------------------------------------------------------------------------------------------------------+-----------------------+ +Message: Improper header validation (CVE-2023-29197): https://github.com/guzzle/psr7/security/advisories/GHSA-wxmh-65f7-jcvw +Target: guzzlehttp/psr7:2.4.1 ``` -## Example of code that causes an upgradability error +## Example of code that causes an evaluator error Your `composer.lock` file contains package versions that have security issues: diff --git a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/single-plugin-argument.md b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/single-plugin-argument.md index bfac10e6573..46edf7fab1c 100644 --- a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/single-plugin-argument.md +++ b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/single-plugin-argument.md @@ -4,11 +4,11 @@ description: Reference information for evaluator tools. template: howto-guide-template --- -This check makes sure that the plugins don't require the complicated constructor arguments. +This check makes sure that the plugins don't require complicated constructor arguments. ## Problem description -Inside of the dependency provider you can register the plugin directly in the method or through another wrap method, with and without constructor arguments. +Inside of the dependency provider, you can register the plugin directly in the method or through another wrap method, with and without constructor arguments. To keep the plugins simple, they shouldn't require complicated objects as constructor arguments. Supported argument types: @@ -22,23 +22,20 @@ Supported argument types: ## Example of evaluator error message ```bash -================ +====================== SINGLE PLUGIN ARGUMENT -================ - -+---+-------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ -| # | Message | Target | -+---+-------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ -| 1 | Plugin \Spryker\Zed\Console\Communication\Plugin\MonitoringConsolePlugin | | -| | should not have unsupported constructor parameters. | \ConsoleDependencyProvider::getMonitoringConsoleMethod | -| | Supported argument types: int, float, string, const, bool, int, usage of new statement to | | -| | instantiate a class (without further methods calls) | | -+---+-------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +====================== + +Message: The "\Spryker\Zed\Console\Communication\Plugin\MonitoringConsolePlugin" plugin + should not have unsupported constructor parameters. + Supported argument types: int, float, string, const, bool, int, usage of new statement to + instantiate a class (without further methods calls). +Target: {PATH_TO_PROJECT}\ConsoleDependencyProvider::getMonitoringConsoleMethod() ``` -## Example of code that causes an upgradability error +## Example of code that causes an evaluator error -The dependency provider method returns the plugin with unwanted argument: +The dependency provider method returns the plugin with the unwanted argument: ```bash namespace Pyz\Zed\SinglePluginArgument; @@ -62,5 +59,5 @@ class ConsoleDependencyProvider ### Resolving the error To resolve the error: -1. Rework the plugin - remove the usage of the complicated constructor arguments. +1. Refactor the plugin - remove the usage of the complicated constructor arguments. diff --git a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/upgradability-guidelines.md b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/upgradability-guidelines.md index 423907eb3a5..9425b961638 100644 --- a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/upgradability-guidelines.md +++ b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/upgradability-guidelines.md @@ -14,13 +14,8 @@ Example: DEPENDENCY PROVIDER ADDITIONAL LOGIC CHECKER ============================================ -+---+----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| # | Message | Target | -+---+----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| 1 | The condition statement if (!static::IS_DEV) {} is forbidden in the DependencyProvider | tests/Acceptance/_data/InvalidProject/src/Pyz/Zed/Console/ConsoleDependencyProvider.php | -+---+----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ - - +Message: In DependencyProvider, the "if (!static::IS_DEV) {}" conditional statement is forbidden. +Target: tests/Acceptance/_data/InvalidProject/src/Pyz/Zed/Console/ConsoleDependencyProvider.php ``` In the example, the name is `DEPENDENCY PROVIDER ADDITIONAL LOGIC CHECKER`. The table bellow describes the error and documentation about it. diff --git a/docs/scos/dev/guidelines/project-development-guidelines.md b/docs/scos/dev/guidelines/project-development-guidelines.md index 8ec20e61661..e7165b42235 100644 --- a/docs/scos/dev/guidelines/project-development-guidelines.md +++ b/docs/scos/dev/guidelines/project-development-guidelines.md @@ -56,7 +56,7 @@ For example, customize the names by adding the project name. ## Avoid using, extending, and overriding Private API -Instead of using, extending, and overriding [Private API](/docs/scos/dev/architecture/module-api/declaration-of-module-apis-public-and-private.html), register the missing extension points in [Spryker ideas](https://spryker.ideas.aha.io/). In future, we will add the registered extension points, and you will be able to extend it via Public API. +Instead of using, extending, and overriding [Private API](/docs/scos/dev/architecture/module-api/declaration-of-module-apis-public-and-private.html), send a request about the missing endpoints to your Spryker account manager. In future, we will add the extension points, and you will be able to extend it via Public API. ## Keep modules up to date diff --git a/docs/scos/dev/guidelines/security-guidelines.md b/docs/scos/dev/guidelines/security-guidelines.md index e001026cc8b..825a6212a07 100644 --- a/docs/scos/dev/guidelines/security-guidelines.md +++ b/docs/scos/dev/guidelines/security-guidelines.md @@ -49,6 +49,94 @@ You can force HTTPS for the Storefront, Back Office, and Glue using the `Strict- * `HttpConstants::GLUE_HTTP_STRICT_TRANSPORT_SECURITY_ENABLED` * `HttpConstants::GLUE_HTTP_STRICT_TRANSPORT_SECURITY_CONFIG` +## Security Headers + +Security headers are directives used by web applications to configure security defenses in web browsers. +Based on these directives, browsers can make it harder to exploit client-side vulnerabilities such as Cross-Site Scripting or Clickjacking. +Headers can also be used to configure the browser to only allow valid TLS communication and enforce valid certificates, +or even enforce using a specific server certificate. + +The sections below detail configure places for various security headers. You can change them at the project level. + +### X-Content-Type-Options, X-Frame-Options, X-XSS-Protection, Content-Security-Policy + +#### Yves +For Yves set of default security headers in: `\Spryker\Yves\Application\ApplicationConfig::getSecurityHeaders()`. + +Default values: + +``` +X-Content-Type-Options: nosniff +X-Frame-Options: SAMEORIGIN +X-XSS-Protection: 1; mode=block +Content-Security-Policy: frame-ancestors 'self'; sandbox allow-downloads allow-forms allow-modals allow-pointer-lock allow-popups allow-popups-to-escape-sandbox allow-same-origin allow-scripts allow-top-navigation; base-uri 'self'; form-action 'self' +``` + +#### Zed + +For Zed set of default security headers in: `\Spryker\Zed\Application\ApplicationConfig::getSecurityHeaders()`. + +Default values: + +``` +X-Content-Type-Options: nosniff +X-Frame-Options: SAMEORIGIN +X-XSS-Protection: 1; mode=block +Content-Security-Policy: frame-ancestors 'self' +``` + +#### Glue + +For Glue set of default security headers in: `\Spryker\Glue\GlueApplication\GlueApplicationConfig::getSecurityHeaders()`. + +Default values: + +``` +X-Content-Type-Options: nosniff +X-Frame-Options: SAMEORIGIN +X-XSS-Protection: 1; mode=block +Content-Security-Policy: frame-ancestors 'self' +``` + +#### Glue Storefront + +Glue is in the set of default security headers in: `\Spryker\Glue\GlueStorefrontApiApplication\GlueStorefrontApiApplicationConfig:::getSecurityHeaders()`. + +Default values: + +``` +X-Content-Type-Options: nosniff +X-Frame-Options: SAMEORIGIN +X-XSS-Protection: 1; mode=block +Content-Security-Policy: frame-ancestors 'self' +``` + +#### Glue Backend + +Glue is in the set of default security headers in: `\Spryker\Glue\GlueBackendApiApplication\GlueBackendApiApplicationConfig::getSecurityHeaders()`. + +Default values: + +``` +X-Content-Type-Options: nosniff +X-Frame-Options: SAMEORIGIN +X-XSS-Protection: 1; mode=block +Content-Security-Policy: frame-ancestors 'self' +``` + +#### Cache-Control header + +You can enable custom Cache-Control header for the Storefront, Back Office, and Glue using plugins: +* `Spryker\Zed\Http\Communication\Plugin\EventDispatcher\CacheControlHeaderEventDispatcherPlugin` plugin can be added into application specific method for Zed `\Pyz\Zed\EventDispatcher::getEventDispatcherPlugins()` +and configure using: `Spryker\Shared\Http\HttpConstants::ZED_HTTP_CACHE_CONTROL_ENABLED`, `Spryker\Shared\Http\HttpConstants::ZED_HTTP_CACHE_CONTROL_CONFIG`. +* `Spryker\Yves\Http\Plugin\EventDispatcher\CacheControlHeaderEventDispatcherPlugin` plugin can be added into application specific method for Yves `\Pyz\Yves\EventDispatcher::getEventDispatcherPlugins()` + and configure using: `Spryker\Shared\Http\HttpConstants::YVES_HTTP_CACHE_CONTROL_ENABLED`, `Spryker\Shared\Http\HttpConstants::YVES_HTTP_CACHE_CONTROL_CONFIG`. +* `Spryker\Glue\Http\Plugin\EventDispatcher\CacheControlHeaderEventDispatcherPlugin` plugin can be added into application specific method for Glue `\Pyz\Glue\EventDispatcher::getEventDispatcherPlugins()` + and configure using: `Spryker\Shared\Http\HttpConstants::GLUE_HTTP_CACHE_CONTROL_ENABLED`, `Spryker\Shared\Http\HttpConstants::GLUE_HTTP_CACHE_CONTROL_CONFIG`. + + + + ## Session security and hijacking Websites include many third-party JavaScript libraries that can access the content of a page. diff --git a/docs/marketplace/dev/technical-enhancement/202212.0/migration-guide-upgrade-to-angular-v12.md b/docs/scos/dev/migration-concepts/upgrade-to-angular-12.md similarity index 97% rename from docs/marketplace/dev/technical-enhancement/202212.0/migration-guide-upgrade-to-angular-v12.md rename to docs/scos/dev/migration-concepts/upgrade-to-angular-12.md index 067d6ab551a..4144b91804f 100644 --- a/docs/marketplace/dev/technical-enhancement/202212.0/migration-guide-upgrade-to-angular-v12.md +++ b/docs/scos/dev/migration-concepts/upgrade-to-angular-12.md @@ -1,20 +1,21 @@ --- -title: Migration guide - Upgrade to Angular v12 +title: Upgrade to Angular 12 description: Use the guide to update versions of the Angular and related modules. template: module-migration-guide-template redirect_from: - /docs/marketplace/dev/front-end/extending-the-project/migration-guide-upgrade-to-angular-v12.html + - /docs/marketplace/dev/technical-enhancement/202212.0/migration-guide-upgrade-to-angular-v12.html --- ## Upgrading from version 9.* to version 12.* This document shows how to upgrade Angular to version 12 in your Spryker project. -### Overview +### Overview Every six months, the Angular community releases a major update, and on 12th May 2021 version 12 of Angular was released. -A version upgrade is necessary for improved performance, stability, and security. Stability allows reusable components and tools and makes medium and large applications thrive and shine. +A version upgrade is necessary for improved performance, stability, and security. Stability allows reusable components and tools and makes medium and large applications thrive and shine. Angular provides regular updates to ensure stability and security. These are major, minor, and small patches. An upgrade from an existing version to a newer version always requires time and changes to the code. @@ -282,7 +283,7 @@ module.exports = { ...nxPreset }; "defaultProject": "merchant-portal" } ``` -
+
`jest.config.js` in the `frontend/merchant-portal/` folder: @@ -323,7 +324,7 @@ import 'jest-preset-angular/setup-jest'; 1. Rename `tsconfig.json` to `tsconfig.base.json` and fix usage in `tsconfig.mp.json`: -**tsconfig.mp.json** +**tsconfig.mp.json** ```json "extends": "./tsconfig.base.json", diff --git a/docs/marketplace/dev/technical-enhancement/202304.0/migration-guide-upgrade-to-angular-v15.md b/docs/scos/dev/migration-concepts/upgrade-to-angular-15.md similarity index 96% rename from docs/marketplace/dev/technical-enhancement/202304.0/migration-guide-upgrade-to-angular-v15.md rename to docs/scos/dev/migration-concepts/upgrade-to-angular-15.md index c6ad826dfaf..5952a905285 100644 --- a/docs/marketplace/dev/technical-enhancement/202304.0/migration-guide-upgrade-to-angular-v15.md +++ b/docs/scos/dev/migration-concepts/upgrade-to-angular-15.md @@ -1,5 +1,5 @@ --- -title: Migration guide - Upgrade to Angular v15 +title: Upgrade to Angular 15 description: Use the guide to update versions of the Angular and related modules. last_updated: Mar 24, 2023 template: module-migration-guide-template @@ -32,9 +32,9 @@ So the update requires a major release for these modules: ### 1) Update modules -1. Upgrade modules to the new version: +1. Upgrade modules to the new version: -The marketplace modules must correspond to the following versions: +The marketplace modules must correspond to the following versions: | NAME | VERSION | | ------------------------------------------- | --------- | @@ -72,9 +72,9 @@ Make sure you are using [Node.js 18 or later](https://nodejs.org/en/download). {% endinfo_block %} -1. In `package.json`, do the following: +1. In `package.json`, do the following: - 1. Update or add the following dependencies: + 1. Update or add the following dependencies: ```json { @@ -151,7 +151,7 @@ Ensure that the `package-lock.json` file and the `node_modules` folder have been 1. In `frontend/merchant-portal` folder, do the following: - 1. Rename the `jest.config.js` file to `jest.config.ts` and replace its content with the following: + 1. Rename the `jest.config.js` file to `jest.config.ts` and replace its content with the following: ```ts export default { @@ -174,7 +174,7 @@ Ensure that the `package-lock.json` file and the `node_modules` folder have been passWithNoTests: true, }; ``` - + 2. In `jest.preset.js`, replace its content with the following: ```js @@ -210,7 +210,7 @@ Ensure that the `package-lock.json` file and the `node_modules` folder have been ] } ``` - + 4. In `webpack.config.ts`, add aliases to resolve imports paths in `.less` files: ```js @@ -220,7 +220,7 @@ Ensure that the `package-lock.json` file and the `node_modules` folder have been }; ``` -2. In `angular.json`, add the following changes: +2. In `angular.json`, add the following changes: 1. Update the `test` section: @@ -235,16 +235,16 @@ Ensure that the `package-lock.json` file and the `node_modules` folder have been // must be "outputs": ["{projectRoot}/coverage"] ``` - + 2. Remove the `defaultProject` section. - + 3. Add the `.angular` folder to `.gitignore` and `.prettierignore` files: ```text /.angular/ ``` -4. In `nx.json`, replace its content with the following: +4. In `nx.json`, replace its content with the following: ```json { @@ -278,7 +278,7 @@ Ensure that the `package-lock.json` file and the `node_modules` folder have been } ``` -5. In `tsconfig.base.json`, add the following changes: +5. In `tsconfig.base.json`, add the following changes: 1. In `compilerOptions` section, change the `target` property and add the new `useDefineForClassFields` property. 2. In `exclude` section, add the `"**/*.test.ts"` file extension. @@ -296,7 +296,7 @@ Ensure that the `package-lock.json` file and the `node_modules` folder have been } ``` -6. In `tsconfig.mp.json`, add the `"src/Pyz/Zed/ZedUi/Presentation/Components/environments/environment.prod.ts"` path to the `include` section: +6. In `tsconfig.mp.json`, add the `"src/Pyz/Zed/ZedUi/Presentation/Components/environments/environment.prod.ts"` path to the `include` section: ```json { @@ -317,7 +317,7 @@ Ensure that the `package-lock.json` file and the `node_modules` folder have been - `tslint.mp-githook.json` - `tslint.mp.json` -2. Add a new `.eslintrc.mp.json` file to the root folder with the following content: +2. Add a new `.eslintrc.mp.json` file to the root folder with the following content: ```json { @@ -422,7 +422,7 @@ Ensure that the `package-lock.json` file and the `node_modules` folder have been }, ``` -4. In `tslint.json`, add the `"src/Pyz/Zed/*/Presentation/Components/**"` path to the `linterOptions.exlude` section: +4. In `tslint.json`, add the `"src/Pyz/Zed/*/Presentation/Components/**"` path to the `linterOptions.exlude` section: ```json { @@ -436,7 +436,7 @@ Ensure that the `package-lock.json` file and the `node_modules` folder have been } ``` -5. Make sure to replace `tslint` disable comments with `eslint`—for example: +5. Make sure to replace `tslint` disable comments with `eslint`—for example: ```ts /* tslint:disable:no-unnecessary-class */ diff --git a/docs/marketplace/dev/howtos/how-to-upgrade-spryker-instance-to-marketplace.md b/docs/scos/dev/migration-concepts/upgrade-to-marketplace.md similarity index 94% rename from docs/marketplace/dev/howtos/how-to-upgrade-spryker-instance-to-marketplace.md rename to docs/scos/dev/migration-concepts/upgrade-to-marketplace.md index 3088c2e9cdd..eafb929ee95 100644 --- a/docs/marketplace/dev/howtos/how-to-upgrade-spryker-instance-to-marketplace.md +++ b/docs/scos/dev/migration-concepts/upgrade-to-marketplace.md @@ -1,12 +1,14 @@ --- -title: "How-To: Upgrade Spryker instance to the Marketplace" +title: Upgrade to Marketplace description: This document provides details how to upgrade Spryker instance to the Marketplace. template: howto-guide-template +redirect_from: + - /docs/marketplace/dev/howtos/how-to-upgrade-spryker-instance-to-marketplace.html --- This document describes how to upgrade the existing instance of Spryker Shop to the Marketplace. -## 1) Add core features +## 1. Add core features Implement the features and functionality of the Marketplace by following the integration guides from the following table. @@ -27,7 +29,7 @@ Implement the features and functionality of the Marketplace by following the int | [Marketplace Shipment](/docs/marketplace/dev/feature-integration-guides/{{site.version}}/marketplace-shipment-feature-integration.html) | The Marketplace orders are split into several shipments based on the merchants from which the items were bought. Merchants can see their shipments only. | | [Marketplace Return Management](/docs/pbc/all/return-management/{{site.version}}/marketplace/install-and-upgrade/install-the-marketplace-return-management-glue-api.html) | Order returns management enhancement for OMS. | -## 2) Add MerchantPortal features +## 2. Add MerchantPortal features Follow feature integration guides from the table that provides functionality for MerchantPortal Application. @@ -40,7 +42,10 @@ Follow feature integration guides from the table that provides functionality for | [Marketplace Merchant Portal Order Management](/docs/marketplace/dev/feature-integration-guides/{{site.version}}/merchant-portal-marketplace-order-management-feature-integration.html) | Allows merchants to manage their orders in the Merchant Portal. | | [ACL](/docs/pbc/all/user-management/{{site.version}}/install-and-upgrade/install-the-acl-feature.html) | Allows managing access to HTTP endpoints and Persistence entities. | -## 3) Build app +## 3. Build and start the instance -Please rebuild your app in order to apply all the changes regarding database entities, data imports, search engine indexes, UI assets. -Depending on the virtualization solution you use, use the recommendations in [Docker based instance build](/docs/scos/dev/set-up-spryker-locally/set-up-spryker-locally.html). +Rebuild your app in order to apply all the changes regarding database entities, data imports, search engine indexes, UI assets: + +```shell +docker/sdk up +``` diff --git a/docs/scos/dev/set-up-spryker-locally/install-spryker/install-docker-prerequisites/install-docker-prerequisites-on-linux.md b/docs/scos/dev/set-up-spryker-locally/install-spryker/install-docker-prerequisites/install-docker-prerequisites-on-linux.md index 6eed0ad99cb..da2be2d05ea 100644 --- a/docs/scos/dev/set-up-spryker-locally/install-spryker/install-docker-prerequisites/install-docker-prerequisites-on-linux.md +++ b/docs/scos/dev/set-up-spryker-locally/install-spryker/install-docker-prerequisites/install-docker-prerequisites-on-linux.md @@ -57,33 +57,15 @@ Signup for Docker Hub is not required. {% endinfo_block %} -2. To enable BuildKit, create or update `/etc/docker/daemon.json`: - -```php -{ - ... - "features" : { - ... - "buildkit" : true - } -} -``` - -3. Restart Docker: - -```bash -/etc/init.d/docker restart -``` - -4. Optional: Configure the `docker` group to manage Docker as a non-root user. See [Manage Docker as a non-root user](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user) for configuration instructions. +2. Optional: Configure the `docker` group to manage Docker as a non-root user. See [Manage Docker as a non-root user](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user) for configuration instructions. -5. Install Docker-compose: +3. Install Docker-compose: ```bash sudo curl -L "https://github.com/docker/compose/releases/download/2.18.1/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose ``` -6. Apply executable permissions to the binary: +4. Apply executable permissions to the binary: ```bash sudo chmod +x /usr/local/bin/docker-compose diff --git a/docs/scos/dev/set-up-spryker-locally/install-spryker/install/install-in-demo-mode-on-macos-and-linux.md b/docs/scos/dev/set-up-spryker-locally/install-spryker/install/install-in-demo-mode-on-macos-and-linux.md index 8d5bae025bb..54eb3f639d7 100644 --- a/docs/scos/dev/set-up-spryker-locally/install-spryker/install/install-in-demo-mode-on-macos-and-linux.md +++ b/docs/scos/dev/set-up-spryker-locally/install-spryker/install/install-in-demo-mode-on-macos-and-linux.md @@ -41,38 +41,37 @@ This document describes how to install Spryker in [Demo Mode](/docs/scos/dev/set ## Clone a Demo Shop and the Docker SDK 1. Open a terminal. -2. Create a folder for the project and navigate into it: -```bash -mkdir spryker-shop && cd spryker-shop -``` - -3. Clone *one* of the following Demo Shops: +2. Clone *one* of the following Demo Shops and navigate into its folder: * B2C Demo Shop: ```shell - git clone https://github.com/spryker-shop/b2c-demo-shop.git -b 202212.0-p2 --single-branch ./ + git clone https://github.com/spryker-shop/b2c-demo-shop.git -b 202212.0-p2 --single-branch ./b2c-demo-shop && \ + cd b2c-demo-shop ``` * B2B Demo Shop: ```shell - git clone https://github.com/spryker-shop/b2b-demo-shop.git -b 202212.0-p2 --single-branch ./ + git clone https://github.com/spryker-shop/b2b-demo-shop.git -b 202212.0-p2 --single-branch ./b2b-demo-shop && \ + cd b2c-demo-shop ``` * B2C Marketplace Demo Shop ```shell - git clone https://github.com/spryker-shop/b2c-demo-marketplace.git -b 202212.0-p2 --single-branch ./ + git clone https://github.com/spryker-shop/b2c-demo-marketplace.git -b 202212.0-p2 --single-branch ./b2c-demo-marketplace && \ + cd b2c-demo-marketplace ``` * B2B Marketplace Demo Shop ```shell - git clone https://github.com/spryker-shop/b2b-demo-marketplace.git -b 202212.0-p2 --single-branch ./ + git clone https://github.com/spryker-shop/b2b-demo-marketplace.git -b 202212.0-p2 --single-branch ./b2b-demo-marketplace && \ + cd b2b-demo-marketplace ``` -5. Clone the Docker SDK: +3. Clone the Docker SDK: ```shell git clone https://github.com/spryker/docker-sdk.git --single-branch docker diff --git a/docs/scos/dev/set-up-spryker-locally/install-spryker/install/install-in-demo-mode-on-windows.md b/docs/scos/dev/set-up-spryker-locally/install-spryker/install/install-in-demo-mode-on-windows.md index 0e8febf2a87..2761203d503 100644 --- a/docs/scos/dev/set-up-spryker-locally/install-spryker/install/install-in-demo-mode-on-windows.md +++ b/docs/scos/dev/set-up-spryker-locally/install-spryker/install/install-in-demo-mode-on-windows.md @@ -28,58 +28,62 @@ Depending on the needed WSL version, follow one of the guides: * [Install Docker prerequisites on Windows with WSL2](/docs/scos/dev/set-up-spryker-locally/install-spryker/install-docker-prerequisites/install-docker-prerequisites-on-windows-with-wsl2.html). -## Install Spryker in Demo mode on Windows +## Clone a Demo Shop and the Docker SDK 1. Open Ubuntu. 2. Open a terminal. 3. Create a new folder and navigate into it. -4. Clone *one* of the [Demo Shops](/docs/scos/user/intro-to-spryker/intro-to-spryker.html#spryker-b2bb2c-demo-shops): +4. Clone *one* of the [Demo Shops](/docs/scos/user/intro-to-spryker/intro-to-spryker.html#spryker-b2bb2c-demo-shops) and navigate into its folder: * B2C Demo Shop: ```shell - git clone https://github.com/spryker-shop/b2c-demo-shop.git -b 202212.0-p2 --single-branch ./b2c-demo-shop + git clone https://github.com/spryker-shop/b2c-demo-shop.git -b 202212.0-p2 --single-branch ./b2c-demo-shop && \ + cd b2c-demo-shop ``` * B2B Demo Shop: ```shell - git clone https://github.com/spryker-shop/b2b-demo-shop.git -b 202212.0-p2 --single-branch ./b2b-demo-shop + git clone https://github.com/spryker-shop/b2b-demo-shop.git -b 202212.0-p2 --single-branch ./b2b-demo-shop && \ + cd b2c-demo-shop ``` -5. Depending on the cloned Demo Shop, navigate into the cloned folder: + * B2C Marketplace Demo Shop - * B2C Demo Shop: - - ```bash - cd b2c-demo-shop + ```shell + git clone https://github.com/spryker-shop/b2c-demo-marketplace.git -b 202212.0-p2 --single-branch ./b2c-demo-marketplace && \ + cd b2c-demo-marketplace ``` - * B2B Demo Shop: + * B2B Marketplace Demo Shop - ```bash - cd b2b-demo-shop + ```shell + git clone https://github.com/spryker-shop/b2b-demo-marketplace.git -b 202212.0-p2 --single-branch ./b2b-demo-marketplace && \ + cd b2b-demo-marketplace ``` {% info_block warningBox "Verification" %} -Make sure that you are in the correct folder by running the `pwd` command. +Make sure that you are in the Demo Shop's folder by running the `pwd` command. -{% endinfo_block %} +{% endinfo_block %} -6. Clone the Docker SDK repository into the same folder: +5. Clone the Docker SDK repository into the same folder: ```shell git clone https://github.com/spryker/docker-sdk.git --single-branch docker ``` -7. Add your user to the `docker` group: +## Configure and start the instance + +1. Add your user to the `docker` group: ```bash sudo usermod -aG docker $USER ``` -8. Bootstrap the local Docker setup for demo: +2. Bootstrap the local Docker setup for demo: ```shell docker/sdk bootstrap @@ -91,7 +95,7 @@ Once you finish the setup, you don't need to run `bootstrap` to start the instan {% endinfo_block %} -9. Update the `hosts` file: +3. Update the `hosts` file: 1. Open the Start menu. 2. In the search field, enter `Notepad`. 3. Right-click *Notepad* and select **Run as administrator**. @@ -118,7 +122,7 @@ Once you finish the setup, you don't need to run `bootstrap` to start the instan 9. Select **File > Save**. 10. Close the file. -10. Build and start the instance: +4. Build and start the instance: ```shell docker/sdk up diff --git a/docs/scos/dev/set-up-spryker-locally/install-spryker/install/install-in-development-mode-on-macos-and-linux.md b/docs/scos/dev/set-up-spryker-locally/install-spryker/install/install-in-development-mode-on-macos-and-linux.md index 8c6dc3e6910..2b89cb8e821 100644 --- a/docs/scos/dev/set-up-spryker-locally/install-spryker/install/install-in-development-mode-on-macos-and-linux.md +++ b/docs/scos/dev/set-up-spryker-locally/install-spryker/install/install-in-development-mode-on-macos-and-linux.md @@ -47,38 +47,37 @@ This document describes how to install Spryker in [Development Mode](/docs/scos/ ## Clone a Demo Shop and the Docker SDK 1. Open a terminal. -2. Create a folder for the project and navigate into it: -```bash -mkdir spryker-shop && cd spryker-shop -``` - -3. Clone *one* of the following Demo Shops: +2. Clone *one* of the following Demo Shops and navigate into its folder: * B2C Demo Shop: ```shell - git clone https://github.com/spryker-shop/b2c-demo-shop.git -b 202212.0-p2 --single-branch ./b2c-demo-shop + git clone https://github.com/spryker-shop/b2c-demo-shop.git -b 202212.0-p2 --single-branch ./b2c-demo-shop && \ + cd b2c-demo-shop ``` * B2B Demo Shop: ```shell - git clone https://github.com/spryker-shop/b2b-demo-shop.git -b 202212.0-p2 --single-branch ./b2b-demo-shop + git clone https://github.com/spryker-shop/b2b-demo-shop.git -b 202212.0-p2 --single-branch ./b2b-demo-shop && \ + cd b2c-demo-shop ``` * B2C Marketplace Demo Shop ```shell - git clone https://github.com/spryker-shop/b2c-demo-marketplace.git -b 202212.0-p2 --single-branch ./ + git clone https://github.com/spryker-shop/b2c-demo-marketplace.git -b 202212.0-p2 --single-branch ./b2c-demo-marketplace && \ + cd b2c-demo-marketplace ``` * B2B Marketplace Demo Shop ```shell - git clone https://github.com/spryker-shop/b2b-demo-marketplace.git -b 202212.0-p2 --single-branch ./ + git clone https://github.com/spryker-shop/b2b-demo-marketplace.git -b 202212.0-p2 --single-branch ./b2b-demo-marketplace && \ + cd b2b-demo-marketplace ``` -5. Clone the Docker SDK: +3. Clone the Docker SDK: ```bash git clone https://github.com/spryker/docker-sdk.git --single-branch docker diff --git a/docs/scos/dev/set-up-spryker-locally/install-spryker/install/install-in-development-mode-on-windows.md b/docs/scos/dev/set-up-spryker-locally/install-spryker/install/install-in-development-mode-on-windows.md index e3214bb2715..c360854065e 100644 --- a/docs/scos/dev/set-up-spryker-locally/install-spryker/install/install-in-development-mode-on-windows.md +++ b/docs/scos/dev/set-up-spryker-locally/install-spryker/install/install-in-development-mode-on-windows.md @@ -29,7 +29,7 @@ This document describes how to install Spryker in [Development Mode](/docs/scos/ * [Install Docker prerequisites on Windows with WSL2](/docs/scos/dev/set-up-spryker-locally/install-spryker/install-docker-prerequisites/install-docker-prerequisites-on-windows-with-wsl2.html). -## Install Spryker in Development mode on Windows +## Clone a Demo Shop and the Docker SDK {% info_block warningBox "Filesystems" %} @@ -49,43 +49,48 @@ Recommended: `/home/jdoe/workspace/project`. * B2C Demo Shop: - ```bash - git clone https://github.com/spryker-shop/b2c-demo-shop.git -b 202212.0-p2 --single-branch ./b2c-demo-shop + ```shell + git clone https://github.com/spryker-shop/b2c-demo-shop.git -b 202212.0-p2 --single-branch ./b2c-demo-shop && \ + cd b2c-demo-shop ``` * B2B Demo Shop: - ```bash - git clone https://github.com/spryker-shop/b2b-demo-shop.git -b 202212.0-p2 --single-branch ./b2b-demo-shop + ```shell + git clone https://github.com/spryker-shop/b2b-demo-shop.git -b 202212.0-p2 --single-branch ./b2b-demo-shop && \ + cd b2c-demo-shop ``` -5. Depending on the Demo Shop you've cloned, navigate into the cloned folder: - - * B2C Demo Shop: + * B2C Marketplace Demo Shop - ```bash - cd b2c-demo-shop + ```shell + git clone https://github.com/spryker-shop/b2c-demo-marketplace.git -b 202212.0-p2 --single-branch ./b2c-demo-marketplace && \ + cd b2c-demo-marketplace ``` - * B2B Demo Shop: + * B2B Marketplace Demo Shop - ```bash - cd b2b-demo-shop + ```shell + git clone https://github.com/spryker-shop/b2b-demo-marketplace.git -b 202212.0-p2 --single-branch ./b2b-demo-marketplace && \ + cd b2b-demo-marketplace ``` {% info_block warningBox "Verification" %} -Make sure that you are in the correct folder by running the `pwd` command. +Make sure that you are in the Demo Shop's folder by running the `pwd` command. {% endinfo_block %} -6. Clone the Docker SDK: +5. Clone the Docker SDK: ```bash git clone https://github.com/spryker/docker-sdk.git --single-branch docker ``` -7. In `{shop_name}/docker/context/php/debug/etc/php/debug.conf.d/69-xdebug.ini`, set `xdebug.remote_host` and `xdebug.client_host` to `host.docker.internal`: +## Configure and start the instance + + +1. In `{shop_name}/docker/context/php/debug/etc/php/debug.conf.d/69-xdebug.ini`, set `xdebug.remote_host` and `xdebug.client_host` to `host.docker.internal`: ```text ... @@ -94,13 +99,13 @@ xdebug.remote_host=host.docker.internal xdebug.client_host=host.docker.internal ``` -8. Add your user to the `docker` group: +2. Add your user to the `docker` group: ```bash sudo usermod -aG docker $USER ``` -9. Bootstrap local docker setup: +3. Bootstrap local docker setup: ```bash docker/sdk bootstrap deploy.dev.yml @@ -112,7 +117,7 @@ Once you finish the setup, you don't need to run `bootstrap` to start the instan {% endinfo_block %} -10. Update the hosts file based on the output of the previous step: +4. Update the hosts file based on the output of the previous step: 1. Open the Start menu. 2. In the search field, enter `Notepad`. 3. Right-click **Notepad** and select **Run as administrator**. @@ -132,7 +137,7 @@ Once you finish the setup, you don't need to run `bootstrap` to start the instan 9. Click **File > Save**. 10. Close the file. -11. Build and start the instance: +5. Build and start the instance: ```bash docker/sdk up diff --git a/docs/scos/dev/set-up-spryker-locally/set-up-spryker-locally.md b/docs/scos/dev/set-up-spryker-locally/set-up-spryker-locally.md index 531a0d48ca8..0c033474312 100644 --- a/docs/scos/dev/set-up-spryker-locally/set-up-spryker-locally.md +++ b/docs/scos/dev/set-up-spryker-locally/set-up-spryker-locally.md @@ -6,6 +6,8 @@ last_updated: Jun 23, 2023 redirect_from: - /docs/about-installation - /docs/scos/dev/setup/setup.html + - /docs/marketplace/dev/setup/202212.0/setup.html + - /docs/scos/dev/setup/installing-spryker-with-docker/installing-spryker-with-docker.html --- This section contains instructions for installing Spryker Cloud Commerce OS (SCCOS) locally. Local instances are used for development, demos, and experimentation purposes. To launch a live shop, [contact us](https://spryker.com/contact-us-commerce/). diff --git a/docs/scos/dev/system-requirements/202212.0/system-requirements.md b/docs/scos/dev/system-requirements/202212.0/system-requirements.md index c5bfe2a20f4..05f7a78839a 100644 --- a/docs/scos/dev/system-requirements/202212.0/system-requirements.md +++ b/docs/scos/dev/system-requirements/202212.0/system-requirements.md @@ -26,6 +26,7 @@ redirect_from: - /v4/docs/en/supported-browsers - /docs/scos/dev/set-up-spryker-locally/system-requirements.html - /docs/scos/dev/set-up-spryker-locally/installing-spryker-with-development-virtual-machine/devvm-system-requirements.html +- /docs/marketplace/dev/setup/202212.0/system-requirements.html --- | REQUIREMENT | VALUE | |-------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -43,3 +44,22 @@ redirect_from: | npm | Version >= 8.0.0 | | Intranet | Back Office application (Zed) must be secured in an Intranet (using VPN, Basic Auth, IP Allowlist or DMZ.) | | Available languages | Spryker is available in the following languages:
  • German
  • English
Spryker offers full UTF-8 left-to-right language support. | + + +## Spryker Marketplace system requirements + +| OPERATING SYSTEM | NATIVE: LINUX-ONLY THROUGH VM: MACOS AND MS WINDOWS | +|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Web Server | NginX—preferred. But any webserver which supports PHP will work such as lighttpd, Apache, Cherokee. | +| Databases | Depending on the project, one of the databases: MariaDB >= 10.4—preferred, PostgreSQL >=9.6, or MySQL >=5.7. | +| PHP | Spryker supports PHP `>=8.0` with the following extensions: `curl`, `json`, `mysql`, `pdo-sqlite`, `sqlite3`, `gd`, `intl`, `mysqli`, `pgsql`, `ssh2`, `gmp`, `mcrypt`, `pdo-mysql`, `readline`, `twig`, `imagick`, `memcache`, `pdo-pgsql`, `redis`, `xml`, `bz2`, `mbstring`. For details about the supported PHP versions, see [Supported Versions of PHP](/docs/scos/user/intro-to-spryker/whats-new/supported-versions-of-php.html). | +| SSL | For production systems, a valid security certificate is required for HTTPS. | +| Redis | Version >=3.2, >=5.0 | +| Elasticsearch | Version 6.*x* or 7.*x* | +| RabbitMQ | Version 3.6+ | +| Jenkins (for cronjob management) | Version 1.6.*x* or 2.*x* | +| Graphviz (for statemachine visualization) | 2.*x* | +| Symfony | Version >= 4.0 | +| Node.js | Version >= 16.0.0 | +| Intranet | Back Office application (Zed) must be secured in an Intranet (using VPN, Basic Auth, IP Allowlist, and DMZ) | +| Spryker Commerce OS | Version >= {{page.version}} | diff --git a/docs/scos/dev/system-requirements/202304.0/system-requirements.md b/docs/scos/dev/system-requirements/202304.0/system-requirements.md index d9be1c09d6e..e006769ac3f 100644 --- a/docs/scos/dev/system-requirements/202304.0/system-requirements.md +++ b/docs/scos/dev/system-requirements/202304.0/system-requirements.md @@ -43,3 +43,22 @@ redirect_from: | npm | Version >= 9.0.0 | | Intranet | Back Office application (Zed) must be secured in an Intranet (using VPN, Basic Auth, IP allowlist, or DMZ). | | Available languages | Spryker is available in the following languages:
  • German
  • English
Spryker offers full UTF-8 left-to-right language support. | + + +## Spryker Marketplace system requirements + +| OPERATING SYSTEM | NATIVE: LINUXONLY tHROUGH VM: MACOS AND MS WINDOWS | +|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Web Server | NginX—preferred. But any webserver which supports PHP will work such as lighttpd, Apache, Cherokee. | +| Databases | Depending on the project, one of the databases: MariaDB >= 10.4—preferred, PostgreSQL >=9.6, or MySQL >=5.7. | +| PHP | Spryker supports PHP `>=8.0` with the following extensions: `curl`, `json`, `mysql`, `pdo-sqlite`, `sqlite3`, `gd`, `intl`, `mysqli`, `pgsql`, `ssh2`, `gmp`, `mcrypt`, `pdo-mysql`, `readline`, `twig`, `imagick`, `memcache`, `pdo-pgsql`, `redis`, `xml`, `bz2`, `mbstring`. For details about the supported PHP versions, see [Supported Versions of PHP](/docs/scos/user/intro-to-spryker/whats-new/supported-versions-of-php.html). | +| SSL | For production systems, a valid security certificate is required for HTTPS. | +| Redis | Version >=3.2, >=5.0 | +| Elasticsearch | Version 6.*x* or 7.*x* | +| RabbitMQ | Version 3.6+ | +| Jenkins (for cronjob management) | Version 1.6.*x* or 2.*x* | +| Graphviz (for statemachine visualization) | 2.*x* | +| Symfony | Version >= 4.0 | +| Node.js | Version >= 18.0.0 | +| Intranet | Back Office application (Zed) must be secured in an Intranet (using VPN, Basic Auth, IP Allowlist, and DMZ) | +| Spryker Commerce OS | Version >= {{page.version}} | diff --git a/docs/scos/dev/technical-enhancement-integration-guides/integrate-multi-database-logic.md b/docs/scos/dev/technical-enhancement-integration-guides/integrate-multi-database-logic.md index b924ba8c88c..f6a2cfc0e81 100644 --- a/docs/scos/dev/technical-enhancement-integration-guides/integrate-multi-database-logic.md +++ b/docs/scos/dev/technical-enhancement-integration-guides/integrate-multi-database-logic.md @@ -28,8 +28,8 @@ regions: name: Spryker No-Reply email: no-reply@spryker.local databases: - eu-region-db-de: - eu-region-db-at: + eu-region-db-one: + eu-region-db-two: ... ``` diff --git a/docs/scos/dev/the-docker-sdk/202212.0/configure-services.md b/docs/scos/dev/the-docker-sdk/202212.0/configure-services.md index b00ec12f38e..4953e31903f 100644 --- a/docs/scos/dev/the-docker-sdk/202212.0/configure-services.md +++ b/docs/scos/dev/the-docker-sdk/202212.0/configure-services.md @@ -72,7 +72,7 @@ When configuring a service, you need to define its version. The Docker SDK suppo | | | mariadb-10.3 | ✓ | | | | | mariadb-10.4 | ✓ | | | | | mariadb-10.5 | ✓ | | -| broke | rabbitmq | 3.7 | | | +| broker | rabbitmq | 3.7 | | | | | | 3.8 | ✓ | | | | | 3.9 | ✓ | | | session | redis | 5.0 | ✓ | | diff --git a/docs/scos/dev/the-docker-sdk/202212.0/the-docker-sdk.md b/docs/scos/dev/the-docker-sdk/202212.0/the-docker-sdk.md index c26cc34eadc..56cf95ed2a1 100644 --- a/docs/scos/dev/the-docker-sdk/202212.0/the-docker-sdk.md +++ b/docs/scos/dev/the-docker-sdk/202212.0/the-docker-sdk.md @@ -238,7 +238,7 @@ To extend Docker/sdk, you can do the following: ``` This approach is compatible with SCCOS, but provides limited customization possibilities. -- To introduce "mocks" for development and CI/CD testing, you can use the [Docker-compose extension](https://docs.docker.com/compose/extends/): +- To introduce "mocks" for development and CI/CD testing, you can use the [Docker-compose extension](https://docs.docker.com/compose/compose-file/11-extension/): ``` docker: compose: diff --git a/docs/scos/dev/tutorials-and-howtos/howtos/about-howtos.md b/docs/scos/dev/tutorials-and-howtos/howtos/about-howtos.md index 426d7913f53..fb71a90cda9 100644 --- a/docs/scos/dev/tutorials-and-howtos/howtos/about-howtos.md +++ b/docs/scos/dev/tutorials-and-howtos/howtos/about-howtos.md @@ -34,7 +34,7 @@ HowTos are simple step-by-step instructions to guide you through the process of -**Glue API HowTos** provide guides and instructions for tasks related to [Spryker Glue Rest API](/docs/scos/dev/glue-api-guides/{{site.version}}/glue-rest-api.html). These guides walk you through the following topics: +**Glue API HowTos** provide guides and instructions for tasks related to [Spryker Glue Rest API](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/glue-rest-api.html). These guides walk you through the following topics: * [Configuring visibility of the included section](/docs/scos/dev/tutorials-and-howtos/howtos/glue-api-howtos/configuring-visibility-of-the-included-section.html) * [Configuring Glue for cross-origin requests](/docs/scos/dev/tutorials-and-howtos/howtos/glue-api-howtos/configuring-glue-for-cross-origin-requests.html) diff --git a/docs/scos/dev/tutorials-and-howtos/howtos/glue-api-howtos/glue-api-howtos.md b/docs/scos/dev/tutorials-and-howtos/howtos/glue-api-howtos/glue-api-howtos.md index c40ff8aed60..d1206c01a1d 100644 --- a/docs/scos/dev/tutorials-and-howtos/howtos/glue-api-howtos/glue-api-howtos.md +++ b/docs/scos/dev/tutorials-and-howtos/howtos/glue-api-howtos/glue-api-howtos.md @@ -21,10 +21,10 @@ redirect_from: - /v2/docs/en/about-glue-api-howtos related: - title: Glue REST API - link: docs/scos/dev/glue-api-guides/page.version/glue-rest-api.html + link: docs/scos/dev/glue-api-guides/page.version/old-glue-infrastructure/glue-rest-api.html --- -Glue API HowTo tutorials provide guides and instructions for tasks related to [Spryker Glue Rest API](/docs/scos/dev/glue-api-guides/{{site.version}}/glue-rest-api.html). +Glue API HowTo tutorials provide guides and instructions for tasks related to [Spryker Glue Rest API](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/glue-rest-api.html). From these guides, you can learn how to perform the following tasks: diff --git a/docs/marketplace/dev/howtos/how-to-create-a-new-angular-module-with-application.md b/docs/scos/dev/tutorials-and-howtos/howtos/howto-create-an-angular-module-with-application.md similarity index 96% rename from docs/marketplace/dev/howtos/how-to-create-a-new-angular-module-with-application.md rename to docs/scos/dev/tutorials-and-howtos/howtos/howto-create-an-angular-module-with-application.md index 560c1339d2a..1758e9f0a34 100644 --- a/docs/marketplace/dev/howtos/how-to-create-a-new-angular-module-with-application.md +++ b/docs/scos/dev/tutorials-and-howtos/howtos/howto-create-an-angular-module-with-application.md @@ -1,5 +1,5 @@ --- -title: "HowTo: Create a new Angular module with application" +title: "HowTo: Create an Angular module with application" last_updated: Jan 17, 2023 description: This document shows how to create a new Angular module with the application template: howto-guide-template @@ -21,7 +21,7 @@ A new Angular module needs a proper scaffolding structure. The necessary list of files is provided in the [Project structure document, Module structure section](/docs/marketplace/dev/front-end/{{site.version}}/project-structure.html#module-structure). Each new Angular module can contain its own set of Twig Web Components. -## 2) Register a new Angular module +## 2) Register aт Angular module To register components, a special Angular module is created. The `components.module.ts` file contains a list of all Angular components exposed as Web Components. diff --git a/docs/marketplace/dev/howtos/how-to-split-products-by-stores.md b/docs/scos/dev/tutorials-and-howtos/howtos/howto-split-products-by-stores.md similarity index 99% rename from docs/marketplace/dev/howtos/how-to-split-products-by-stores.md rename to docs/scos/dev/tutorials-and-howtos/howtos/howto-split-products-by-stores.md index e5f59cd39c0..51f9af84f94 100644 --- a/docs/marketplace/dev/howtos/how-to-split-products-by-stores.md +++ b/docs/scos/dev/tutorials-and-howtos/howtos/howto-split-products-by-stores.md @@ -1,7 +1,9 @@ --- -title: "How-To: Split products by stores" +title: "HowTo: Split products by stores" description: This document provides details about how to split products by stores. template: howto-guide-template +redirect_from: + - /docs/marketplace/dev/howtos/how-to-split-products-by-stores.html related: - title: Persistence ACL feature walkthrough link: docs/marketplace/dev/feature-walkthroughs/page.version/persistence-acl-feature-walkthrough/persistence-acl-feature-walkthrough.html diff --git a/docs/scos/user/intro-to-spryker/b2b-suite.md b/docs/scos/user/intro-to-spryker/b2b-suite.md index 66bfbb7ab5f..b7a5f94b47d 100644 --- a/docs/scos/user/intro-to-spryker/b2b-suite.md +++ b/docs/scos/user/intro-to-spryker/b2b-suite.md @@ -65,7 +65,7 @@ The Spryker B2B Suite is a collection of ready-to-use B2B-specific features. Of - [Reorder](/docs/pbc/all/customer-relationship-management/{{site.version}}/reorder-feature-overview.html) - [Shipment](/docs/scos/user/features/{{site.version}}/shipment-feature-overview.html) - [Agent Assist](/docs/pbc/all/user-management/{{site.version}}/agent-assist-feature-overview.html) -- [Payments](/docs/pbc/all/payment-service-provider/{{site.version}}/payments-feature-overview.html) +- [Payments](/docs/pbc/all/payment-service-provider/{{site.version}}/spryker-pay/base-shop/payments-feature-overview.html) - [Checkout](/docs/scos/user/features/{{site.version}}/checkout-feature-overview/checkout-feature-overview.html) - [Mailing & Notifications](/docs/pbc/all/emails/{{site.version}}/emails.html) diff --git a/docs/scos/user/intro-to-spryker/b2c-suite.md b/docs/scos/user/intro-to-spryker/b2c-suite.md index fbaca67f655..190c9442c09 100644 --- a/docs/scos/user/intro-to-spryker/b2c-suite.md +++ b/docs/scos/user/intro-to-spryker/b2c-suite.md @@ -51,7 +51,7 @@ The Spryker B2С Suite is a collection of ready-to-use B2С-specific features. O - [Reorder](/docs/pbc/all/customer-relationship-management/{{site.version}}/reorder-feature-overview.html) - [Shipment](/docs/scos/user/features/{{site.version}}/shipment-feature-overview.html) - [Agent Assist](/docs/pbc/all/user-management/{{site.version}}/agent-assist-feature-overview.html) -- [Payments](/docs/pbc/all/payment-service-provider/{{site.version}}/payments-feature-overview.html) +- [Payments](/docs/pbc/all/payment-service-provider/{{site.version}}/spryker-pay/base-shop/payments-feature-overview.html) - [Gift cards](/docs/pbc/all/gift-cards/{{site.version}}/gift-cards.html) - [Checkout](/docs/scos/user/features/{{site.version}}/checkout-feature-overview/checkout-feature-overview.html) diff --git a/docs/scos/user/intro-to-spryker/docs-release-notes.md b/docs/scos/user/intro-to-spryker/docs-release-notes.md index ed1eedb0930..7f045132293 100644 --- a/docs/scos/user/intro-to-spryker/docs-release-notes.md +++ b/docs/scos/user/intro-to-spryker/docs-release-notes.md @@ -10,27 +10,27 @@ In June 2023, we have added and updated the following pages: ### New pages - [Security release notes 202306.0](/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202306.0/security-release-notes-202306.0.html). - [Oryx: Presets](/docs/scos/dev/front-end-development/202212.0/oryx/oryx-presets.html): Learn how you can use presets to install predefined applications. -- [Service Points feature integration guide](/docs/scos/dev/feature-integration-guides/202304.0/install-the-service-points-feature.html). -- [Shipment + Service Points feature integration guide](/docs/scos/dev/feature-integration-guides/202304.0/install-the-shipment-service-points-feature.html). +- [Service Points feature integration guide](/docs/pbc/all/service-points/202400.0/unified-commerce/install-the-service-points-feature.html). +- [Shipment + Service Points feature integration guide](/docs/pbc/all/carrier-management/202400.0/unified-commerce/install-and-upgrade/install-the-shipment-service-points-feature.html). - [Backend API - Glue JSON:API Convention integration](/docs/scos/dev/feature-integration-guides/202304.0/glue-api/install-backend-api-glue-json-api-convention.html). - Documentation on shipment data import: - - [File details - shipment_method_shipment_type.csv](/docs/pbc/all/carrier-management/202304.0/base-shop/import-and-export-data/file-details-shipment-method-shipment-type.csv.html). - - [File details - shipment_type_store.csv](/docs/pbc/all/carrier-management/202304.0/base-shop/import-and-export-data/file-details-shipment-type-store.csv.html). - - [File details - shipment_type.csv](/docs/pbc/all/carrier-management/202304.0/base-shop/import-and-export-data/file-details-shipment-type.csv.html). + - [File details - shipment_method_shipment_type.csv](/docs/pbc/all/carrier-management/202400.0/unified-commerce/import-and-export-data/file-details-shipment-method-shipment-type.csv.html). + - [File details - shipment_type_store.csv](/docs/pbc/all/carrier-management/202400.0/unified-commerce/import-and-export-data/file-details-shipment-type-store.csv.html). + - [File details - shipment_type.csv](/docs/pbc/all/carrier-management/202400.0/unified-commerce/import-and-export-data/file-details-shipment-type.csv.html). - [Migration guide - Upgrade Node.js to v18 and npm to v9](/docs/scos/dev/front-end-development/202212.0/migration-guide-upgrade-nodejs-to-v18-and-npm-to-v9.html). - [Spryker documentation style guide](/docs/scos/user/intro-to-spryker/contribute-to-the-documentation/spryker-documentation-style-guide/spryker-documentation-style-guide.html): - [Examples](/docs/scos/user/intro-to-spryker/contribute-to-the-documentation/spryker-documentation-style-guide/examples.html). - [Spelling](/docs/scos/user/intro-to-spryker/contribute-to-the-documentation/spryker-documentation-style-guide/spelling.html). ## Updated pages -- [Shipment feature integration guide](/docs/pbc/all/carrier-management/202304.0/base-shop/install-and-upgrade/install-the-shipment-feature.html). +- [Shipment feature integration guide](/docs/pbc/all/carrier-management/202400.0/unified-commerce/install-and-upgrade/install-the-shipment-feature.html). - [Environments overview](/docs/cloud/dev/spryker-cloud-commerce-os/environments-overview.html). -- [Spryker Core Back Office + Warehouse User Management feature integration guide](/docs/pbc/all/back-office/202304.0/install-spryker-core-back-office-warehouse-user-management-feature.html). -- [Warehouse User Management feature integration guide](/docs/pbc/all/warehouse-management-system/202304.0/base-shop/install-and-upgrade/install-the-warehouse-user-management-feature.html). -- [Warehouse picking feature integration guide](/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-feature.html). -- [Push notification feature integration guide](/docs/scos/dev/feature-integration-guides/202304.0/install-the-push-notification-feature.html). -- [Product Offer Shipment feature integration guide](/docs/scos/dev/feature-integration-guides/202304.0/install-the-product-offer-shipment-feature.html). -- [Service Points feature integration guide](/docs/scos/dev/feature-integration-guides/202304.0/install-the-service-points-feature.html). +- [Spryker Core Back Office + Warehouse User Management feature integration guide](/docs/pbc/all/back-office/202400.0/unified-commerce/install-and-upgrade/install-the-spryker-core-back-office-warehouse-user-management-feature.html). +- [Warehouse User Management feature integration guide](/docs/pbc/all/warehouse-management-system/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-user-management-feature.html). +- [Warehouse picking feature integration guide](/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-feature.html). +- [Push notification feature integration guide](/docs/pbc/all/push-notification/202400.0/unified-commerce/install-and-upgrade/install-the-push-notification-feature.html). +- [Product offer shipment feature integration guide](/docs/pbc/all/offer-management/202400.0/unified-commerce/install-and-upgrade/install-the-product-offer-shipment-feature.html). +- [Service Points feature integration guide](/docs/pbc/all/service-points/202400.0/unified-commerce/install-the-service-points-feature.html). - [Additional logic in dependency provider](/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/additional-logic-in-dependency-provider.html): Resolve issues with additional logic in dependency provider. - [Dead code checker](/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/dead-code-checker.html): Check if there is dead code that extends core classes in your project. - [Minimum allowed shop version](/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/minimum-allowed-shop-version.html): Learn how to resolve issues with project upgradability when your projects contains old package dependencies that are already not supported. @@ -116,20 +116,20 @@ In April 2023, we have added and updated the following pages: - [Connect the Upgrader to a project self-hosted with GitLab](/docs/scu/dev/onboard-to-spryker-code-upgrader/connect-spryker-ci-to-a-project-self-hosted-with-gitlab.html): Learn how to connect the Spryker Code Upgrader manually using a Gitlab CE/EE access token. - [Updating Spryker](/docs/scos/dev/updating-spryker/updating-spryker.html#spryker-product-structure): Learn how and when to update your Spryker project. - Warehouse picking feature integration guides: - - [Install the Warehouse picking feature](/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-feature.html) + - [Install the Warehouse picking feature](/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-feature.html) - [Install the Picker user login feature](/docs/scos/dev/feature-integration-guides/202304.0/install-the-picker-user-login-feature.html) - - [Install the Warehouse picking + Inventory Management feature](/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-inventory-management-feature.html) + - [Install the Warehouse picking + Inventory Management feature](/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-inventory-management-feature.html) - [Install the Warehouse picking + Order Management feature](/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-order-management-feature.html) - - [Install the Warehouse picking + Product feature](/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-product-feature.html) - - [Install the Warehouse picking + Shipment feature](/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-shipment-feature.html) - - [Install the Warehouse picking + Spryker Core Back Office feature](/docs/scos/dev/feature-integration-guides/202304.0/install-the-warehouse-picking-spryker-core-back-office-feature.html) + - [Install the Warehouse picking + Product feature](/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-order-management-feature.html) + - [Install the Warehouse picking + Shipment feature](/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-shipment-feature.html) + - [Install the Warehouse picking + Spryker Core Back Office feature](/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-spryker-core-back-office-feature.html) - [Security release notes 202304.0](/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202304.0/security-release-notes-202304.0.html) - [Releases vs Customization types](/docs/sdk/dev/releases-vs-customization-types.html): Learn about the customization strategies and release types you can use to integrate releases and customize your project. ### Updated pages -- [Install the Spryker Core Back Office + Warehouse User Management feature](/docs/pbc/all/back-office/202304.0/install-spryker-core-back-office-warehouse-user-management-feature.html) +- [Install the Spryker Core Back Office + Warehouse User Management feature](/docs/pbc/all/back-office/202400.0/unified-commerce/install-and-upgrade/install-the-spryker-core-back-office-warehouse-user-management-feature.html) - [Install the Spryker Core Back Office feature](/docs/pbc/all/back-office/202304.0/install-the-spryker-core-back-office-feature.html) - [Product + Category feature integration](/docs/pbc/all/product-information-management/202304.0/base-shop/install-and-upgrade/install-features/install-the-product-category-feature.html) -- [Install the Shipment feature](/docs/pbc/all/carrier-management/202304.0/base-shop/install-and-upgrade/install-the-shipment-feature.html) +- [Install the Shipment feature](/docs/pbc/all/carrier-management/202400.0/unified-commerce//install-and-upgrade/install-the-shipment-feature.html) -For more details on the latest additions and updates to the Spryker docs, refer to the [docs release notes page on GitHub](https://github.com/spryker/spryker-docs/releases). +For more details about the latest additions and updates to the Spryker docs, refer to the [docs release notes page on GitHub](https://github.com/spryker/spryker-docs/releases). diff --git a/docs/scos/user/intro-to-spryker/intro-to-spryker.md b/docs/scos/user/intro-to-spryker/intro-to-spryker.md index 72ed4e3b769..7d0a198a84f 100644 --- a/docs/scos/user/intro-to-spryker/intro-to-spryker.md +++ b/docs/scos/user/intro-to-spryker/intro-to-spryker.md @@ -105,6 +105,6 @@ This documentation site contains lots of information on Spryker Commerce OS. Sel * [What's new](/docs/scos/user/intro-to-spryker/whats-new/whats-new.html): general information about Spryker, news, and release notes. * [Setup](/docs/scos/dev/set-up-spryker-locally/set-up-spryker-locally.html): installation of Spryker. * [Packaged Business Capabilities](/docs/pbc/all/pbc.html): catalogue of functionality and related guides. -* [Glue REST API](/docs/scos/dev/glue-api-guides/{{site.version}}/glue-rest-api.html): Spryker Glue REST API overview, reference, and features. +* [Glue REST API](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/glue-rest-api.html): Spryker Glue REST API overview, reference, and features. * [Developer Guides](/docs/scos/dev/developer-getting-started-guide.html): technical information and guides for developers. * [Tutorials](/docs/scos/dev/tutorials-and-howtos/tutorials-and-howtos.html): tutorials and HowTos. diff --git a/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-2018.12.0.md b/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-2018.12.0.md index 9ee460091b4..f310a6d06a6 100644 --- a/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-2018.12.0.md +++ b/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-2018.12.0.md @@ -72,8 +72,8 @@ Your customers can benefit from the same shop experience with the customer accou To help you keep track of your API development, we implemented a simple command that will create a YAML file to be used in your Swagger implementation to share the progress of development in your company. **Documentation**: -* [REST API B2B Demo Shop reference](/docs/scos/dev/glue-api-guides/{{site.version}}/rest-api-b2b-reference.html). -* [REST API B2C Demo Shop reference](/docs/scos/dev/glue-api-guides/{{site.version}}/rest-api-b2c-reference.html) +* [REST API B2B Demo Shop reference](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/rest-api-b2b-reference.html). +* [REST API B2C Demo Shop reference](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/rest-api-b2c-reference.html) ## B2C API React Example ![B2C API React example](https://spryker.s3.eu-central-1.amazonaws.com/docs/About/Releases/Release+notes/Release+Notes+2018.12.0/image2.png) diff --git a/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-201903.0/release-notes-201903.0.md b/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-201903.0/release-notes-201903.0.md index 71a3ec5bae9..a82ad429454 100644 --- a/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-201903.0/release-notes-201903.0.md +++ b/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-201903.0/release-notes-201903.0.md @@ -164,7 +164,7 @@ With the market showing an increasing number of marketplaces, Spryker has integr Customer payments can now be split in the background and assigned to the corresponding vendors when a client buys a product delivered by different vendors. This feature ensures customers can buy several units of the same product sold by different vendors while still going through the checkout with one single order and one single payment. -**Documentation**: [Integrating the Split-payment Marketplace payment method for Heidelpay](/docs/pbc/all/payment-service-provider/{{site.version}}/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.html). +**Documentation**: [Integrating the Split-payment Marketplace payment method for Heidelpay](/docs/pbc/all/payment-service-provider/{{site.version}}/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-split-payment-marketplace-payment-method-for-heidelpay.html). ### Adyen Our recently finished Adyen integration covers a wide range of payment methods used both in the DACH region as well as outside of it, thus making sure customers can select the most appropriate payment method. diff --git a/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-201907.0/release-notes-201907.0.md b/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-201907.0/release-notes-201907.0.md index 6ef62c85bd7..ce851f313c1 100644 --- a/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-201907.0/release-notes-201907.0.md +++ b/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-201907.0/release-notes-201907.0.md @@ -148,7 +148,7 @@ In many cases, you may decide to provide your buyers and users with alternative **Documentation**: -* [Interact with third party payment providers using Glue API](/docs/pbc/all/payment-service-provider/{{site.version}}/interact-with-third-party-payment-providers-using-glue-api.html) +* [Interact with third party payment providers using Glue API](/docs/pbc/all/payment-service-provider/{{site.version}}/spryker-pay/base-shop/interact-with-third-party-payment-providers-using-glue-api.html) * [B2B-B2C Checking Out Purchases and Getting Checkout Data](/docs/scos/dev/glue-api-guides/201907.0/checking-out/checking-out-purchases.html) Additionally, the following APIs were modified to support B2B use cases (they work now both for B2C and B2B) : @@ -260,7 +260,7 @@ We have extended our Payone module with the cash-on-delivery payment method. Thi ### Heidelpay Easycredit We have extended our existing Heidelpay module with the payment method Easycredit, which allows customers to pay via an installment plan. This can help to increase your conversion rates of more expensive products and services. -**Documentation**: [Integrating the Easy Credit payment method for Heidelpay](/docs/pbc/all/payment-service-provider/{{site.version}}/third-party-integrations/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html) +**Documentation**: [Integrating the Easy Credit payment method for Heidelpay](/docs/pbc/all/payment-service-provider/{{site.version}}/heidelpay/integrate-payment-methods-for-heidelpay/integrate-the-easy-credit-payment-method-for-heidelpay.html) ### RatePay We have extended our partner portfolio with a RatePay integration that offers 4 payment methods out-of-the-box: @@ -285,7 +285,7 @@ We now have a new integration of our new partner Episerver and their online plat ### Easycredit Direct Integration We have now a new integration of our new partner TeamBank AG and their payment method ratenkauf by easyCredit, which allows customers to pay via an installment plan. This can help to increase your conversion rates of the more expensive products and services. -**Documentation**: [Installing and configuring ratenkauf by easyCredit](/docs/pbc/all/payment-service-provider/{{site.version}}/third-party-integrations/ratenkauf-by-easycredit/install-and-configure-ratenkauf-by-easycredit.html) +**Documentation**: [Installing and configuring ratenkauf by easyCredit](/docs/pbc/all/payment-service-provider/{{site.version}}/ratenkauf-by-easycredit/install-and-configure-ratenkauf-by-easycredit.html) ### CrefoPay We now have an integration with our new payment partner CrefoPay, which will provide the following payment methods out-of-the-box including partial operations and B2B: @@ -297,7 +297,7 @@ We now have an integration with our new payment partner CrefoPay, which will pro * Sofort * Cash on Delivery -**Documentation**: [CrefoPay](/docs/pbc/all/payment-service-provider/{{site.version}}/third-party-integrations/crefopay/install-and-configure-crefopay.html) +**Documentation**: [CrefoPay](/docs/pbc/all/payment-service-provider/{{site.version}}/crefopay/install-and-configure-crefopay.html) *** ## Technical Enhancements diff --git a/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202306.0/security-release-notes-202306.0.md b/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202306.0/security-release-notes-202306.0.md index c252b8254c6..a6b0b2cbca0 100644 --- a/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202306.0/security-release-notes-202306.0.md +++ b/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202306.0/security-release-notes-202306.0.md @@ -174,6 +174,10 @@ console transfer:generate 8. Add configuration to `config/Shared/config_default.php`: ```php +use Spryker\Shared\SecurityBlockerBackoffice\SecurityBlockerBackofficeConstants; +use Spryker\Shared\SecurityBlockerStorefrontAgent\SecurityBlockerStorefrontAgentConstants; +use Spryker\Shared\SecurityBlockerStorefrontCustomer\SecurityBlockerStorefrontCustomerConstants; + // >>> Redis Security Blocker $config[SecurityBlockerConstants::SECURITY_BLOCKER_REDIS_PERSISTENT_CONNECTION] = true; $config[SecurityBlockerConstants::SECURITY_BLOCKER_REDIS_SCHEME] = 'tcp://'; @@ -578,7 +582,7 @@ composer update spryker/event-dispatcher spryker/glue-backend-api-application sp 2. Register `Spryker\Glue\Http\Plugin\EventDispatcher\CacheControlHeaderEventDispatcherPlugin` in `Pyz\Glue\EventDispatcher::getEventDispatcherPlugins()`. -3. Register `Spryker\Glue\GlueBackendApiApplication\Plugin\GlueApplication\StrictTransportSecurityHeaderResponseFormatterPlugin` in `Pyz\Glue\GlueBackendApiApplication::getResponseFormatterPlugins()`. +3. Register `Spryker\Glue\GlueBackendApiApplication\Plugin\GlueApplication\StrictTransportSecurityHeaderResponseFormatterPlugin` in `Pyz\Glue\GlueBackendApiApplication\GlueBackendApiApplicationDependencyProvider::getResponseFormatterPlugins()`. 4. In `Pyz\Glue\GlueStorefrontApiApplication\GlueStorefrontApiApplicationDependencyProvider::getResponseFormatterPlugins()`, register `Spryker\Glue\GlueStorefrontApiApplication\Plugin\GlueApplication\StrictTransportSecurityHeaderResponseFormatterPlugin`. @@ -619,17 +623,17 @@ public function getSecurityHeaders(): array use Spryker\Shared\Http\HttpConstants; $config[HttpConstants::YVES_HTTP_CACHE_CONTROL_CONFIG] = [ - 'public' = true, - 'max-age' = 3600, + 'public' => true, + 'max-age' => 3600, ]; $config[HttpConstants::ZED_HTTP_CACHE_CONTROL_CONFIG] = [ - 'public' = true, - 'max-age' = 3600, + 'public' => true, + 'max-age' => 3600, ]; $config[HttpConstants::GLUE_HTTP_CACHE_CONTROL_CONFIG] = [ - 'public' = true, - 'max-age' = 3600, + 'public' => true, + 'max-age' => 3600, ]; ``` diff --git a/docs/scos/user/intro-to-spryker/support/getting-support.md b/docs/scos/user/intro-to-spryker/support/getting-support.md index 3fe11c922ac..87062d0ea11 100644 --- a/docs/scos/user/intro-to-spryker/support/getting-support.md +++ b/docs/scos/user/intro-to-spryker/support/getting-support.md @@ -21,6 +21,7 @@ redirect_from: - /v1/docs/en/getting-support - /v6/docs/getting-support - /v6/docs/en/getting-support + - /docs/scos/user/intro-to-spryker/support/handling-new-feature-requests.html related: - title: How to use the Support Portal link: docs/scos/user/intro-to-spryker/support/how-to-use-the-support-portal.html @@ -28,7 +29,7 @@ related: link: docs/scos/user/intro-to-spryker/support/how-spryker-support-works.html - title: How to get the most out of Spryker Support link: docs/scos/user/intro-to-spryker/support/how-to-get-the-most-out-of-spryker-support.html - + --- If you need technical help for issues that can't be resolved with our documentation, you can always count on our support team. diff --git a/docs/scos/user/intro-to-spryker/support/handling-security-issues.md b/docs/scos/user/intro-to-spryker/support/handling-security-issues.md index 6a1f967e46e..f0c4c3a0dbf 100644 --- a/docs/scos/user/intro-to-spryker/support/handling-security-issues.md +++ b/docs/scos/user/intro-to-spryker/support/handling-security-issues.md @@ -28,7 +28,7 @@ If you find a security issue in a Spryker product, please report it to us. ## Reporting a security issue -Do not use public AHA Ideas, public Slack channels, or other public channels to report a security issue. Instead, send an e-mail to [security@spryker.com](mailto:security@spryker.com) in English and include system configuration details, reproduction steps, and received results. Your email will be forwarded to our internal team and we will confirm that we received your email and ask for more details if needed. +Do not use public Slack channels or other public channels to report a security issue. Instead, send an e-mail to [security@spryker.com](mailto:security@spryker.com) in English and include system configuration details, reproduction steps, and received results. Your email will be forwarded to our internal team and we will confirm that we received your email and ask for more details if needed. ## How we are handling security reports diff --git a/docs/scos/user/intro-to-spryker/supported-browsers.md b/docs/scos/user/intro-to-spryker/supported-browsers.md index aa0f32a6bb7..ca92725c9c6 100644 --- a/docs/scos/user/intro-to-spryker/supported-browsers.md +++ b/docs/scos/user/intro-to-spryker/supported-browsers.md @@ -1,15 +1,22 @@ --- title: Supported browsers -description: This document lists browsers supported by Spryker Commerce OS. +description: This document lists browsers supported by Spryker Cloud Commerce OS. last_updated: Jun 8, 2022 template: howto-guide-template redirect_from: - /docs/scos/dev/set-up-spryker-locally/installing-spryker-with-development-virtual-machine/scos-supported-browsers.html - /docs/scos/dev/system-requirements/202212.0/scos-supported-browsers.html + - /docs/marketplace/dev/setup/202212.0/marketplace-supported-browsers.html --- -The Spryker Commerce OS supports the following browsers for all frontend-related projects and products—[B2B Demo Shop](/docs/scos/user/intro-to-spryker/b2b-suite.html), [B2C Demo Shop](/docs/scos/user/intro-to-spryker/b2c-suite.html), [Master Suite](/docs/scos/user/intro-to-spryker/master-suite.html): +Spryker Cloud Commerce OS supports the following browsers for all frontend-related projects and products—[B2B Demo Shop](/docs/scos/user/intro-to-spryker/b2b-suite.html), [B2C Demo Shop](/docs/scos/user/intro-to-spryker/b2c-suite.html), [Master Suite](/docs/scos/user/intro-to-spryker/master-suite.html): | DESKTOP: BACK OFFICE AND STOREFRONT | MOBILE: STOREFRONT | TABLET: STOREFRONT | | --- | --- | --- | | *Browsers*:
  • Windows, macOS: Chrome (latest version)
  • Windows: Firefox (latest version)
  • Windows: Edge (latest version)
  • macOS: Safari (latest version)
*Windows versions*:
  • Windows 10
  • Windows 7
*macOS versions*:
  • Catalina 10 or later
*Screen resolutions*:
  • 1024-1920 width
|*Browsers*:
  • iOS: Safari
  • Android: Chrome
*Screen resolutions*:
  • 360x640—for example, Samsung Galaxy S8 or S9
  • 375x667—for example, iPhone 7 or 8
  • iPhone X, Xs, Xr
*Android versions*:
  • 8.0
*iOS versions*:
  • iOS 13 or later
| *Browsers*:
  • iOS: Safari
  • Android: Chrome
*iOS versions*:
  • iOS 13
*Screen resolutions*:
  • 1024x703—for example, iPad Air
| + +Spryker Marketplace supports the following browsers: + +| DESKTOP (MARKETPLACE AND MERCHANT PORTAL) | MOBILE (MARKETPLACE ONLY) | TABLET (MARKETPLACE AND MERCHANT PORTAL) | +| --- | --- | --- | +| *Browsers*:
  • Windows, macOS: Chrome (latest version)
  • Windows: Firefox (latest version)
  • Windows: Edge (latest version)
  • macOS: Safari (latest version)
*Windows versions*:
  • Windows 10
  • Windows 7
*macOS versions*:
  • Catalina 10 or later
*Screen resolutions*:
  • 1024-1920 width
| *Browsers*:
  • iOS: Safari
  • Android: Chrome
*Screen resolutions*:
  • 360x640—for example, Samsung Galaxy S8 or S9)
  • 375x667—for example, iPhone 7 or 8
  • iPhone X, Xs, Xr
*Android versions*:
  • 8.0
*iOS versions*:
  • iOS 13 or later
| *Browsers*:
  • iOS: Safari
  • Android: Chrome
*iOS versions*:
  • iOS 13
*Screen resolutions*:
  • 1024x703—for example, iPad Air
| diff --git a/docs/scos/user/intro-to-spryker/whats-new/security-updates.md b/docs/scos/user/intro-to-spryker/whats-new/security-updates.md index 3eeab10bb3a..64f84abc44b 100644 --- a/docs/scos/user/intro-to-spryker/whats-new/security-updates.md +++ b/docs/scos/user/intro-to-spryker/whats-new/security-updates.md @@ -1,7 +1,7 @@ --- title: Security updates -description: This article contains information about the security updates that happened to the Spryker Commerce OS. -last_updated: Jun 16, 2021 +description: Learn about the security updates that happened to the Spryker Commerce OS. +last_updated: Jul 12, 2023 template: concept-topic-template originalLink: https://documentation.spryker.com/2021080/docs/security-updates originalArticleId: 52f64151-dd88-406c-8408-9c08d9c0bb2d @@ -23,6 +23,10 @@ redirect_from: - /v6/docs/security-updates - /v6/docs/en/security-updates related: + - title: Security release notes 202306.0 + link: docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202306.0/security-release-notes-202306.0.html + - title: Security release notes 202304.0 + link: docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202304.0/security-release-notes-202304.0.html - title: Security release notes 202212.0 link: docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202212.0/security-release-notes-202212.0.html - title: Security release notes 202108.0 diff --git a/docs/scu/dev/onboard-to-spryker-code-upgrader/prepare-a-project-for-spryker-code-upgrader.md b/docs/scu/dev/onboard-to-spryker-code-upgrader/prepare-a-project-for-spryker-code-upgrader.md index 334fae59f95..cb24278475c 100644 --- a/docs/scu/dev/onboard-to-spryker-code-upgrader/prepare-a-project-for-spryker-code-upgrader.md +++ b/docs/scu/dev/onboard-to-spryker-code-upgrader/prepare-a-project-for-spryker-code-upgrader.md @@ -26,14 +26,6 @@ Upgrades are provided as PRs that are automatically created in a project’s rep Currently, the Upgrader supports GitHub, GitLab and Azure. If you want to use a different version control system, [contact support](https://spryker.force.com/support/s/), so we can implement its support in future. -## Optional: Implement headless design - -The Upgrader does not evaluate frontend customizations. You can either move to headless or apply frontend upgrades manually. - -## Optional: Ensure your code is compliant with the supported extensions scenarios. - -To ensure the successful delivery of Spryker updates, we recommend using the extension points that exist in the [Keeping a project upgradable](/docs/scos/dev/guidelines/keeping-a-project-upgradable/keeping-a-project-upgradable.html). - ## Migrate to Spryker Cloud Commerce OS The Upgrader supports only projects that run on [Spryker Cloud Commerce OS (SCCOS)](/docs/cloud/dev/spryker-cloud-commerce-os/getting-started-with-the-spryker-cloud-commerce-os.html). If you are running Spryker on premises, migrate to SCCOS. From a75e80717530e4aa0d74a0d8644cba04204a9e7f Mon Sep 17 00:00:00 2001 From: AlexSlawinski Date: Thu, 27 Jul 2023 09:58:39 +0200 Subject: [PATCH 09/10] Update _data/sidebars/scos_dev_sidebar.yml --- _data/sidebars/scos_dev_sidebar.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_data/sidebars/scos_dev_sidebar.yml b/_data/sidebars/scos_dev_sidebar.yml index b24cd8e1ca9..57e2dbcfb98 100644 --- a/_data/sidebars/scos_dev_sidebar.yml +++ b/_data/sidebars/scos_dev_sidebar.yml @@ -3923,7 +3923,7 @@ entries: - title: "HowTo: Allow Zed SCSS/JS on a project level for `oryx-for-zed` version 2.13.0 and later" url: /docs/scos/dev/tutorials-and-howtos/howtos/howto-allow-zed-css-js-on-a-project-for-oryx-for-zed-2.13.0-and-later.html - title: "HowTo: Reduce Jenkins execution by up to 80% without P&S and Data importers refactoring" - url: /docs/scos/dev/tutorials-and-howtos/howtos/howto-reduce-jenkins-execution-by-up-to-80-percent-without-ps-and-data-import-refactoring.html + url: /docs/scos/dev/tutorials-and-howtos/howtos/howto-reduce-jenkins-execution-costs-without-refactoring.md - title: "HowTo: Create an Angular module with application" url: /docs/scos/dev/tutorials-and-howtos/howtos/howto-create-an-angular-module-with-application.html - title: "HowTo: Split products by stores" From 3d407fe3d8bcee1d7d24342f31bf5645dd10df84 Mon Sep 17 00:00:00 2001 From: AlexSlawinski Date: Thu, 27 Jul 2023 09:58:52 +0200 Subject: [PATCH 10/10] Update _data/sidebars/scos_dev_sidebar.yml --- _data/sidebars/scos_dev_sidebar.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_data/sidebars/scos_dev_sidebar.yml b/_data/sidebars/scos_dev_sidebar.yml index 57e2dbcfb98..b2a2ff4c1fb 100644 --- a/_data/sidebars/scos_dev_sidebar.yml +++ b/_data/sidebars/scos_dev_sidebar.yml @@ -3923,7 +3923,7 @@ entries: - title: "HowTo: Allow Zed SCSS/JS on a project level for `oryx-for-zed` version 2.13.0 and later" url: /docs/scos/dev/tutorials-and-howtos/howtos/howto-allow-zed-css-js-on-a-project-for-oryx-for-zed-2.13.0-and-later.html - title: "HowTo: Reduce Jenkins execution by up to 80% without P&S and Data importers refactoring" - url: /docs/scos/dev/tutorials-and-howtos/howtos/howto-reduce-jenkins-execution-costs-without-refactoring.md + url: /docs/scos/dev/tutorials-and-howtos/howtos/howto-reduce-jenkins-execution-costs-without-refactoring.html - title: "HowTo: Create an Angular module with application" url: /docs/scos/dev/tutorials-and-howtos/howtos/howto-create-an-angular-module-with-application.html - title: "HowTo: Split products by stores"