GITBOOK: Export Sylius documentation

This commit is contained in:
Magdalena Sadowska 2024-11-13 11:26:19 +00:00 committed by gitbook-bot
parent ad65a2c6f4
commit 97442ff7c3
No known key found for this signature in database
GPG key ID: 07D2180C7B12D0FF
16 changed files with 77 additions and 17 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 35 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 61 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 80 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 159 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 189 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 188 KiB

View file

@ -14,7 +14,11 @@ layout:
# 📖 Sylius 2.0 Documentation # 📖 Sylius 2.0 Documentation
<figure><img src=".gitbook/assets/sylius-logo_sylius-logo-light.png" alt="" width="563"><figcaption></figcaption></figure> <div data-full-width="true">
<figure><img src=".gitbook/assets/sylius-docs-heading.png" alt=""><figcaption></figcaption></figure>
</div>
**Sylius** is an open-source e-commerce platform with a modular architecture, providing a robust foundation for online stores. It focuses on delivering a dynamic developer experience and allows extensive customization to meet unique business needs.&#x20; **Sylius** is an open-source e-commerce platform with a modular architecture, providing a robust foundation for online stores. It focuses on delivering a dynamic developer experience and allows extensive customization to meet unique business needs.&#x20;

View file

@ -31,7 +31,7 @@
* [System Requirements](the-book/installation/system-requirements.md) * [System Requirements](the-book/installation/system-requirements.md)
* [Sylius CE Installation](the-book/installation/sylius-ce-installation/README.md) * [Sylius CE Installation](the-book/installation/sylius-ce-installation/README.md)
* [Sylius CE Installation with Docker](the-book/installation/sylius-ce-installation/sylius-ce-installation-with-docker.md) * [Sylius CE Installation with Docker](the-book/installation/sylius-ce-installation/sylius-ce-installation-with-docker.md)
* [Sylius Plus Installation](the-book/installation/sylius-plus-installation.md) * [ Sylius Plus Installation](the-book/installation/sylius-plus-installation.md)
* [Upgrading Sylius CE](the-book/installation/upgrading-sylius-ce.md) * [Upgrading Sylius CE](the-book/installation/upgrading-sylius-ce.md)
* [Upgrading Sylius Plus](the-book/installation/upgrading-sylius-plus.md) * [Upgrading Sylius Plus](the-book/installation/upgrading-sylius-plus.md)
* [Architecture](the-book/architecture/README.md) * [Architecture](the-book/architecture/README.md)
@ -50,7 +50,7 @@
* [Currencies](the-book/configuration/currencies.md) * [Currencies](the-book/configuration/currencies.md)
* [Customers](the-book/customers/README.md) * [Customers](the-book/customers/README.md)
* [Customer & ShopUser](the-book/customers/customer-and-shopuser.md) * [Customer & ShopUser](the-book/customers/customer-and-shopuser.md)
* [Customer Pools](the-book/customers/customer-pools.md) * [ Customer Pools](the-book/customers/customer-pools.md)
* [AdminUser](the-book/customers/adminuser.md) * [AdminUser](the-book/customers/adminuser.md)
* [Addresses](the-book/customers/addresses/README.md) * [Addresses](the-book/customers/addresses/README.md)
* [Countries](the-book/customers/addresses/countries.md) * [Countries](the-book/customers/addresses/countries.md)
@ -66,7 +66,7 @@
* [Catalog Promotions](the-book/products/catalog-promotions.md) * [Catalog Promotions](the-book/products/catalog-promotions.md)
* [Taxons](the-book/products/taxons.md) * [Taxons](the-book/products/taxons.md)
* [Inventory](the-book/products/inventory.md) * [Inventory](the-book/products/inventory.md)
* [Multi-Source Inventory](the-book/products/multi-source-inventory.md) * [ Multi-Source Inventory](the-book/products/multi-source-inventory.md)
* [Search](the-book/products/search.md) * [Search](the-book/products/search.md)
* [Carts & Orders](the-book/carts-and-orders/README.md) * [Carts & Orders](the-book/carts-and-orders/README.md)
* [Orders](the-book/carts-and-orders/orders.md) * [Orders](the-book/carts-and-orders/orders.md)
@ -76,7 +76,7 @@
* [Cart Promotions](the-book/carts-and-orders/cart-promotions.md) * [Cart Promotions](the-book/carts-and-orders/cart-promotions.md)
* [Coupons](the-book/carts-and-orders/coupons.md) * [Coupons](the-book/carts-and-orders/coupons.md)
* [Payments](the-book/carts-and-orders/payments.md) * [Payments](the-book/carts-and-orders/payments.md)
* [Invoices](the-book/carts-and-orders/invoices.md) * [🧩 Invoices](the-book/carts-and-orders/invoices.md)
* [Shipments](the-book/carts-and-orders/shipments.md) * [Shipments](the-book/carts-and-orders/shipments.md)
* [Checkout](the-book/carts-and-orders/checkout.md) * [Checkout](the-book/carts-and-orders/checkout.md)
* [Returns](the-book/carts-and-orders/returns.md) * [Returns](the-book/carts-and-orders/returns.md)

View file

@ -101,7 +101,7 @@ You have the following parameters available:
* `channel`: Channel in which an order was placed * `channel`: Channel in which an order was placed
* `localeCode`: Locale code in which an order was placed * `localeCode`: Locale code in which an order was placed
{% embed url="https://sylius.com/plus/?utm_campaign=plus&utm_medium=cta&utm_source=docs" fullWidth="true" %} <figure><img src="../../.gitbook/assets/sylius-docs-plusfeature-start (1).png" alt=""><figcaption></figcaption></figure>
### Sylius Plus: Return Requests Emails ### Sylius Plus: Return Requests Emails
@ -175,7 +175,7 @@ Parameters:
<div data-full-width="true"> <div data-full-width="true">
<figure><img src="../../.gitbook/assets/banner.png" alt=""><figcaption></figcaption></figure> <figure><img src="../../.gitbook/assets/sylius-docs-plusfeature-end.png" alt=""><figcaption></figcaption></figure>
</div> </div>

View file

@ -12,10 +12,16 @@ layout:
visible: true visible: true
--- ---
# Invoices # 🧩 Invoices
An invoice is a commercial document issued by a shop as a confirmation of a sales transaction. It lists the products, quantities, and prices agreed upon, and typically includes payment terms (e.g., due date, payment status). For the shop, it's a sales invoice; for the customer, it's a purchase invoice. An invoice is a commercial document issued by a shop as a confirmation of a sales transaction. It lists the products, quantities, and prices agreed upon, and typically includes payment terms (e.g., due date, payment status). For the shop, it's a sales invoice; for the customer, it's a purchase invoice.
<div data-full-width="false">
<figure><img src="../../.gitbook/assets/sylius-docs-pluginfeature-start.png" alt=""><figcaption></figcaption></figure>
</div>
## Invoicing in Sylius ## Invoicing in Sylius
Sylius provides invoicing functionality through [a free open-source plugin](https://github.com/Sylius/InvoicingPlugin). For installation, refer to the plugins README. Sylius provides invoicing functionality through [a free open-source plugin](https://github.com/Sylius/InvoicingPlugin). For installation, refer to the plugins README.
@ -49,3 +55,9 @@ The plugin uses the billing data provided in Sylius Channels for invoice details
## Learn more ## Learn more
* [Sylius Invoicing Plugin](https://github.com/Sylius/InvoicingPlugin) * [Sylius Invoicing Plugin](https://github.com/Sylius/InvoicingPlugin)
<div data-full-width="false">
<figure><img src="../../.gitbook/assets/sylius-docs-pluginfeature-end.png" alt=""><figcaption></figcaption></figure>
</div>

View file

@ -22,10 +22,14 @@ A shipment represents a shipping request for an order in Sylius. Each order can
To understand the process of creating shipments, refer to the guide on [Orders](orders.md) where shipments are covered in detail. To understand the process of creating shipments, refer to the guide on [Orders](orders.md) where shipments are covered in detail.
{% endhint %} {% endhint %}
<figure><img src="../../.gitbook/assets/sylius-docs-plusfeature-start (1).png" alt=""><figcaption></figcaption></figure>
### Splitting Shipments ### Splitting Shipments
In Sylius Plus, orders can be fulfilled partially, allowing for shipment splitting. This feature provides a UI where you can select items from an existing shipment to create a new one and send it (with or without a tracking code). Shipments can be split as long as at least one shipment remains in the `ready` state. In Sylius Plus, orders can be fulfilled partially, allowing for shipment splitting. This feature provides a UI where you can select items from an existing shipment to create a new one and send it (with or without a tracking code). Shipments can be split as long as at least one shipment remains in the `ready` state.
<figure><img src="../../.gitbook/assets/sylius-docs-plusfeature-end.png" alt=""><figcaption></figcaption></figure>
### Shipment State Machine ### Shipment State Machine
Each shipment has its own state machine with these states: `cart`, `ready`, `cancelled`, `shipped`. Each shipment has its own state machine with these states: `cart`, `ready`, `cancelled`, `shipped`.

View file

@ -84,7 +84,11 @@ For [Invoicing](https://docs.sylius.com/en/1.13/book/orders/invoices.html) and [
<figure><img src="../../.gitbook/assets/shop_billing_data.png" alt=""><figcaption></figcaption></figure> <figure><img src="../../.gitbook/assets/shop_billing_data.png" alt=""><figcaption></figcaption></figure>
{% embed url="https://sylius.com/plus/?utm_campaign=plus&utm_medium=cta&utm_source=docs" fullWidth="true" %} <div data-full-width="true">
<figure><img src="../../.gitbook/assets/sylius-docs-plusfeature-start (1).png" alt=""><figcaption></figcaption></figure>
</div>
#### Business Units #### Business Units
@ -104,6 +108,6 @@ Sylius Plus is supplied with an enhanced version of Shop Billing Data from Syliu
<div data-full-width="true"> <div data-full-width="true">
<figure><img src="../../.gitbook/assets/banner.png" alt=""><figcaption></figcaption></figure> <figure><img src="../../.gitbook/assets/sylius-docs-plusfeature-end.png" alt=""><figcaption></figcaption></figure>
</div> </div>

View file

@ -36,6 +36,12 @@ In **Sylius** by default you have got the administration panel routes (`/admin/*
Only the logged-in **AdminUsers** are eligible to enter these routes. Only the logged-in **AdminUsers** are eligible to enter these routes.
<div data-full-width="true">
<figure><img src="../../.gitbook/assets/sylius-docs-plusfeature-start (1).png" alt=""><figcaption></figcaption></figure>
</div>
## Access Control via Administrator Roles (ACL/RBAC) ## Access Control via Administrator Roles (ACL/RBAC)
RBAC (_Role Based Access Control_) or ACL (_Access Control Layer_) is an approach to restricting system access for users using the roles system. It is required by the majority of companies on the enterprise level, thus it is provided in the Sylius Plus edition. RBAC (_Role Based Access Control_) or ACL (_Access Control Layer_) is an approach to restricting system access for users using the roles system. It is required by the majority of companies on the enterprise level, thus it is provided in the Sylius Plus edition.
@ -194,6 +200,12 @@ It is possible to choose a channel to which an Administrator has access. It is d
Having chosen a channel on an Administrator, their access will get restricted within the Sales section of the main menu in the Admin Panel. Thus they will see only orders, payments, shipments, return requests, invoices and credit memos from the channel they have access to. Having chosen a channel on an Administrator, their access will get restricted within the Sales section of the main menu in the Admin Panel. Thus they will see only orders, payments, shipments, return requests, invoices and credit memos from the channel they have access to.
<div data-full-width="true">
<figure><img src="../../.gitbook/assets/sylius-docs-plusfeature-end.png" alt=""><figcaption></figcaption></figure>
</div>
### Additional Admin User Fixtures ### Additional Admin User Fixtures
Three new fields have been added to the Admin User fixtures: `channel`, `roles` and `enable_permission_checker`. They can be configured as below: Three new fields have been added to the Admin User fixtures: `channel`, `roles` and `enable_permission_checker`. They can be configured as below:

View file

@ -1,5 +1,9 @@
--- ---
coverY: 0
layout: layout:
cover:
visible: true
size: full
title: title:
visible: true visible: true
description: description:
@ -12,7 +16,13 @@ layout:
visible: true visible: true
--- ---
# Customer Pools # Customer Pools
<div data-full-width="true">
<figure><img src="../../.gitbook/assets/sylius-docs-plusfeature-start (1).png" alt=""><figcaption></figcaption></figure>
</div>
Customer Pool is a collection of Customers that is assigned to a specific channel. Thanks to this concept, if you have two channels, each of them has a separate customer pool, then customers that have accounts in channel A, and have not registered in channel B, will not be able to log in to channel B with credentials they have specified in channel A (which is the behavior happening in Sylius CE). This feature allows you to sell via multiple channels, creating an illusion of shopping in completely different stores, while you still have one administration panel. Customer Pool is a collection of Customers that is assigned to a specific channel. Thanks to this concept, if you have two channels, each of them has a separate customer pool, then customers that have accounts in channel A, and have not registered in channel B, will not be able to log in to channel B with credentials they have specified in channel A (which is the behavior happening in Sylius CE). This feature allows you to sell via multiple channels, creating an illusion of shopping in completely different stores, while you still have one administration panel.
@ -93,3 +103,9 @@ To assign a Customer Pool to a Channel programmatically use this simple trick:
$channel->setCustomerPool($customerPool); $channel->setCustomerPool($customerPool);
``` ```
<div data-full-width="true">
<figure><img src="../../.gitbook/assets/sylius-docs-plusfeature-end.png" alt=""><figcaption></figcaption></figure>
</div>

View file

@ -1,9 +1,5 @@
--- ---
coverY: 0
layout: layout:
cover:
visible: true
size: full
title: title:
visible: true visible: true
description: description:
@ -16,7 +12,7 @@ layout:
visible: true visible: true
--- ---
# Sylius Plus Installation # Sylius Plus Installation
Sylius Plus is a licensed, modular set of advanced extensions to Sylius applications that add new features and experience. As these are private packages they cannot be installed by every Sylius user, but only by those having the license. Sylius Plus is a licensed, modular set of advanced extensions to Sylius applications that add new features and experience. As these are private packages they cannot be installed by every Sylius user, but only by those having the license.

View file

@ -12,7 +12,13 @@ layout:
visible: true visible: true
--- ---
# Multi-Source Inventory # Multi-Source Inventory
<div data-full-width="true">
<figure><img src="../../.gitbook/assets/sylius-docs-plusfeature-start (1).png" alt=""><figcaption></figcaption></figure>
</div>
Sylius Plus offers a more advanced approach to inventory management than the open-source version. While the Community Edition allows only one stock amount per variant, **Sylius Plus Multi-Source Inventory** enables you to create multiple **Inventory Sources** and manage different stock amounts for each source. Sylius Plus offers a more advanced approach to inventory management than the open-source version. While the Community Edition allows only one stock amount per variant, **Sylius Plus Multi-Source Inventory** enables you to create multiple **Inventory Sources** and manage different stock amounts for each source.
@ -107,3 +113,9 @@ stocks_in_frankfurt_warehouse:
- 'HOME_WEB' - 'HOME_WEB'
- 'FASHION_WEB' - 'FASHION_WEB'
``` ```
<div data-full-width="true">
<figure><img src="../../.gitbook/assets/sylius-docs-plusfeature-end.png" alt=""><figcaption></figcaption></figure>
</div>