Order Hold

The problem

Plugins that keep placed orders unpaid for a while (pay on account, manual review) all need the same changes to Sylius: keep their orders out of sylius:cancel-unpaid-orders, hide some payment methods everywhere Sylius offers or assigns one, and stop the customer from paying an order that is not ready. When two plugins decorate the same Sylius services on their own, the decorations compete and break each other.

Features

• UnpaidOrderCancellationExclusionInterface: hold an order indefinitely or since a date; one decorator of the unpaid orders updater, a command that always terminates, each cancellation flushed and logged on its own.
• UnpaidOrderCandidateQueryExtensionInterface: exclude held orders in SQL.
• PaymentMethodEligibilityCheckerInterface: refuse a payment method with a reason, applied to the shop and API method lists, the default method, payments created after a failed one, method changes after checkout, payment requests and checkout completion.
• PaymentEntryBlockerInterface: block the shop payment routes and shop API payment requests until the order may be paid.
• AccountOwnerResolverInterface: the customer by default, decorated by a company plugin.
• Fails early (container build) when the checkout, order or payment graph runs on Winzou.

This is a library for plugin developers: it has no route, no screen and no table of its own. Merchants get it as a dependency of Trade Credit.

Installation

Usually installed as a dependency of another plugin. Directly:

1. composer require tmonier/sylius-order-hold-plugin
2. Register Tmonier\SyliusOrderHoldPlugin\TmonierSyliusOrderHoldPlugin in config/bundles.php.
3. Implement and tag the interfaces you need (see "Writing a hold plugin" in the README).

Full documentation: README on GitHub.

Compatibility

Sylius 2.2.9+ and 2.3, Symfony Workflow adapter for the checkout, order and payment graphs (the Sylius 2 default); MySQL, MariaDB and PostgreSQL.

Languages

Default messages in English, French, German, Spanish, Italian, Dutch, Polish.