Download the PHP package 3brs/sylius-shipment-export-plugin without Composer
On this page you can find all versions of the php package 3brs/sylius-shipment-export-plugin. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download 3brs/sylius-shipment-export-plugin
More information about 3brs/sylius-shipment-export-plugin
Files in 3brs/sylius-shipment-export-plugin
Package sylius-shipment-export-plugin
Short Description Shipping export plugin for Sylius
License MIT
Informations about the package sylius-shipment-export-plugin
Shipment Export Plugin
Features
- See list of all ready to ship orders (offline payment method or payment completed for non offline method)
- Mark more orders at once as shipped
- Download CSV for submitting batch shipments with Geis
- Download CSV for submitting batch shipments with Czech Post
- You can easily extend the module to support custom CSV format for other shipping providers
Installation
- Run
composer require 3brs/sylius-shipment-export-plugin. - Register
ThreeBRS\SyliusShipmentExportPlugin\ThreeBRSSyliusShipmentExportPlugin::class => ['all' => true]in yourconfig/bundles.php. -
Import routes in your
config/routes.yaml - Import plugin configuration in your
config/packages/_sylius.yaml
Usage
You can use predefined CSV type for shipment providers Geis and Czech Post) or write your own exporter.
Your custom exporter has to implement ThreeBRS\SyliusShipmentExportPlugin\Model\ShipmentExporterInterface
and must be defined as service. Check out our sample implementations.
Predefined shipping providers:
-
Czech post
- Geis
Shipping methods
Your shipping methods must have a code that matches the code of the shipping method in the exporter
- for Geis see
\ThreeBRS\SyliusShipmentExportPlugin\Model\GeisShipmentExporter::getShippingMethodsCodes - for Czech Post see
\ThreeBRS\SyliusShipmentExportPlugin\Model\CeskaPostaShipmentExporter::getShippingMethodsCodes
Development
Usage
- Develop your plugin in
/src - See
bin/for useful commands
Testing
After your changes you must ensure that the tests are still passing.
License
This library is under the MIT license.