Skip to content

Exports shipments to CSV and mark as sent, works with Czech Post and Geis

License

Notifications You must be signed in to change notification settings

munzarf/sylius-shipment-export-plugin

 
 

Repository files navigation

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

  1. Run $ composer require 3brs/sylius-shipment-export-plugin.
  2. Register \ThreeBRS\SyliusShipmentExportPlugin\ThreeBRSSyliusShipmentExportPlugin in your Kernel.
  3. Import @ThreeBRSSyliusShipmentExportPlugin/Resources/config/routing.yml in the routing.yml.
threebrs_shipment_export_plugin:
    resource: "@ThreeBRSSyliusShipmentExportPlugin/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 ThreeBRS\SyliusShipmentExportPlugin\Model\ShipmentExporterInterface and must be defined as service. Check out our sample implementations.

Predefined shipping providers:

  • Czech post
ThreeBRS\SyliusShipmentExportPlugin\Model\CeskaPostaShipmentExporter:
    public: true
    arguments:
        $currencyConverter: '@sylius.currency_converter'    
    tags:
        - name: threebrs.shipment_exporter_type
          type: 'ceska_posta'
          label: 'Česká pošta'
  • Geis
ThreeBRS\SyliusShipmentExportPlugin\Model\GeisShipmentExporter:
    public: true
    arguments:
        $currencyConverter: '@sylius.currency_converter'
    tags:
        - name: threebrs.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 3BRS
Forked from manGoweb.

About

Exports shipments to CSV and mark as sent, works with Czech Post and Geis

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • PHP 83.3%
  • Twig 9.6%
  • JavaScript 5.7%
  • Shell 1.4%