Feature WalkthroughsEdit on GitHub
This section contains a collection of walkthroughs for the features found within the Spryker Commerce OS. Once Spryker has been installed, you can take advantage of its many different features as described below.
The Agent Assist feature lets you add an agent, a person who assists customers: advises the best fit for customers and performs various activities on behalf of a customer on the Storefront.
The Alternative Products feature lets you define alternative products for products that are discontinued or out of stock.
The Catalog feature lets you build and organize products to meet your and your customer’s demands, primarily to make sure everyone can quickly find what they are looking for.
The Category Management feature lets you manage your product catalog with customized categories, category pages, and filters. All products can be categorized into logical clusters so that customers can filter them on the Storefront.
The CMS feature adds a content management system that lets you create and manage the content of custom pages that are not part of the product catalog.
CMS extension points: reference information
The CMS module provides an extension point for post activation and deactivation of CMS pages.
The Comments feature lets you add multiple comments to any entity. The feature can be integrated into any page or entity of the online shop.
The Company Account feature lets you control user access to the system within an organization by configuring different permissions and roles for the company’s entities (units) and users.
Company account: module relations
This schema illustrates relations between company, business unit, company unit address and company user (customer).
Customer Login by Token: reference information
A token is a unique identifier that contains all the information needed for authentication to fetch a specific resource without using a username and password. The tokens are JSON strings that are encoded in the base64url format.
The Configurable Bundle feature lets you create a configurable list of items.
The Configurable Product feature introduces a new type of product that can be customized by customers—a configurable product.
Configuration process flow of Configurable Product
The configuration process of a configurable product consists of eight phases.
The Content Items feature creates an abstraction layer for content management in the Back Office. It lets content managers create and preserve small content pieces, which can be inserted into CMS blocks and then into Storefront pages.
Content item types: module relations
This document describes each content item type and the module relations used for them.
The Customer Access feature lets you limit what information guest customers can access.
Customer Account Management
The Customer Account Management feature enables a wide range of management options for customer accounts and additional functionalities.
Customer module overview
The Customer entity wraps data around registered customers. Customer data is managed from the Back Office by a shop administrator and from a shop website itself by customers. This document describes how new customers can be created and managed and how to enable specific features related to customers.
The File Manager feature lets you upload files required for your shop.
AvailabilityStorage module: reference information
The AvailabilityStorage module publishes all the availability information for abstract and concrete products. Items are grouped by abstract product, and the process is handled by Publish and Synchronize.
The Measurement Units feature lets you sell products by any unit of measure defined by in the Back Office.
The Merchant feature provides the core functionality for the SCOS B2B and Marketplace with the basic create-read-update operations over the Merchant entity. You cannot delete a merchant but only deactivate them.
Merchant B2B Contracts
The Merchant B2B Contracts feature lets you set up contracts between a merchant and B2B customer.
Merchant Product Restrictions
The Merchant Product Restrictions feature lets merchants define what products are available to each of their B2B customers.
Restricted products behavior
On this page, you can find commonly encountered cases of product restrictions behavior.
Navigation module: reference information
The Navigation module manages multiple navigation menus that can be displayed on the frontend (Yves). Every navigation section can contain its own nested structure of navigation nodes. Navigation nodes have types that help define what kind of link they represent.
The Non-splittable Products feature lets you control if items bought in quantities greater than 1 are grouped in the cart or processed as separate items.
The Order Management feature adds a collection of functionalities that let you see the quantity of the order items, their status, and how long they exist. Also, you can view details per status and order page.
Custom Order Reference: module relations
The module relations for the Custom Order Reference feature.
The Sales module provides the order management functionality. The functionality is obtained through the ZED UI that renders orders with order details and the Client API to get customer orders.
The Packaging Units feature defines if a packaging unit holds a fixed amount of products or if customers can buy any amount of products in this packaging unit. Also, it lets you apply amount restrictions to products.
The Payments feature lets customers pay for orders with none, one, or multiple payment methods during the checkout process.
Persistent Cart Sharing: module relations
This schema illustrates module relations in the Unique URL per Cart for the Easy Sharing feature
PriceProduct module details: reference information
This document describes technical details of the PriceProduct module that are valid since version 2 of the module.
The Product feature lets you create products and manage their characteristics and settings.
Product Approval Process
The Product Approval Process feature adds approval mechanisms for products by providing an optional
spy_product_abstract.approval_status DB column to store product approval statuses. Thus, a shop owner can follow the review process and manage which products will be placed in the store by setting the corresponding approval statuses. The feature also provides the Back Office UI for managing the approval statuses and the corresponding Data importer.
The Product Barcode feature lets you create barcodes for any kind of entity.
The Product Bundles feature lets you tie individual items together and sell them as a package.
The Product Groups feature lets product catalog managers group products by attributes, like color or size.
The Product Labels feature enables product catalog managers to highlight the desired products by adding a special type of information—product labels.
The Product Lists feature lets you configure product availability for specific companies by blacklisting or whitelisting products for them.
The Product Options feature lets a Back Office user create and assign product options to abstract products.
Product Rating and Reviews
The Product Rating & Reviews feature lets customers add reviews and ratings to abstract products.
The Product Relations feature enables product catalog managers to create logical relations between products based on their actual properties. Product relations are displayed on the Storefront to achieve multiple purposes.
Product Relations: module relations
This schema illustrates the module relations within the Product Relations feature.
The Product Sets feature lets you create and sell collections of products.
Product Sets: module relations
The ProductSet module provides a
spy_product_set table that stores some non-localized data about Product Sets entities. Localized data is stored in the
spy_product_set_data table. These tables, along with their related URLs and product image sets, contain all the necessary data about Product Sets entities that you can list on the Storefront or show their representing Product details pages.
The Reclamations feature lets Back Office users handle order claims issued by customers.
Spryker Core Back Office
The Spryker Core Back Office feature adds a comprehensive, intuitive administration area that provides the product and content management capabilities, categories and navigation building blocks, search and filter customizations, barcode generator, order handling, company structure creation (for B2B users), merchant-buyer contracts’ setup.
The Tax feature lets you define taxes for the items you sell. The feature is represented by two entities: tax rates and tax sets.
Tax module: reference information
The Tax module is responsible for handling tax rates that can apply for products, product options, or a shipment.
For submitting the form