mangoweb-sylius/sylius-shipment-export-plugin

Shipping export plugin for Sylius


README

38423357?s=200&v=4

Shipment Export Plugin
68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f6d616e676f7765622d73796c6975732f73796c6975732d736869706d656e742d6578706f72742d706c7567696e2e737667 68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6d616e676f7765622d73796c6975732f73796c6975732d736869706d656e742d6578706f72742d706c7567696e2e737667 68747470733a2f2f696d672e736869656c64732e696f2f7472617669732f6d616e676f7765622d73796c6975732f53796c697573536869706d656e744578706f7274506c7567696e2f6d61737465722e737667

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

menu.png

list.png

Installation

  1. Run $ composer require mangoweb-sylius/sylius-shipment-export-plugin.
  2. Register \MangoSylius\ShipmentExportPlugin\MangoSyliusShipmentExportPlugin in your Kernel.
  3. Import @MangoSyliusShipmentExportPlugin/Resources/config/routing.yml in the routing.yml.
mango_sylius_shipment_export_plugin:
    resource: "@MangoSyliusShipmentExportPlugin/Resources/config/routing.yml"
    prefix: /admin

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 MangoSylius\ShipmentExportPlugin\Model\ShipmentExporterInterface and must be defined as service. Check out our sample implementations.

Predefined shipping providers:

  • Czech post
MangoSylius\ShipmentExportPlugin\Model\CeskaPostaShipmentExporter:
    public: true
    arguments:
        $currencyConverter: '@sylius.currency_converter'    
    tags:
        - name: mango_sylius.shipment_exporter_type
          type: 'ceska_posta'
          label: 'Česká pošta'
  • Geis
MangoSylius\ShipmentExportPlugin\Model\GeisShipmentExporter:
    public: true
    arguments:
        $currencyConverter: '@sylius.currency_converter'
    tags:
        - name: mango_sylius.shipment_exporter_type
          type: 'geis'
          label: 'Geis'

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.

$ composer install
$ bin/phpstan.sh
$ bin/ecs.sh

License

This library is under the MIT license.

Credits

Developed by manGoweb.