Sylius Documentation¶
Sylius is a modern e-commerce solution for PHP, based on Symfony Framework.
Note
This documentation assumes you have a working knowledge of the Symfony Framework. If you’re not familiar with Symfony, please start with reading the Quick Tour from the Symfony documentation.
Tip
The Book, Customization Guide, REST API Reference, Cookbook, Contribution Guide and Behat Guide are chapters describing the usage of the whole Sylius platform, on the examples for Sylius-Standard distribution.
For tips on using only some bundles of Sylius head to Bundles and Components docs.
The Book¶
The Developer’s guide to leveraging the flexibility of Sylius. Here you will find all the concepts used in the Sylius platform. The Book helps to understand how Sylius works.
The Customization Guide¶
The Customization Guide is helpful while wanting to adapt Sylius to your personal business needs.
Sylius Plugins¶
The collection of Sylius Plugins together with the guide on Plugins development. Remember that you can use all the customization techniques in Plugins.
The REST API Reference¶
The API guide covers the REST API of Sylius platform.
- Introduction to Sylius REST API
- Authorization
- Admin Users API
- Carts API
- Channels API
- Checkout API
- Countries API
- Currencies API
- Customers API
- Exchange Rates API
- Locales API
- Orders API
- Payment Methods API
- Payments API
- Product Attributes API
- Product Options API
- Product Reviews API
- Product Variants API
- Products API
- Promotion Coupons API
- Promotions API
- Provinces API
- Shipments API
- Shipping Categories API
- Shipping Methods API
- Tax Categories API
- Tax Rates API
- Taxons API
- Zones API
- Sorting and filtration
The BDD Guide¶
In the BDD Guide you will learn how to write clean and reusable features, contexts and pages using Behat.
Components & Bundles¶
Documentation of all Sylius components and bundles useful when using them standalone.