8. Shipping method requirements¶

Sylius has a very flexible system for displaying only the right shipping methods to the user.

8.1. Shipping categories¶

Every ShippableInterface can hold a reference to ShippingCategory. The ShippingSubjectInterface (or ShipmentInterface) returns a collection of shippables.

ShippingMethod has an optional shipping category setting as well as categoryRequirement which has 3 options. If this setting is set to null, categories system is ignored.

8.1.1. “Match any” requirement¶

With this requirement, the shipping method will support any shipment (or shipping subject) which contains at least one shippable with the same category.

8.1.2. “Match all” requirement¶

All shippables have to reference the same category as the ShippingMethod.

8.1.3. “Match none” requirement¶

None of the shippables can have the same shipping category.

8.2. Shipping rules¶

The categories system is sufficient for basic use cases, for more advanced requirements, Sylius has the shipping rules system.

Every ShippingMethod can have a collection of ShippingRule instances. Each shipping rule, has a checker and configuration assigned. The ShippingRule.checker attribute holds the alias name of appropriate service implementing RuleCheckerInterface. Just like with cost calculators, Sylius ships with default checkers, but you can easily implement your own.

The ShippingMethodEligibilityChecker service can check if given subject, satisfies the category and shipping rules.